Regen docs (#373)
diff --git a/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.invitations.html b/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.invitations.html
index 361790f..1dbaef9 100644
--- a/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.invitations.html
+++ b/docs/dyn/adexchangebuyer2_v2beta1.accounts.clients.invitations.html
@@ -102,14 +102,14 @@
{ # An invitation for a new client user to get access to the Ad Exchange
# Buyer UI.
# All fields are required unless otherwise specified.
- "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
- # The value of this field is ignored in create operations.
"clientAccountId": "A String", # Numerical account ID of the client buyer
# that the invited user is associated with.
# The value of this field is ignored in create operations.
"email": "A String", # The email address to which the invitation is sent. Email
# addresses should be unique among all client users under each sponsor
# buyer.
+ "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
+ # The value of this field is ignored in create operations.
}
x__xgafv: string, V1 error format.
@@ -123,14 +123,14 @@
{ # An invitation for a new client user to get access to the Ad Exchange
# Buyer UI.
# All fields are required unless otherwise specified.
- "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
- # The value of this field is ignored in create operations.
"clientAccountId": "A String", # Numerical account ID of the client buyer
# that the invited user is associated with.
# The value of this field is ignored in create operations.
"email": "A String", # The email address to which the invitation is sent. Email
# addresses should be unique among all client users under each sponsor
# buyer.
+ "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
+ # The value of this field is ignored in create operations.
}</pre>
</div>
@@ -154,14 +154,14 @@
{ # An invitation for a new client user to get access to the Ad Exchange
# Buyer UI.
# All fields are required unless otherwise specified.
- "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
- # The value of this field is ignored in create operations.
"clientAccountId": "A String", # Numerical account ID of the client buyer
# that the invited user is associated with.
# The value of this field is ignored in create operations.
"email": "A String", # The email address to which the invitation is sent. Email
# addresses should be unique among all client users under each sponsor
# buyer.
+ "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
+ # The value of this field is ignored in create operations.
}</pre>
</div>
@@ -206,14 +206,14 @@
{ # An invitation for a new client user to get access to the Ad Exchange
# Buyer UI.
# All fields are required unless otherwise specified.
- "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
- # The value of this field is ignored in create operations.
"clientAccountId": "A String", # Numerical account ID of the client buyer
# that the invited user is associated with.
# The value of this field is ignored in create operations.
"email": "A String", # The email address to which the invitation is sent. Email
# addresses should be unique among all client users under each sponsor
# buyer.
+ "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
+ # The value of this field is ignored in create operations.
},
],
}</pre>
diff --git a/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.dealAssociations.html b/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.dealAssociations.html
index 52f88fb..86edd0f 100644
--- a/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.dealAssociations.html
+++ b/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.dealAssociations.html
@@ -162,11 +162,6 @@
An object of the form:
{ # A response for listing creative and deal associations
- "nextPageToken": "A String", # A token to retrieve the next page of results.
- # Pass this value in the
- # ListDealAssociationsRequest.page_token
- # field in the subsequent call to 'ListDealAssociation' method to retrieve
- # the next page of results.
"associations": [ # The list of associations.
{ # The association between a creative and a deal.
"dealsId": "A String", # The externalDealId for the deal associated with the creative.
@@ -174,6 +169,11 @@
"accountId": "A String", # The account the creative belongs to.
},
],
+ "nextPageToken": "A String", # A token to retrieve the next page of results.
+ # Pass this value in the
+ # ListDealAssociationsRequest.page_token
+ # field in the subsequent call to 'ListDealAssociation' method to retrieve
+ # the next page of results.
}</pre>
</div>
diff --git a/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.html b/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.html
index 725bd1d..62d48ff 100644
--- a/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.html
+++ b/docs/dyn/adexchangebuyer2_v2beta1.accounts.creatives.html
@@ -173,22 +173,6 @@
"A String",
],
"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
- "accountId": "A String", # The account that this creative belongs to.
- # Can be used to filter the response of the
- # creatives.list
- # method.
- "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative.
- # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
- # for possible values.
- 42,
- ],
- "agencyId": "A String", # The agency ID for this creative.
- "html": { # HTML content for a creative. # An HTML creative.
- "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
- "width": 42, # The width of the HTML snippet in pixels.
- "height": 42, # The height of the HTML snippet in pixels.
- },
- "apiUpdateTime": "A String", # @OutputOnly The last update timestamp of the creative via API.
"native": { # Native content for a creative. # A native creative.
"body": "A String", # A long description of the ad.
"videoUrl": "A String", # The URL to fetch a native video ad.
@@ -199,10 +183,16 @@
"width": 42, # Image width in pixels.
"height": 42, # Image height in pixels.
},
- "clickTrackingUrl": "A String", # The URL to use for click tracking.
"starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
"advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
"priceDisplayText": "A String", # The price of the promoted app including currency info.
+ "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
+ "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.
+ # so long as the aspect ratio is preserved.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ "height": 42, # Image height in pixels.
+ },
"callToAction": "A String", # A label for the button that the user is supposed to click.
"logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo.
# so long as the aspect ratio is preserved.
@@ -210,32 +200,44 @@
"width": 42, # Image width in pixels.
"height": 42, # Image height in pixels.
},
- "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.
- # so long as the aspect ratio is preserved.
- "url": "A String", # The URL of the image.
- "width": 42, # Image width in pixels.
- "height": 42, # Image height in pixels.
- },
- "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
"clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
},
+ "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative.
+ # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
+ # for possible values.
+ 42,
+ ],
"detectedProductCategories": [ # @OutputOnly Detected product categories, if any.
# See the ad-product-categories.txt file in the technical documentation
# for a list of IDs.
42,
],
+ "html": { # HTML content for a creative. # An HTML creative.
+ "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
+ "width": 42, # The width of the HTML snippet in pixels.
+ "height": 42, # The height of the HTML snippet in pixels.
+ },
+ "apiUpdateTime": "A String", # @OutputOnly The last update timestamp of the creative via API.
+ "accountId": "A String", # The account that this creative belongs to.
+ # Can be used to filter the response of the
+ # creatives.list
+ # method.
+ "agencyId": "A String", # The agency ID for this creative.
"detectedDomains": [ # @OutputOnly
# The detected domains for this creative.
"A String",
],
- "attributes": [ # All attributes for the ads that may be shown from this creative.
+ "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
+ # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
+ # serving_restrictions will also exist. Note
+ # that this may be nuanced with other contextual restrictions, in which case,
+ # it may be preferable to read from serving_restrictions directly.
# Can be used to filter the response of the
# creatives.list
# method.
- "A String",
- ],
- "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
- # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
+ "openAuctionStatus": "A String", # @OutputOnly The top-level open auction status of this creative.
+ # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
# serving_restrictions will also exist. Note
# that this may be nuanced with other contextual restrictions, in which case,
# it may be preferable to read from serving_restrictions directly.
@@ -250,6 +252,8 @@
# specific context. A context here relates to where something ultimately serves
# (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,
# or the type of auction).
+ "status": "A String", # The status of the creative in this context (for example, it has been
+ # explicitly disapproved or is pending review).
"contexts": [ # The contexts for the restriction.
{ # The serving context for this restriction.
"all": "A String", # Matches all contexts.
@@ -284,8 +288,6 @@
},
},
],
- "status": "A String", # The status of the creative in this context (for example, it has been
- # explicitly disapproved or is pending review).
"disapprovalReasons": [ # Any disapprovals bound to this restriction.
# Only present if status=DISAPPROVED.
# Can be used to filter the response of the
@@ -345,14 +347,12 @@
],
},
],
- "openAuctionStatus": "A String", # @OutputOnly The top-level open auction status of this creative.
- # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
- # serving_restrictions will also exist. Note
- # that this may be nuanced with other contextual restrictions, in which case,
- # it may be preferable to read from serving_restrictions directly.
+ "attributes": [ # All attributes for the ads that may be shown from this creative.
# Can be used to filter the response of the
# creatives.list
# method.
+ "A String",
+ ],
}
duplicateIdMode: string, Indicates if multiple creatives can share an ID or not. Default is
@@ -425,22 +425,6 @@
"A String",
],
"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
- "accountId": "A String", # The account that this creative belongs to.
- # Can be used to filter the response of the
- # creatives.list
- # method.
- "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative.
- # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
- # for possible values.
- 42,
- ],
- "agencyId": "A String", # The agency ID for this creative.
- "html": { # HTML content for a creative. # An HTML creative.
- "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
- "width": 42, # The width of the HTML snippet in pixels.
- "height": 42, # The height of the HTML snippet in pixels.
- },
- "apiUpdateTime": "A String", # @OutputOnly The last update timestamp of the creative via API.
"native": { # Native content for a creative. # A native creative.
"body": "A String", # A long description of the ad.
"videoUrl": "A String", # The URL to fetch a native video ad.
@@ -451,10 +435,16 @@
"width": 42, # Image width in pixels.
"height": 42, # Image height in pixels.
},
- "clickTrackingUrl": "A String", # The URL to use for click tracking.
"starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
"advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
"priceDisplayText": "A String", # The price of the promoted app including currency info.
+ "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
+ "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.
+ # so long as the aspect ratio is preserved.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ "height": 42, # Image height in pixels.
+ },
"callToAction": "A String", # A label for the button that the user is supposed to click.
"logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo.
# so long as the aspect ratio is preserved.
@@ -462,32 +452,44 @@
"width": 42, # Image width in pixels.
"height": 42, # Image height in pixels.
},
- "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.
- # so long as the aspect ratio is preserved.
- "url": "A String", # The URL of the image.
- "width": 42, # Image width in pixels.
- "height": 42, # Image height in pixels.
- },
- "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
"clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
},
+ "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative.
+ # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
+ # for possible values.
+ 42,
+ ],
"detectedProductCategories": [ # @OutputOnly Detected product categories, if any.
# See the ad-product-categories.txt file in the technical documentation
# for a list of IDs.
42,
],
+ "html": { # HTML content for a creative. # An HTML creative.
+ "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
+ "width": 42, # The width of the HTML snippet in pixels.
+ "height": 42, # The height of the HTML snippet in pixels.
+ },
+ "apiUpdateTime": "A String", # @OutputOnly The last update timestamp of the creative via API.
+ "accountId": "A String", # The account that this creative belongs to.
+ # Can be used to filter the response of the
+ # creatives.list
+ # method.
+ "agencyId": "A String", # The agency ID for this creative.
"detectedDomains": [ # @OutputOnly
# The detected domains for this creative.
"A String",
],
- "attributes": [ # All attributes for the ads that may be shown from this creative.
+ "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
+ # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
+ # serving_restrictions will also exist. Note
+ # that this may be nuanced with other contextual restrictions, in which case,
+ # it may be preferable to read from serving_restrictions directly.
# Can be used to filter the response of the
# creatives.list
# method.
- "A String",
- ],
- "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
- # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
+ "openAuctionStatus": "A String", # @OutputOnly The top-level open auction status of this creative.
+ # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
# serving_restrictions will also exist. Note
# that this may be nuanced with other contextual restrictions, in which case,
# it may be preferable to read from serving_restrictions directly.
@@ -502,6 +504,8 @@
# specific context. A context here relates to where something ultimately serves
# (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,
# or the type of auction).
+ "status": "A String", # The status of the creative in this context (for example, it has been
+ # explicitly disapproved or is pending review).
"contexts": [ # The contexts for the restriction.
{ # The serving context for this restriction.
"all": "A String", # Matches all contexts.
@@ -536,8 +540,6 @@
},
},
],
- "status": "A String", # The status of the creative in this context (for example, it has been
- # explicitly disapproved or is pending review).
"disapprovalReasons": [ # Any disapprovals bound to this restriction.
# Only present if status=DISAPPROVED.
# Can be used to filter the response of the
@@ -597,14 +599,12 @@
],
},
],
- "openAuctionStatus": "A String", # @OutputOnly The top-level open auction status of this creative.
- # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
- # serving_restrictions will also exist. Note
- # that this may be nuanced with other contextual restrictions, in which case,
- # it may be preferable to read from serving_restrictions directly.
+ "attributes": [ # All attributes for the ads that may be shown from this creative.
# Can be used to filter the response of the
# creatives.list
# method.
+ "A String",
+ ],
}</pre>
</div>
@@ -683,22 +683,6 @@
"A String",
],
"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
- "accountId": "A String", # The account that this creative belongs to.
- # Can be used to filter the response of the
- # creatives.list
- # method.
- "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative.
- # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
- # for possible values.
- 42,
- ],
- "agencyId": "A String", # The agency ID for this creative.
- "html": { # HTML content for a creative. # An HTML creative.
- "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
- "width": 42, # The width of the HTML snippet in pixels.
- "height": 42, # The height of the HTML snippet in pixels.
- },
- "apiUpdateTime": "A String", # @OutputOnly The last update timestamp of the creative via API.
"native": { # Native content for a creative. # A native creative.
"body": "A String", # A long description of the ad.
"videoUrl": "A String", # The URL to fetch a native video ad.
@@ -709,10 +693,16 @@
"width": 42, # Image width in pixels.
"height": 42, # Image height in pixels.
},
- "clickTrackingUrl": "A String", # The URL to use for click tracking.
"starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
"advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
"priceDisplayText": "A String", # The price of the promoted app including currency info.
+ "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
+ "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.
+ # so long as the aspect ratio is preserved.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ "height": 42, # Image height in pixels.
+ },
"callToAction": "A String", # A label for the button that the user is supposed to click.
"logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo.
# so long as the aspect ratio is preserved.
@@ -720,32 +710,44 @@
"width": 42, # Image width in pixels.
"height": 42, # Image height in pixels.
},
- "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.
- # so long as the aspect ratio is preserved.
- "url": "A String", # The URL of the image.
- "width": 42, # Image width in pixels.
- "height": 42, # Image height in pixels.
- },
- "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
"clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
},
+ "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative.
+ # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
+ # for possible values.
+ 42,
+ ],
"detectedProductCategories": [ # @OutputOnly Detected product categories, if any.
# See the ad-product-categories.txt file in the technical documentation
# for a list of IDs.
42,
],
+ "html": { # HTML content for a creative. # An HTML creative.
+ "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
+ "width": 42, # The width of the HTML snippet in pixels.
+ "height": 42, # The height of the HTML snippet in pixels.
+ },
+ "apiUpdateTime": "A String", # @OutputOnly The last update timestamp of the creative via API.
+ "accountId": "A String", # The account that this creative belongs to.
+ # Can be used to filter the response of the
+ # creatives.list
+ # method.
+ "agencyId": "A String", # The agency ID for this creative.
"detectedDomains": [ # @OutputOnly
# The detected domains for this creative.
"A String",
],
- "attributes": [ # All attributes for the ads that may be shown from this creative.
+ "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
+ # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
+ # serving_restrictions will also exist. Note
+ # that this may be nuanced with other contextual restrictions, in which case,
+ # it may be preferable to read from serving_restrictions directly.
# Can be used to filter the response of the
# creatives.list
# method.
- "A String",
- ],
- "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
- # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
+ "openAuctionStatus": "A String", # @OutputOnly The top-level open auction status of this creative.
+ # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
# serving_restrictions will also exist. Note
# that this may be nuanced with other contextual restrictions, in which case,
# it may be preferable to read from serving_restrictions directly.
@@ -760,6 +762,8 @@
# specific context. A context here relates to where something ultimately serves
# (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,
# or the type of auction).
+ "status": "A String", # The status of the creative in this context (for example, it has been
+ # explicitly disapproved or is pending review).
"contexts": [ # The contexts for the restriction.
{ # The serving context for this restriction.
"all": "A String", # Matches all contexts.
@@ -794,8 +798,6 @@
},
},
],
- "status": "A String", # The status of the creative in this context (for example, it has been
- # explicitly disapproved or is pending review).
"disapprovalReasons": [ # Any disapprovals bound to this restriction.
# Only present if status=DISAPPROVED.
# Can be used to filter the response of the
@@ -855,14 +857,12 @@
],
},
],
- "openAuctionStatus": "A String", # @OutputOnly The top-level open auction status of this creative.
- # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
- # serving_restrictions will also exist. Note
- # that this may be nuanced with other contextual restrictions, in which case,
- # it may be preferable to read from serving_restrictions directly.
+ "attributes": [ # All attributes for the ads that may be shown from this creative.
# Can be used to filter the response of the
# creatives.list
# method.
+ "A String",
+ ],
}</pre>
</div>
@@ -970,22 +970,6 @@
"A String",
],
"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
- "accountId": "A String", # The account that this creative belongs to.
- # Can be used to filter the response of the
- # creatives.list
- # method.
- "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative.
- # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
- # for possible values.
- 42,
- ],
- "agencyId": "A String", # The agency ID for this creative.
- "html": { # HTML content for a creative. # An HTML creative.
- "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
- "width": 42, # The width of the HTML snippet in pixels.
- "height": 42, # The height of the HTML snippet in pixels.
- },
- "apiUpdateTime": "A String", # @OutputOnly The last update timestamp of the creative via API.
"native": { # Native content for a creative. # A native creative.
"body": "A String", # A long description of the ad.
"videoUrl": "A String", # The URL to fetch a native video ad.
@@ -996,10 +980,16 @@
"width": 42, # Image width in pixels.
"height": 42, # Image height in pixels.
},
- "clickTrackingUrl": "A String", # The URL to use for click tracking.
"starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
"advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
"priceDisplayText": "A String", # The price of the promoted app including currency info.
+ "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
+ "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.
+ # so long as the aspect ratio is preserved.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ "height": 42, # Image height in pixels.
+ },
"callToAction": "A String", # A label for the button that the user is supposed to click.
"logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo.
# so long as the aspect ratio is preserved.
@@ -1007,32 +997,44 @@
"width": 42, # Image width in pixels.
"height": 42, # Image height in pixels.
},
- "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.
- # so long as the aspect ratio is preserved.
- "url": "A String", # The URL of the image.
- "width": 42, # Image width in pixels.
- "height": 42, # Image height in pixels.
- },
- "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
"clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
},
+ "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative.
+ # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
+ # for possible values.
+ 42,
+ ],
"detectedProductCategories": [ # @OutputOnly Detected product categories, if any.
# See the ad-product-categories.txt file in the technical documentation
# for a list of IDs.
42,
],
+ "html": { # HTML content for a creative. # An HTML creative.
+ "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
+ "width": 42, # The width of the HTML snippet in pixels.
+ "height": 42, # The height of the HTML snippet in pixels.
+ },
+ "apiUpdateTime": "A String", # @OutputOnly The last update timestamp of the creative via API.
+ "accountId": "A String", # The account that this creative belongs to.
+ # Can be used to filter the response of the
+ # creatives.list
+ # method.
+ "agencyId": "A String", # The agency ID for this creative.
"detectedDomains": [ # @OutputOnly
# The detected domains for this creative.
"A String",
],
- "attributes": [ # All attributes for the ads that may be shown from this creative.
+ "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
+ # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
+ # serving_restrictions will also exist. Note
+ # that this may be nuanced with other contextual restrictions, in which case,
+ # it may be preferable to read from serving_restrictions directly.
# Can be used to filter the response of the
# creatives.list
# method.
- "A String",
- ],
- "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
- # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
+ "openAuctionStatus": "A String", # @OutputOnly The top-level open auction status of this creative.
+ # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
# serving_restrictions will also exist. Note
# that this may be nuanced with other contextual restrictions, in which case,
# it may be preferable to read from serving_restrictions directly.
@@ -1047,6 +1049,8 @@
# specific context. A context here relates to where something ultimately serves
# (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,
# or the type of auction).
+ "status": "A String", # The status of the creative in this context (for example, it has been
+ # explicitly disapproved or is pending review).
"contexts": [ # The contexts for the restriction.
{ # The serving context for this restriction.
"all": "A String", # Matches all contexts.
@@ -1081,8 +1085,6 @@
},
},
],
- "status": "A String", # The status of the creative in this context (for example, it has been
- # explicitly disapproved or is pending review).
"disapprovalReasons": [ # Any disapprovals bound to this restriction.
# Only present if status=DISAPPROVED.
# Can be used to filter the response of the
@@ -1142,14 +1144,12 @@
],
},
],
- "openAuctionStatus": "A String", # @OutputOnly The top-level open auction status of this creative.
- # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
- # serving_restrictions will also exist. Note
- # that this may be nuanced with other contextual restrictions, in which case,
- # it may be preferable to read from serving_restrictions directly.
+ "attributes": [ # All attributes for the ads that may be shown from this creative.
# Can be used to filter the response of the
# creatives.list
# method.
+ "A String",
+ ],
},
],
}</pre>
@@ -1280,22 +1280,6 @@
"A String",
],
"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
- "accountId": "A String", # The account that this creative belongs to.
- # Can be used to filter the response of the
- # creatives.list
- # method.
- "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative.
- # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
- # for possible values.
- 42,
- ],
- "agencyId": "A String", # The agency ID for this creative.
- "html": { # HTML content for a creative. # An HTML creative.
- "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
- "width": 42, # The width of the HTML snippet in pixels.
- "height": 42, # The height of the HTML snippet in pixels.
- },
- "apiUpdateTime": "A String", # @OutputOnly The last update timestamp of the creative via API.
"native": { # Native content for a creative. # A native creative.
"body": "A String", # A long description of the ad.
"videoUrl": "A String", # The URL to fetch a native video ad.
@@ -1306,10 +1290,16 @@
"width": 42, # Image width in pixels.
"height": 42, # Image height in pixels.
},
- "clickTrackingUrl": "A String", # The URL to use for click tracking.
"starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
"advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
"priceDisplayText": "A String", # The price of the promoted app including currency info.
+ "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
+ "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.
+ # so long as the aspect ratio is preserved.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ "height": 42, # Image height in pixels.
+ },
"callToAction": "A String", # A label for the button that the user is supposed to click.
"logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo.
# so long as the aspect ratio is preserved.
@@ -1317,32 +1307,44 @@
"width": 42, # Image width in pixels.
"height": 42, # Image height in pixels.
},
- "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.
- # so long as the aspect ratio is preserved.
- "url": "A String", # The URL of the image.
- "width": 42, # Image width in pixels.
- "height": 42, # Image height in pixels.
- },
- "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
"clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
},
+ "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative.
+ # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
+ # for possible values.
+ 42,
+ ],
"detectedProductCategories": [ # @OutputOnly Detected product categories, if any.
# See the ad-product-categories.txt file in the technical documentation
# for a list of IDs.
42,
],
+ "html": { # HTML content for a creative. # An HTML creative.
+ "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
+ "width": 42, # The width of the HTML snippet in pixels.
+ "height": 42, # The height of the HTML snippet in pixels.
+ },
+ "apiUpdateTime": "A String", # @OutputOnly The last update timestamp of the creative via API.
+ "accountId": "A String", # The account that this creative belongs to.
+ # Can be used to filter the response of the
+ # creatives.list
+ # method.
+ "agencyId": "A String", # The agency ID for this creative.
"detectedDomains": [ # @OutputOnly
# The detected domains for this creative.
"A String",
],
- "attributes": [ # All attributes for the ads that may be shown from this creative.
+ "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
+ # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
+ # serving_restrictions will also exist. Note
+ # that this may be nuanced with other contextual restrictions, in which case,
+ # it may be preferable to read from serving_restrictions directly.
# Can be used to filter the response of the
# creatives.list
# method.
- "A String",
- ],
- "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
- # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
+ "openAuctionStatus": "A String", # @OutputOnly The top-level open auction status of this creative.
+ # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
# serving_restrictions will also exist. Note
# that this may be nuanced with other contextual restrictions, in which case,
# it may be preferable to read from serving_restrictions directly.
@@ -1357,6 +1359,8 @@
# specific context. A context here relates to where something ultimately serves
# (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,
# or the type of auction).
+ "status": "A String", # The status of the creative in this context (for example, it has been
+ # explicitly disapproved or is pending review).
"contexts": [ # The contexts for the restriction.
{ # The serving context for this restriction.
"all": "A String", # Matches all contexts.
@@ -1391,8 +1395,6 @@
},
},
],
- "status": "A String", # The status of the creative in this context (for example, it has been
- # explicitly disapproved or is pending review).
"disapprovalReasons": [ # Any disapprovals bound to this restriction.
# Only present if status=DISAPPROVED.
# Can be used to filter the response of the
@@ -1452,14 +1454,12 @@
],
},
],
- "openAuctionStatus": "A String", # @OutputOnly The top-level open auction status of this creative.
- # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
- # serving_restrictions will also exist. Note
- # that this may be nuanced with other contextual restrictions, in which case,
- # it may be preferable to read from serving_restrictions directly.
+ "attributes": [ # All attributes for the ads that may be shown from this creative.
# Can be used to filter the response of the
# creatives.list
# method.
+ "A String",
+ ],
}
x__xgafv: string, V1 error format.
@@ -1530,22 +1530,6 @@
"A String",
],
"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
- "accountId": "A String", # The account that this creative belongs to.
- # Can be used to filter the response of the
- # creatives.list
- # method.
- "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative.
- # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
- # for possible values.
- 42,
- ],
- "agencyId": "A String", # The agency ID for this creative.
- "html": { # HTML content for a creative. # An HTML creative.
- "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
- "width": 42, # The width of the HTML snippet in pixels.
- "height": 42, # The height of the HTML snippet in pixels.
- },
- "apiUpdateTime": "A String", # @OutputOnly The last update timestamp of the creative via API.
"native": { # Native content for a creative. # A native creative.
"body": "A String", # A long description of the ad.
"videoUrl": "A String", # The URL to fetch a native video ad.
@@ -1556,10 +1540,16 @@
"width": 42, # Image width in pixels.
"height": 42, # Image height in pixels.
},
- "clickTrackingUrl": "A String", # The URL to use for click tracking.
"starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
"advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
"priceDisplayText": "A String", # The price of the promoted app including currency info.
+ "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
+ "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.
+ # so long as the aspect ratio is preserved.
+ "url": "A String", # The URL of the image.
+ "width": 42, # Image width in pixels.
+ "height": 42, # Image height in pixels.
+ },
"callToAction": "A String", # A label for the button that the user is supposed to click.
"logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo.
# so long as the aspect ratio is preserved.
@@ -1567,32 +1557,44 @@
"width": 42, # Image width in pixels.
"height": 42, # Image height in pixels.
},
- "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.
- # so long as the aspect ratio is preserved.
- "url": "A String", # The URL of the image.
- "width": 42, # Image width in pixels.
- "height": 42, # Image height in pixels.
- },
- "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app.
+ "clickTrackingUrl": "A String", # The URL to use for click tracking.
"clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
},
+ "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative.
+ # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
+ # for possible values.
+ 42,
+ ],
"detectedProductCategories": [ # @OutputOnly Detected product categories, if any.
# See the ad-product-categories.txt file in the technical documentation
# for a list of IDs.
42,
],
+ "html": { # HTML content for a creative. # An HTML creative.
+ "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
+ "width": 42, # The width of the HTML snippet in pixels.
+ "height": 42, # The height of the HTML snippet in pixels.
+ },
+ "apiUpdateTime": "A String", # @OutputOnly The last update timestamp of the creative via API.
+ "accountId": "A String", # The account that this creative belongs to.
+ # Can be used to filter the response of the
+ # creatives.list
+ # method.
+ "agencyId": "A String", # The agency ID for this creative.
"detectedDomains": [ # @OutputOnly
# The detected domains for this creative.
"A String",
],
- "attributes": [ # All attributes for the ads that may be shown from this creative.
+ "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
+ # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
+ # serving_restrictions will also exist. Note
+ # that this may be nuanced with other contextual restrictions, in which case,
+ # it may be preferable to read from serving_restrictions directly.
# Can be used to filter the response of the
# creatives.list
# method.
- "A String",
- ],
- "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
- # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
+ "openAuctionStatus": "A String", # @OutputOnly The top-level open auction status of this creative.
+ # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
# serving_restrictions will also exist. Note
# that this may be nuanced with other contextual restrictions, in which case,
# it may be preferable to read from serving_restrictions directly.
@@ -1607,6 +1609,8 @@
# specific context. A context here relates to where something ultimately serves
# (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,
# or the type of auction).
+ "status": "A String", # The status of the creative in this context (for example, it has been
+ # explicitly disapproved or is pending review).
"contexts": [ # The contexts for the restriction.
{ # The serving context for this restriction.
"all": "A String", # Matches all contexts.
@@ -1641,8 +1645,6 @@
},
},
],
- "status": "A String", # The status of the creative in this context (for example, it has been
- # explicitly disapproved or is pending review).
"disapprovalReasons": [ # Any disapprovals bound to this restriction.
# Only present if status=DISAPPROVED.
# Can be used to filter the response of the
@@ -1702,14 +1704,12 @@
],
},
],
- "openAuctionStatus": "A String", # @OutputOnly The top-level open auction status of this creative.
- # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
- # serving_restrictions will also exist. Note
- # that this may be nuanced with other contextual restrictions, in which case,
- # it may be preferable to read from serving_restrictions directly.
+ "attributes": [ # All attributes for the ads that may be shown from this creative.
# Can be used to filter the response of the
# creatives.list
# method.
+ "A String",
+ ],
}</pre>
</div>
diff --git a/docs/dyn/admin_directory_v1.users.html b/docs/dyn/admin_directory_v1.users.html
index 9a992f2..c52841b 100644
--- a/docs/dyn/admin_directory_v1.users.html
+++ b/docs/dyn/admin_directory_v1.users.html
@@ -146,6 +146,7 @@
{ # JSON template for User object in Directory API.
"addresses": "",
+ "posixAccounts": "",
"phones": "",
"isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
"thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
@@ -176,6 +177,7 @@
"agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
"externalIds": "",
"ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
+ "sshPublicKeys": "",
"primaryEmail": "A String", # username of User
"isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only)
"isMailboxSetup": True or False, # Is mailbox setup (Read-only)
@@ -207,6 +209,7 @@
{ # JSON template for User object in Directory API.
"addresses": "",
+ "posixAccounts": "",
"phones": "",
"isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
"thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
@@ -237,6 +240,7 @@
"agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
"externalIds": "",
"ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
+ "sshPublicKeys": "",
"primaryEmail": "A String", # username of User
"isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only)
"isMailboxSetup": True or False, # Is mailbox setup (Read-only)
@@ -263,6 +267,7 @@
{ # JSON template for User object in Directory API.
"addresses": "",
+ "posixAccounts": "",
"phones": "",
"isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
"thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
@@ -293,6 +298,7 @@
"agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
"externalIds": "",
"ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
+ "sshPublicKeys": "",
"primaryEmail": "A String", # username of User
"isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only)
"isMailboxSetup": True or False, # Is mailbox setup (Read-only)
@@ -363,6 +369,7 @@
"users": [ # List of user objects.
{ # JSON template for User object in Directory API.
"addresses": "",
+ "posixAccounts": "",
"phones": "",
"isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
"thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
@@ -393,6 +400,7 @@
"agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
"externalIds": "",
"ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
+ "sshPublicKeys": "",
"primaryEmail": "A String", # username of User
"isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only)
"isMailboxSetup": True or False, # Is mailbox setup (Read-only)
@@ -457,6 +465,7 @@
{ # JSON template for User object in Directory API.
"addresses": "",
+ "posixAccounts": "",
"phones": "",
"isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
"thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
@@ -487,6 +496,7 @@
"agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
"externalIds": "",
"ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
+ "sshPublicKeys": "",
"primaryEmail": "A String", # username of User
"isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only)
"isMailboxSetup": True or False, # Is mailbox setup (Read-only)
@@ -513,6 +523,7 @@
{ # JSON template for User object in Directory API.
"addresses": "",
+ "posixAccounts": "",
"phones": "",
"isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
"thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
@@ -543,6 +554,7 @@
"agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
"externalIds": "",
"ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
+ "sshPublicKeys": "",
"primaryEmail": "A String", # username of User
"isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only)
"isMailboxSetup": True or False, # Is mailbox setup (Read-only)
@@ -591,6 +603,7 @@
{ # JSON template for User object in Directory API.
"addresses": "",
+ "posixAccounts": "",
"phones": "",
"isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
"thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
@@ -621,6 +634,7 @@
"agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
"externalIds": "",
"ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
+ "sshPublicKeys": "",
"primaryEmail": "A String", # username of User
"isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only)
"isMailboxSetup": True or False, # Is mailbox setup (Read-only)
@@ -647,6 +661,7 @@
{ # JSON template for User object in Directory API.
"addresses": "",
+ "posixAccounts": "",
"phones": "",
"isDelegatedAdmin": True or False, # Boolean indicating if the user is delegated admin (Read-only)
"thumbnailPhotoEtag": "A String", # ETag of the user's photo (Read-only)
@@ -677,6 +692,7 @@
"agreedToTerms": True or False, # Indicates if user has agreed to terms (Read-only)
"externalIds": "",
"ipWhitelisted": True or False, # Boolean indicating if ip is whitelisted
+ "sshPublicKeys": "",
"primaryEmail": "A String", # username of User
"isEnforcedIn2Sv": True or False, # Is 2-step verification enforced (Read-only)
"isMailboxSetup": True or False, # Is mailbox setup (Read-only)
diff --git a/docs/dyn/admin_reports_v1.activities.html b/docs/dyn/admin_reports_v1.activities.html
index 46a342c..a2094ce 100644
--- a/docs/dyn/admin_reports_v1.activities.html
+++ b/docs/dyn/admin_reports_v1.activities.html
@@ -96,8 +96,8 @@
pageToken: string, Token to specify next page.
filters: string, Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...
maxResults: integer, Number of activity records to be shown in each page.
- startTime: string, Return events which occured at or after this time.
- endTime: string, Return events which occured at or before this time.
+ startTime: string, Return events which occurred at or after this time.
+ endTime: string, Return events which occurred at or before this time.
customerId: string, Represents the customer for which the data is to be fetched.
Returns:
@@ -189,13 +189,13 @@
"id": "A String", # A UUID or similar unique string that identifies this channel.
}
- startTime: string, Return events which occured at or after this time.
+ startTime: string, Return events which occurred at or after this time.
filters: string, Event parameters in the form [parameter1 name][operator][parameter1 value],[parameter2 name][operator][parameter2 value],...
eventName: string, Name of the event being queried.
actorIpAddress: string, IP Address of host where the event was performed. Supports both IPv4 and IPv6 addresses.
pageToken: string, Token to specify next page.
maxResults: integer, Number of activity records to be shown in each page.
- endTime: string, Return events which occured at or before this time.
+ endTime: string, Return events which occurred at or before this time.
customerId: string, Represents the customer for which the data is to be fetched.
Returns:
diff --git a/docs/dyn/analytics_v3.management.remarketingAudience.html b/docs/dyn/analytics_v3.management.remarketingAudience.html
index e72c4e4..0d3fb10 100644
--- a/docs/dyn/analytics_v3.management.remarketingAudience.html
+++ b/docs/dyn/analytics_v3.management.remarketingAudience.html
@@ -75,6 +75,9 @@
<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.remarketingAudience.html">remarketingAudience</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#delete">delete(accountId, webPropertyId, remarketingAudienceId)</a></code></p>
+<p class="firstline">Delete a remarketing audience.</p>
+<p class="toc_element">
<code><a href="#get">get(accountId, webPropertyId, remarketingAudienceId)</a></code></p>
<p class="firstline">Gets a remarketing audience to which the user has access.</p>
<p class="toc_element">
@@ -91,6 +94,17 @@
<p class="firstline">Updates an existing remarketing audience.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="delete">delete(accountId, webPropertyId, remarketingAudienceId)</code>
+ <pre>Delete a remarketing audience.
+
+Args:
+ accountId: string, Account ID to which the remarketing audience belongs. (required)
+ webPropertyId: string, Web property ID to which the remarketing audience belongs. (required)
+ remarketingAudienceId: string, The ID of the remarketing audience to delete. (required)
+</pre>
+</div>
+
+<div class="method">
<code class="details" id="get">get(accountId, webPropertyId, remarketingAudienceId)</code>
<pre>Gets a remarketing audience to which the user has access.
diff --git a/docs/dyn/analyticsreporting_v4.reports.html b/docs/dyn/analyticsreporting_v4.reports.html
index 5ca527f..ac0d3dc 100644
--- a/docs/dyn/analyticsreporting_v4.reports.html
+++ b/docs/dyn/analyticsreporting_v4.reports.html
@@ -111,6 +111,13 @@
],
"hideTotals": True or False, # If set to true, hides the total of all metrics for all the matching rows,
# for every date range. The default false and will return the totals.
+ "filtersExpression": "A String", # Dimension or metric filters that restrict the data returned for your
+ # request. To use the `filtersExpression`, supply a dimension or metric on
+ # which to filter, followed by the filter expression. For example, the
+ # following expression selects `ga:browser` dimension which starts with
+ # Firefox; `ga:browser=~^Firefox`. For more information on dimensions
+ # and metric filters, see
+ # [Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).
"pageSize": 42, # Page size is for paging and specifies the maximum number of returned rows.
# Page size should be >= 0. A query returns the default of 1,000 rows.
# The Analytics Core Reporting API returns a maximum of 10,000 rows per
@@ -119,13 +126,6 @@
# For instance, there are fewer than 300 possible values for `ga:country`,
# so when segmenting only by country, you can't get more than 300 rows,
# even if you set `pageSize` to a higher value.
- "filtersExpression": "A String", # Dimension or metric filters that restrict the data returned for your
- # request. To use the `filtersExpression`, supply a dimension or metric on
- # which to filter, followed by the filter expression. For example, the
- # following expression selects `ga:browser` dimension which starts with
- # Firefox; `ga:browser=~^Firefox`. For more information on dimensions
- # and metric filters, see
- # [Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).
"pivots": [ # The pivot definitions. Requests can have a maximum of 2 pivots.
{ # The Pivot describes the pivot section in the request.
# The Pivot helps rearrange the information in the table for certain reports
@@ -152,8 +152,19 @@
# `INTEGER`.
},
],
- "maxGroupCount": 42, # Specifies the maximum number of groups to return.
- # The default value is 10, also the maximum value is 1,000.
+ "startGroup": 42, # If k metrics were requested, then the response will contain some
+ # data-dependent multiple of k columns in the report. E.g., if you pivoted
+ # on the dimension `ga:browser` then you'd get k columns for "Firefox", k
+ # columns for "IE", k columns for "Chrome", etc. The ordering of the groups
+ # of columns is determined by descending order of "total" for the first of
+ # the k values. Ties are broken by lexicographic ordering of the first
+ # pivot dimension, then lexicographic ordering of the second pivot
+ # dimension, and so on. E.g., if the totals for the first value for
+ # Firefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns
+ # would be Chrome, Firefox, IE.
+ #
+ # The following let you choose which of the groups of k columns are
+ # included in the response.
"dimensions": [ # A list of dimensions to show as pivot columns. A Pivot can have a maximum
# of 4 dimensions. Pivot dimensions are part of the restriction on the
# total number of dimensions allowed in the request.
@@ -226,54 +237,17 @@
],
},
],
- "startGroup": 42, # If k metrics were requested, then the response will contain some
- # data-dependent multiple of k columns in the report. E.g., if you pivoted
- # on the dimension `ga:browser` then you'd get k columns for "Firefox", k
- # columns for "IE", k columns for "Chrome", etc. The ordering of the groups
- # of columns is determined by descending order of "total" for the first of
- # the k values. Ties are broken by lexicographic ordering of the first
- # pivot dimension, then lexicographic ordering of the second pivot
- # dimension, and so on. E.g., if the totals for the first value for
- # Firefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns
- # would be Chrome, Firefox, IE.
- #
- # The following let you choose which of the groups of k columns are
- # included in the response.
+ "maxGroupCount": 42, # Specifies the maximum number of groups to return.
+ # The default value is 10, also the maximum value is 1,000.
},
],
- "dimensionFilterClauses": [ # The dimension filter clauses for filtering Dimension Values. They are
- # logically combined with the `AND` operator. Note that filtering occurs
- # before any dimensions are aggregated, so that the returned metrics
- # represent the total for only the relevant dimensions.
- { # A group of dimension filters. Set the operator value to specify how
- # the filters are logically combined.
- "operator": "A String", # The operator for combining multiple dimension filters. If unspecified, it
- # is treated as an `OR`.
- "filters": [ # The repeated set of filters. They are logically combined based on the
- # operator specified.
- { # Dimension filter specifies the filtering options on a dimension.
- "dimensionName": "A String", # The dimension to filter on. A DimensionFilter must contain a dimension.
- "caseSensitive": True or False, # Should the match be case sensitive? Default is false.
- "expressions": [ # Strings or regular expression to match against. Only the first value of
- # the list is used for comparison unless the operator is `IN_LIST`.
- # If `IN_LIST` operator, then the entire list is used to filter the
- # dimensions as explained in the description of the `IN_LIST` operator.
- "A String",
- ],
- "not": True or False, # Logical `NOT` operator. If this boolean is set to true, then the matching
- # dimension values will be excluded in the report. The default is false.
- "operator": "A String", # How to match the dimension to the expression. The default is REGEXP.
- },
- ],
- },
- ],
+ "includeEmptyRows": True or False, # If set to false, the response does not include rows if all the retrieved
+ # metrics are equal to zero. The default is false which will exclude these
+ # rows.
"viewId": "A String", # The Analytics
# [view ID](https://support.google.com/analytics/answer/1009618)
# from which to retrieve data. Every [ReportRequest](#ReportRequest)
# within a `batchGet` method must contain the same `viewId`.
- "includeEmptyRows": True or False, # If set to false, the response does not include rows if all the retrieved
- # metrics are equal to zero. The default is false which will exclude these
- # rows.
"samplingLevel": "A String", # The desired report
# [sample](https://support.google.com/analytics/answer/2637192) size.
# If the the `samplingLevel` field is unspecified the `DEFAULT` sampling
@@ -396,6 +370,32 @@
# the GetReports request.
"hideValueRanges": True or False, # If set to true, hides the minimum and maximum across all matching rows.
# The default is false and the value ranges are returned.
+ "dimensionFilterClauses": [ # The dimension filter clauses for filtering Dimension Values. They are
+ # logically combined with the `AND` operator. Note that filtering occurs
+ # before any dimensions are aggregated, so that the returned metrics
+ # represent the total for only the relevant dimensions.
+ { # A group of dimension filters. Set the operator value to specify how
+ # the filters are logically combined.
+ "operator": "A String", # The operator for combining multiple dimension filters. If unspecified, it
+ # is treated as an `OR`.
+ "filters": [ # The repeated set of filters. They are logically combined based on the
+ # operator specified.
+ { # Dimension filter specifies the filtering options on a dimension.
+ "dimensionName": "A String", # The dimension to filter on. A DimensionFilter must contain a dimension.
+ "caseSensitive": True or False, # Should the match be case sensitive? Default is false.
+ "expressions": [ # Strings or regular expression to match against. Only the first value of
+ # the list is used for comparison unless the operator is `IN_LIST`.
+ # If `IN_LIST` operator, then the entire list is used to filter the
+ # dimensions as explained in the description of the `IN_LIST` operator.
+ "A String",
+ ],
+ "not": True or False, # Logical `NOT` operator. If this boolean is set to true, then the matching
+ # dimension values will be excluded in the report. The default is false.
+ "operator": "A String", # How to match the dimension to the expression. The default is REGEXP.
+ },
+ ],
+ },
+ ],
"metricFilterClauses": [ # The metric filter clauses. They are logically combined with the `AND`
# operator. Metric filters look at only the first date range and not the
# comparing date range. Note that filtering on metrics occurs after the
@@ -502,6 +502,8 @@
# be combined with special sequence operators.
# by one or more dimension/metric conditions. Multiple steps can be combined
# with special sequence operators.
+ "firstStepShouldMatchFirstHit": True or False, # If set, first step condition must match the first hit of the visitor (in
+ # the date range).
"segmentSequenceSteps": [ # The list of steps in the sequence.
{ # A segment sequence definition.
"matchType": "A String", # Specifies if the step immediately precedes or can be any time before the
@@ -543,8 +545,6 @@
],
},
],
- "firstStepShouldMatchFirstHit": True or False, # If set, first step condition must match the first hit of the visitor (in
- # the date range).
},
},
],
@@ -621,6 +621,8 @@
# be combined with special sequence operators.
# by one or more dimension/metric conditions. Multiple steps can be combined
# with special sequence operators.
+ "firstStepShouldMatchFirstHit": True or False, # If set, first step condition must match the first hit of the visitor (in
+ # the date range).
"segmentSequenceSteps": [ # The list of steps in the sequence.
{ # A segment sequence definition.
"matchType": "A String", # Specifies if the step immediately precedes or can be any time before the
@@ -662,8 +664,6 @@
],
},
],
- "firstStepShouldMatchFirstHit": True or False, # If set, first step condition must match the first hit of the visitor (in
- # the date range).
},
},
],
@@ -839,6 +839,12 @@
"A String",
],
"metricHeader": { # The headers for the metrics. # Metric headers for the metrics in the response.
+ "metricHeaderEntries": [ # Headers for the metrics in the response.
+ { # Header for the metrics.
+ "type": "A String", # The type of the metric, for example `INTEGER`.
+ "name": "A String", # The name of the header.
+ },
+ ],
"pivotHeaders": [ # Headers for the pivots in the response.
{ # The headers for each of the pivot sections defined in the request.
"totalPivotGroupsCount": 42, # The total number of groups for this pivot.
@@ -859,12 +865,6 @@
],
},
],
- "metricHeaderEntries": [ # Headers for the metrics in the response.
- { # Header for the metrics.
- "type": "A String", # The type of the metric, for example `INTEGER`.
- "name": "A String", # The name of the header.
- },
- ],
},
},
},
diff --git a/docs/dyn/appengine_v1.apps.html b/docs/dyn/appengine_v1.apps.html
index 54b5736..70aba84 100644
--- a/docs/dyn/appengine_v1.apps.html
+++ b/docs/dyn/appengine_v1.apps.html
@@ -91,20 +91,20 @@
<p class="toc_element">
<code><a href="#create">create(body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates an App Engine application for a Google Cloud Platform project. This requires a project that excludes an App Engine application. For details about creating a project without an application, see the Google Cloud Resource Manager create project topic (https://cloud.google.com/resource-manager/docs/creating-project).</p>
+<p class="firstline">Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).</p>
<p class="toc_element">
<code><a href="#get">get(appsId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about an application.</p>
<p class="toc_element">
<code><a href="#patch">patch(appsId, body, updateMask=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates the specified Application resource. You can update the following fields: auth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps#Application.FIELDS.auth_domain) default_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps#Application.FIELDS.default_cookie_expiration)</p>
+<p class="firstline">Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application.</p>
<p class="toc_element">
<code><a href="#repair">repair(appsId, body, x__xgafv=None)</a></code></p>
<p class="firstline">Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(body, x__xgafv=None)</code>
- <pre>Creates an App Engine application for a Google Cloud Platform project. This requires a project that excludes an App Engine application. For details about creating a project without an application, see the Google Cloud Resource Manager create project topic (https://cloud.google.com/resource-manager/docs/creating-project).
+ <pre>Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).
Args:
body: object, The request body. (required)
@@ -113,17 +113,25 @@
{ # An Application resource contains the top-level configuration of an App Engine application.
"defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine.@OutputOnly
"name": "A String", # Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
+ "gcrDomain": "A String", # The Google Container Registry domain used for storing managed build docker images for this application.
"codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly
"defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
- "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly
+ "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly
{ # Rules to match an HTTP request and dispatch that request to a service.
- "path": "A String", # Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
+ "path": "A String", # Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.
"domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
"service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
},
],
"defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
+ "servingStatus": "A String", # Serving status of this application.
"locationId": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
+ "iap": { # Identity-Aware Proxy
+ "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
+ "enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
+ "oauth2ClientSecret": "A String", # OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
+ "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
+ },
"authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
"id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
}
@@ -168,17 +176,25 @@
{ # An Application resource contains the top-level configuration of an App Engine application.
"defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine.@OutputOnly
"name": "A String", # Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
+ "gcrDomain": "A String", # The Google Container Registry domain used for storing managed build docker images for this application.
"codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly
"defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
- "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly
+ "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly
{ # Rules to match an HTTP request and dispatch that request to a service.
- "path": "A String", # Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
+ "path": "A String", # Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.
"domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
"service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
},
],
"defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
+ "servingStatus": "A String", # Serving status of this application.
"locationId": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
+ "iap": { # Identity-Aware Proxy
+ "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
+ "enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
+ "oauth2ClientSecret": "A String", # OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
+ "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
+ },
"authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
"id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
}</pre>
@@ -186,7 +202,7 @@
<div class="method">
<code class="details" id="patch">patch(appsId, body, updateMask=None, x__xgafv=None)</code>
- <pre>Updates the specified Application resource. You can update the following fields: auth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps#Application.FIELDS.auth_domain) default_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps#Application.FIELDS.default_cookie_expiration)
+ <pre>Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application.
Args:
appsId: string, Part of `name`. Name of the Application resource to update. Example: apps/myapp. (required)
@@ -196,17 +212,25 @@
{ # An Application resource contains the top-level configuration of an App Engine application.
"defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine.@OutputOnly
"name": "A String", # Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
+ "gcrDomain": "A String", # The Google Container Registry domain used for storing managed build docker images for this application.
"codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly
"defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
- "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly
+ "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly
{ # Rules to match an HTTP request and dispatch that request to a service.
- "path": "A String", # Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
+ "path": "A String", # Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.
"domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
"service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
},
],
"defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
+ "servingStatus": "A String", # Serving status of this application.
"locationId": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
+ "iap": { # Identity-Aware Proxy
+ "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
+ "enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
+ "oauth2ClientSecret": "A String", # OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
+ "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
+ },
"authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
"id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
}
diff --git a/docs/dyn/appengine_v1.apps.locations.html b/docs/dyn/appengine_v1.apps.locations.html
index 4189291..72924a9 100644
--- a/docs/dyn/appengine_v1.apps.locations.html
+++ b/docs/dyn/appengine_v1.apps.locations.html
@@ -122,7 +122,7 @@
Returns:
An object of the form:
- { # The response message for LocationService.ListLocations.
+ { # The response message for Locations.ListLocations.
"nextPageToken": "A String", # The standard List next-page token.
"locations": [ # A list of locations that matches the specified filter in the request.
{ # A resource that represents Google Cloud Platform location.
diff --git a/docs/dyn/appengine_v1.apps.services.html b/docs/dyn/appengine_v1.apps.services.html
index ca148e8..91a8095 100644
--- a/docs/dyn/appengine_v1.apps.services.html
+++ b/docs/dyn/appengine_v1.apps.services.html
@@ -217,7 +217,7 @@
"id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly
}
- migrateTraffic: boolean, Set to true to gradually shift traffic from one version to another single version. By default, traffic is shifted immediately. For gradual traffic migration, the target version must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
+ migrateTraffic: boolean, Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
updateMask: string, Standard field mask for the set of fields to be updated.
x__xgafv: string, V1 error format.
diff --git a/docs/dyn/appengine_v1.apps.services.versions.html b/docs/dyn/appengine_v1.apps.services.versions.html
index 8d15d33..a33a374 100644
--- a/docs/dyn/appengine_v1.apps.services.versions.html
+++ b/docs/dyn/appengine_v1.apps.services.versions.html
@@ -130,6 +130,14 @@
},
],
"id": "A String", # Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
+ "readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.
+ "checkInterval": "A String", # Interval between health checks.
+ "unhealthyThreshold": 42, # Number of consecutive failed checks required before removing traffic.
+ "healthyThreshold": 42, # Number of consecutive successful checks required before receiving traffic.
+ "host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
+ "timeout": "A String", # Time before the check is considered failed.
+ "path": "A String", # The request path.
+ },
"apiConfig": { # Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.
"url": "A String", # URL to serve the endpoint at.
"securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
@@ -217,14 +225,15 @@
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
- "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses to run the version. Only applicable for instances in App Engine flexible environment.
- "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
+ "container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
"zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
"filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
+ "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
"createTime": "A String", # Time that this version was created.@OutputOnly
"network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
"instanceTag": "A String", # Tag to apply to the VM instance during creation.
@@ -234,7 +243,15 @@
"name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
"subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
},
- "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
+ "livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.
+ "checkInterval": "A String", # Interval between health checks.
+ "initialDelay": "A String", # The initial delay before starting to execute the checks.
+ "unhealthyThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy.
+ "healthyThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy.
+ "host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"
+ "timeout": "A String", # Time before the check is considered failed.
+ "path": "A String", # The request path.
+ },
"name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.
{ # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
@@ -362,6 +379,14 @@
},
],
"id": "A String", # Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
+ "readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.
+ "checkInterval": "A String", # Interval between health checks.
+ "unhealthyThreshold": 42, # Number of consecutive failed checks required before removing traffic.
+ "healthyThreshold": 42, # Number of consecutive successful checks required before receiving traffic.
+ "host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
+ "timeout": "A String", # Time before the check is considered failed.
+ "path": "A String", # The request path.
+ },
"apiConfig": { # Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.
"url": "A String", # URL to serve the endpoint at.
"securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
@@ -449,14 +474,15 @@
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
- "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses to run the version. Only applicable for instances in App Engine flexible environment.
- "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
+ "container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
"zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
"filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
+ "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
"createTime": "A String", # Time that this version was created.@OutputOnly
"network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
"instanceTag": "A String", # Tag to apply to the VM instance during creation.
@@ -466,7 +492,15 @@
"name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
"subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
},
- "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
+ "livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.
+ "checkInterval": "A String", # Interval between health checks.
+ "initialDelay": "A String", # The initial delay before starting to execute the checks.
+ "unhealthyThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy.
+ "healthyThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy.
+ "host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"
+ "timeout": "A String", # Time before the check is considered failed.
+ "path": "A String", # The request path.
+ },
"name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.
{ # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
@@ -539,6 +573,14 @@
},
],
"id": "A String", # Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
+ "readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.
+ "checkInterval": "A String", # Interval between health checks.
+ "unhealthyThreshold": 42, # Number of consecutive failed checks required before removing traffic.
+ "healthyThreshold": 42, # Number of consecutive successful checks required before receiving traffic.
+ "host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
+ "timeout": "A String", # Time before the check is considered failed.
+ "path": "A String", # The request path.
+ },
"apiConfig": { # Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.
"url": "A String", # URL to serve the endpoint at.
"securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
@@ -626,14 +668,15 @@
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
- "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses to run the version. Only applicable for instances in App Engine flexible environment.
- "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
+ "container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
"zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
"filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
+ "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
"createTime": "A String", # Time that this version was created.@OutputOnly
"network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
"instanceTag": "A String", # Tag to apply to the VM instance during creation.
@@ -643,7 +686,15 @@
"name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
"subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
},
- "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
+ "livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.
+ "checkInterval": "A String", # Interval between health checks.
+ "initialDelay": "A String", # The initial delay before starting to execute the checks.
+ "unhealthyThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy.
+ "healthyThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy.
+ "host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"
+ "timeout": "A String", # Time before the check is considered failed.
+ "path": "A String", # The request path.
+ },
"name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.
{ # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
@@ -725,6 +776,14 @@
},
],
"id": "A String", # Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
+ "readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.
+ "checkInterval": "A String", # Interval between health checks.
+ "unhealthyThreshold": 42, # Number of consecutive failed checks required before removing traffic.
+ "healthyThreshold": 42, # Number of consecutive successful checks required before receiving traffic.
+ "host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
+ "timeout": "A String", # Time before the check is considered failed.
+ "path": "A String", # The request path.
+ },
"apiConfig": { # Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers. # Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.
"url": "A String", # URL to serve the endpoint at.
"securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
@@ -812,14 +871,15 @@
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
- "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses to run the version. Only applicable for instances in App Engine flexible environment.
- "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
+ "container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
"zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
"filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
+ "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
"createTime": "A String", # Time that this version was created.@OutputOnly
"network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
"instanceTag": "A String", # Tag to apply to the VM instance during creation.
@@ -829,7 +889,15 @@
"name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
"subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
},
- "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
+ "livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.
+ "checkInterval": "A String", # Interval between health checks.
+ "initialDelay": "A String", # The initial delay before starting to execute the checks.
+ "unhealthyThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy.
+ "healthyThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy.
+ "host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"
+ "timeout": "A String", # Time before the check is considered failed.
+ "path": "A String", # The request path.
+ },
"name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.
{ # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
diff --git a/docs/dyn/appengine_v1.apps.services.versions.instances.html b/docs/dyn/appengine_v1.apps.services.versions.instances.html
index 10345fa..0be048a 100644
--- a/docs/dyn/appengine_v1.apps.services.versions.instances.html
+++ b/docs/dyn/appengine_v1.apps.services.versions.instances.html
@@ -85,7 +85,7 @@
<p class="firstline">Gets instance information.</p>
<p class="toc_element">
<code><a href="#list">list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p>
-<p class="firstline">Lists the instances of a version.</p>
+<p class="firstline">Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).</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>
@@ -203,7 +203,7 @@
<div class="method">
<code class="details" id="list">list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None)</code>
- <pre>Lists the instances of a version.
+ <pre>Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
Args:
appsId: string, Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1. (required)
diff --git a/docs/dyn/appengine_v1alpha.apps.html b/docs/dyn/appengine_v1alpha.apps.html
index 32634da..a4ae81c 100644
--- a/docs/dyn/appengine_v1alpha.apps.html
+++ b/docs/dyn/appengine_v1alpha.apps.html
@@ -84,257 +84,4 @@
</p>
<p class="firstline">Returns the operations Resource.</p>
-<p class="toc_element">
- <code><a href="appengine_v1alpha.apps.services.html">services()</a></code>
-</p>
-<p class="firstline">Returns the services Resource.</p>
-
-<p class="toc_element">
- <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates an App Engine application for a Google Cloud Platform project. Required fields:</p>
-<p class="toc_element">
- <code><a href="#get">get(appsId, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets information about an application.</p>
-<p class="toc_element">
- <code><a href="#patch">patch(appsId, body, updateMask=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates the specified Application resource. You can update the following fields:</p>
-<p class="toc_element">
- <code><a href="#repair">repair(appsId, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.</p>
-<h3>Method Details</h3>
-<div class="method">
- <code class="details" id="create">create(body, x__xgafv=None)</code>
- <pre>Creates an App Engine application for a Google Cloud Platform project. Required fields:
-id - The ID of the target Cloud Platform project.
-location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).
-
-Args:
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An Application resource contains the top-level configuration of an App Engine application.
- "defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine.@OutputOnly
- "iap": { # Identity-Aware Proxy
- "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
- "enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
- "oauth2ClientSecret": "A String", # OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
- "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
- },
- "gcrDomain": "A String", # The Google Container Registry domain used for storing managed build docker images for this application.
- "codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly
- "defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
- "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly
- { # Rules to match an HTTP request and dispatch that request to a service.
- "path": "A String", # Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
- "domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
- "service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
- },
- ],
- "defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
- "servingStatus": "A String", # Serving status of this application.
- "locationId": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
- "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
- "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
- "name": "A String", # Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
- }
-
- 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.
- },
- "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: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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.
- },
- ],
- },
- "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.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="get">get(appsId, x__xgafv=None)</code>
- <pre>Gets information about an application.
-
-Args:
- appsId: string, Part of `name`. Name of the Application resource to get. Example: apps/myapp. (required)
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # An Application resource contains the top-level configuration of an App Engine application.
- "defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine.@OutputOnly
- "iap": { # Identity-Aware Proxy
- "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
- "enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
- "oauth2ClientSecret": "A String", # OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
- "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
- },
- "gcrDomain": "A String", # The Google Container Registry domain used for storing managed build docker images for this application.
- "codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly
- "defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
- "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly
- { # Rules to match an HTTP request and dispatch that request to a service.
- "path": "A String", # Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
- "domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
- "service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
- },
- ],
- "defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
- "servingStatus": "A String", # Serving status of this application.
- "locationId": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
- "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
- "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
- "name": "A String", # Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="patch">patch(appsId, body, updateMask=None, x__xgafv=None)</code>
- <pre>Updates the specified Application resource. You can update the following fields:
-auth_domain - Google authentication domain for controlling user access to the application.
-default_cookie_expiration - Cookie expiration policy for the application.
-
-Args:
- appsId: string, Part of `name`. Name of the Application resource to update. Example: apps/myapp. (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # An Application resource contains the top-level configuration of an App Engine application.
- "defaultHostname": "A String", # Hostname used to reach this application, as resolved by App Engine.@OutputOnly
- "iap": { # Identity-Aware Proxy
- "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
- "enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
- "oauth2ClientSecret": "A String", # OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
- "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
- },
- "gcrDomain": "A String", # The Google Container Registry domain used for storing managed build docker images for this application.
- "codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly
- "defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
- "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly
- { # Rules to match an HTTP request and dispatch that request to a service.
- "path": "A String", # Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
- "domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
- "service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
- },
- ],
- "defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
- "servingStatus": "A String", # Serving status of this application.
- "locationId": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
- "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
- "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
- "name": "A String", # Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly
- }
-
- updateMask: string, Standard field mask for the set of fields to be updated.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # 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.
- },
- "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: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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.
- },
- ],
- },
- "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.
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="repair">repair(appsId, body, x__xgafv=None)</code>
- <pre>Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.
-
-Args:
- appsId: string, Part of `name`. Name of the application to repair. Example: apps/myapp (required)
- body: object, The request body. (required)
- The object takes the form of:
-
-{ # Request message for 'Applications.RepairApplication'.
- }
-
- 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.
- },
- "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: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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.
- },
- ],
- },
- "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.
- }</pre>
-</div>
-
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/appengine_v1alpha.apps.locations.html b/docs/dyn/appengine_v1alpha.apps.locations.html
index 7e8bf58..dce39f3 100644
--- a/docs/dyn/appengine_v1alpha.apps.locations.html
+++ b/docs/dyn/appengine_v1alpha.apps.locations.html
@@ -92,16 +92,12 @@
appsId: string, Part of `name`. Resource name for the location. (required)
locationsId: string, Part of `name`. See documentation of `appsId`. (required)
x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
Returns:
An object of the form:
{ # A resource that represents Google Cloud Platform location.
- "labels": { # Cross-service attributes for the location. For example
- # {"cloud.googleapis.com/region": "us-east1"}
+ "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
"a_key": "A String",
},
"locationId": "A String", # The canonical id for this location. For example: "us-east1".
@@ -122,9 +118,6 @@
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:
@@ -133,8 +126,7 @@
"nextPageToken": "A String", # The standard List next-page token.
"locations": [ # A list of locations that matches the specified filter in the request.
{ # A resource that represents Google Cloud Platform location.
- "labels": { # Cross-service attributes for the location. For example
- # {"cloud.googleapis.com/region": "us-east1"}
+ "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
"a_key": "A String",
},
"locationId": "A String", # The canonical id for this location. For example: "us-east1".
diff --git a/docs/dyn/appengine_v1alpha.apps.operations.html b/docs/dyn/appengine_v1alpha.apps.operations.html
index 0043da1..ba84a81 100644
--- a/docs/dyn/appengine_v1alpha.apps.operations.html
+++ b/docs/dyn/appengine_v1alpha.apps.operations.html
@@ -92,25 +92,15 @@
appsId: string, Part of `name`. The name of the operation resource. (required)
operationsId: string, Part of `name`. See documentation of `appsId`. (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.
+ "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: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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.
+ "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 needsOverviewThe 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 mappingThe 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 usesThe 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.
@@ -120,10 +110,10 @@
],
},
"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.
+ "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.
},
- "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.
}</pre>
</div>
@@ -137,28 +127,17 @@
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.
+ "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: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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.
+ "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 needsOverviewThe 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 mappingThe 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 usesThe 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.
@@ -168,12 +147,13 @@
],
},
"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.
+ "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.
},
- "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.
},
],
+ "nextPageToken": "A String", # The standard List next-page token.
}</pre>
</div>
diff --git a/docs/dyn/appengine_v1beta.apps.authorizedCertificates.html b/docs/dyn/appengine_v1beta.apps.authorizedCertificates.html
new file mode 100644
index 0000000..4c5b5d8
--- /dev/null
+++ b/docs/dyn/appengine_v1beta.apps.authorizedCertificates.html
@@ -0,0 +1,317 @@
+<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="appengine_v1beta.html">Google App Engine Admin API</a> . <a href="appengine_v1beta.apps.html">apps</a> . <a href="appengine_v1beta.apps.authorizedCertificates.html">authorizedCertificates</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#create">create(appsId, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Uploads the specified SSL certificate.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(appsId, authorizedCertificatesId, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes the specified SSL certificate.</p>
+<p class="toc_element">
+ <code><a href="#get">get(appsId, authorizedCertificatesId, x__xgafv=None, view=None)</a></code></p>
+<p class="firstline">Gets the specified SSL certificate.</p>
+<p class="toc_element">
+ <code><a href="#list">list(appsId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists all SSL certificates the user is authorized to administer.</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(appsId, authorizedCertificatesId, body, updateMask=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(appsId, body, x__xgafv=None)</code>
+ <pre>Uploads the specified SSL certificate.
+
+Args:
+ appsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+ "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+ "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+ "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET requests when specifically requested by the view=FULL option.@OutputOnly
+ "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET requests when specifically requested by the view=FULL option.@OutputOnly
+ "A String",
+ ],
+ "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+ "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+ "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example:
+ # -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY-----
+ # @InputOnly
+ "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example:
+ # -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+ },
+ "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+ "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+ "A String",
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+ "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+ "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+ "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET requests when specifically requested by the view=FULL option.@OutputOnly
+ "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET requests when specifically requested by the view=FULL option.@OutputOnly
+ "A String",
+ ],
+ "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+ "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+ "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example:
+ # -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY-----
+ # @InputOnly
+ "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example:
+ # -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+ },
+ "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+ "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(appsId, authorizedCertificatesId, x__xgafv=None)</code>
+ <pre>Deletes the specified SSL certificate.
+
+Args:
+ appsId: string, Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345. (required)
+ authorizedCertificatesId: string, Part of `name`. See documentation of `appsId`. (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(appsId, authorizedCertificatesId, x__xgafv=None, view=None)</code>
+ <pre>Gets the specified SSL certificate.
+
+Args:
+ appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345. (required)
+ authorizedCertificatesId: string, Part of `name`. See documentation of `appsId`. (required)
+ x__xgafv: string, V1 error format.
+ view: string, Controls the set of fields returned in the GET response.
+
+Returns:
+ An object of the form:
+
+ { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+ "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+ "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+ "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET requests when specifically requested by the view=FULL option.@OutputOnly
+ "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET requests when specifically requested by the view=FULL option.@OutputOnly
+ "A String",
+ ],
+ "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+ "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+ "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example:
+ # -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY-----
+ # @InputOnly
+ "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example:
+ # -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+ },
+ "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+ "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(appsId, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists all SSL certificates the user is authorized to administer.
+
+Args:
+ appsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required)
+ pageSize: integer, Maximum results to return per page.
+ pageToken: string, Continuation token for fetching the next page of results.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # Response message for AuthorizedCertificates.ListAuthorizedCertificates.
+ "certificates": [ # The SSL certificates the user is authorized to administer.
+ { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+ "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+ "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+ "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET requests when specifically requested by the view=FULL option.@OutputOnly
+ "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET requests when specifically requested by the view=FULL option.@OutputOnly
+ "A String",
+ ],
+ "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+ "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+ "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example:
+ # -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY-----
+ # @InputOnly
+ "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example:
+ # -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+ },
+ "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+ "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+ "A String",
+ ],
+ },
+ ],
+ "nextPageToken": "A String", # Continuation token for fetching the next page of results.
+ }</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(appsId, authorizedCertificatesId, body, updateMask=None, x__xgafv=None)</code>
+ <pre>Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.
+
+Args:
+ appsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345. (required)
+ authorizedCertificatesId: string, Part of `name`. See documentation of `appsId`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+ "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+ "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+ "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET requests when specifically requested by the view=FULL option.@OutputOnly
+ "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET requests when specifically requested by the view=FULL option.@OutputOnly
+ "A String",
+ ],
+ "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+ "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+ "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example:
+ # -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY-----
+ # @InputOnly
+ "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example:
+ # -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+ },
+ "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+ "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+ "A String",
+ ],
+ }
+
+ updateMask: string, Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.
+ "displayName": "A String", # The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.
+ "name": "A String", # Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly
+ "domainMappingsCount": 42, # Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET requests when specifically requested by the view=FULL option.@OutputOnly
+ "visibleDomainMappings": [ # The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET requests when specifically requested by the view=FULL option.@OutputOnly
+ "A String",
+ ],
+ "expireTime": "A String", # The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
+ "certificateRawData": { # An SSL certificate obtained from a certificate authority. # The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.
+ "privateKey": "A String", # Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example:
+ # -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY-----
+ # @InputOnly
+ "publicCertificate": "A String", # PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example:
+ # -----BEGIN CERTIFICATE----- -----END CERTIFICATE-----
+ },
+ "id": "A String", # Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
+ "domainNames": [ # Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/appengine_v1beta.apps.authorizedDomains.html b/docs/dyn/appengine_v1beta.apps.authorizedDomains.html
new file mode 100644
index 0000000..13630dc
--- /dev/null
+++ b/docs/dyn/appengine_v1beta.apps.authorizedDomains.html
@@ -0,0 +1,122 @@
+<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="appengine_v1beta.html">Google App Engine Admin API</a> . <a href="appengine_v1beta.apps.html">apps</a> . <a href="appengine_v1beta.apps.authorizedDomains.html">authorizedDomains</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#list">list(appsId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists all domains the user is authorized to administer.</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(appsId, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists all domains the user is authorized to administer.
+
+Args:
+ appsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required)
+ pageSize: integer, Maximum results to return per page.
+ pageToken: string, Continuation token for fetching the next page of results.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # Response message for AuthorizedDomains.ListAuthorizedDomains.
+ "domains": [ # The authorized domains belonging to the user.
+ { # A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).
+ "name": "A String", # Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly
+ "id": "A String", # Fully qualified domain name of the domain authorized for use. Example: example.com.
+ },
+ ],
+ "nextPageToken": "A String", # Continuation token for fetching the next page of results.
+ }</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/appengine_v1beta.apps.domainMappings.html b/docs/dyn/appengine_v1beta.apps.domainMappings.html
new file mode 100644
index 0000000..5b4bc80
--- /dev/null
+++ b/docs/dyn/appengine_v1beta.apps.domainMappings.html
@@ -0,0 +1,307 @@
+<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="appengine_v1beta.html">Google App Engine Admin API</a> . <a href="appengine_v1beta.apps.html">apps</a> . <a href="appengine_v1beta.apps.domainMappings.html">domainMappings</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#create">create(appsId, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(appsId, domainMappingsId, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.</p>
+<p class="toc_element">
+ <code><a href="#get">get(appsId, domainMappingsId, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the specified domain mapping.</p>
+<p class="toc_element">
+ <code><a href="#list">list(appsId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists the domain mappings on an application.</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(appsId, domainMappingsId, body, updateMask=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(appsId, body, x__xgafv=None)</code>
+ <pre>Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.
+
+Args:
+ appsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A domain serving an App Engine application.
+ "sslSettings": { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
+ "certificateId": "A String", # ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.
+ },
+ "name": "A String", # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
+ "resourceRecords": [ # The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
+ { # A DNS resource record.
+ "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
+ "type": "A String", # Resource record type. Example: AAAA.
+ "name": "A String", # Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
+ },
+ ],
+ "id": "A String", # Relative name of the domain serving the application. Example: example.com.
+ }
+
+ 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 needsOverviewThe 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 mappingThe 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 usesThe 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.
+ {
+ "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(appsId, domainMappingsId, x__xgafv=None)</code>
+ <pre>Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.
+
+Args:
+ appsId: string, Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com. (required)
+ domainMappingsId: string, Part of `name`. See documentation of `appsId`. (required)
+ 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 needsOverviewThe 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 mappingThe 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 usesThe 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.
+ {
+ "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="get">get(appsId, domainMappingsId, x__xgafv=None)</code>
+ <pre>Gets the specified domain mapping.
+
+Args:
+ appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com. (required)
+ domainMappingsId: string, Part of `name`. See documentation of `appsId`. (required)
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # A domain serving an App Engine application.
+ "sslSettings": { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
+ "certificateId": "A String", # ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.
+ },
+ "name": "A String", # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
+ "resourceRecords": [ # The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
+ { # A DNS resource record.
+ "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
+ "type": "A String", # Resource record type. Example: AAAA.
+ "name": "A String", # Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
+ },
+ ],
+ "id": "A String", # Relative name of the domain serving the application. Example: example.com.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(appsId, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists the domain mappings on an application.
+
+Args:
+ appsId: string, Part of `parent`. Name of the parent Application resource. Example: apps/myapp. (required)
+ pageSize: integer, Maximum results to return per page.
+ pageToken: string, Continuation token for fetching the next page of results.
+ x__xgafv: string, V1 error format.
+
+Returns:
+ An object of the form:
+
+ { # Response message for DomainMappings.ListDomainMappings.
+ "nextPageToken": "A String", # Continuation token for fetching the next page of results.
+ "domainMappings": [ # The domain mappings for the application.
+ { # A domain serving an App Engine application.
+ "sslSettings": { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
+ "certificateId": "A String", # ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.
+ },
+ "name": "A String", # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
+ "resourceRecords": [ # The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
+ { # A DNS resource record.
+ "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
+ "type": "A String", # Resource record type. Example: AAAA.
+ "name": "A String", # Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
+ },
+ ],
+ "id": "A String", # Relative name of the domain serving the application. Example: example.com.
+ },
+ ],
+ }</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(appsId, domainMappingsId, body, updateMask=None, x__xgafv=None)</code>
+ <pre>Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.
+
+Args:
+ appsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com. (required)
+ domainMappingsId: string, Part of `name`. See documentation of `appsId`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A domain serving an App Engine application.
+ "sslSettings": { # SSL configuration for a DomainMapping resource. # SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.
+ "certificateId": "A String", # ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.
+ },
+ "name": "A String", # Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly
+ "resourceRecords": [ # The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly
+ { # A DNS resource record.
+ "rrdata": "A String", # Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).
+ "type": "A String", # Resource record type. Example: AAAA.
+ "name": "A String", # Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.
+ },
+ ],
+ "id": "A String", # Relative name of the domain serving the application. Example: example.com.
+ }
+
+ updateMask: string, Standard field mask for the set of fields to be updated.
+ 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 needsOverviewThe 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 mappingThe 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 usesThe 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.
+ {
+ "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>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/appengine_v1beta.apps.html b/docs/dyn/appengine_v1beta.apps.html
index d9bb28d..c9433e3 100644
--- a/docs/dyn/appengine_v1beta.apps.html
+++ b/docs/dyn/appengine_v1beta.apps.html
@@ -75,6 +75,21 @@
<h1><a href="appengine_v1beta.html">Google App Engine Admin API</a> . <a href="appengine_v1beta.apps.html">apps</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="appengine_v1beta.apps.authorizedCertificates.html">authorizedCertificates()</a></code>
+</p>
+<p class="firstline">Returns the authorizedCertificates Resource.</p>
+
+<p class="toc_element">
+ <code><a href="appengine_v1beta.apps.authorizedDomains.html">authorizedDomains()</a></code>
+</p>
+<p class="firstline">Returns the authorizedDomains Resource.</p>
+
+<p class="toc_element">
+ <code><a href="appengine_v1beta.apps.domainMappings.html">domainMappings()</a></code>
+</p>
+<p class="firstline">Returns the domainMappings Resource.</p>
+
+<p class="toc_element">
<code><a href="appengine_v1beta.apps.locations.html">locations()</a></code>
</p>
<p class="firstline">Returns the locations Resource.</p>
@@ -91,22 +106,20 @@
<p class="toc_element">
<code><a href="#create">create(body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates an App Engine application for a Google Cloud Platform project. Required fields:</p>
+<p class="firstline">Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).</p>
<p class="toc_element">
<code><a href="#get">get(appsId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about an application.</p>
<p class="toc_element">
<code><a href="#patch">patch(appsId, body, updateMask=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates the specified Application resource. You can update the following fields:</p>
+<p class="firstline">Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application.</p>
<p class="toc_element">
<code><a href="#repair">repair(appsId, body, x__xgafv=None)</a></code></p>
<p class="firstline">Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(body, x__xgafv=None)</code>
- <pre>Creates an App Engine application for a Google Cloud Platform project. Required fields:
-id - The ID of the target Cloud Platform project.
-location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).
+ <pre>Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).
Args:
body: object, The request body. (required)
@@ -118,9 +131,9 @@
"gcrDomain": "A String", # The Google Container Registry domain used for storing managed build docker images for this application.
"codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly
"defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
- "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly
+ "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly
{ # Rules to match an HTTP request and dispatch that request to a service.
- "path": "A String", # Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
+ "path": "A String", # Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.
"domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
"service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
},
@@ -128,33 +141,26 @@
"defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
"servingStatus": "A String", # Serving status of this application.
"locationId": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
- "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
- "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
"iap": { # Identity-Aware Proxy
"oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
"enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
"oauth2ClientSecret": "A String", # OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
"oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
},
+ "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
+ "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
}
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.
- "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: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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.
+ "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 needsOverviewThe 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 mappingThe 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 usesThe 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.
@@ -164,9 +170,6 @@
],
},
"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.
"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.
@@ -181,9 +184,6 @@
Args:
appsId: string, Part of `name`. Name of the Application resource to get. Example: apps/myapp. (required)
x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
Returns:
An object of the form:
@@ -194,9 +194,9 @@
"gcrDomain": "A String", # The Google Container Registry domain used for storing managed build docker images for this application.
"codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly
"defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
- "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly
+ "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly
{ # Rules to match an HTTP request and dispatch that request to a service.
- "path": "A String", # Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
+ "path": "A String", # Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.
"domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
"service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
},
@@ -204,22 +204,20 @@
"defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
"servingStatus": "A String", # Serving status of this application.
"locationId": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
- "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
- "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
"iap": { # Identity-Aware Proxy
"oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
"enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
"oauth2ClientSecret": "A String", # OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
"oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
},
+ "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
+ "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(appsId, body, updateMask=None, x__xgafv=None)</code>
- <pre>Updates the specified Application resource. You can update the following fields:
-auth_domain - Google authentication domain for controlling user access to the application.
-default_cookie_expiration - Cookie expiration policy for the application.
+ <pre>Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application.
Args:
appsId: string, Part of `name`. Name of the Application resource to update. Example: apps/myapp. (required)
@@ -232,9 +230,9 @@
"gcrDomain": "A String", # The Google Container Registry domain used for storing managed build docker images for this application.
"codeBucket": "A String", # Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly
"defaultBucket": "A String", # Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly
- "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly
+ "dispatchRules": [ # HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly
{ # Rules to match an HTTP request and dispatch that request to a service.
- "path": "A String", # Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.
+ "path": "A String", # Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.
"domain": "A String", # Domain name to match against. The wildcard "*" is supported if specified before a period: "*.".Defaults to matching all domains: "*".
"service": "A String", # Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.
},
@@ -242,34 +240,27 @@
"defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
"servingStatus": "A String", # Serving status of this application.
"locationId": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
- "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
- "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
"iap": { # Identity-Aware Proxy
"oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
"enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
"oauth2ClientSecret": "A String", # OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
"oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
},
+ "authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
+ "id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
}
updateMask: string, Standard field mask for the set of fields to be updated.
x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "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: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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.
+ "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 needsOverviewThe 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 mappingThe 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 usesThe 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.
@@ -279,9 +270,6 @@
],
},
"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.
"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.
@@ -302,22 +290,15 @@
}
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.
- "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: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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.
+ "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 needsOverviewThe 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 mappingThe 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 usesThe 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.
@@ -327,9 +308,6 @@
],
},
"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.
"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.
diff --git a/docs/dyn/appengine_v1beta.apps.locations.html b/docs/dyn/appengine_v1beta.apps.locations.html
index 6bb77ab..c3e5cff 100644
--- a/docs/dyn/appengine_v1beta.apps.locations.html
+++ b/docs/dyn/appengine_v1beta.apps.locations.html
@@ -92,16 +92,12 @@
appsId: string, Part of `name`. Resource name for the location. (required)
locationsId: string, Part of `name`. See documentation of `appsId`. (required)
x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
Returns:
An object of the form:
{ # A resource that represents Google Cloud Platform location.
- "labels": { # Cross-service attributes for the location. For example
- # {"cloud.googleapis.com/region": "us-east1"}
+ "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
"a_key": "A String",
},
"locationId": "A String", # The canonical id for this location. For example: "us-east1".
@@ -122,9 +118,6 @@
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:
@@ -133,8 +126,7 @@
"nextPageToken": "A String", # The standard List next-page token.
"locations": [ # A list of locations that matches the specified filter in the request.
{ # A resource that represents Google Cloud Platform location.
- "labels": { # Cross-service attributes for the location. For example
- # {"cloud.googleapis.com/region": "us-east1"}
+ "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
"a_key": "A String",
},
"locationId": "A String", # The canonical id for this location. For example: "us-east1".
diff --git a/docs/dyn/appengine_v1beta.apps.operations.html b/docs/dyn/appengine_v1beta.apps.operations.html
index e5fcbd1..8778ddc 100644
--- a/docs/dyn/appengine_v1beta.apps.operations.html
+++ b/docs/dyn/appengine_v1beta.apps.operations.html
@@ -92,22 +92,15 @@
appsId: string, Part of `name`. The name of the operation resource. (required)
operationsId: string, Part of `name`. See documentation of `appsId`. (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.
- "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: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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.
+ "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 needsOverviewThe 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 mappingThe 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 usesThe 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.
@@ -117,9 +110,6 @@
],
},
"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.
"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.
@@ -137,9 +127,6 @@
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:
@@ -147,14 +134,10 @@
{ # The response message for Operations.ListOperations.
"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.
- "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: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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.
+ "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 needsOverviewThe 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 mappingThe 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 usesThe 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.
@@ -164,9 +147,6 @@
],
},
"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.
"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.
diff --git a/docs/dyn/appengine_v1beta.apps.services.html b/docs/dyn/appengine_v1beta.apps.services.html
index 64ae750..7a8f6e9 100644
--- a/docs/dyn/appengine_v1beta.apps.services.html
+++ b/docs/dyn/appengine_v1beta.apps.services.html
@@ -103,22 +103,15 @@
appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default. (required)
servicesId: string, Part of `name`. See documentation of `appsId`. (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.
- "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: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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.
+ "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 needsOverviewThe 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 mappingThe 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 usesThe 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.
@@ -128,9 +121,6 @@
],
},
"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.
"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.
@@ -146,9 +136,6 @@
appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default. (required)
servicesId: string, Part of `name`. See documentation of `appsId`. (required)
x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
Returns:
An object of the form:
@@ -174,9 +161,6 @@
pageSize: integer, Maximum results to return per page.
pageToken: string, Continuation token for fetching the next page of results.
x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
Returns:
An object of the form:
@@ -236,22 +220,15 @@
migrateTraffic: boolean, Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
updateMask: string, Standard field mask for the set of fields to be updated.
x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "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: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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.
+ "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 needsOverviewThe 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 mappingThe 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 usesThe 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.
@@ -261,9 +238,6 @@
],
},
"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.
"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.
diff --git a/docs/dyn/appengine_v1beta.apps.services.versions.html b/docs/dyn/appengine_v1beta.apps.services.versions.html
index f011702..e60d96b 100644
--- a/docs/dyn/appengine_v1beta.apps.services.versions.html
+++ b/docs/dyn/appengine_v1beta.apps.services.versions.html
@@ -89,14 +89,14 @@
<code><a href="#get">get(appsId, servicesId, versionsId, x__xgafv=None, view=None)</a></code></p>
<p class="firstline">Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.</p>
<p class="toc_element">
- <code><a href="#list">list(appsId, servicesId, pageSize=None, pageToken=None, x__xgafv=None, view=None)</a></code></p>
+ <code><a href="#list">list(appsId, servicesId, pageSize=None, x__xgafv=None, pageToken=None, view=None)</a></code></p>
<p class="firstline">Lists the versions of a service.</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(appsId, servicesId, versionsId, body, updateMask=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:</p>
+<p class="firstline">Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(appsId, servicesId, body, x__xgafv=None)</code>
@@ -113,15 +113,15 @@
"configId": "A String", # Endpoints service configuration id as specified by the Service Management API. For example "2016-09-19r1"
"name": "A String", # Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
},
- "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
"idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
"maxInstances": 42, # Maximum number of instances to create for this version.
},
+ "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
+ "a_key": "A String",
+ },
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
- "instanceClass": "A String", # Instance class that is used to run this version. Valid values are:
- # AutomaticScaling: F1, F2, F4, F4_1G
- # ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
+ "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
"errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
{ # Custom static error page to be served when an error occurs.
"errorCode": "A String", # Error condition this handler applies to.
@@ -145,17 +145,7 @@
"login": "A String", # Level of login required to access this resource. Defaults to optional.
"script": "A String", # Path to the script from the application root directory.
},
- "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
- "instanceTag": "A String", # Tag to apply to the VM instance during creation.
- "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
- "A String",
- ],
- "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
- "subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.
- # If the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.
- # If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.
- # If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
- },
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
"healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.
"restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
"checkInterval": "A String", # Interval between health checks.
@@ -165,6 +155,7 @@
"timeout": "A String", # Time before the health check is considered failed.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
},
+ "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
{ # Third-party Python runtime library that is required by the application.
@@ -175,10 +166,7 @@
"env": "A String", # App Engine execution environment for this version.Defaults to standard.
"diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly
"automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
- "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
- "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
- "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
- },
+ "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
"networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
"targetReceivedPacketsPerSecond": 42, # Target packets received per second.
"targetSentPacketsPerSecond": 42, # Target packets sent per second.
@@ -202,7 +190,10 @@
"maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
"maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.
"minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
- "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
+ "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
+ "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
+ "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
+ },
},
"envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set.
"a_key": "A String",
@@ -225,15 +216,12 @@
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
- "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
- "a_key": "A String",
- },
"createdBy": "A String", # Email address of the user who created this version.@OutputOnly
"deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
"files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
"a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
"mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage.
- "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
@@ -242,9 +230,19 @@
},
"zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
"filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
- "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
+ "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
+ "createTime": "A String", # Time that this version was created.@OutputOnly
+ "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
+ "instanceTag": "A String", # Tag to apply to the VM instance during creation.
+ "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
+ "A String",
+ ],
+ "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
+ "subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
+ },
"livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.
"checkInterval": "A String", # Interval between health checks.
"initialDelay": "A String", # The initial delay before starting to execute the checks.
@@ -254,9 +252,6 @@
"timeout": "A String", # Time before the check is considered failed.
"path": "A String", # The request path.
},
- "createTime": "A String", # Time that this version was created.@OutputOnly
- "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
- "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
"name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.
{ # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
@@ -268,20 +263,20 @@
},
"staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
"mimeType": "A String", # MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.
+ "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
+ "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
+ "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
+ "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
+ "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
- "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
- "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
- "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
- "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
- "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
},
"apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
"scriptPath": "A String", # Path to the script from the application root directory.
},
- "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
"login": "A String", # Level of login required to access this resource.
+ "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
},
],
"servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
@@ -289,22 +284,15 @@
}
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.
- "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: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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.
+ "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 needsOverviewThe 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 mappingThe 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 usesThe 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.
@@ -314,9 +302,6 @@
],
},
"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.
"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.
@@ -333,22 +318,15 @@
servicesId: string, Part of `name`. See documentation of `appsId`. (required)
versionsId: string, Part of `name`. See documentation of `appsId`. (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.
- "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: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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.
+ "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 needsOverviewThe 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 mappingThe 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 usesThe 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.
@@ -358,9 +336,6 @@
],
},
"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.
"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.
@@ -377,9 +352,6 @@
servicesId: string, Part of `name`. See documentation of `appsId`. (required)
versionsId: string, Part of `name`. See documentation of `appsId`. (required)
x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
view: string, Controls the set of fields returned in the Get response.
Returns:
@@ -390,15 +362,15 @@
"configId": "A String", # Endpoints service configuration id as specified by the Service Management API. For example "2016-09-19r1"
"name": "A String", # Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
},
- "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
"idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
"maxInstances": 42, # Maximum number of instances to create for this version.
},
+ "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
+ "a_key": "A String",
+ },
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
- "instanceClass": "A String", # Instance class that is used to run this version. Valid values are:
- # AutomaticScaling: F1, F2, F4, F4_1G
- # ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
+ "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
"errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
{ # Custom static error page to be served when an error occurs.
"errorCode": "A String", # Error condition this handler applies to.
@@ -422,17 +394,7 @@
"login": "A String", # Level of login required to access this resource. Defaults to optional.
"script": "A String", # Path to the script from the application root directory.
},
- "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
- "instanceTag": "A String", # Tag to apply to the VM instance during creation.
- "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
- "A String",
- ],
- "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
- "subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.
- # If the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.
- # If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.
- # If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
- },
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
"healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.
"restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
"checkInterval": "A String", # Interval between health checks.
@@ -442,6 +404,7 @@
"timeout": "A String", # Time before the health check is considered failed.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
},
+ "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
{ # Third-party Python runtime library that is required by the application.
@@ -452,10 +415,7 @@
"env": "A String", # App Engine execution environment for this version.Defaults to standard.
"diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly
"automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
- "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
- "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
- "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
- },
+ "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
"networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
"targetReceivedPacketsPerSecond": 42, # Target packets received per second.
"targetSentPacketsPerSecond": 42, # Target packets sent per second.
@@ -479,7 +439,10 @@
"maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
"maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.
"minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
- "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
+ "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
+ "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
+ "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
+ },
},
"envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set.
"a_key": "A String",
@@ -502,15 +465,12 @@
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
- "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
- "a_key": "A String",
- },
"createdBy": "A String", # Email address of the user who created this version.@OutputOnly
"deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
"files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
"a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
"mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage.
- "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
@@ -519,9 +479,19 @@
},
"zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
"filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
- "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
+ "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
+ "createTime": "A String", # Time that this version was created.@OutputOnly
+ "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
+ "instanceTag": "A String", # Tag to apply to the VM instance during creation.
+ "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
+ "A String",
+ ],
+ "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
+ "subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
+ },
"livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.
"checkInterval": "A String", # Interval between health checks.
"initialDelay": "A String", # The initial delay before starting to execute the checks.
@@ -531,9 +501,6 @@
"timeout": "A String", # Time before the check is considered failed.
"path": "A String", # The request path.
},
- "createTime": "A String", # Time that this version was created.@OutputOnly
- "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
- "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
"name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.
{ # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
@@ -545,20 +512,20 @@
},
"staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
"mimeType": "A String", # MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.
+ "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
+ "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
+ "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
+ "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
+ "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
- "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
- "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
- "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
- "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
- "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
},
"apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
"scriptPath": "A String", # Path to the script from the application root directory.
},
- "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
"login": "A String", # Level of login required to access this resource.
+ "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
},
],
"servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
@@ -567,18 +534,15 @@
</div>
<div class="method">
- <code class="details" id="list">list(appsId, servicesId, pageSize=None, pageToken=None, x__xgafv=None, view=None)</code>
+ <code class="details" id="list">list(appsId, servicesId, pageSize=None, x__xgafv=None, pageToken=None, view=None)</code>
<pre>Lists the versions of a service.
Args:
appsId: string, Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default. (required)
servicesId: string, Part of `parent`. See documentation of `appsId`. (required)
pageSize: integer, Maximum results to return per page.
- pageToken: string, Continuation token for fetching the next page of results.
x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
+ pageToken: string, Continuation token for fetching the next page of results.
view: string, Controls the set of fields returned in the List response.
Returns:
@@ -592,15 +556,15 @@
"configId": "A String", # Endpoints service configuration id as specified by the Service Management API. For example "2016-09-19r1"
"name": "A String", # Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
},
- "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
"idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
"maxInstances": 42, # Maximum number of instances to create for this version.
},
+ "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
+ "a_key": "A String",
+ },
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
- "instanceClass": "A String", # Instance class that is used to run this version. Valid values are:
- # AutomaticScaling: F1, F2, F4, F4_1G
- # ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
+ "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
"errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
{ # Custom static error page to be served when an error occurs.
"errorCode": "A String", # Error condition this handler applies to.
@@ -624,17 +588,7 @@
"login": "A String", # Level of login required to access this resource. Defaults to optional.
"script": "A String", # Path to the script from the application root directory.
},
- "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
- "instanceTag": "A String", # Tag to apply to the VM instance during creation.
- "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
- "A String",
- ],
- "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
- "subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.
- # If the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.
- # If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.
- # If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
- },
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
"healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.
"restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
"checkInterval": "A String", # Interval between health checks.
@@ -644,6 +598,7 @@
"timeout": "A String", # Time before the health check is considered failed.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
},
+ "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
{ # Third-party Python runtime library that is required by the application.
@@ -654,10 +609,7 @@
"env": "A String", # App Engine execution environment for this version.Defaults to standard.
"diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly
"automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
- "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
- "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
- "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
- },
+ "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
"networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
"targetReceivedPacketsPerSecond": 42, # Target packets received per second.
"targetSentPacketsPerSecond": 42, # Target packets sent per second.
@@ -681,7 +633,10 @@
"maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
"maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.
"minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
- "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
+ "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
+ "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
+ "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
+ },
},
"envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set.
"a_key": "A String",
@@ -704,15 +659,12 @@
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
- "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
- "a_key": "A String",
- },
"createdBy": "A String", # Email address of the user who created this version.@OutputOnly
"deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
"files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
"a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
"mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage.
- "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
@@ -721,9 +673,19 @@
},
"zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
"filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
- "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
+ "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
+ "createTime": "A String", # Time that this version was created.@OutputOnly
+ "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
+ "instanceTag": "A String", # Tag to apply to the VM instance during creation.
+ "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
+ "A String",
+ ],
+ "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
+ "subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
+ },
"livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.
"checkInterval": "A String", # Interval between health checks.
"initialDelay": "A String", # The initial delay before starting to execute the checks.
@@ -733,9 +695,6 @@
"timeout": "A String", # Time before the check is considered failed.
"path": "A String", # The request path.
},
- "createTime": "A String", # Time that this version was created.@OutputOnly
- "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
- "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
"name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.
{ # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
@@ -747,20 +706,20 @@
},
"staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
"mimeType": "A String", # MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.
+ "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
+ "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
+ "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
+ "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
+ "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
- "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
- "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
- "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
- "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
- "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
},
"apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
"scriptPath": "A String", # Path to the script from the application root directory.
},
- "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
"login": "A String", # Level of login required to access this resource.
+ "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
},
],
"servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
@@ -786,11 +745,7 @@
<div class="method">
<code class="details" id="patch">patch(appsId, servicesId, versionsId, body, updateMask=None, x__xgafv=None)</code>
- <pre>Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:
-serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.
-instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.
-automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.
-automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.
+ <pre>Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment. instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment. automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment. automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.
Args:
appsId: string, Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1. (required)
@@ -804,15 +759,15 @@
"configId": "A String", # Endpoints service configuration id as specified by the Service Management API. For example "2016-09-19r1"
"name": "A String", # Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
},
- "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
"idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
"maxInstances": 42, # Maximum number of instances to create for this version.
},
+ "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
+ "a_key": "A String",
+ },
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
- "instanceClass": "A String", # Instance class that is used to run this version. Valid values are:
- # AutomaticScaling: F1, F2, F4, F4_1G
- # ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
+ "instanceClass": "A String", # Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
"errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
{ # Custom static error page to be served when an error occurs.
"errorCode": "A String", # Error condition this handler applies to.
@@ -836,17 +791,7 @@
"login": "A String", # Level of login required to access this resource. Defaults to optional.
"script": "A String", # Path to the script from the application root directory.
},
- "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
- "instanceTag": "A String", # Tag to apply to the VM instance during creation.
- "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
- "A String",
- ],
- "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
- "subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.
- # If the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.
- # If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.
- # If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
- },
+ "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
"healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.
"restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
"checkInterval": "A String", # Interval between health checks.
@@ -856,6 +801,7 @@
"timeout": "A String", # Time before the health check is considered failed.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
},
+ "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
{ # Third-party Python runtime library that is required by the application.
@@ -866,10 +812,7 @@
"env": "A String", # App Engine execution environment for this version.Defaults to standard.
"diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly
"automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics.
- "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
- "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
- "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
- },
+ "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
"networkUtilization": { # Target scaling by network usage. Only applicable for VM runtimes. # Target scaling by network usage.
"targetReceivedPacketsPerSecond": 42, # Target packets received per second.
"targetSentPacketsPerSecond": 42, # Target packets sent per second.
@@ -893,7 +836,10 @@
"maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests.
"maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.
"minTotalInstances": 42, # Minimum number of instances that should be maintained for this version.
- "minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
+ "cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
+ "targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
+ "aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
+ },
},
"envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set.
"a_key": "A String",
@@ -916,15 +862,12 @@
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
- "betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
- "a_key": "A String",
- },
"createdBy": "A String", # Email address of the user who created this version.@OutputOnly
"deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
"files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
"a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
"mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage.
- "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ "sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
},
},
@@ -933,9 +876,19 @@
},
"zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
"filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
- "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/<bucket>/<object>'.
+ "sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
+ "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
+ "createTime": "A String", # Time that this version was created.@OutputOnly
+ "network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
+ "instanceTag": "A String", # Tag to apply to the VM instance during creation.
+ "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container.
+ "A String",
+ ],
+ "name": "A String", # Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
+ "subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.
+ },
"livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.
"checkInterval": "A String", # Interval between health checks.
"initialDelay": "A String", # The initial delay before starting to execute the checks.
@@ -945,9 +898,6 @@
"timeout": "A String", # Time before the check is considered failed.
"path": "A String", # The request path.
},
- "createTime": "A String", # Time that this version was created.@OutputOnly
- "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
- "nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
"name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.
{ # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
@@ -959,20 +909,20 @@
},
"staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
"mimeType": "A String", # MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.
+ "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
+ "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
+ "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
+ "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
+ "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
- "expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
- "path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
- "uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
- "requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
- "applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
},
"apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
"scriptPath": "A String", # Path to the script from the application root directory.
},
- "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
"login": "A String", # Level of login required to access this resource.
+ "redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
},
],
"servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
@@ -981,22 +931,15 @@
updateMask: string, Standard field mask for the set of fields to be updated.
x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "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: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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.
+ "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 needsOverviewThe 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 mappingThe 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 usesThe 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.
@@ -1006,9 +949,6 @@
],
},
"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.
"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.
diff --git a/docs/dyn/appengine_v1beta.apps.services.versions.instances.html b/docs/dyn/appengine_v1beta.apps.services.versions.instances.html
index 21e6641..51123af 100644
--- a/docs/dyn/appengine_v1beta.apps.services.versions.instances.html
+++ b/docs/dyn/appengine_v1beta.apps.services.versions.instances.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(appsId, servicesId, versionsId, instancesId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets instance information.</p>
<p class="toc_element">
- <code><a href="#list">list(appsId, servicesId, versionsId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p>
<p class="firstline">Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -103,28 +103,19 @@
The object takes the form of:
{ # Request message for Instances.DebugInstance.
- "sshKey": "A String", # Public SSH key to add to the instance. Examples:
- # [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]
- # [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).
+ "sshKey": "A String", # Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).
}
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.
- "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: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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.
+ "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 needsOverviewThe 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 mappingThe 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 usesThe 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.
@@ -134,9 +125,6 @@
],
},
"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.
"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.
@@ -154,22 +142,15 @@
versionsId: string, Part of `name`. See documentation of `appsId`. (required)
instancesId: string, Part of `name`. See documentation of `appsId`. (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.
- "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: # The error result of the operation in case of failure or cancellation.
- # Simple to use and understand for most users
- # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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.
+ "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 needsOverviewThe 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 mappingThe 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 usesThe 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.
@@ -179,9 +160,6 @@
],
},
"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.
"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.
@@ -199,9 +177,6 @@
versionsId: string, Part of `name`. See documentation of `appsId`. (required)
instancesId: string, Part of `name`. See documentation of `appsId`. (required)
x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
Returns:
An object of the form:
@@ -212,7 +187,7 @@
"appEngineRelease": "A String", # App Engine release this instance is running on.@OutputOnly
"vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly
"memoryUsage": "A String", # Total memory in use (bytes).@OutputOnly
- "availability": "A String", # Availability of the instance.@OutputOnly
+ "id": "A String", # Relative name of the instance within the version. Example: instance-1.@OutputOnly
"averageLatency": 42, # Average latency (ms) over the last minute.@OutputOnly
"vmDebugEnabled": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly
"startTime": "A String", # Time that this instance was started.@OutputOnly
@@ -220,14 +195,14 @@
"qps": 3.14, # Average queries per second (QPS) over the last minute.@OutputOnly
"requests": 42, # Number of requests since this instance was started.@OutputOnly
"vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly
- "id": "A String", # Relative name of the instance within the version. Example: instance-1.@OutputOnly
+ "availability": "A String", # Availability of the instance.@OutputOnly
"vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly
"vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(appsId, servicesId, versionsId, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None)</code>
<pre>Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
Args:
@@ -235,11 +210,8 @@
servicesId: string, Part of `parent`. See documentation of `appsId`. (required)
versionsId: string, Part of `parent`. See documentation of `appsId`. (required)
pageSize: integer, Maximum results to return per page.
- pageToken: string, Continuation token for fetching the next page of results.
x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
+ pageToken: string, Continuation token for fetching the next page of results.
Returns:
An object of the form:
@@ -253,7 +225,7 @@
"appEngineRelease": "A String", # App Engine release this instance is running on.@OutputOnly
"vmId": "A String", # Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly
"memoryUsage": "A String", # Total memory in use (bytes).@OutputOnly
- "availability": "A String", # Availability of the instance.@OutputOnly
+ "id": "A String", # Relative name of the instance within the version. Example: instance-1.@OutputOnly
"averageLatency": 42, # Average latency (ms) over the last minute.@OutputOnly
"vmDebugEnabled": True or False, # Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly
"startTime": "A String", # Time that this instance was started.@OutputOnly
@@ -261,7 +233,7 @@
"qps": 3.14, # Average queries per second (QPS) over the last minute.@OutputOnly
"requests": 42, # Number of requests since this instance was started.@OutputOnly
"vmName": "A String", # Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly
- "id": "A String", # Relative name of the instance within the version. Example: instance-1.@OutputOnly
+ "availability": "A String", # Availability of the instance.@OutputOnly
"vmZoneName": "A String", # Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly
"vmStatus": "A String", # Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly
},
diff --git a/docs/dyn/appengine_v1beta4.apps.html b/docs/dyn/appengine_v1beta4.apps.html
index 8e89eb4..fadcb1e 100644
--- a/docs/dyn/appengine_v1beta4.apps.html
+++ b/docs/dyn/appengine_v1beta4.apps.html
@@ -91,7 +91,7 @@
<p class="toc_element">
<code><a href="#create">create(body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates an App Engine application for a Google Cloud Platform project. This requires a project that excludes an App Engine application. For details about creating a project without an application, see the Google Cloud Resource Manager create project topic (https://cloud.google.com/resource-manager/docs/creating-project).</p>
+<p class="firstline">Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).</p>
<p class="toc_element">
<code><a href="#get">get(appsId, x__xgafv=None, ensureResourcesExist=None)</a></code></p>
<p class="firstline">Gets information about an application.</p>
@@ -101,7 +101,7 @@
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(body, x__xgafv=None)</code>
- <pre>Creates an App Engine application for a Google Cloud Platform project. This requires a project that excludes an App Engine application. For details about creating a project without an application, see the Google Cloud Resource Manager create project topic (https://cloud.google.com/resource-manager/docs/creating-project).
+ <pre>Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).
Args:
body: object, The request body. (required)
@@ -120,6 +120,12 @@
},
],
"defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
+ "iap": { # Identity-Aware Proxy
+ "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
+ "enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
+ "oauth2ClientSecret": "A String", # For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
+ "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
+ },
"location": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
"authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
"id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
@@ -176,6 +182,12 @@
},
],
"defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
+ "iap": { # Identity-Aware Proxy
+ "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
+ "enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
+ "oauth2ClientSecret": "A String", # For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
+ "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
+ },
"location": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
"authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
"id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
@@ -204,6 +216,12 @@
},
],
"defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
+ "iap": { # Identity-Aware Proxy
+ "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
+ "enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
+ "oauth2ClientSecret": "A String", # For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
+ "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
+ },
"location": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
"authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
"id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
diff --git a/docs/dyn/appengine_v1beta4.apps.locations.html b/docs/dyn/appengine_v1beta4.apps.locations.html
index 313ecca..2eab9cf 100644
--- a/docs/dyn/appengine_v1beta4.apps.locations.html
+++ b/docs/dyn/appengine_v1beta4.apps.locations.html
@@ -122,7 +122,7 @@
Returns:
An object of the form:
- { # The response message for LocationService.ListLocations.
+ { # The response message for Locations.ListLocations.
"nextPageToken": "A String", # The standard List next-page token.
"locations": [ # A list of locations that matches the specified filter in the request.
{ # A resource that represents Google Cloud Platform location.
diff --git a/docs/dyn/appengine_v1beta4.apps.modules.html b/docs/dyn/appengine_v1beta4.apps.modules.html
index 27462af..25c8f14 100644
--- a/docs/dyn/appengine_v1beta4.apps.modules.html
+++ b/docs/dyn/appengine_v1beta4.apps.modules.html
@@ -217,7 +217,7 @@
"id": "A String", # Relative name of the module within the application. Example: default.@OutputOnly
}
- migrateTraffic: boolean, Set to true to gradually shift traffic from one version to another single version. By default, traffic is shifted immediately. For gradual traffic migration, the target version must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules#shardby) field in the Module resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
+ migrateTraffic: boolean, Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules#shardby) field in the Module resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
mask: string, Standard field mask for the set of fields to be updated.
x__xgafv: string, V1 error format.
diff --git a/docs/dyn/appengine_v1beta4.apps.modules.versions.html b/docs/dyn/appengine_v1beta4.apps.modules.versions.html
index 9675228..be1bd3a 100644
--- a/docs/dyn/appengine_v1beta4.apps.modules.versions.html
+++ b/docs/dyn/appengine_v1beta4.apps.modules.versions.html
@@ -217,8 +217,8 @@
"repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
},
],
- "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
- "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
+ "container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
},
"network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
@@ -454,8 +454,8 @@
"repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
},
],
- "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
- "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
+ "container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
},
"network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
@@ -636,8 +636,8 @@
"repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
},
],
- "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
- "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
+ "container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
},
"network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
@@ -827,8 +827,8 @@
"repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
},
],
- "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
- "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
+ "container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
},
"network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
diff --git a/docs/dyn/appengine_v1beta4.apps.modules.versions.instances.html b/docs/dyn/appengine_v1beta4.apps.modules.versions.instances.html
index 43ad34a..58e36e9 100644
--- a/docs/dyn/appengine_v1beta4.apps.modules.versions.instances.html
+++ b/docs/dyn/appengine_v1beta4.apps.modules.versions.instances.html
@@ -85,7 +85,7 @@
<p class="firstline">Gets instance information.</p>
<p class="toc_element">
<code><a href="#list">list(appsId, modulesId, versionsId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists the instances of a version.</p>
+<p class="firstline">Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).</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>
@@ -203,7 +203,7 @@
<div class="method">
<code class="details" id="list">list(appsId, modulesId, versionsId, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists the instances of a version.
+ <pre>Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
Args:
appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1. (required)
diff --git a/docs/dyn/appengine_v1beta5.apps.html b/docs/dyn/appengine_v1beta5.apps.html
index 85ea070..e0b3803 100644
--- a/docs/dyn/appengine_v1beta5.apps.html
+++ b/docs/dyn/appengine_v1beta5.apps.html
@@ -91,7 +91,7 @@
<p class="toc_element">
<code><a href="#create">create(body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates an App Engine application for a Google Cloud Platform project. This requires a project that excludes an App Engine application. For details about creating a project without an application, see the Google Cloud Resource Manager create project topic (https://cloud.google.com/resource-manager/docs/creating-project).</p>
+<p class="firstline">Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).</p>
<p class="toc_element">
<code><a href="#get">get(appsId, x__xgafv=None, ensureResourcesExist=None)</a></code></p>
<p class="firstline">Gets information about an application.</p>
@@ -101,7 +101,7 @@
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(body, x__xgafv=None)</code>
- <pre>Creates an App Engine application for a Google Cloud Platform project. This requires a project that excludes an App Engine application. For details about creating a project without an application, see the Google Cloud Resource Manager create project topic (https://cloud.google.com/resource-manager/docs/creating-project).
+ <pre>Creates an App Engine application for a Google Cloud Platform project. Required fields: id - The ID of the target Cloud Platform project. location - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).
Args:
body: object, The request body. (required)
@@ -120,6 +120,12 @@
},
],
"defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
+ "iap": { # Identity-Aware Proxy
+ "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
+ "enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
+ "oauth2ClientSecret": "A String", # For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
+ "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
+ },
"location": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
"authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
"id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
@@ -176,6 +182,12 @@
},
],
"defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
+ "iap": { # Identity-Aware Proxy
+ "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
+ "enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
+ "oauth2ClientSecret": "A String", # For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
+ "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
+ },
"location": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
"authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
"id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
@@ -204,6 +216,12 @@
},
],
"defaultCookieExpiration": "A String", # Cookie expiration policy for this application.
+ "iap": { # Identity-Aware Proxy
+ "oauth2ClientId": "A String", # OAuth2 client ID to use for the authentication flow.
+ "enabled": True or False, # Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
+ "oauth2ClientSecret": "A String", # For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
+ "oauth2ClientSecretSha256": "A String", # Hex-encoded SHA-256 hash of the client secret.@OutputOnly
+ },
"location": "A String", # Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US
"authDomain": "A String", # Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
"id": "A String", # Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.
diff --git a/docs/dyn/appengine_v1beta5.apps.locations.html b/docs/dyn/appengine_v1beta5.apps.locations.html
index 8692253..2ab9275 100644
--- a/docs/dyn/appengine_v1beta5.apps.locations.html
+++ b/docs/dyn/appengine_v1beta5.apps.locations.html
@@ -122,7 +122,7 @@
Returns:
An object of the form:
- { # The response message for LocationService.ListLocations.
+ { # The response message for Locations.ListLocations.
"nextPageToken": "A String", # The standard List next-page token.
"locations": [ # A list of locations that matches the specified filter in the request.
{ # A resource that represents Google Cloud Platform location.
diff --git a/docs/dyn/appengine_v1beta5.apps.services.html b/docs/dyn/appengine_v1beta5.apps.services.html
index 1f5111a..063d274 100644
--- a/docs/dyn/appengine_v1beta5.apps.services.html
+++ b/docs/dyn/appengine_v1beta5.apps.services.html
@@ -217,7 +217,7 @@
"id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly
}
- migrateTraffic: boolean, Set to true to gradually shift traffic from one version to another single version. By default, traffic is shifted immediately. For gradual traffic migration, the target version must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
+ migrateTraffic: boolean, Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).
mask: string, Standard field mask for the set of fields to be updated.
x__xgafv: string, V1 error format.
diff --git a/docs/dyn/appengine_v1beta5.apps.services.versions.html b/docs/dyn/appengine_v1beta5.apps.services.versions.html
index 8a3c947..f6942a7 100644
--- a/docs/dyn/appengine_v1beta5.apps.services.versions.html
+++ b/docs/dyn/appengine_v1beta5.apps.services.versions.html
@@ -222,8 +222,8 @@
"repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
},
],
- "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
- "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
+ "container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
},
"network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
@@ -455,8 +455,8 @@
"repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
},
],
- "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
- "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
+ "container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
},
"network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
@@ -633,8 +633,8 @@
"repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
},
],
- "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
- "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
+ "container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
},
"network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
@@ -820,8 +820,8 @@
"repository": "A String", # URI string identifying the repository. Example: "https://source.developers.google.com/p/app-123/r/default"
},
],
- "container": { # Docker image that is used to start a VM container for the version you deploy. # A Docker image that App Engine uses the run the version. Only applicable for instances in App Engine flexible environment.
- "image": "A String", # URI to the hosted container image in a Docker repository. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
+ "container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
+ "image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
},
"network": { # Extra network settings. Only applicable for VM runtimes. # Extra network settings. Only applicable for VM runtimes.
diff --git a/docs/dyn/appengine_v1beta5.apps.services.versions.instances.html b/docs/dyn/appengine_v1beta5.apps.services.versions.instances.html
index 0e2a897..4715503 100644
--- a/docs/dyn/appengine_v1beta5.apps.services.versions.instances.html
+++ b/docs/dyn/appengine_v1beta5.apps.services.versions.instances.html
@@ -85,7 +85,7 @@
<p class="firstline">Gets instance information.</p>
<p class="toc_element">
<code><a href="#list">list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p>
-<p class="firstline">Lists the instances of a version.</p>
+<p class="firstline">Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).</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>
@@ -203,7 +203,7 @@
<div class="method">
<code class="details" id="list">list(appsId, servicesId, versionsId, pageSize=None, x__xgafv=None, pageToken=None)</code>
- <pre>Lists the instances of a version.
+ <pre>Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
Args:
appsId: string, Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. (required)
diff --git a/docs/dyn/bigquery_v2.datasets.html b/docs/dyn/bigquery_v2.datasets.html
index a1bbe9b..4045384 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. See Labeling Datasets for more information.
+ "labels": { # 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.
@@ -145,7 +145,7 @@
],
"defaultTableExpirationMs": "A String", # [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
"etag": "A String", # [Output-only] A hash of the resource.
- "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
+ "location": "A String", # The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
"friendlyName": "A String", # [Optional] A descriptive name for the dataset.
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
"id": "A String", # [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
@@ -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. See Labeling Datasets for more information.
+ "labels": { # 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.
@@ -189,7 +189,7 @@
],
"defaultTableExpirationMs": "A String", # [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
"etag": "A String", # [Output-only] A hash of the resource.
- "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
+ "location": "A String", # The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
"friendlyName": "A String", # [Optional] A descriptive name for the dataset.
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
"id": "A String", # [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
@@ -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. See Labeling Datasets for more information.
+ "labels": { # 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.
@@ -227,7 +227,7 @@
],
"defaultTableExpirationMs": "A String", # [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
"etag": "A String", # [Output-only] A hash of the resource.
- "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
+ "location": "A String", # The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
"friendlyName": "A String", # [Optional] A descriptive name for the dataset.
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
"id": "A String", # [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
@@ -256,7 +256,7 @@
{
"friendlyName": "A String", # A descriptive name for the dataset, if one exists.
"kind": "bigquery#dataset", # The resource type. This property always returns the value "bigquery#dataset".
- "labels": { # [Experimental] The labels associated with this dataset. You can use these to organize and group your datasets.
+ "labels": { # The labels associated with this dataset. You can use these to organize and group your datasets.
"a_key": "A String",
},
"id": "A String", # The fully-qualified, unique, opaque ID of the dataset.
@@ -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. See Labeling Datasets for more information.
+ "labels": { # 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.
@@ -321,7 +321,7 @@
],
"defaultTableExpirationMs": "A String", # [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
"etag": "A String", # [Output-only] A hash of the resource.
- "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
+ "location": "A String", # The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
"friendlyName": "A String", # [Optional] A descriptive name for the dataset.
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
"id": "A String", # [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
@@ -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. See Labeling Datasets for more information.
+ "labels": { # 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.
@@ -359,7 +359,7 @@
],
"defaultTableExpirationMs": "A String", # [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
"etag": "A String", # [Output-only] A hash of the resource.
- "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
+ "location": "A String", # The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
"friendlyName": "A String", # [Optional] A descriptive name for the dataset.
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
"id": "A String", # [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
@@ -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. See Labeling Datasets for more information.
+ "labels": { # 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.
@@ -404,7 +404,7 @@
],
"defaultTableExpirationMs": "A String", # [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
"etag": "A String", # [Output-only] A hash of the resource.
- "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
+ "location": "A String", # The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
"friendlyName": "A String", # [Optional] A descriptive name for the dataset.
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
"id": "A String", # [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
@@ -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. See Labeling Datasets for more information.
+ "labels": { # 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.
@@ -442,7 +442,7 @@
],
"defaultTableExpirationMs": "A String", # [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
"etag": "A String", # [Output-only] A hash of the resource.
- "location": "A String", # [Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
+ "location": "A String", # The geographic location where the dataset should reside. Possible values include EU and US. The default value is US.
"friendlyName": "A String", # [Optional] A descriptive name for the dataset.
"lastModifiedTime": "A String", # [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
"id": "A String", # [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html
index 91d83ac..6a076d1 100644
--- a/docs/dyn/bigquery_v2.jobs.html
+++ b/docs/dyn/bigquery_v2.jobs.html
@@ -141,7 +141,7 @@
"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
"startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
"query": { # [Output-only] Statistics for a query job.
- "queryPlan": [ # [Output-only, Experimental] Describes execution plan for the query.
+ "queryPlan": [ # [Output-only] Describes execution plan for the query.
{
"status": "A String", # Current status for the stage.
"computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
@@ -195,7 +195,7 @@
"name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
},
],
- "numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
+ "numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
"billingTier": 42, # [Output-only] Billing tier for the job.
"referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
{
@@ -238,7 +238,7 @@
],
"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- "autodetect": True or False, # [Experimental] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
+ "autodetect": True or False, # Indicates if we should automatically infer the options and schema for CSV and JSON sources.
"sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". The default value is CSV.
"destinationTable": { # [Required] The destination table to load the data into.
"projectId": "A String", # [Required] The ID of the project containing this table.
@@ -258,7 +258,7 @@
"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- "projectionFields": [ # [Experimental] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
+ "projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
"A String",
],
"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
@@ -300,7 +300,7 @@
"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
"allowLargeResults": True or False, # If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.
- "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
+ "userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.
{
"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
@@ -346,7 +346,7 @@
"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
},
- "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
+ "autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
@@ -374,7 +374,7 @@
},
],
},
- "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
+ "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
},
@@ -393,7 +393,7 @@
},
},
},
- "parameterMode": "A String", # [Experimental] Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
+ "parameterMode": "A String", # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
},
"copy": { # [Pick one] Copies a table.
"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
@@ -480,7 +480,7 @@
"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
"startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
"query": { # [Output-only] Statistics for a query job.
- "queryPlan": [ # [Output-only, Experimental] Describes execution plan for the query.
+ "queryPlan": [ # [Output-only] Describes execution plan for the query.
{
"status": "A String", # Current status for the stage.
"computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
@@ -534,7 +534,7 @@
"name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
},
],
- "numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
+ "numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
"billingTier": 42, # [Output-only] Billing tier for the job.
"referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
{
@@ -577,7 +577,7 @@
],
"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- "autodetect": True or False, # [Experimental] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
+ "autodetect": True or False, # Indicates if we should automatically infer the options and schema for CSV and JSON sources.
"sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". The default value is CSV.
"destinationTable": { # [Required] The destination table to load the data into.
"projectId": "A String", # [Required] The ID of the project containing this table.
@@ -597,7 +597,7 @@
"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- "projectionFields": [ # [Experimental] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
+ "projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
"A String",
],
"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
@@ -639,7 +639,7 @@
"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
"allowLargeResults": True or False, # If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.
- "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
+ "userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.
{
"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
@@ -685,7 +685,7 @@
"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
},
- "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
+ "autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
@@ -713,7 +713,7 @@
},
],
},
- "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
+ "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
},
@@ -732,7 +732,7 @@
},
},
},
- "parameterMode": "A String", # [Experimental] Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
+ "parameterMode": "A String", # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
},
"copy": { # [Pick one] Copies a table.
"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
@@ -820,7 +820,7 @@
],
},
],
- "numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
+ "numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
"schema": { # The schema of the results. Present only when the query completes successfully.
"fields": [ # Describes the fields in a table.
{
@@ -890,7 +890,7 @@
"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
"startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
"query": { # [Output-only] Statistics for a query job.
- "queryPlan": [ # [Output-only, Experimental] Describes execution plan for the query.
+ "queryPlan": [ # [Output-only] Describes execution plan for the query.
{
"status": "A String", # Current status for the stage.
"computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
@@ -944,7 +944,7 @@
"name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
},
],
- "numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
+ "numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
"billingTier": 42, # [Output-only] Billing tier for the job.
"referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
{
@@ -987,7 +987,7 @@
],
"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- "autodetect": True or False, # [Experimental] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
+ "autodetect": True or False, # Indicates if we should automatically infer the options and schema for CSV and JSON sources.
"sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". The default value is CSV.
"destinationTable": { # [Required] The destination table to load the data into.
"projectId": "A String", # [Required] The ID of the project containing this table.
@@ -1007,7 +1007,7 @@
"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- "projectionFields": [ # [Experimental] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
+ "projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
"A String",
],
"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
@@ -1049,7 +1049,7 @@
"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
"allowLargeResults": True or False, # If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.
- "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
+ "userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.
{
"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
@@ -1095,7 +1095,7 @@
"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
},
- "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
+ "autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
@@ -1123,7 +1123,7 @@
},
],
},
- "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
+ "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
},
@@ -1142,7 +1142,7 @@
},
},
},
- "parameterMode": "A String", # [Experimental] Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
+ "parameterMode": "A String", # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
},
"copy": { # [Pick one] Copies a table.
"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
@@ -1221,7 +1221,7 @@
"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
"startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
"query": { # [Output-only] Statistics for a query job.
- "queryPlan": [ # [Output-only, Experimental] Describes execution plan for the query.
+ "queryPlan": [ # [Output-only] Describes execution plan for the query.
{
"status": "A String", # Current status for the stage.
"computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
@@ -1275,7 +1275,7 @@
"name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
},
],
- "numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
+ "numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
"billingTier": 42, # [Output-only] Billing tier for the job.
"referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
{
@@ -1318,7 +1318,7 @@
],
"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- "autodetect": True or False, # [Experimental] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
+ "autodetect": True or False, # Indicates if we should automatically infer the options and schema for CSV and JSON sources.
"sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". The default value is CSV.
"destinationTable": { # [Required] The destination table to load the data into.
"projectId": "A String", # [Required] The ID of the project containing this table.
@@ -1338,7 +1338,7 @@
"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- "projectionFields": [ # [Experimental] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
+ "projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
"A String",
],
"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
@@ -1380,7 +1380,7 @@
"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
"allowLargeResults": True or False, # If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.
- "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
+ "userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.
{
"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
@@ -1426,7 +1426,7 @@
"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
},
- "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
+ "autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
@@ -1454,7 +1454,7 @@
},
],
},
- "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
+ "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
},
@@ -1473,7 +1473,7 @@
},
},
},
- "parameterMode": "A String", # [Experimental] Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
+ "parameterMode": "A String", # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
},
"copy": { # [Pick one] Copies a table.
"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
@@ -1574,7 +1574,7 @@
"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
"startTime": "A String", # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
"query": { # [Output-only] Statistics for a query job.
- "queryPlan": [ # [Output-only, Experimental] Describes execution plan for the query.
+ "queryPlan": [ # [Output-only] Describes execution plan for the query.
{
"status": "A String", # Current status for the stage.
"computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
@@ -1628,7 +1628,7 @@
"name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
},
],
- "numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
+ "numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
"billingTier": 42, # [Output-only] Billing tier for the job.
"referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
{
@@ -1671,7 +1671,7 @@
],
"encoding": "A String", # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
"fieldDelimiter": "A String", # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- "autodetect": True or False, # [Experimental] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
+ "autodetect": True or False, # Indicates if we should automatically infer the options and schema for CSV and JSON sources.
"sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". The default value is CSV.
"destinationTable": { # [Required] The destination table to load the data into.
"projectId": "A String", # [Required] The ID of the project containing this table.
@@ -1691,7 +1691,7 @@
"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.
"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- "projectionFields": [ # [Experimental] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
+ "projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
"A String",
],
"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
@@ -1733,7 +1733,7 @@
"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
"allowLargeResults": True or False, # If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.
- "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
+ "userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.
{
"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
@@ -1779,7 +1779,7 @@
"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
},
- "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
+ "autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
@@ -1807,7 +1807,7 @@
},
],
},
- "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
+ "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
},
@@ -1826,7 +1826,7 @@
},
},
},
- "parameterMode": "A String", # [Experimental] Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
+ "parameterMode": "A String", # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
},
"copy": { # [Pick one] Copies a table.
"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
@@ -1904,7 +1904,7 @@
"timeoutMs": 42, # [Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds).
"kind": "bigquery#queryRequest", # The resource type of the request.
"dryRun": True or False, # [Optional] If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false.
- "parameterMode": "A String", # [Experimental] Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
+ "parameterMode": "A String", # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
"useQueryCache": true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.
"defaultDataset": { # [Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'.
"projectId": "A String", # [Optional] The ID of the project containing this dataset.
@@ -1912,7 +1912,7 @@
},
"useLegacySql": true, # Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the values of allowLargeResults and flattenResults are ignored; query will be run as if allowLargeResults is true and flattenResults is false.
"maxResults": 42, # [Optional] The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies.
- "queryParameters": [ # [Experimental] Query parameters for Standard SQL queries.
+ "queryParameters": [ # Query parameters for Standard SQL queries.
{
"parameterType": { # [Required] The type of this parameter.
"structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
@@ -1973,7 +1973,7 @@
],
},
],
- "numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
+ "numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
"schema": { # The schema of the results. Present only when the query completes successfully.
"fields": [ # Describes the fields in a table.
{
diff --git a/docs/dyn/bigquery_v2.tabledata.html b/docs/dyn/bigquery_v2.tabledata.html
index e3eabd9..edd2dee 100644
--- a/docs/dyn/bigquery_v2.tabledata.html
+++ b/docs/dyn/bigquery_v2.tabledata.html
@@ -78,7 +78,7 @@
<code><a href="#insertAll">insertAll(projectId, datasetId, tableId, body)</a></code></p>
<p class="firstline">Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.</p>
<p class="toc_element">
- <code><a href="#list">list(projectId, datasetId, tableId, pageToken=None, maxResults=None, startIndex=None)</a></code></p>
+ <code><a href="#list">list(projectId, datasetId, tableId, selectedFields=None, pageToken=None, maxResults=None, startIndex=None)</a></code></p>
<p class="firstline">Retrieves table data from a specified set of rows. Requires the READER dataset role.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -133,13 +133,14 @@
</div>
<div class="method">
- <code class="details" id="list">list(projectId, datasetId, tableId, pageToken=None, maxResults=None, startIndex=None)</code>
+ <code class="details" id="list">list(projectId, datasetId, tableId, selectedFields=None, pageToken=None, maxResults=None, startIndex=None)</code>
<pre>Retrieves table data from a specified set of rows. Requires the READER dataset role.
Args:
projectId: string, Project ID of the table to read (required)
datasetId: string, Dataset ID of the table to read (required)
tableId: string, Table ID of the table to read (required)
+ selectedFields: string, List of fields to return (comma-separated). If unspecified, all fields are returned
pageToken: string, Page token, returned by a previous call, identifying the result set
maxResults: integer, Maximum number of results to return
startIndex: string, Zero-based index of the starting row to read
diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html
index b62bd8f..8c7b8e1 100644
--- a/docs/dyn/bigquery_v2.tables.html
+++ b/docs/dyn/bigquery_v2.tables.html
@@ -78,7 +78,7 @@
<code><a href="#delete">delete(projectId, datasetId, tableId)</a></code></p>
<p class="firstline">Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.</p>
<p class="toc_element">
- <code><a href="#get">get(projectId, datasetId, tableId)</a></code></p>
+ <code><a href="#get">get(projectId, datasetId, tableId, selectedFields=None)</a></code></p>
<p class="firstline">Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.</p>
<p class="toc_element">
<code><a href="#insert">insert(projectId, datasetId, body)</a></code></p>
@@ -108,13 +108,14 @@
</div>
<div class="method">
- <code class="details" id="get">get(projectId, datasetId, tableId)</code>
+ <code class="details" id="get">get(projectId, datasetId, tableId, selectedFields=None)</code>
<pre>Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.
Args:
projectId: string, Project ID of the requested table (required)
datasetId: string, Dataset ID of the requested table (required)
tableId: string, Table ID of the requested table (required)
+ selectedFields: string, List of fields to return (comma-separated). If unspecified, all fields are returned
Returns:
An object of the form:
@@ -137,7 +138,7 @@
"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
},
- "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
+ "autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
@@ -165,7 +166,7 @@
},
],
},
- "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
+ "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
},
@@ -194,7 +195,7 @@
"view": { # [Optional] The view definition.
"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
- "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
+ "userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.
{
"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
@@ -261,7 +262,7 @@
"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
},
- "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
+ "autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
@@ -289,7 +290,7 @@
},
],
},
- "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
+ "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
},
@@ -318,7 +319,7 @@
"view": { # [Optional] The view definition.
"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
- "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
+ "userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.
{
"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
@@ -378,7 +379,7 @@
"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
},
- "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
+ "autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
@@ -406,7 +407,7 @@
},
],
},
- "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
+ "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
},
@@ -435,7 +436,7 @@
"view": { # [Optional] The view definition.
"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
- "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
+ "userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.
{
"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
@@ -557,7 +558,7 @@
"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
},
- "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
+ "autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
@@ -585,7 +586,7 @@
},
],
},
- "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
+ "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
},
@@ -614,7 +615,7 @@
"view": { # [Optional] The view definition.
"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
- "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
+ "userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.
{
"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
@@ -674,7 +675,7 @@
"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
},
- "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
+ "autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
@@ -702,7 +703,7 @@
},
],
},
- "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
+ "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
},
@@ -731,7 +732,7 @@
"view": { # [Optional] The view definition.
"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
- "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
+ "userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.
{
"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
@@ -799,7 +800,7 @@
"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
},
- "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
+ "autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
@@ -827,7 +828,7 @@
},
],
},
- "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
+ "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
},
@@ -856,7 +857,7 @@
"view": { # [Optional] The view definition.
"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
- "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
+ "userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.
{
"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
@@ -916,7 +917,7 @@
"quote": """, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
"allowQuotedNewlines": True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
},
- "autodetect": True or False, # [Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored.
+ "autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
"ignoreUnknownValues": True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.
@@ -944,7 +945,7 @@
},
],
},
- "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Experimental] For Google Cloud Bigtable, specify "BIGTABLE". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project.
+ "sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
"skipLeadingRows": "A String", # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
},
@@ -973,7 +974,7 @@
"view": { # [Optional] The view definition.
"query": "A String", # [Required] A query that BigQuery executes when the view is referenced.
"useLegacySql": True or False, # Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
- "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
+ "userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.
{
"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
"inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
diff --git a/docs/dyn/classroom_v1.courses.aliases.html b/docs/dyn/classroom_v1.courses.aliases.html
index a701879..f8cf10b 100644
--- a/docs/dyn/classroom_v1.courses.aliases.html
+++ b/docs/dyn/classroom_v1.courses.aliases.html
@@ -75,75 +75,197 @@
<h1><a href="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.courses.html">courses</a> . <a href="classroom_v1.courses.aliases.html">aliases</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(courseId, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists.</p>
+ <code><a href="#create">create(courseId=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates an alias for a course.</p>
<p class="toc_element">
- <code><a href="#delete">delete(courseId, alias, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist.</p>
+ <code><a href="#delete">delete(courseId=None, alias=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes an alias of a course.</p>
<p class="toc_element">
- <code><a href="#list">list(courseId, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p>
-<p class="firstline">Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.</p>
+ <code><a href="#list">list(courseId=None, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p>
+<p class="firstline">Returns a list of aliases for a course.</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(courseId, body, x__xgafv=None)</code>
- <pre>Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists.
+ <code class="details" id="create">create(courseId=None, body, x__xgafv=None)</code>
+ <pre>Creates an alias for a course.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to create the
+alias or for access errors.
+* `NOT_FOUND` if the course does not exist.
+* `ALREADY_EXISTS` if the alias already exists.
+* `FAILED_PRECONDITION` if the alias requested does not make sense for the
+ requesting user or course (for example, if a user not in a domain
+ attempts to access a domain-scoped alias).
Args:
- courseId: string, Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ courseId: string, Identifier of the course to alias.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.
- "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.
+{ # Alternative identifier for a course.
+ #
+ # An alias uniquely identifies a course. It must be unique within one of the
+ # following scopes:
+ #
+ # * domain: A domain-scoped alias is visible to all users within the alias
+ # creator's domain and can be created only by a domain admin. A domain-scoped
+ # alias is often used when a course has an identifier external to Classroom.
+ #
+ # * project: A project-scoped alias is visible to any request from an
+ # application using the Developer Console project ID that created the alias
+ # and can be created by any project. A project-scoped alias is often used when
+ # an application has alternative identifiers. A random value can also be used
+ # to avoid duplicate courses in the event of transmission failures, as retrying
+ # a request will return `ALREADY_EXISTS` if a previous one has succeeded.
+ "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping.
+ #
+ # * `d:<name>` indicates a domain-scoped alias.
+ # Example: `d:math_101`
+ # * `p:<name>` indicates a project-scoped alias.
+ # Example: `p:abc123`
+ #
+ # This field has a maximum length of 256 characters.
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.
- "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.
+ { # Alternative identifier for a course.
+ #
+ # An alias uniquely identifies a course. It must be unique within one of the
+ # following scopes:
+ #
+ # * domain: A domain-scoped alias is visible to all users within the alias
+ # creator's domain and can be created only by a domain admin. A domain-scoped
+ # alias is often used when a course has an identifier external to Classroom.
+ #
+ # * project: A project-scoped alias is visible to any request from an
+ # application using the Developer Console project ID that created the alias
+ # and can be created by any project. A project-scoped alias is often used when
+ # an application has alternative identifiers. A random value can also be used
+ # to avoid duplicate courses in the event of transmission failures, as retrying
+ # a request will return `ALREADY_EXISTS` if a previous one has succeeded.
+ "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping.
+ #
+ # * `d:<name>` indicates a domain-scoped alias.
+ # Example: `d:math_101`
+ # * `p:<name>` indicates a project-scoped alias.
+ # Example: `p:abc123`
+ #
+ # This field has a maximum length of 256 characters.
}</pre>
</div>
<div class="method">
- <code class="details" id="delete">delete(courseId, alias, x__xgafv=None)</code>
- <pre>Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist.
+ <code class="details" id="delete">delete(courseId=None, alias=None, x__xgafv=None)</code>
+ <pre>Deletes an alias of a course.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to remove the
+alias or for access errors.
+* `NOT_FOUND` if the alias does not exist.
+* `FAILED_PRECONDITION` if the alias requested does not make sense for the
+ requesting user or course (for example, if a user not in a domain
+ attempts to delete a domain-scoped alias).
Args:
- courseId: string, Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias. (required)
- alias: string, Alias to delete. This may not be the Classroom-assigned identifier. (required)
+ courseId: string, Identifier of the course whose alias should be deleted.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
+ alias: string, Alias to delete.
+This may not be the Classroom-assigned identifier. (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="list">list(courseId, pageSize=None, x__xgafv=None, pageToken=None)</code>
- <pre>Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.
+ <code class="details" id="list">list(courseId=None, pageSize=None, x__xgafv=None, pageToken=None)</code>
+ <pre>Returns a list of aliases for a course.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to access the
+course or for access errors.
+* `NOT_FOUND` if the course does not exist.
Args:
- courseId: string, The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
- 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.
+ courseId: string, The identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
+ 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.
x__xgafv: string, V1 error format.
- 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.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ 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.
Returns:
An object of the form:
{ # Response when listing course aliases.
- "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
+ "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
+ # results are available.
"aliases": [ # The course aliases.
- { # Alternative identifier for a course. An alias uniquely identifies a course. It must be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return `ALREADY_EXISTS` if a previous one has succeeded.
- "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.
+ { # Alternative identifier for a course.
+ #
+ # An alias uniquely identifies a course. It must be unique within one of the
+ # following scopes:
+ #
+ # * domain: A domain-scoped alias is visible to all users within the alias
+ # creator's domain and can be created only by a domain admin. A domain-scoped
+ # alias is often used when a course has an identifier external to Classroom.
+ #
+ # * project: A project-scoped alias is visible to any request from an
+ # application using the Developer Console project ID that created the alias
+ # and can be created by any project. A project-scoped alias is often used when
+ # an application has alternative identifiers. A random value can also be used
+ # to avoid duplicate courses in the event of transmission failures, as retrying
+ # a request will return `ALREADY_EXISTS` if a previous one has succeeded.
+ "alias": "A String", # Alias string. The format of the string indicates the desired alias scoping.
+ #
+ # * `d:<name>` indicates a domain-scoped alias.
+ # Example: `d:math_101`
+ # * `p:<name>` indicates a project-scoped alias.
+ # Example: `p:abc123`
+ #
+ # This field has a maximum length of 256 characters.
},
],
}</pre>
diff --git a/docs/dyn/classroom_v1.courses.courseWork.html b/docs/dyn/classroom_v1.courses.courseWork.html
index 17a041b..b5925db 100644
--- a/docs/dyn/classroom_v1.courses.courseWork.html
+++ b/docs/dyn/classroom_v1.courses.courseWork.html
@@ -80,356 +80,788 @@
<p class="firstline">Returns the studentSubmissions Resource.</p>
<p class="toc_element">
- <code><a href="#create">create(courseId, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible</p>
+ <code><a href="#create">create(courseId=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates course work.</p>
<p class="toc_element">
- <code><a href="#delete">delete(courseId, id, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.</p>
+ <code><a href="#delete">delete(courseId=None, id=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a course work.</p>
<p class="toc_element">
- <code><a href="#get">get(courseId, id, x__xgafv=None)</a></code></p>
-<p class="firstline">Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.</p>
+ <code><a href="#get">get(courseId=None, id, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns course work.</p>
<p class="toc_element">
- <code><a href="#list">list(courseId, orderBy=None, courseWorkStates=None, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p>
-<p class="firstline">Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. 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. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.</p>
+ <code><a href="#list">list(courseId=None, orderBy=None, courseWorkStates=None, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p>
+<p class="firstline">Returns a list of course work that the requester is permitted to view.</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(courseId, id, body, updateMask=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p>
+ <code><a href="#patch">patch(courseId=None, id, body, updateMask=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates one or more fields of a course work.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(courseId, body, x__xgafv=None)</code>
- <pre>Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible
+ <code class="details" id="create">create(courseId=None, body, x__xgafv=None)</code>
+ <pre>Creates course work.
+
+The resulting course work (and corresponding student submissions) are
+associated with the Developer Console project of the
+[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
+make the request. Classroom API requests to modify course work and student
+submissions must be made with an OAuth client ID from the associated
+Developer Console project.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to access the
+requested course, create course work in the requested course, share a
+Drive attachment, or for access errors.
+* `INVALID_ARGUMENT` if the request is malformed.
+* `NOT_FOUND` if the requested course does not exist.
+* `FAILED_PRECONDITION` for the following request error:
+ * AttachmentNotVisible
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Course work created by a teacher for students of the course.
- "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only.
- "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
- "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.
- "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
- "courseId": "A String", # Identifier of the course. Read-only.
- "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only.
- "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "updateTime": "A String", # Timestamp of the most recent change to this course work.
+ #
+ # Read-only.
+ "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions.
+ # If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
+ "description": "A String", # Optional description of this course work.
+ # If set, the description must be a valid UTF-8 string containing no more
+ # than 30,000 characters.
+ "title": "A String", # Title of this course work.
+ # The title must be a valid UTF-8 string containing between 1 and 3000
+ # characters.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
+ "assignment": { # Additional details for assignments. # Assignment details.
+ # This is populated only when `work_type` is `ASSIGNMENT`.
+ #
+ # Read-only.
+ "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed.
+ # This is only populated for course teachers.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
},
},
- "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
- "creationTime": "A String", # Timestamp when this course work was created. Read-only.
- "dueDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional date, in UTC, that submissions for this this course work are due. This must be specified if `due_time` is specified.
- "month": 42, # Month of year. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
- },
- "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`.
- "materials": [ # Additional materials. CourseWork must have no more than 20 material items.
- { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
- "link": { # URL item. # Link material. On creation, will be upgraded to a more appropriate type if possible, and this will be reflected in the response.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI.
+ # This is only populated if `state` is `PUBLISHED`.
+ #
+ # Read-only.
+ "creationTime": "A String", # Timestamp when this course work was created.
+ #
+ # Read-only.
+ "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console
+ # project making the request.
+ #
+ # See google.classroom.Work.CreateCourseWork for more
+ # details.
+ #
+ # Read-only.
+ "state": "A String", # Status of this course work.
+ # If unspecified, the default state is `DRAFT`.
+ "materials": [ # Additional materials.
+ #
+ # CourseWork must have no more than 20 material items.
+ { # Material attached to course work.
+ #
+ # When creating attachments, setting the `form` field is not supported.
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
"driveFile": { # Representation of a Google Drive file. # Drive file details.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"shareMode": "A String", # Mechanism by which students access the Drive item.
},
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "link": { # URL item. # Link material. On creation, will be upgraded to a more appropriate type
+ # if possible, and this will be reflected in the response.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms material.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
- "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise.
+ "dueDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and # Optional date, in UTC, that submissions for this this course work are due.
+ # This must be specified if `due_time` is specified.
+ # time zone are either specified elsewhere or are not significant. The date
+ # is relative to the Proleptic Gregorian Calendar. The day may be 0 to
+ # represent a year and month where the day is not significant, e.g. credit card
+ # expiration date. The year may be 0 to represent a month and day independent
+ # of year, e.g. anniversary date. Related types are google.type.TimeOfDay
+ # and `google.protobuf.Timestamp`.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year/month where the day is not significant.
+ "month": 42, # Month of year. Must be from 1 to 12.
+ },
+ "maxPoints": 3.14, # Maximum grade for this course work.
+ # If zero or unspecified, this assignment is considered ungraded.
+ # This must be a non-negative integer value.
+ "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details.
+ # For read operations, this field is populated only when `work_type` is
+ # `MULTIPLE_CHOICE_QUESTION`.
+ # For write operations, this field must be specified when creating course
+ # work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be
+ # set otherwise.
"choices": [ # Possible choices.
"A String",
],
},
- "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.
- "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
- "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only.
- "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this this course work are due. This must be specified if `due_date` is specified.
- "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "id": "A String", # Classroom-assigned identifier of this course work, unique per course.
+ #
+ # Read-only.
+ "dueTime": { # Represents a time of day. The date and time zone are either not significant # Optional time of day, in UTC, that submissions for this this course work
+ # are due.
+ # This must be specified if `due_date` is specified.
+ # or are specified elsewhere. An API may choose to allow leap seconds. Related
+ # types are google.type.Date and `google.protobuf.Timestamp`.
"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
+ # to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
+ # allow the value 60 if it allows leap-seconds.
},
- "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed.
+ "workType": "A String", # Type of this course work.
+ #
+ # The type is set when the course work is created and cannot be changed.
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Course work created by a teacher for students of the course.
- "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only.
- "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
- "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.
- "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
- "courseId": "A String", # Identifier of the course. Read-only.
- "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only.
- "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "updateTime": "A String", # Timestamp of the most recent change to this course work.
+ #
+ # Read-only.
+ "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions.
+ # If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
+ "description": "A String", # Optional description of this course work.
+ # If set, the description must be a valid UTF-8 string containing no more
+ # than 30,000 characters.
+ "title": "A String", # Title of this course work.
+ # The title must be a valid UTF-8 string containing between 1 and 3000
+ # characters.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
+ "assignment": { # Additional details for assignments. # Assignment details.
+ # This is populated only when `work_type` is `ASSIGNMENT`.
+ #
+ # Read-only.
+ "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed.
+ # This is only populated for course teachers.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
},
},
- "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
- "creationTime": "A String", # Timestamp when this course work was created. Read-only.
- "dueDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional date, in UTC, that submissions for this this course work are due. This must be specified if `due_time` is specified.
- "month": 42, # Month of year. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
- },
- "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`.
- "materials": [ # Additional materials. CourseWork must have no more than 20 material items.
- { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
- "link": { # URL item. # Link material. On creation, will be upgraded to a more appropriate type if possible, and this will be reflected in the response.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI.
+ # This is only populated if `state` is `PUBLISHED`.
+ #
+ # Read-only.
+ "creationTime": "A String", # Timestamp when this course work was created.
+ #
+ # Read-only.
+ "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console
+ # project making the request.
+ #
+ # See google.classroom.Work.CreateCourseWork for more
+ # details.
+ #
+ # Read-only.
+ "state": "A String", # Status of this course work.
+ # If unspecified, the default state is `DRAFT`.
+ "materials": [ # Additional materials.
+ #
+ # CourseWork must have no more than 20 material items.
+ { # Material attached to course work.
+ #
+ # When creating attachments, setting the `form` field is not supported.
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
"driveFile": { # Representation of a Google Drive file. # Drive file details.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"shareMode": "A String", # Mechanism by which students access the Drive item.
},
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "link": { # URL item. # Link material. On creation, will be upgraded to a more appropriate type
+ # if possible, and this will be reflected in the response.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms material.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
- "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise.
+ "dueDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and # Optional date, in UTC, that submissions for this this course work are due.
+ # This must be specified if `due_time` is specified.
+ # time zone are either specified elsewhere or are not significant. The date
+ # is relative to the Proleptic Gregorian Calendar. The day may be 0 to
+ # represent a year and month where the day is not significant, e.g. credit card
+ # expiration date. The year may be 0 to represent a month and day independent
+ # of year, e.g. anniversary date. Related types are google.type.TimeOfDay
+ # and `google.protobuf.Timestamp`.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year/month where the day is not significant.
+ "month": 42, # Month of year. Must be from 1 to 12.
+ },
+ "maxPoints": 3.14, # Maximum grade for this course work.
+ # If zero or unspecified, this assignment is considered ungraded.
+ # This must be a non-negative integer value.
+ "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details.
+ # For read operations, this field is populated only when `work_type` is
+ # `MULTIPLE_CHOICE_QUESTION`.
+ # For write operations, this field must be specified when creating course
+ # work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be
+ # set otherwise.
"choices": [ # Possible choices.
"A String",
],
},
- "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.
- "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
- "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only.
- "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this this course work are due. This must be specified if `due_date` is specified.
- "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "id": "A String", # Classroom-assigned identifier of this course work, unique per course.
+ #
+ # Read-only.
+ "dueTime": { # Represents a time of day. The date and time zone are either not significant # Optional time of day, in UTC, that submissions for this this course work
+ # are due.
+ # This must be specified if `due_date` is specified.
+ # or are specified elsewhere. An API may choose to allow leap seconds. Related
+ # types are google.type.Date and `google.protobuf.Timestamp`.
"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
+ # to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
+ # allow the value 60 if it allows leap-seconds.
},
- "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed.
+ "workType": "A String", # Type of this course work.
+ #
+ # The type is set when the course work is created and cannot be changed.
}</pre>
</div>
<div class="method">
- <code class="details" id="delete">delete(courseId, id, x__xgafv=None)</code>
- <pre>Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.
+ <code class="details" id="delete">delete(courseId=None, id=None, x__xgafv=None)</code>
+ <pre>Deletes a course work.
+
+This request must be made by the Developer Console project of the
+[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
+create the corresponding course work item.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting developer project did not create
+the corresponding course work, if the requesting user is not permitted
+to delete the requested course or for access errors.
+* `FAILED_PRECONDITION` if the requested course work has already been
+deleted.
+* `NOT_FOUND` if no course exists with the requested ID.
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
- id: string, Identifier of the course work to delete. This identifier is a Classroom-assigned identifier. (required)
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
+ id: string, Identifier of the course work to delete.
+This identifier is a Classroom-assigned identifier. (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(courseId, id, x__xgafv=None)</code>
- <pre>Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.
+ <code class="details" id="get">get(courseId=None, id, x__xgafv=None)</code>
+ <pre>Returns course work.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to access the
+requested course or course work, or for access errors.
+* `INVALID_ARGUMENT` if the request is malformed.
+* `NOT_FOUND` if the requested course or course work does not exist.
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
id: string, Identifier of the course work. (required)
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Course work created by a teacher for students of the course.
- "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only.
- "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
- "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.
- "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
- "courseId": "A String", # Identifier of the course. Read-only.
- "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only.
- "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "updateTime": "A String", # Timestamp of the most recent change to this course work.
+ #
+ # Read-only.
+ "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions.
+ # If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
+ "description": "A String", # Optional description of this course work.
+ # If set, the description must be a valid UTF-8 string containing no more
+ # than 30,000 characters.
+ "title": "A String", # Title of this course work.
+ # The title must be a valid UTF-8 string containing between 1 and 3000
+ # characters.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
+ "assignment": { # Additional details for assignments. # Assignment details.
+ # This is populated only when `work_type` is `ASSIGNMENT`.
+ #
+ # Read-only.
+ "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed.
+ # This is only populated for course teachers.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
},
},
- "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
- "creationTime": "A String", # Timestamp when this course work was created. Read-only.
- "dueDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional date, in UTC, that submissions for this this course work are due. This must be specified if `due_time` is specified.
- "month": 42, # Month of year. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
- },
- "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`.
- "materials": [ # Additional materials. CourseWork must have no more than 20 material items.
- { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
- "link": { # URL item. # Link material. On creation, will be upgraded to a more appropriate type if possible, and this will be reflected in the response.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI.
+ # This is only populated if `state` is `PUBLISHED`.
+ #
+ # Read-only.
+ "creationTime": "A String", # Timestamp when this course work was created.
+ #
+ # Read-only.
+ "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console
+ # project making the request.
+ #
+ # See google.classroom.Work.CreateCourseWork for more
+ # details.
+ #
+ # Read-only.
+ "state": "A String", # Status of this course work.
+ # If unspecified, the default state is `DRAFT`.
+ "materials": [ # Additional materials.
+ #
+ # CourseWork must have no more than 20 material items.
+ { # Material attached to course work.
+ #
+ # When creating attachments, setting the `form` field is not supported.
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
"driveFile": { # Representation of a Google Drive file. # Drive file details.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"shareMode": "A String", # Mechanism by which students access the Drive item.
},
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "link": { # URL item. # Link material. On creation, will be upgraded to a more appropriate type
+ # if possible, and this will be reflected in the response.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms material.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
- "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise.
+ "dueDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and # Optional date, in UTC, that submissions for this this course work are due.
+ # This must be specified if `due_time` is specified.
+ # time zone are either specified elsewhere or are not significant. The date
+ # is relative to the Proleptic Gregorian Calendar. The day may be 0 to
+ # represent a year and month where the day is not significant, e.g. credit card
+ # expiration date. The year may be 0 to represent a month and day independent
+ # of year, e.g. anniversary date. Related types are google.type.TimeOfDay
+ # and `google.protobuf.Timestamp`.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year/month where the day is not significant.
+ "month": 42, # Month of year. Must be from 1 to 12.
+ },
+ "maxPoints": 3.14, # Maximum grade for this course work.
+ # If zero or unspecified, this assignment is considered ungraded.
+ # This must be a non-negative integer value.
+ "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details.
+ # For read operations, this field is populated only when `work_type` is
+ # `MULTIPLE_CHOICE_QUESTION`.
+ # For write operations, this field must be specified when creating course
+ # work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be
+ # set otherwise.
"choices": [ # Possible choices.
"A String",
],
},
- "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.
- "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
- "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only.
- "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this this course work are due. This must be specified if `due_date` is specified.
- "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "id": "A String", # Classroom-assigned identifier of this course work, unique per course.
+ #
+ # Read-only.
+ "dueTime": { # Represents a time of day. The date and time zone are either not significant # Optional time of day, in UTC, that submissions for this this course work
+ # are due.
+ # This must be specified if `due_date` is specified.
+ # or are specified elsewhere. An API may choose to allow leap seconds. Related
+ # types are google.type.Date and `google.protobuf.Timestamp`.
"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
+ # to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
+ # allow the value 60 if it allows leap-seconds.
},
- "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed.
+ "workType": "A String", # Type of this course work.
+ #
+ # The type is set when the course work is created and cannot be changed.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(courseId, orderBy=None, courseWorkStates=None, pageSize=None, x__xgafv=None, pageToken=None)</code>
- <pre>Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. 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. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
+ <code class="details" id="list">list(courseId=None, orderBy=None, courseWorkStates=None, pageSize=None, x__xgafv=None, pageToken=None)</code>
+ <pre>Returns a list of course work that the requester is permitted to view.
+
+Course students may only view `PUBLISHED` course work. Course teachers
+and domain administrators may view all course work.
+
+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.
+* `INVALID_ARGUMENT` if the request is malformed.
+* `NOT_FOUND` if the requested course does not exist.
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
- orderBy: string, Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`
- courseWorkStates: string, Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned. (repeated)
- 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.
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
+ orderBy: string, Optional sort ordering for results. A comma-separated list of fields with
+an optional sort direction keyword. Supported fields are `updateTime`
+and `dueDate`. Supported direction keywords are `asc` and `desc`.
+If not specified, `updateTime desc` is the default behavior.
+Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`
+ courseWorkStates: string, Restriction on the work status to return. Only courseWork that matches
+is returned. If unspecified, items with a work status of `PUBLISHED`
+is returned. (repeated)
+ 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.
x__xgafv: string, V1 error format.
- 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.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ 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.
Returns:
An object of the form:
{ # Response when listing course work.
- "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
+ "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
+ # results are available.
"courseWork": [ # Course work items that match the request.
{ # Course work created by a teacher for students of the course.
- "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only.
- "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
- "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.
- "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
- "courseId": "A String", # Identifier of the course. Read-only.
- "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only.
- "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "updateTime": "A String", # Timestamp of the most recent change to this course work.
+ #
+ # Read-only.
+ "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions.
+ # If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
+ "description": "A String", # Optional description of this course work.
+ # If set, the description must be a valid UTF-8 string containing no more
+ # than 30,000 characters.
+ "title": "A String", # Title of this course work.
+ # The title must be a valid UTF-8 string containing between 1 and 3000
+ # characters.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
+ "assignment": { # Additional details for assignments. # Assignment details.
+ # This is populated only when `work_type` is `ASSIGNMENT`.
+ #
+ # Read-only.
+ "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed.
+ # This is only populated for course teachers.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
},
},
- "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
- "creationTime": "A String", # Timestamp when this course work was created. Read-only.
- "dueDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional date, in UTC, that submissions for this this course work are due. This must be specified if `due_time` is specified.
- "month": 42, # Month of year. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
- },
- "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`.
- "materials": [ # Additional materials. CourseWork must have no more than 20 material items.
- { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
- "link": { # URL item. # Link material. On creation, will be upgraded to a more appropriate type if possible, and this will be reflected in the response.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI.
+ # This is only populated if `state` is `PUBLISHED`.
+ #
+ # Read-only.
+ "creationTime": "A String", # Timestamp when this course work was created.
+ #
+ # Read-only.
+ "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console
+ # project making the request.
+ #
+ # See google.classroom.Work.CreateCourseWork for more
+ # details.
+ #
+ # Read-only.
+ "state": "A String", # Status of this course work.
+ # If unspecified, the default state is `DRAFT`.
+ "materials": [ # Additional materials.
+ #
+ # CourseWork must have no more than 20 material items.
+ { # Material attached to course work.
+ #
+ # When creating attachments, setting the `form` field is not supported.
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
"driveFile": { # Representation of a Google Drive file. # Drive file details.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"shareMode": "A String", # Mechanism by which students access the Drive item.
},
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "link": { # URL item. # Link material. On creation, will be upgraded to a more appropriate type
+ # if possible, and this will be reflected in the response.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms material.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
- "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise.
+ "dueDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and # Optional date, in UTC, that submissions for this this course work are due.
+ # This must be specified if `due_time` is specified.
+ # time zone are either specified elsewhere or are not significant. The date
+ # is relative to the Proleptic Gregorian Calendar. The day may be 0 to
+ # represent a year and month where the day is not significant, e.g. credit card
+ # expiration date. The year may be 0 to represent a month and day independent
+ # of year, e.g. anniversary date. Related types are google.type.TimeOfDay
+ # and `google.protobuf.Timestamp`.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year/month where the day is not significant.
+ "month": 42, # Month of year. Must be from 1 to 12.
+ },
+ "maxPoints": 3.14, # Maximum grade for this course work.
+ # If zero or unspecified, this assignment is considered ungraded.
+ # This must be a non-negative integer value.
+ "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details.
+ # For read operations, this field is populated only when `work_type` is
+ # `MULTIPLE_CHOICE_QUESTION`.
+ # For write operations, this field must be specified when creating course
+ # work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be
+ # set otherwise.
"choices": [ # Possible choices.
"A String",
],
},
- "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.
- "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
- "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only.
- "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this this course work are due. This must be specified if `due_date` is specified.
- "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "id": "A String", # Classroom-assigned identifier of this course work, unique per course.
+ #
+ # Read-only.
+ "dueTime": { # Represents a time of day. The date and time zone are either not significant # Optional time of day, in UTC, that submissions for this this course work
+ # are due.
+ # This must be specified if `due_date` is specified.
+ # or are specified elsewhere. An API may choose to allow leap seconds. Related
+ # types are google.type.Date and `google.protobuf.Timestamp`.
"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
+ # to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
+ # allow the value 60 if it allows leap-seconds.
},
- "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed.
+ "workType": "A String", # Type of this course work.
+ #
+ # The type is set when the course work is created and cannot be changed.
},
],
}</pre>
@@ -450,155 +882,364 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(courseId, id, body, updateMask=None, x__xgafv=None)</code>
- <pre>Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
+ <code class="details" id="patch">patch(courseId=None, id, body, updateMask=None, x__xgafv=None)</code>
+ <pre>Updates one or more fields of a course work.
+
+See google.classroom.v1.CourseWork for details
+of which fields may be updated and who may change them.
+
+This request must be made by the Developer Console project of the
+[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
+create the corresponding course work item.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting developer project did not create
+the corresponding course work, if the user is not permitted to make the
+requested modification to the student submission, or for
+access errors.
+* `INVALID_ARGUMENT` if the request is malformed.
+* `FAILED_PRECONDITION` if the requested course work has already been
+deleted.
+* `NOT_FOUND` if the requested course, course work, or student submission
+does not exist.
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
id: string, Identifier of the course work. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Course work created by a teacher for students of the course.
- "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only.
- "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
- "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.
- "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
- "courseId": "A String", # Identifier of the course. Read-only.
- "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only.
- "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "updateTime": "A String", # Timestamp of the most recent change to this course work.
+ #
+ # Read-only.
+ "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions.
+ # If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
+ "description": "A String", # Optional description of this course work.
+ # If set, the description must be a valid UTF-8 string containing no more
+ # than 30,000 characters.
+ "title": "A String", # Title of this course work.
+ # The title must be a valid UTF-8 string containing between 1 and 3000
+ # characters.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
+ "assignment": { # Additional details for assignments. # Assignment details.
+ # This is populated only when `work_type` is `ASSIGNMENT`.
+ #
+ # Read-only.
+ "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed.
+ # This is only populated for course teachers.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
},
},
- "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
- "creationTime": "A String", # Timestamp when this course work was created. Read-only.
- "dueDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional date, in UTC, that submissions for this this course work are due. This must be specified if `due_time` is specified.
- "month": 42, # Month of year. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
- },
- "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`.
- "materials": [ # Additional materials. CourseWork must have no more than 20 material items.
- { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
- "link": { # URL item. # Link material. On creation, will be upgraded to a more appropriate type if possible, and this will be reflected in the response.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI.
+ # This is only populated if `state` is `PUBLISHED`.
+ #
+ # Read-only.
+ "creationTime": "A String", # Timestamp when this course work was created.
+ #
+ # Read-only.
+ "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console
+ # project making the request.
+ #
+ # See google.classroom.Work.CreateCourseWork for more
+ # details.
+ #
+ # Read-only.
+ "state": "A String", # Status of this course work.
+ # If unspecified, the default state is `DRAFT`.
+ "materials": [ # Additional materials.
+ #
+ # CourseWork must have no more than 20 material items.
+ { # Material attached to course work.
+ #
+ # When creating attachments, setting the `form` field is not supported.
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
"driveFile": { # Representation of a Google Drive file. # Drive file details.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"shareMode": "A String", # Mechanism by which students access the Drive item.
},
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "link": { # URL item. # Link material. On creation, will be upgraded to a more appropriate type
+ # if possible, and this will be reflected in the response.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms material.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
- "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise.
+ "dueDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and # Optional date, in UTC, that submissions for this this course work are due.
+ # This must be specified if `due_time` is specified.
+ # time zone are either specified elsewhere or are not significant. The date
+ # is relative to the Proleptic Gregorian Calendar. The day may be 0 to
+ # represent a year and month where the day is not significant, e.g. credit card
+ # expiration date. The year may be 0 to represent a month and day independent
+ # of year, e.g. anniversary date. Related types are google.type.TimeOfDay
+ # and `google.protobuf.Timestamp`.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year/month where the day is not significant.
+ "month": 42, # Month of year. Must be from 1 to 12.
+ },
+ "maxPoints": 3.14, # Maximum grade for this course work.
+ # If zero or unspecified, this assignment is considered ungraded.
+ # This must be a non-negative integer value.
+ "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details.
+ # For read operations, this field is populated only when `work_type` is
+ # `MULTIPLE_CHOICE_QUESTION`.
+ # For write operations, this field must be specified when creating course
+ # work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be
+ # set otherwise.
"choices": [ # Possible choices.
"A String",
],
},
- "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.
- "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
- "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only.
- "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this this course work are due. This must be specified if `due_date` is specified.
- "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "id": "A String", # Classroom-assigned identifier of this course work, unique per course.
+ #
+ # Read-only.
+ "dueTime": { # Represents a time of day. The date and time zone are either not significant # Optional time of day, in UTC, that submissions for this this course work
+ # are due.
+ # This must be specified if `due_date` is specified.
+ # or are specified elsewhere. An API may choose to allow leap seconds. Related
+ # types are google.type.Date and `google.protobuf.Timestamp`.
"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
+ # to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
+ # allow the value 60 if it allows leap-seconds.
},
- "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed.
+ "workType": "A String", # Type of this course work.
+ #
+ # The type is set when the course work is created and cannot be changed.
}
- updateMask: string, Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `submission_modification_mode`
+ updateMask: string, Mask that identifies which fields on the course work to update.
+This field is required to do an update. The update fails if invalid
+fields are specified. If a field supports empty values, it can be cleared
+by specifying it in the update mask and not in the CourseWork object. If a
+field that does not support empty values is included in the update mask and
+not set in the CourseWork object, an `INVALID_ARGUMENT` error will be
+returned.
+
+The following fields may be specified by teachers:
+* `title`
+* `description`
+* `state`
+* `due_date`
+* `due_time`
+* `max_points`
+* `submission_modification_mode`
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Course work created by a teacher for students of the course.
- "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only.
- "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
- "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.
- "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
- "courseId": "A String", # Identifier of the course. Read-only.
- "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only.
- "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "updateTime": "A String", # Timestamp of the most recent change to this course work.
+ #
+ # Read-only.
+ "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions.
+ # If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.
+ "description": "A String", # Optional description of this course work.
+ # If set, the description must be a valid UTF-8 string containing no more
+ # than 30,000 characters.
+ "title": "A String", # Title of this course work.
+ # The title must be a valid UTF-8 string containing between 1 and 3000
+ # characters.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
+ "assignment": { # Additional details for assignments. # Assignment details.
+ # This is populated only when `work_type` is `ASSIGNMENT`.
+ #
+ # Read-only.
+ "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed.
+ # This is only populated for course teachers.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
},
},
- "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
- "creationTime": "A String", # Timestamp when this course work was created. Read-only.
- "dueDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Optional date, in UTC, that submissions for this this course work are due. This must be specified if `due_time` is specified.
- "month": 42, # Month of year. Must be from 1 to 12.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
- },
- "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`.
- "materials": [ # Additional materials. CourseWork must have no more than 20 material items.
- { # Material attached to course work. When creating attachments, setting the `form` field is not supported.
- "link": { # URL item. # Link material. On creation, will be upgraded to a more appropriate type if possible, and this will be reflected in the response.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI.
+ # This is only populated if `state` is `PUBLISHED`.
+ #
+ # Read-only.
+ "creationTime": "A String", # Timestamp when this course work was created.
+ #
+ # Read-only.
+ "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console
+ # project making the request.
+ #
+ # See google.classroom.Work.CreateCourseWork for more
+ # details.
+ #
+ # Read-only.
+ "state": "A String", # Status of this course work.
+ # If unspecified, the default state is `DRAFT`.
+ "materials": [ # Additional materials.
+ #
+ # CourseWork must have no more than 20 material items.
+ { # Material attached to course work.
+ #
+ # When creating attachments, setting the `form` field is not supported.
+ "youtubeVideo": { # YouTube video item. # YouTube video material.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
+ "id": "A String", # YouTube API resource ID.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"driveFile": { # Drive file that is used as material for course work. # Google Drive file material.
"driveFile": { # Representation of a Google Drive file. # Drive file details.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"shareMode": "A String", # Mechanism by which students access the Drive item.
},
- "youtubeVideo": { # YouTube video item. # YouTube video material.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
- "id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "link": { # URL item. # Link material. On creation, will be upgraded to a more appropriate type
+ # if possible, and this will be reflected in the response.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms material.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
- "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise.
+ "dueDate": { # Represents a whole calendar date, e.g. date of birth. The time of day and # Optional date, in UTC, that submissions for this this course work are due.
+ # This must be specified if `due_time` is specified.
+ # time zone are either specified elsewhere or are not significant. The date
+ # is relative to the Proleptic Gregorian Calendar. The day may be 0 to
+ # represent a year and month where the day is not significant, e.g. credit card
+ # expiration date. The year may be 0 to represent a month and day independent
+ # of year, e.g. anniversary date. Related types are google.type.TimeOfDay
+ # and `google.protobuf.Timestamp`.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year/month where the day is not significant.
+ "month": 42, # Month of year. Must be from 1 to 12.
+ },
+ "maxPoints": 3.14, # Maximum grade for this course work.
+ # If zero or unspecified, this assignment is considered ungraded.
+ # This must be a non-negative integer value.
+ "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details.
+ # For read operations, this field is populated only when `work_type` is
+ # `MULTIPLE_CHOICE_QUESTION`.
+ # For write operations, this field must be specified when creating course
+ # work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be
+ # set otherwise.
"choices": [ # Possible choices.
"A String",
],
},
- "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.
- "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
- "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only.
- "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this this course work are due. This must be specified if `due_date` is specified.
- "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "id": "A String", # Classroom-assigned identifier of this course work, unique per course.
+ #
+ # Read-only.
+ "dueTime": { # Represents a time of day. The date and time zone are either not significant # Optional time of day, in UTC, that submissions for this this course work
+ # are due.
+ # This must be specified if `due_date` is specified.
+ # or are specified elsewhere. An API may choose to allow leap seconds. Related
+ # types are google.type.Date and `google.protobuf.Timestamp`.
"nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
+ # to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
+ # allow the value 60 if it allows leap-seconds.
},
- "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed.
+ "workType": "A String", # Type of this course work.
+ #
+ # The type is set when the course work is created and cannot be changed.
}</pre>
</div>
diff --git a/docs/dyn/classroom_v1.courses.courseWork.studentSubmissions.html b/docs/dyn/classroom_v1.courses.courseWork.studentSubmissions.html
index 9e4c3b3..f98c36a 100644
--- a/docs/dyn/classroom_v1.courses.courseWork.studentSubmissions.html
+++ b/docs/dyn/classroom_v1.courses.courseWork.studentSubmissions.html
@@ -75,164 +75,363 @@
<h1><a href="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.courses.html">courses</a> . <a href="classroom_v1.courses.courseWork.html">courseWork</a> . <a href="classroom_v1.courses.courseWork.studentSubmissions.html">studentSubmissions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#get">get(courseId, courseWorkId, id, x__xgafv=None)</a></code></p>
-<p class="firstline">Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p>
+ <code><a href="#get">get(courseId=None, courseWorkId, id, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns a student submission.</p>
<p class="toc_element">
- <code><a href="#list">list(courseId, courseWorkId, pageSize=None, userId=None, states=None, x__xgafv=None, pageToken=None, late=None)</a></code></p>
-<p class="firstline">Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.</p>
+ <code><a href="#list">list(courseId=None, courseWorkId=None, pageSize=None, userId=None, states=None, x__xgafv=None, pageToken=None, late=None)</a></code></p>
+<p class="firstline">Returns a list of student submissions that the requester is permitted to</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="#modifyAttachments">modifyAttachments(courseId, courseWorkId, id, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p>
+ <code><a href="#modifyAttachments">modifyAttachments(courseId=None, courseWorkId, id, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Modifies attachments of student submission.</p>
<p class="toc_element">
- <code><a href="#patch">patch(courseId, courseWorkId, id, body, updateMask=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p>
+ <code><a href="#patch">patch(courseId=None, courseWorkId, id, body, updateMask=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates one or more fields of a student submission.</p>
<p class="toc_element">
- <code><a href="#reclaim">reclaim(courseId, courseWorkId, id, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and update the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p>
+ <code><a href="#reclaim">reclaim(courseId=None, courseWorkId, id, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Reclaims a student submission on behalf of the student that owns it.</p>
<p class="toc_element">
- <code><a href="#return_">return_(courseId, courseWorkId, id, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p>
+ <code><a href="#return_">return_(courseId=None, courseWorkId, id, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns a student submission.</p>
<p class="toc_element">
- <code><a href="#turnIn">turnIn(courseId, courseWorkId, id, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.</p>
+ <code><a href="#turnIn">turnIn(courseId=None, courseWorkId, id, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Turns in a student submission.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="get">get(courseId, courseWorkId, id, x__xgafv=None)</code>
- <pre>Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
+ <code class="details" id="get">get(courseId=None, courseWorkId, id, x__xgafv=None)</code>
+ <pre>Returns a student submission.
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to access the
+requested course, course work, or student submission or for
+access errors.
+* `INVALID_ARGUMENT` if the request is malformed.
+* `NOT_FOUND` if the requested course, course work, or student submission
+does not exist.
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
courseWorkId: string, Identifier of the course work. (required)
id: string, Identifier of the student submission. (required)
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.
- "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This must be a non-negative integer value. This is only visible to and modifiable by course teachers.
- "updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.
- "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only.
- "courseId": "A String", # Identifier of the course. Read-only.
- "userId": "A String", # Identifier for the student that owns this submission. Read-only.
- "creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.
- "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
- "answer": "A String", # Student response to a short-answer question.
- },
- "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
- "late": True or False, # Whether this submission is late. Read-only.
- "state": "A String", # State of this submission. Read-only.
- "courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
- "courseWorkType": "A String", # Type of course work this submission is for. Read-only.
+ { # Student submission for course work.
+ #
+ # StudentSubmission items are generated when a CourseWork item is created.
+ #
+ # StudentSubmissions that have never been accessed (i.e. with `state` = NEW)
+ # may not have a creation time or update time.
+ "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set.
+ # This must be a non-negative integer value.
+ #
+ # This is only visible to and modifiable by course teachers.
+ "updateTime": "A String", # Last update time of this submission.
+ # This may be unset if the student has not accessed this item.
+ #
+ # Read-only.
+ "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI.
+ #
+ # Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
"multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.
"answer": "A String", # Student's select choice.
},
- "assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course teachers.
+ "userId": "A String", # Identifier for the student that owns this submission.
+ #
+ # Read-only.
+ "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
+ "answer": "A String", # Student response to a short-answer question.
+ },
+ "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console
+ # project making the request.
+ #
+ # See google.classroom.Work.CreateCourseWork for more
+ # details.
+ #
+ # Read-only.
+ "late": True or False, # Whether this submission is late.
+ #
+ # Read-only.
+ "state": "A String", # State of this submission.
+ #
+ # Read-only.
+ "courseWorkId": "A String", # Identifier for the course work this corresponds to.
+ #
+ # Read-only.
+ "courseWorkType": "A String", # Type of course work this submission is for.
+ #
+ # Read-only.
+ "assignedGrade": 3.14, # Optional grade. If unset, no grade was set.
+ # This must be a non-negative integer value.
+ #
+ # This may be modified only by course teachers.
+ "creationTime": "A String", # Creation time of this submission.
+ # This may be unset if the student has not accessed this item.
+ #
+ # Read-only.
"assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT .
- "attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (e.g. title) may not be.
- { # Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported.
+ "attachments": [ # Attachments added by the student.
+ # Drive files that correspond to materials with a share mode of
+ # STUDENT_COPY may not exist yet if the student has not accessed the
+ # assignment in Classroom.
+ #
+ # Some attachment metadata is only populated if the requesting user has
+ # permission to access it. Identifier and alternate_link fields are always
+ # available, but others (e.g. title) may not be.
+ { # Attachment added to student assignment work.
+ #
+ # When creating attachments, setting the `form` field is not supported.
"link": { # URL item. # Link attachment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
"id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
},
- "id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.
+ "id": "A String", # Classroom-assigned Identifier for the student submission.
+ # This is unique among submissions for the relevant course work.
+ #
+ # Read-only.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(courseId, courseWorkId, pageSize=None, userId=None, states=None, x__xgafv=None, pageToken=None, late=None)</code>
- <pre>Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
+ <code class="details" id="list">list(courseId=None, courseWorkId=None, pageSize=None, userId=None, states=None, x__xgafv=None, pageToken=None, late=None)</code>
+ <pre>Returns a list of student submissions that the requester is permitted to
+view, factoring in the OAuth scopes of the request.
+`-` may be specified as the `course_work_id` to include student
+submissions for multiple course work items.
+
+Course students may only view their own work. Course teachers
+and domain administrators may view all student submissions.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to access the
+requested course or course work, or for access errors.
+* `INVALID_ARGUMENT` if the request is malformed.
+* `NOT_FOUND` if the requested course does not exist.
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
- courseWorkId: string, Identifer of the student work to request. This may be set to the string literal `"-"` to request student work for all course work in the specified course. (required)
- 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.
- userId: string, Optional argument to restrict returned student work to those owned by the 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
- states: string, Requested submission states. If specified, returned student submissions match one of the specified submission states. (repeated)
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
+ courseWorkId: string, Identifer of the student work to request.
+This may be set to the string literal `"-"` to request student work for
+all course work in the specified course. (required)
+ 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.
+ userId: string, Optional argument to restrict returned student work to those owned by the
+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
+ states: string, Requested submission states. If specified, returned student submissions
+match one of the specified submission states. (repeated)
x__xgafv: string, V1 error format.
- 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.
- late: string, Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ 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.
+ late: string, Requested lateness value. If specified, returned student submissions are
+restricted by the requested value.
+If unspecified, submissions are returned regardless of `late` value.
Returns:
An object of the form:
{ # Response when listing student submissions.
- "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
+ "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
+ # results are available.
"studentSubmissions": [ # Student work that matches the request.
- { # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.
- "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This must be a non-negative integer value. This is only visible to and modifiable by course teachers.
- "updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.
- "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only.
- "courseId": "A String", # Identifier of the course. Read-only.
- "userId": "A String", # Identifier for the student that owns this submission. Read-only.
- "creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.
- "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
- "answer": "A String", # Student response to a short-answer question.
- },
- "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
- "late": True or False, # Whether this submission is late. Read-only.
- "state": "A String", # State of this submission. Read-only.
- "courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
- "courseWorkType": "A String", # Type of course work this submission is for. Read-only.
+ { # Student submission for course work.
+ #
+ # StudentSubmission items are generated when a CourseWork item is created.
+ #
+ # StudentSubmissions that have never been accessed (i.e. with `state` = NEW)
+ # may not have a creation time or update time.
+ "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set.
+ # This must be a non-negative integer value.
+ #
+ # This is only visible to and modifiable by course teachers.
+ "updateTime": "A String", # Last update time of this submission.
+ # This may be unset if the student has not accessed this item.
+ #
+ # Read-only.
+ "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI.
+ #
+ # Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
"multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.
"answer": "A String", # Student's select choice.
},
- "assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course teachers.
+ "userId": "A String", # Identifier for the student that owns this submission.
+ #
+ # Read-only.
+ "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
+ "answer": "A String", # Student response to a short-answer question.
+ },
+ "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console
+ # project making the request.
+ #
+ # See google.classroom.Work.CreateCourseWork for more
+ # details.
+ #
+ # Read-only.
+ "late": True or False, # Whether this submission is late.
+ #
+ # Read-only.
+ "state": "A String", # State of this submission.
+ #
+ # Read-only.
+ "courseWorkId": "A String", # Identifier for the course work this corresponds to.
+ #
+ # Read-only.
+ "courseWorkType": "A String", # Type of course work this submission is for.
+ #
+ # Read-only.
+ "assignedGrade": 3.14, # Optional grade. If unset, no grade was set.
+ # This must be a non-negative integer value.
+ #
+ # This may be modified only by course teachers.
+ "creationTime": "A String", # Creation time of this submission.
+ # This may be unset if the student has not accessed this item.
+ #
+ # Read-only.
"assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT .
- "attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (e.g. title) may not be.
- { # Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported.
+ "attachments": [ # Attachments added by the student.
+ # Drive files that correspond to materials with a share mode of
+ # STUDENT_COPY may not exist yet if the student has not accessed the
+ # assignment in Classroom.
+ #
+ # Some attachment metadata is only populated if the requesting user has
+ # permission to access it. Identifier and alternate_link fields are always
+ # available, but others (e.g. title) may not be.
+ { # Attachment added to student assignment work.
+ #
+ # When creating attachments, setting the `form` field is not supported.
"link": { # URL item. # Link attachment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
"id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
},
- "id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.
+ "id": "A String", # Classroom-assigned Identifier for the student submission.
+ # This is unique among submissions for the relevant course work.
+ #
+ # Read-only.
},
],
}</pre>
@@ -253,229 +452,553 @@
</div>
<div class="method">
- <code class="details" id="modifyAttachments">modifyAttachments(courseId, courseWorkId, id, body, x__xgafv=None)</code>
- <pre>Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
+ <code class="details" id="modifyAttachments">modifyAttachments(courseId=None, courseWorkId, id, body, x__xgafv=None)</code>
+ <pre>Modifies attachments of student submission.
+
+Attachments may only be added to student submissions belonging to course
+work objects with a `workType` of `ASSIGNMENT`.
+
+This request must be made by the Developer Console project of the
+[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
+create the corresponding course work item.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to access the
+requested course or course work, if the user is not permitted to modify
+attachments on the requested student submission, or for
+access errors.
+* `INVALID_ARGUMENT` if the request is malformed.
+* `NOT_FOUND` if the requested course, course work, or student submission
+does not exist.
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
courseWorkId: string, Identifier of the course work. (required)
id: string, Identifier of the student submission. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request to modify the attachments of a student submission.
- "addAttachments": [ # Attachments to add. A student submission may not have more than 20 attachments. Form attachments are not supported.
- { # Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported.
+ "addAttachments": [ # Attachments to add.
+ # A student submission may not have more than 20 attachments.
+ #
+ # Form attachments are not supported.
+ { # Attachment added to student assignment work.
+ #
+ # When creating attachments, setting the `form` field is not supported.
"link": { # URL item. # Link attachment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
"id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.
- "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This must be a non-negative integer value. This is only visible to and modifiable by course teachers.
- "updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.
- "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only.
- "courseId": "A String", # Identifier of the course. Read-only.
- "userId": "A String", # Identifier for the student that owns this submission. Read-only.
- "creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.
- "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
- "answer": "A String", # Student response to a short-answer question.
- },
- "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
- "late": True or False, # Whether this submission is late. Read-only.
- "state": "A String", # State of this submission. Read-only.
- "courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
- "courseWorkType": "A String", # Type of course work this submission is for. Read-only.
+ { # Student submission for course work.
+ #
+ # StudentSubmission items are generated when a CourseWork item is created.
+ #
+ # StudentSubmissions that have never been accessed (i.e. with `state` = NEW)
+ # may not have a creation time or update time.
+ "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set.
+ # This must be a non-negative integer value.
+ #
+ # This is only visible to and modifiable by course teachers.
+ "updateTime": "A String", # Last update time of this submission.
+ # This may be unset if the student has not accessed this item.
+ #
+ # Read-only.
+ "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI.
+ #
+ # Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
"multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.
"answer": "A String", # Student's select choice.
},
- "assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course teachers.
+ "userId": "A String", # Identifier for the student that owns this submission.
+ #
+ # Read-only.
+ "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
+ "answer": "A String", # Student response to a short-answer question.
+ },
+ "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console
+ # project making the request.
+ #
+ # See google.classroom.Work.CreateCourseWork for more
+ # details.
+ #
+ # Read-only.
+ "late": True or False, # Whether this submission is late.
+ #
+ # Read-only.
+ "state": "A String", # State of this submission.
+ #
+ # Read-only.
+ "courseWorkId": "A String", # Identifier for the course work this corresponds to.
+ #
+ # Read-only.
+ "courseWorkType": "A String", # Type of course work this submission is for.
+ #
+ # Read-only.
+ "assignedGrade": 3.14, # Optional grade. If unset, no grade was set.
+ # This must be a non-negative integer value.
+ #
+ # This may be modified only by course teachers.
+ "creationTime": "A String", # Creation time of this submission.
+ # This may be unset if the student has not accessed this item.
+ #
+ # Read-only.
"assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT .
- "attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (e.g. title) may not be.
- { # Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported.
+ "attachments": [ # Attachments added by the student.
+ # Drive files that correspond to materials with a share mode of
+ # STUDENT_COPY may not exist yet if the student has not accessed the
+ # assignment in Classroom.
+ #
+ # Some attachment metadata is only populated if the requesting user has
+ # permission to access it. Identifier and alternate_link fields are always
+ # available, but others (e.g. title) may not be.
+ { # Attachment added to student assignment work.
+ #
+ # When creating attachments, setting the `form` field is not supported.
"link": { # URL item. # Link attachment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
"id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
},
- "id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.
+ "id": "A String", # Classroom-assigned Identifier for the student submission.
+ # This is unique among submissions for the relevant course work.
+ #
+ # Read-only.
}</pre>
</div>
<div class="method">
- <code class="details" id="patch">patch(courseId, courseWorkId, id, body, updateMask=None, x__xgafv=None)</code>
- <pre>Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
+ <code class="details" id="patch">patch(courseId=None, courseWorkId, id, body, updateMask=None, x__xgafv=None)</code>
+ <pre>Updates one or more fields of a student submission.
+
+See google.classroom.v1.StudentSubmission for details
+of which fields may be updated and who may change them.
+
+This request must be made by the Developer Console project of the
+[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
+create the corresponding course work item.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting developer project did not create
+the corresponding course work, if the user is not permitted to make the
+requested modification to the student submission, or for
+access errors.
+* `INVALID_ARGUMENT` if the request is malformed.
+* `NOT_FOUND` if the requested course, course work, or student submission
+does not exist.
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
courseWorkId: string, Identifier of the course work. (required)
id: string, Identifier of the student submission. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.
- "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This must be a non-negative integer value. This is only visible to and modifiable by course teachers.
- "updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.
- "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only.
- "courseId": "A String", # Identifier of the course. Read-only.
- "userId": "A String", # Identifier for the student that owns this submission. Read-only.
- "creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.
- "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
- "answer": "A String", # Student response to a short-answer question.
- },
- "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
- "late": True or False, # Whether this submission is late. Read-only.
- "state": "A String", # State of this submission. Read-only.
- "courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
- "courseWorkType": "A String", # Type of course work this submission is for. Read-only.
+{ # Student submission for course work.
+ #
+ # StudentSubmission items are generated when a CourseWork item is created.
+ #
+ # StudentSubmissions that have never been accessed (i.e. with `state` = NEW)
+ # may not have a creation time or update time.
+ "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set.
+ # This must be a non-negative integer value.
+ #
+ # This is only visible to and modifiable by course teachers.
+ "updateTime": "A String", # Last update time of this submission.
+ # This may be unset if the student has not accessed this item.
+ #
+ # Read-only.
+ "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI.
+ #
+ # Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
"multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.
"answer": "A String", # Student's select choice.
},
- "assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course teachers.
+ "userId": "A String", # Identifier for the student that owns this submission.
+ #
+ # Read-only.
+ "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
+ "answer": "A String", # Student response to a short-answer question.
+ },
+ "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console
+ # project making the request.
+ #
+ # See google.classroom.Work.CreateCourseWork for more
+ # details.
+ #
+ # Read-only.
+ "late": True or False, # Whether this submission is late.
+ #
+ # Read-only.
+ "state": "A String", # State of this submission.
+ #
+ # Read-only.
+ "courseWorkId": "A String", # Identifier for the course work this corresponds to.
+ #
+ # Read-only.
+ "courseWorkType": "A String", # Type of course work this submission is for.
+ #
+ # Read-only.
+ "assignedGrade": 3.14, # Optional grade. If unset, no grade was set.
+ # This must be a non-negative integer value.
+ #
+ # This may be modified only by course teachers.
+ "creationTime": "A String", # Creation time of this submission.
+ # This may be unset if the student has not accessed this item.
+ #
+ # Read-only.
"assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT .
- "attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (e.g. title) may not be.
- { # Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported.
+ "attachments": [ # Attachments added by the student.
+ # Drive files that correspond to materials with a share mode of
+ # STUDENT_COPY may not exist yet if the student has not accessed the
+ # assignment in Classroom.
+ #
+ # Some attachment metadata is only populated if the requesting user has
+ # permission to access it. Identifier and alternate_link fields are always
+ # available, but others (e.g. title) may not be.
+ { # Attachment added to student assignment work.
+ #
+ # When creating attachments, setting the `form` field is not supported.
"link": { # URL item. # Link attachment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
"id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
},
- "id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.
+ "id": "A String", # Classroom-assigned Identifier for the student submission.
+ # This is unique among submissions for the relevant course work.
+ #
+ # Read-only.
}
- updateMask: string, Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade`
+ updateMask: string, Mask that identifies which fields on the student submission to update.
+This field is required to do an update. The update fails if invalid
+fields are specified.
+
+The following fields may be specified by teachers:
+* `draft_grade`
+* `assigned_grade`
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
- { # Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.
- "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set. This must be a non-negative integer value. This is only visible to and modifiable by course teachers.
- "updateTime": "A String", # Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.
- "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI. Read-only.
- "courseId": "A String", # Identifier of the course. Read-only.
- "userId": "A String", # Identifier for the student that owns this submission. Read-only.
- "creationTime": "A String", # Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.
- "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
- "answer": "A String", # Student response to a short-answer question.
- },
- "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.
- "late": True or False, # Whether this submission is late. Read-only.
- "state": "A String", # State of this submission. Read-only.
- "courseWorkId": "A String", # Identifier for the course work this corresponds to. Read-only.
- "courseWorkType": "A String", # Type of course work this submission is for. Read-only.
+ { # Student submission for course work.
+ #
+ # StudentSubmission items are generated when a CourseWork item is created.
+ #
+ # StudentSubmissions that have never been accessed (i.e. with `state` = NEW)
+ # may not have a creation time or update time.
+ "draftGrade": 3.14, # Optional pending grade. If unset, no grade was set.
+ # This must be a non-negative integer value.
+ #
+ # This is only visible to and modifiable by course teachers.
+ "updateTime": "A String", # Last update time of this submission.
+ # This may be unset if the student has not accessed this item.
+ #
+ # Read-only.
+ "alternateLink": "A String", # Absolute link to the submission in the Classroom web UI.
+ #
+ # Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
"multipleChoiceSubmission": { # Student work for a multiple-choice question. # Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION.
"answer": "A String", # Student's select choice.
},
- "assignedGrade": 3.14, # Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course teachers.
+ "userId": "A String", # Identifier for the student that owns this submission.
+ #
+ # Read-only.
+ "shortAnswerSubmission": { # Student work for a short answer question. # Submission content when course_work_type is SHORT_ANSWER_QUESTION.
+ "answer": "A String", # Student response to a short-answer question.
+ },
+ "associatedWithDeveloper": True or False, # Whether this student submission is associated with the Developer Console
+ # project making the request.
+ #
+ # See google.classroom.Work.CreateCourseWork for more
+ # details.
+ #
+ # Read-only.
+ "late": True or False, # Whether this submission is late.
+ #
+ # Read-only.
+ "state": "A String", # State of this submission.
+ #
+ # Read-only.
+ "courseWorkId": "A String", # Identifier for the course work this corresponds to.
+ #
+ # Read-only.
+ "courseWorkType": "A String", # Type of course work this submission is for.
+ #
+ # Read-only.
+ "assignedGrade": 3.14, # Optional grade. If unset, no grade was set.
+ # This must be a non-negative integer value.
+ #
+ # This may be modified only by course teachers.
+ "creationTime": "A String", # Creation time of this submission.
+ # This may be unset if the student has not accessed this item.
+ #
+ # Read-only.
"assignmentSubmission": { # Student work for an assignment. # Submission content when course_work_type is ASSIGNMENT .
- "attachments": [ # Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (e.g. title) may not be.
- { # Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported.
+ "attachments": [ # Attachments added by the student.
+ # Drive files that correspond to materials with a share mode of
+ # STUDENT_COPY may not exist yet if the student has not accessed the
+ # assignment in Classroom.
+ #
+ # Some attachment metadata is only populated if the requesting user has
+ # permission to access it. Identifier and alternate_link fields are always
+ # available, but others (e.g. title) may not be.
+ { # Attachment added to student assignment work.
+ #
+ # When creating attachments, setting the `form` field is not supported.
"link": { # URL item. # Link attachment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
"id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
},
- "id": "A String", # Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.
+ "id": "A String", # Classroom-assigned Identifier for the student submission.
+ # This is unique among submissions for the relevant course work.
+ #
+ # Read-only.
}</pre>
</div>
<div class="method">
- <code class="details" id="reclaim">reclaim(courseId, courseWorkId, id, body, x__xgafv=None)</code>
- <pre>Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and update the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
+ <code class="details" id="reclaim">reclaim(courseId=None, courseWorkId, id, body, x__xgafv=None)</code>
+ <pre>Reclaims a student submission on behalf of the student that owns it.
+
+Reclaiming a student submission transfers ownership of attached Drive
+files to the student and update the submission state.
+
+Only the student that owns the requested student submission may call this
+method, and only for a student submission that has been turned in.
+
+This request must be made by the Developer Console project of the
+[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
+create the corresponding course work item.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to access the
+requested course or course work, unsubmit the requested student submission,
+or for access errors.
+* `FAILED_PRECONDITION` if the student submission has not been turned in.
+* `INVALID_ARGUMENT` if the request is malformed.
+* `NOT_FOUND` if the requested course, course work, or student submission
+does not exist.
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
courseWorkId: string, Identifier of the course work. (required)
id: string, Identifier of the student submission. (required)
body: object, The request body. (required)
@@ -485,20 +1008,54 @@
}
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="return_">return_(courseId, courseWorkId, id, body, x__xgafv=None)</code>
- <pre>Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
+ <code class="details" id="return_">return_(courseId=None, courseWorkId, id, body, x__xgafv=None)</code>
+ <pre>Returns a student submission.
+
+Returning a student submission transfers ownership of attached Drive
+files to the student and may also update the submission state.
+Unlike the Classroom application, returning a student submission does not
+set assignedGrade to the draftGrade value.
+
+Only a teacher of the course that contains the requested student submission
+may call this method.
+
+This request must be made by the Developer Console project of the
+[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
+create the corresponding course work item.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to access the
+requested course or course work, return the requested student submission,
+or for access errors.
+* `INVALID_ARGUMENT` if the request is malformed.
+* `NOT_FOUND` if the requested course, course work, or student submission
+does not exist.
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
courseWorkId: string, Identifier of the course work. (required)
id: string, Identifier of the student submission. (required)
body: object, The request body. (required)
@@ -508,20 +1065,52 @@
}
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="turnIn">turnIn(courseId, courseWorkId, id, body, x__xgafv=None)</code>
- <pre>Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
+ <code class="details" id="turnIn">turnIn(courseId=None, courseWorkId, id, body, x__xgafv=None)</code>
+ <pre>Turns in a student submission.
+
+Turning in a student submission transfers ownership of attached Drive
+files to the teacher and may also update the submission state.
+
+This may only be called by the student that owns the specified student
+submission.
+
+This request must be made by the Developer Console project of the
+[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to
+create the corresponding course work item.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to access the
+requested course or course work, turn in the requested student submission,
+or for access errors.
+* `INVALID_ARGUMENT` if the request is malformed.
+* `NOT_FOUND` if the requested course, course work, or student submission
+does not exist.
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
courseWorkId: string, Identifier of the course work. (required)
id: string, Identifier of the student submission. (required)
body: object, The request body. (required)
@@ -531,11 +1120,22 @@
}
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/classroom_v1.courses.html b/docs/dyn/classroom_v1.courses.html
index 35adde3..a449dce 100644
--- a/docs/dyn/classroom_v1.courses.html
+++ b/docs/dyn/classroom_v1.courses.html
@@ -96,303 +96,765 @@
<p class="toc_element">
<code><a href="#create">create(body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.</p>
+<p class="firstline">Creates a course.</p>
<p class="toc_element">
- <code><a href="#delete">delete(id, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.</p>
+ <code><a href="#delete">delete(id=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a course.</p>
<p class="toc_element">
- <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>
+ <code><a href="#get">get(id=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns a course.</p>
<p class="toc_element">
<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="firstline">Returns a list of courses that the requesting user is permitted to view,</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(id, body, updateMask=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable</p>
+ <code><a href="#patch">patch(id=None, body, updateMask=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates one or more fields in a course.</p>
<p class="toc_element">
- <code><a href="#update">update(id, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable</p>
+ <code><a href="#update">update(id=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates a course.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(body, x__xgafv=None)</code>
- <pre>Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.
+ <pre>Creates a course.
+
+The user specified in `ownerId` is the owner of the created course
+and added as a teacher.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to create
+courses or for access errors.
+* `NOT_FOUND` if the primary teacher is not a valid user.
+* `FAILED_PRECONDITION` if the course owner's account is disabled or for
+the following request errors:
+ * UserGroupsMembershipLimitReached
+* `ALREADY_EXISTS` if an alias was specified in the `id` and
+already exists.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # 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.
- "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
- "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
- },
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
- "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
- "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
- { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # Read-only.
+ "section": "A String", # Section of the course.
+ # For example, "Period 2".
+ # If set, this field must be a valid UTF-8 string and no longer than 2800
+ # characters.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # Read-only.
+ "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "name": "A String", # Name of the course.
+ # For example, "10th Grade Biology".
+ # The name is required. It must be between 1 and 750 characters and a valid
+ # UTF-8 string.
+ "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course.
+ #
+ # Read-only.
+ { # A set of materials that appears on the "About" page of the course.
+ # These materials might include a syllabus, schedule, or other background
+ # information relating to the course as a whole.
"materials": [ # Materials attached to this set.
{ # A material attached to a course as part of a material set.
"link": { # URL item. # Link atatchment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
"id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
"title": "A String", # Title for this set.
},
],
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
- "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
- "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. 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 This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
- "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
- "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
- "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
+ "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the
+ # course.
+ #
+ # This field will only be set for teachers of the course and domain administrators.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
+ },
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "ownerId": "A String", # The identifier of the owner of a course.
+ #
+ # When specified as a parameter of a
+ # create course request, this
+ # field is required.
+ # 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
+ #
+ # This must be set in a create request. Specifying this field in a course
+ # update mask results in an `INVALID_ARGUMENT` error.
+ "id": "A String", # Identifier for this course assigned by Classroom.
+ #
+ # When
+ # creating a course,
+ # you may optionally set this identifier to an
+ # alias string in the
+ # request to create a corresponding alias. The `id` is still assigned by
+ # Classroom and cannot be updated after the course is created.
+ #
+ # Specifying this field in a course update mask results in an error.
+ "descriptionHeading": "A String", # Optional heading for the description.
+ # For example, "Welcome to 10th Grade Biology."
+ # If set, this field must be a valid UTF-8 string and no longer than 3600
+ # characters.
+ "room": "A String", # Optional room location.
+ # For example, "301".
+ # If set, this field must be a valid UTF-8 string and no longer than 650
+ # characters.
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # 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.
- "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
- "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
- },
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
- "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
- "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
- { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # Read-only.
+ "section": "A String", # Section of the course.
+ # For example, "Period 2".
+ # If set, this field must be a valid UTF-8 string and no longer than 2800
+ # characters.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # Read-only.
+ "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "name": "A String", # Name of the course.
+ # For example, "10th Grade Biology".
+ # The name is required. It must be between 1 and 750 characters and a valid
+ # UTF-8 string.
+ "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course.
+ #
+ # Read-only.
+ { # A set of materials that appears on the "About" page of the course.
+ # These materials might include a syllabus, schedule, or other background
+ # information relating to the course as a whole.
"materials": [ # Materials attached to this set.
{ # A material attached to a course as part of a material set.
"link": { # URL item. # Link atatchment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
"id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
"title": "A String", # Title for this set.
},
],
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
- "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
- "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. 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 This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
- "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
- "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
- "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
+ "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the
+ # course.
+ #
+ # This field will only be set for teachers of the course and domain administrators.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
+ },
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "ownerId": "A String", # The identifier of the owner of a course.
+ #
+ # When specified as a parameter of a
+ # create course request, this
+ # field is required.
+ # 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
+ #
+ # This must be set in a create request. Specifying this field in a course
+ # update mask results in an `INVALID_ARGUMENT` error.
+ "id": "A String", # Identifier for this course assigned by Classroom.
+ #
+ # When
+ # creating a course,
+ # you may optionally set this identifier to an
+ # alias string in the
+ # request to create a corresponding alias. The `id` is still assigned by
+ # Classroom and cannot be updated after the course is created.
+ #
+ # Specifying this field in a course update mask results in an error.
+ "descriptionHeading": "A String", # Optional heading for the description.
+ # For example, "Welcome to 10th Grade Biology."
+ # If set, this field must be a valid UTF-8 string and no longer than 3600
+ # characters.
+ "room": "A String", # Optional room location.
+ # For example, "301".
+ # If set, this field must be a valid UTF-8 string and no longer than 650
+ # characters.
}</pre>
</div>
<div class="method">
- <code class="details" id="delete">delete(id, x__xgafv=None)</code>
- <pre>Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.
+ <code class="details" id="delete">delete(id=None, x__xgafv=None)</code>
+ <pre>Deletes a course.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to delete the
+requested course or for access errors.
+* `NOT_FOUND` if no course exists with the requested ID.
Args:
- id: string, Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ id: string, Identifier of the course to delete.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (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(id, x__xgafv=None)</code>
- <pre>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.
+ <code class="details" id="get">get(id=None, x__xgafv=None)</code>
+ <pre>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.
Args:
- id: string, Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ id: string, Identifier of the course to return.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # 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.
- "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
- "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
- },
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
- "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
- "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
- { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # Read-only.
+ "section": "A String", # Section of the course.
+ # For example, "Period 2".
+ # If set, this field must be a valid UTF-8 string and no longer than 2800
+ # characters.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # Read-only.
+ "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "name": "A String", # Name of the course.
+ # For example, "10th Grade Biology".
+ # The name is required. It must be between 1 and 750 characters and a valid
+ # UTF-8 string.
+ "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course.
+ #
+ # Read-only.
+ { # A set of materials that appears on the "About" page of the course.
+ # These materials might include a syllabus, schedule, or other background
+ # information relating to the course as a whole.
"materials": [ # Materials attached to this set.
{ # A material attached to a course as part of a material set.
"link": { # URL item. # Link atatchment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
"id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
"title": "A String", # Title for this set.
},
],
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
- "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
- "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. 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 This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
- "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
- "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
- "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
+ "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the
+ # course.
+ #
+ # This field will only be set for teachers of the course and domain administrators.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
+ },
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "ownerId": "A String", # The identifier of the owner of a course.
+ #
+ # When specified as a parameter of a
+ # create course request, this
+ # field is required.
+ # 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
+ #
+ # This must be set in a create request. Specifying this field in a course
+ # update mask results in an `INVALID_ARGUMENT` error.
+ "id": "A String", # Identifier for this course assigned by Classroom.
+ #
+ # When
+ # creating a course,
+ # you may optionally set this identifier to an
+ # alias string in the
+ # request to create a corresponding alias. The `id` is still assigned by
+ # Classroom and cannot be updated after the course is created.
+ #
+ # Specifying this field in a course update mask results in an error.
+ "descriptionHeading": "A String", # Optional heading for the description.
+ # For example, "Welcome to 10th Grade Biology."
+ # If set, this field must be a valid UTF-8 string and no longer than 3600
+ # characters.
+ "room": "A String", # Optional room location.
+ # For example, "301".
+ # If set, this field must be a valid UTF-8 string and no longer than 650
+ # characters.
}</pre>
</div>
<div class="method">
<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.
+ <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.
+ 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
+The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. (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.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Response when listing courses.
- "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
+ "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
+ # results are available.
"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.
- "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
- "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
- },
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
- "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
- "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
- { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # Read-only.
+ "section": "A String", # Section of the course.
+ # For example, "Period 2".
+ # If set, this field must be a valid UTF-8 string and no longer than 2800
+ # characters.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # Read-only.
+ "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "name": "A String", # Name of the course.
+ # For example, "10th Grade Biology".
+ # The name is required. It must be between 1 and 750 characters and a valid
+ # UTF-8 string.
+ "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course.
+ #
+ # Read-only.
+ { # A set of materials that appears on the "About" page of the course.
+ # These materials might include a syllabus, schedule, or other background
+ # information relating to the course as a whole.
"materials": [ # Materials attached to this set.
{ # A material attached to a course as part of a material set.
"link": { # URL item. # Link atatchment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
"id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
"title": "A String", # Title for this set.
},
],
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
- "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
- "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. 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 This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
- "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
- "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
- "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
+ "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the
+ # course.
+ #
+ # This field will only be set for teachers of the course and domain administrators.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
+ },
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "ownerId": "A String", # The identifier of the owner of a course.
+ #
+ # When specified as a parameter of a
+ # create course request, this
+ # field is required.
+ # 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
+ #
+ # This must be set in a create request. Specifying this field in a course
+ # update mask results in an `INVALID_ARGUMENT` error.
+ "id": "A String", # Identifier for this course assigned by Classroom.
+ #
+ # When
+ # creating a course,
+ # you may optionally set this identifier to an
+ # alias string in the
+ # request to create a corresponding alias. The `id` is still assigned by
+ # Classroom and cannot be updated after the course is created.
+ #
+ # Specifying this field in a course update mask results in an error.
+ "descriptionHeading": "A String", # Optional heading for the description.
+ # For example, "Welcome to 10th Grade Biology."
+ # If set, this field must be a valid UTF-8 string and no longer than 3600
+ # characters.
+ "room": "A String", # Optional room location.
+ # For example, "301".
+ # If set, this field must be a valid UTF-8 string and no longer than 650
+ # characters.
},
],
}</pre>
@@ -413,253 +875,678 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(id, body, updateMask=None, x__xgafv=None)</code>
- <pre>Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
+ <code class="details" id="patch">patch(id=None, body, updateMask=None, x__xgafv=None)</code>
+ <pre>Updates one or more fields in a course.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to modify the
+requested course or for access errors.
+* `NOT_FOUND` if no course exists with the requested ID.
+* `INVALID_ARGUMENT` if invalid fields are specified in the update mask or
+if no update mask is supplied.
+* `FAILED_PRECONDITION` for the following request errors:
+ * CourseNotModifiable
Args:
- id: string, Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ id: string, Identifier of the course to update.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
body: object, The request body. (required)
The object takes the form of:
{ # 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.
- "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
- "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
- },
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
- "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
- "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
- { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # Read-only.
+ "section": "A String", # Section of the course.
+ # For example, "Period 2".
+ # If set, this field must be a valid UTF-8 string and no longer than 2800
+ # characters.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # Read-only.
+ "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "name": "A String", # Name of the course.
+ # For example, "10th Grade Biology".
+ # The name is required. It must be between 1 and 750 characters and a valid
+ # UTF-8 string.
+ "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course.
+ #
+ # Read-only.
+ { # A set of materials that appears on the "About" page of the course.
+ # These materials might include a syllabus, schedule, or other background
+ # information relating to the course as a whole.
"materials": [ # Materials attached to this set.
{ # A material attached to a course as part of a material set.
"link": { # URL item. # Link atatchment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
"id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
"title": "A String", # Title for this set.
},
],
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
- "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
- "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. 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 This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
- "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
- "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
- "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
+ "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the
+ # course.
+ #
+ # This field will only be set for teachers of the course and domain administrators.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
+ },
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "ownerId": "A String", # The identifier of the owner of a course.
+ #
+ # When specified as a parameter of a
+ # create course request, this
+ # field is required.
+ # 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
+ #
+ # This must be set in a create request. Specifying this field in a course
+ # update mask results in an `INVALID_ARGUMENT` error.
+ "id": "A String", # Identifier for this course assigned by Classroom.
+ #
+ # When
+ # creating a course,
+ # you may optionally set this identifier to an
+ # alias string in the
+ # request to create a corresponding alias. The `id` is still assigned by
+ # Classroom and cannot be updated after the course is created.
+ #
+ # Specifying this field in a course update mask results in an error.
+ "descriptionHeading": "A String", # Optional heading for the description.
+ # For example, "Welcome to 10th Grade Biology."
+ # If set, this field must be a valid UTF-8 string and no longer than 3600
+ # characters.
+ "room": "A String", # Optional room location.
+ # For example, "301".
+ # If set, this field must be a valid UTF-8 string and no longer than 650
+ # characters.
}
- 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: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` When set in a query parameter, this field should be specified as `updateMask=,,...`
+ 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:
+
+* `name`
+* `section`
+* `descriptionHeading`
+* `description`
+* `room`
+* `courseState`
+
+When set in a query parameter, this field should be specified as
+
+`updateMask=<field1>,<field2>,...`
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # 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.
- "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
- "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
- },
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
- "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
- "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
- { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # Read-only.
+ "section": "A String", # Section of the course.
+ # For example, "Period 2".
+ # If set, this field must be a valid UTF-8 string and no longer than 2800
+ # characters.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # Read-only.
+ "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "name": "A String", # Name of the course.
+ # For example, "10th Grade Biology".
+ # The name is required. It must be between 1 and 750 characters and a valid
+ # UTF-8 string.
+ "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course.
+ #
+ # Read-only.
+ { # A set of materials that appears on the "About" page of the course.
+ # These materials might include a syllabus, schedule, or other background
+ # information relating to the course as a whole.
"materials": [ # Materials attached to this set.
{ # A material attached to a course as part of a material set.
"link": { # URL item. # Link atatchment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
"id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
"title": "A String", # Title for this set.
},
],
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
- "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
- "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. 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 This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
- "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
- "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
- "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
+ "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the
+ # course.
+ #
+ # This field will only be set for teachers of the course and domain administrators.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
+ },
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "ownerId": "A String", # The identifier of the owner of a course.
+ #
+ # When specified as a parameter of a
+ # create course request, this
+ # field is required.
+ # 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
+ #
+ # This must be set in a create request. Specifying this field in a course
+ # update mask results in an `INVALID_ARGUMENT` error.
+ "id": "A String", # Identifier for this course assigned by Classroom.
+ #
+ # When
+ # creating a course,
+ # you may optionally set this identifier to an
+ # alias string in the
+ # request to create a corresponding alias. The `id` is still assigned by
+ # Classroom and cannot be updated after the course is created.
+ #
+ # Specifying this field in a course update mask results in an error.
+ "descriptionHeading": "A String", # Optional heading for the description.
+ # For example, "Welcome to 10th Grade Biology."
+ # If set, this field must be a valid UTF-8 string and no longer than 3600
+ # characters.
+ "room": "A String", # Optional room location.
+ # For example, "301".
+ # If set, this field must be a valid UTF-8 string and no longer than 650
+ # characters.
}</pre>
</div>
<div class="method">
- <code class="details" id="update">update(id, body, x__xgafv=None)</code>
- <pre>Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
+ <code class="details" id="update">update(id=None, body, x__xgafv=None)</code>
+ <pre>Updates a course.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to modify the
+requested course or for access errors.
+* `NOT_FOUND` if no course exists with the requested ID.
+* `FAILED_PRECONDITION` for the following request errors:
+ * CourseNotModifiable
Args:
- id: string, Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ id: string, Identifier of the course to update.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
body: object, The request body. (required)
The object takes the form of:
{ # 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.
- "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
- "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
- },
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
- "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
- "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
- { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # Read-only.
+ "section": "A String", # Section of the course.
+ # For example, "Period 2".
+ # If set, this field must be a valid UTF-8 string and no longer than 2800
+ # characters.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # Read-only.
+ "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "name": "A String", # Name of the course.
+ # For example, "10th Grade Biology".
+ # The name is required. It must be between 1 and 750 characters and a valid
+ # UTF-8 string.
+ "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course.
+ #
+ # Read-only.
+ { # A set of materials that appears on the "About" page of the course.
+ # These materials might include a syllabus, schedule, or other background
+ # information relating to the course as a whole.
"materials": [ # Materials attached to this set.
{ # A material attached to a course as part of a material set.
"link": { # URL item. # Link atatchment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
"id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
"title": "A String", # Title for this set.
},
],
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
- "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
- "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. 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 This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
- "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
- "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
- "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
+ "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the
+ # course.
+ #
+ # This field will only be set for teachers of the course and domain administrators.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
+ },
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "ownerId": "A String", # The identifier of the owner of a course.
+ #
+ # When specified as a parameter of a
+ # create course request, this
+ # field is required.
+ # 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
+ #
+ # This must be set in a create request. Specifying this field in a course
+ # update mask results in an `INVALID_ARGUMENT` error.
+ "id": "A String", # Identifier for this course assigned by Classroom.
+ #
+ # When
+ # creating a course,
+ # you may optionally set this identifier to an
+ # alias string in the
+ # request to create a corresponding alias. The `id` is still assigned by
+ # Classroom and cannot be updated after the course is created.
+ #
+ # Specifying this field in a course update mask results in an error.
+ "descriptionHeading": "A String", # Optional heading for the description.
+ # For example, "Welcome to 10th Grade Biology."
+ # If set, this field must be a valid UTF-8 string and no longer than 3600
+ # characters.
+ "room": "A String", # Optional room location.
+ # For example, "301".
+ # If set, this field must be a valid UTF-8 string and no longer than 650
+ # characters.
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # 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.
- "section": "A String", # Section of the course. For example, "Period 2". If set, this field must be a valid UTF-8 string and no longer than 2800 characters.
- "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
- "id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
- },
- "creationTime": "A String", # Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.
- "name": "A String", # Name of the course. For example, "10th Grade Biology". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.
- "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.
- "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course. Read-only.
- { # A set of materials that appears on the "About" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.
+ "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.
+ "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.
+ "creationTime": "A String", # Creation time of the course.
+ # Specifying this field in a course update mask results in an error.
+ #
+ # Read-only.
+ "section": "A String", # Section of the course.
+ # For example, "Period 2".
+ # If set, this field must be a valid UTF-8 string and no longer than 2800
+ # characters.
+ "guardiansEnabled": True or False, # Whether or not guardian notifications are enabled for this course.
+ #
+ # Read-only.
+ "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "name": "A String", # Name of the course.
+ # For example, "10th Grade Biology".
+ # The name is required. It must be between 1 and 750 characters and a valid
+ # UTF-8 string.
+ "teacherGroupEmail": "A String", # The email address of a Google group containing all teachers of the course.
+ # This group does not accept email and can only be used for permissions.
+ #
+ # Read-only.
+ "courseMaterialSets": [ # Sets of materials that appear on the "about" page of this course.
+ #
+ # Read-only.
+ { # A set of materials that appears on the "About" page of the course.
+ # These materials might include a syllabus, schedule, or other background
+ # information relating to the course as a whole.
"materials": [ # Materials attached to this set.
{ # A material attached to a course as part of a material set.
"link": { # URL item. # Link atatchment.
- "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only.
- "title": "A String", # Title of the target of the URL. Read-only.
+ "url": "A String", # URL to link to.
+ # This must be a valid UTF-8 string containing between 1 and 2024 characters.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL.
+ #
+ # Read-only.
+ "title": "A String", # Title of the target of the URL.
+ #
+ # Read-only.
},
"driveFile": { # Representation of a Google Drive file. # Google Drive file attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive item.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive item. Read-only.
+ "title": "A String", # Title of the Drive item.
+ #
+ # Read-only.
},
"youTubeVideo": { # YouTube video item. # Youtube video attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only.
- "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only.
+ "alternateLink": "A String", # URL that can be used to view the YouTube video.
+ #
+ # Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video.
+ #
+ # Read-only.
"id": "A String", # YouTube API resource ID.
- "title": "A String", # Title of the YouTube video. Read-only.
+ "title": "A String", # Title of the YouTube video.
+ #
+ # Read-only.
},
"form": { # Google Forms item. # Google Forms attachment.
- "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only.
"formUrl": "A String", # URL of the form.
- "responseUrl": "A String", # URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.
- "title": "A String", # Title of the Form. Read-only.
+ "thumbnailUrl": "A String", # URL of a thumbnail image of the Form.
+ #
+ # Read-only.
+ "responseUrl": "A String", # URL of the form responses document.
+ # Only set if respsonses have been recorded and only when the
+ # requesting user is an editor of the form.
+ #
+ # Read-only.
+ "title": "A String", # Title of the Form.
+ #
+ # Read-only.
},
},
],
"title": "A String", # Title for this set.
},
],
- "courseState": "A String", # State of the course. If unspecified, the default state is `PROVISIONED`.
- "courseGroupEmail": "A String", # The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.
- "ownerId": "A String", # The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. 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 This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.
- "id": "A String", # Identifier for this course assigned by Classroom. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.
- "descriptionHeading": "A String", # Optional heading for the description. For example, "Welcome to 10th Grade Biology." If set, this field must be a valid UTF-8 string and no longer than 3600 characters.
- "room": "A String", # Optional room location. For example, "301". If set, this field must be a valid UTF-8 string and no longer than 650 characters.
+ "teacherFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder that is shared with all teachers of the
+ # course.
+ #
+ # This field will only be set for teachers of the course and domain administrators.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
+ "id": "A String", # Drive API resource ID.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
+ },
+ "courseState": "A String", # State of the course.
+ # If unspecified, the default state is `PROVISIONED`.
+ "ownerId": "A String", # The identifier of the owner of a course.
+ #
+ # When specified as a parameter of a
+ # create course request, this
+ # field is required.
+ # 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
+ #
+ # This must be set in a create request. Specifying this field in a course
+ # update mask results in an `INVALID_ARGUMENT` error.
+ "id": "A String", # Identifier for this course assigned by Classroom.
+ #
+ # When
+ # creating a course,
+ # you may optionally set this identifier to an
+ # alias string in the
+ # request to create a corresponding alias. The `id` is still assigned by
+ # Classroom and cannot be updated after the course is created.
+ #
+ # Specifying this field in a course update mask results in an error.
+ "descriptionHeading": "A String", # Optional heading for the description.
+ # For example, "Welcome to 10th Grade Biology."
+ # If set, this field must be a valid UTF-8 string and no longer than 3600
+ # characters.
+ "room": "A String", # Optional room location.
+ # For example, "301".
+ # If set, this field must be a valid UTF-8 string and no longer than 650
+ # characters.
}</pre>
</div>
diff --git a/docs/dyn/classroom_v1.courses.students.html b/docs/dyn/classroom_v1.courses.students.html
index 21978e3..45cf092 100644
--- a/docs/dyn/classroom_v1.courses.students.html
+++ b/docs/dyn/classroom_v1.courses.students.html
@@ -75,182 +75,405 @@
<h1><a href="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.courses.html">courses</a> . <a href="classroom_v1.courses.students.html">students</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(courseId, body, enrollmentCode=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.</p>
+ <code><a href="#create">create(courseId=None, body, enrollmentCode=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Adds a user as a student of a course.</p>
<p class="toc_element">
- <code><a href="#delete">delete(courseId, userId, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.</p>
+ <code><a href="#delete">delete(courseId=None, userId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a student of a course.</p>
<p class="toc_element">
- <code><a href="#get">get(courseId, userId, x__xgafv=None)</a></code></p>
-<p class="firstline">Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.</p>
+ <code><a href="#get">get(courseId=None, userId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns a student of a course.</p>
<p class="toc_element">
- <code><a href="#list">list(courseId, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p>
-<p class="firstline">Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.</p>
+ <code><a href="#list">list(courseId=None, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p>
+<p class="firstline">Returns a list of students of this course that the requester</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(courseId, body, enrollmentCode=None, x__xgafv=None)</code>
- <pre>Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.
+ <code class="details" id="create">create(courseId=None, body, enrollmentCode=None, x__xgafv=None)</code>
+ <pre>Adds a user as a student of a course.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to create
+students in this course or for access errors.
+* `NOT_FOUND` if the requested course ID does not exist.
+* `FAILED_PRECONDITION` if the requested user's account is disabled,
+for the following request errors:
+ * CourseMemberLimitReached
+ * CourseNotModifiable
+ * UserGroupsMembershipLimitReached
+* `ALREADY_EXISTS` if the user is already a student or teacher in the
+course.
Args:
- courseId: string, Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ courseId: string, Identifier of the course to create the student in.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Student in a course.
- "courseId": "A String", # Identifier of the course. Read-only.
- "profile": { # Global information for a user. # Global user information for the student. Read-only.
- "permissions": [ # Global permissions of the user. Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
+ "profile": { # Global information for a user. # Global user information for the student.
+ #
+ # Read-only.
+ "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.
+ },
+ "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.
- },
},
- "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course.
+ # Only visible to the student and domain administrators.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
},
- "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this 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
+ "userId": "A String", # Identifier of the user.
+ #
+ # When specified as a parameter of a request, this 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
}
- enrollmentCode: string, Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.
+ enrollmentCode: string, Enrollment code of the course to create the student in.
+This code is required if userId
+corresponds to the requesting user; it may be omitted if the requesting
+user has administrative permissions to create students for any user.
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Student in a course.
- "courseId": "A String", # Identifier of the course. Read-only.
- "profile": { # Global information for a user. # Global user information for the student. Read-only.
- "permissions": [ # Global permissions of the user. Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
+ "profile": { # Global information for a user. # Global user information for the student.
+ #
+ # Read-only.
+ "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.
+ },
+ "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.
- },
},
- "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course.
+ # Only visible to the student and domain administrators.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
},
- "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this 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
+ "userId": "A String", # Identifier of the user.
+ #
+ # When specified as a parameter of a request, this 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
}</pre>
</div>
<div class="method">
- <code class="details" id="delete">delete(courseId, userId, x__xgafv=None)</code>
- <pre>Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.
+ <code class="details" id="delete">delete(courseId=None, userId=None, x__xgafv=None)</code>
+ <pre>Deletes a student of a course.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to delete
+students of this course or for access errors.
+* `NOT_FOUND` if no student of this course has the requested ID or if the
+course does not exist.
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
- userId: string, Identifier of the student to delete. 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 (required)
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
+ userId: string, Identifier of the student to delete. 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 (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(courseId, userId, x__xgafv=None)</code>
- <pre>Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.
+ <code class="details" id="get">get(courseId=None, userId=None, x__xgafv=None)</code>
+ <pre>Returns a student of a course.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to view
+students of this course or for access errors.
+* `NOT_FOUND` if no student of this course has the requested ID or if the
+course does not exist.
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
- userId: string, Identifier of the student to return. 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 (required)
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
+ userId: string, Identifier of the student to return. 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 (required)
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Student in a course.
- "courseId": "A String", # Identifier of the course. Read-only.
- "profile": { # Global information for a user. # Global user information for the student. Read-only.
- "permissions": [ # Global permissions of the user. Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
+ "profile": { # Global information for a user. # Global user information for the student.
+ #
+ # Read-only.
+ "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.
+ },
+ "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.
- },
},
- "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course.
+ # Only visible to the student and domain administrators.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
},
- "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this 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
+ "userId": "A String", # Identifier of the user.
+ #
+ # When specified as a parameter of a request, this 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
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(courseId, pageSize=None, x__xgafv=None, pageToken=None)</code>
- <pre>Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.
+ <code class="details" id="list">list(courseId=None, pageSize=None, x__xgafv=None, pageToken=None)</code>
+ <pre>Returns a list of students of this course that the requester
+is permitted to view.
+
+This method returns the following error codes:
+
+* `NOT_FOUND` if the course does not exist.
+* `PERMISSION_DENIED` for access errors.
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
- pageSize: integer, Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
+ pageSize: integer, Maximum number of items to return. Zero means no maximum.
+
+The server may return fewer than the specified number of results.
x__xgafv: string, V1 error format.
- 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.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ 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.
Returns:
An object of the form:
{ # Response when listing students.
+ "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
+ # results are available.
"students": [ # Students who match the list request.
{ # Student in a course.
- "courseId": "A String", # Identifier of the course. Read-only.
- "profile": { # Global information for a user. # Global user information for the student. Read-only.
- "permissions": [ # Global permissions of the user. Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
+ "profile": { # Global information for a user. # Global user information for the student.
+ #
+ # Read-only.
+ "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.
+ },
+ "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.
- },
},
- "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only.
- "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only.
+ "studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course.
+ # Only visible to the student and domain administrators.
+ #
+ # Read-only.
+ "alternateLink": "A String", # URL that can be used to access the Drive folder.
+ #
+ # Read-only.
"id": "A String", # Drive API resource ID.
- "title": "A String", # Title of the Drive folder. Read-only.
+ "title": "A String", # Title of the Drive folder.
+ #
+ # Read-only.
},
- "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this 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
+ "userId": "A String", # Identifier of the user.
+ #
+ # When specified as a parameter of a request, this 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
},
],
- "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
}</pre>
</div>
diff --git a/docs/dyn/classroom_v1.courses.teachers.html b/docs/dyn/classroom_v1.courses.teachers.html
index 7fda74e..896454b 100644
--- a/docs/dyn/classroom_v1.courses.teachers.html
+++ b/docs/dyn/classroom_v1.courses.teachers.html
@@ -75,159 +75,354 @@
<h1><a href="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.courses.html">courses</a> . <a href="classroom_v1.courses.teachers.html">teachers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(courseId, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.</p>
+ <code><a href="#create">create(courseId=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a teacher of a course.</p>
<p class="toc_element">
- <code><a href="#delete">delete(courseId, userId, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.</p>
+ <code><a href="#delete">delete(courseId=None, userId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a teacher of a course.</p>
<p class="toc_element">
- <code><a href="#get">get(courseId, userId, x__xgafv=None)</a></code></p>
-<p class="firstline">Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.</p>
+ <code><a href="#get">get(courseId=None, userId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns a teacher of a course.</p>
<p class="toc_element">
- <code><a href="#list">list(courseId, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p>
-<p class="firstline">Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.</p>
+ <code><a href="#list">list(courseId=None, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p>
+<p class="firstline">Returns a list of teachers of this course that the requester</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(courseId, body, x__xgafv=None)</code>
- <pre>Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.
+ <code class="details" id="create">create(courseId=None, body, x__xgafv=None)</code>
+ <pre>Creates a teacher of a course.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to create
+teachers in this course or for access errors.
+* `NOT_FOUND` if the requested course ID does not exist.
+* `FAILED_PRECONDITION` if the requested user's account is disabled,
+for the following request errors:
+ * CourseMemberLimitReached
+ * CourseNotModifiable
+ * CourseTeacherLimitReached
+ * UserGroupsMembershipLimitReached
+* `ALREADY_EXISTS` if the user is already a teacher or student in the
+course.
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Teacher of a course.
- "courseId": "A String", # Identifier of the course. Read-only.
- "profile": { # Global information for a user. # Global user information for the teacher. Read-only.
- "permissions": [ # Global permissions of the user. Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
+ "profile": { # Global information for a user. # Global user information for the teacher.
+ #
+ # Read-only.
+ "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.
+ },
+ "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.
- },
},
- "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this 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
+ "userId": "A String", # Identifier of the user.
+ #
+ # When specified as a parameter of a request, this 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
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Teacher of a course.
- "courseId": "A String", # Identifier of the course. Read-only.
- "profile": { # Global information for a user. # Global user information for the teacher. Read-only.
- "permissions": [ # Global permissions of the user. Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
+ "profile": { # Global information for a user. # Global user information for the teacher.
+ #
+ # Read-only.
+ "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.
+ },
+ "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.
- },
},
- "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this 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
+ "userId": "A String", # Identifier of the user.
+ #
+ # When specified as a parameter of a request, this 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
}</pre>
</div>
<div class="method">
- <code class="details" id="delete">delete(courseId, userId, x__xgafv=None)</code>
- <pre>Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.
+ <code class="details" id="delete">delete(courseId=None, userId=None, x__xgafv=None)</code>
+ <pre>Deletes a teacher of a course.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to delete
+teachers of this course or for access errors.
+* `NOT_FOUND` if no teacher of this course has the requested ID or if the
+course does not exist.
+* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher
+of this course.
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
- userId: string, Identifier of the teacher to delete. 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 (required)
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
+ userId: string, Identifier of the teacher to delete. 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 (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(courseId, userId, x__xgafv=None)</code>
- <pre>Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.
+ <code class="details" id="get">get(courseId=None, userId=None, x__xgafv=None)</code>
+ <pre>Returns a teacher of a course.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to view
+teachers of this course or for access errors.
+* `NOT_FOUND` if no teacher of this course has the requested ID or if the
+course does not exist.
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
- userId: string, Identifier of the teacher to return. 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 (required)
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
+ userId: string, Identifier of the teacher to return. 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 (required)
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Teacher of a course.
- "courseId": "A String", # Identifier of the course. Read-only.
- "profile": { # Global information for a user. # Global user information for the teacher. Read-only.
- "permissions": [ # Global permissions of the user. Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
+ "profile": { # Global information for a user. # Global user information for the teacher.
+ #
+ # Read-only.
+ "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.
+ },
+ "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.
- },
},
- "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this 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
+ "userId": "A String", # Identifier of the user.
+ #
+ # When specified as a parameter of a request, this 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
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(courseId, pageSize=None, x__xgafv=None, pageToken=None)</code>
- <pre>Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.
+ <code class="details" id="list">list(courseId=None, pageSize=None, x__xgafv=None, pageToken=None)</code>
+ <pre>Returns a list of teachers of this course that the requester
+is permitted to view.
+
+This method returns the following error codes:
+
+* `NOT_FOUND` if the course does not exist.
+* `PERMISSION_DENIED` for access errors.
Args:
- courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
- pageSize: integer, Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
+ courseId: string, Identifier of the course.
+This identifier can be either the Classroom-assigned identifier or an
+alias. (required)
+ pageSize: integer, Maximum number of items to return. Zero means no maximum.
+
+The server may return fewer than the specified number of results.
x__xgafv: string, V1 error format.
- 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.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ 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.
Returns:
An object of the form:
{ # Response when listing teachers.
- "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
+ "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
+ # results are available.
"teachers": [ # Teachers who match the list request.
{ # Teacher of a course.
- "courseId": "A String", # Identifier of the course. Read-only.
- "profile": { # Global information for a user. # Global user information for the teacher. Read-only.
- "permissions": [ # Global permissions of the user. Read-only.
+ "courseId": "A String", # Identifier of the course.
+ #
+ # Read-only.
+ "profile": { # Global information for a user. # Global user information for the teacher.
+ #
+ # Read-only.
+ "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.
+ },
+ "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.
- },
},
- "userId": "A String", # Identifier of the user. When specified as a parameter of a request, this 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
+ "userId": "A String", # Identifier of the user.
+ #
+ # When specified as a parameter of a request, this 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
},
],
}</pre>
diff --git a/docs/dyn/classroom_v1.invitations.html b/docs/dyn/classroom_v1.invitations.html
index 326de59..078d83b 100644
--- a/docs/dyn/classroom_v1.invitations.html
+++ b/docs/dyn/classroom_v1.invitations.html
@@ -76,41 +76,76 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#accept">accept(id, x__xgafv=None)</a></code></p>
-<p class="firstline">Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.</p>
+<p class="firstline">Accepts an invitation, removing it and adding the invited user to the</p>
<p class="toc_element">
<code><a href="#create">create(body, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.</p>
+<p class="firstline">Creates an invitation. Only one invitation for a user and course may exist</p>
<p class="toc_element">
<code><a href="#delete">delete(id, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.</p>
+<p class="firstline">Deletes an invitation.</p>
<p class="toc_element">
<code><a href="#get">get(id, x__xgafv=None)</a></code></p>
-<p class="firstline">Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.</p>
+<p class="firstline">Returns an invitation.</p>
<p class="toc_element">
<code><a href="#list">list(pageSize=None, courseId=None, userId=None, x__xgafv=None, pageToken=None)</a></code></p>
-<p class="firstline">Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.</p>
+<p class="firstline">Returns a list of invitations that the requesting user is permitted to</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="accept">accept(id, x__xgafv=None)</code>
- <pre>Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.
+ <pre>Accepts an invitation, removing it and adding the invited user to the
+teachers or students (as appropriate) of the specified course. Only the
+invited user may accept an invitation.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to accept the
+requested invitation or for access errors.
+* `FAILED_PRECONDITION` for the following request errors:
+ * CourseMemberLimitReached
+ * CourseNotModifiable
+ * CourseTeacherLimitReached
+ * UserGroupsMembershipLimitReached
+* `NOT_FOUND` if no invitation exists with the requested ID.
Args:
id: string, Identifier of the invitation to accept. (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="create">create(body, x__xgafv=None)</code>
- <pre>Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.
+ <pre>Creates an invitation. Only one invitation for a user and course may exist
+at a time. Delete and re-create an invitation to make changes.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to create
+invitations for this course or for access errors.
+* `NOT_FOUND` if the course or the user does not exist.
+* `FAILED_PRECONDITION` if the requested user's account is disabled or if
+the user already has this role or a role with greater permissions.
+* `ALREADY_EXISTS` if an invitation for the specified user and course
+already exists.
Args:
body: object, The request body. (required)
@@ -118,80 +153,175 @@
{ # An invitation to join a course.
"courseId": "A String", # Identifier of the course to invite the user to.
- "role": "A String", # Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.
- "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
- "id": "A String", # Identifier assigned by Classroom. Read-only.
+ "userId": "A String", # Identifier of the invited user.
+ #
+ # When specified as a parameter of a request, this identifier can be set to
+ # one of the following:
+ #
+ # * the numeric identifier for the user
+ # * the email address of the user
+ # * the string literal `"me"`, indicating the requesting user
+ "role": "A String", # Role to invite the user to have.
+ # Must not be `COURSE_ROLE_UNSPECIFIED`.
+ "id": "A String", # Identifier assigned by Classroom.
+ #
+ # Read-only.
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # An invitation to join a course.
"courseId": "A String", # Identifier of the course to invite the user to.
- "role": "A String", # Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.
- "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
- "id": "A String", # Identifier assigned by Classroom. Read-only.
+ "userId": "A String", # Identifier of the invited user.
+ #
+ # When specified as a parameter of a request, this identifier can be set to
+ # one of the following:
+ #
+ # * the numeric identifier for the user
+ # * the email address of the user
+ # * the string literal `"me"`, indicating the requesting user
+ "role": "A String", # Role to invite the user to have.
+ # Must not be `COURSE_ROLE_UNSPECIFIED`.
+ "id": "A String", # Identifier assigned by Classroom.
+ #
+ # Read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(id, x__xgafv=None)</code>
- <pre>Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.
+ <pre>Deletes an invitation.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to delete the
+requested invitation or for access errors.
+* `NOT_FOUND` if no invitation exists with the requested ID.
Args:
id: string, Identifier of the invitation to delete. (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(id, x__xgafv=None)</code>
- <pre>Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.
+ <pre>Returns an invitation.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to view the
+requested invitation or for access errors.
+* `NOT_FOUND` if no invitation exists with the requested ID.
Args:
id: string, Identifier of the invitation to return. (required)
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # An invitation to join a course.
"courseId": "A String", # Identifier of the course to invite the user to.
- "role": "A String", # Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.
- "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
- "id": "A String", # Identifier assigned by Classroom. Read-only.
+ "userId": "A String", # Identifier of the invited user.
+ #
+ # When specified as a parameter of a request, this identifier can be set to
+ # one of the following:
+ #
+ # * the numeric identifier for the user
+ # * the email address of the user
+ # * the string literal `"me"`, indicating the requesting user
+ "role": "A String", # Role to invite the user to have.
+ # Must not be `COURSE_ROLE_UNSPECIFIED`.
+ "id": "A String", # Identifier assigned by Classroom.
+ #
+ # Read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageSize=None, courseId=None, userId=None, x__xgafv=None, pageToken=None)</code>
- <pre>Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.
+ <pre>Returns a list of invitations that the requesting user is permitted to
+view, restricted to those that match the list request.
+
+*Note:* At least one of `user_id` or `course_id` must be supplied. Both
+fields can be supplied.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` for access errors.
Args:
- pageSize: integer, Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
- courseId: string, Restricts returned invitations to those for a course with the specified identifier.
- userId: string, Restricts returned invitations to those for a specific user. 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 means no maximum.
+
+The server may return fewer than the specified number of results.
+ courseId: string, Restricts returned invitations to those for a course with the specified
+identifier.
+ userId: string, Restricts returned invitations to those for a specific user. 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
x__xgafv: string, V1 error format.
- 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.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ 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.
Returns:
An object of the form:
{ # Response when listing invitations.
- "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
+ "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
+ # results are available.
"invitations": [ # Invitations that match the list request.
{ # An invitation to join a course.
"courseId": "A String", # Identifier of the course to invite the user to.
- "role": "A String", # Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.
- "userId": "A String", # Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
- "id": "A String", # Identifier assigned by Classroom. Read-only.
+ "userId": "A String", # Identifier of the invited user.
+ #
+ # When specified as a parameter of a request, this identifier can be set to
+ # one of the following:
+ #
+ # * the numeric identifier for the user
+ # * the email address of the user
+ # * the string literal `"me"`, indicating the requesting user
+ "role": "A String", # Role to invite the user to have.
+ # Must not be `COURSE_ROLE_UNSPECIFIED`.
+ "id": "A String", # Identifier assigned by Classroom.
+ #
+ # Read-only.
},
],
}</pre>
diff --git a/docs/dyn/classroom_v1.userProfiles.guardianInvitations.html b/docs/dyn/classroom_v1.userProfiles.guardianInvitations.html
index f9a6e16..368bcd1 100644
--- a/docs/dyn/classroom_v1.userProfiles.guardianInvitations.html
+++ b/docs/dyn/classroom_v1.userProfiles.guardianInvitations.html
@@ -76,95 +76,205 @@
<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="firstline">Creates a guardian invitation, and sends an email to the guardian asking</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="firstline">Returns a specific guardian invitation.</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>
+ <code><a href="#list">list(studentId=None, 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</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>
+<p class="firstline">Modifies a guardian invitation.</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.
+ <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.
+{ # An invitation to become the guardian of a specified user, sent to a specified
+ # email address.
"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.
+ "invitationId": "A String", # Unique identifier for this invitation.
+ #
+ # Read-only.
+ "invitedEmailAddress": "A String", # Email address that the invitation was sent to.
+ # This field is only visible to domain administrators.
+ "creationTime": "A String", # The time that this invitation was created.
+ #
+ # Read-only.
"state": "A String", # The state that this invitation is in.
}
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 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.
+ { # An invitation to become the guardian of a specified user, sent to a specified
+ # email address.
"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.
+ "invitationId": "A String", # Unique identifier for this invitation.
+ #
+ # Read-only.
+ "invitedEmailAddress": "A String", # Email address that the invitation was sent to.
+ # This field is only visible to domain administrators.
+ "creationTime": "A String", # The time that this invitation was created.
+ #
+ # Read-only.
"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.
+ <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.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 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.
+ { # An invitation to become the guardian of a specified user, sent to a specified
+ # email address.
"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.
+ "invitationId": "A String", # Unique identifier for this invitation.
+ #
+ # Read-only.
+ "invitedEmailAddress": "A String", # Email address that the invitation was sent to.
+ # This field is only visible to domain administrators.
+ "creationTime": "A String", # The time that this invitation was created.
+ #
+ # Read-only.
"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.
+ <code class="details" id="list">list(studentId=None, 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.
+ 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.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 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.
+ "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.
+ { # An invitation to become the guardian of a specified user, sent to a specified
+ # email address.
"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.
+ "invitationId": "A String", # Unique identifier for this invitation.
+ #
+ # Read-only.
+ "invitedEmailAddress": "A String", # Email address that the invitation was sent to.
+ # This field is only visible to domain administrators.
+ "creationTime": "A String", # The time that this invitation was created.
+ #
+ # Read-only.
"state": "A String", # The state that this invitation is in.
},
],
@@ -187,7 +297,24 @@
<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.
+ <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)
@@ -195,25 +322,48 @@
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.
+{ # An invitation to become the guardian of a specified user, sent to a specified
+ # email address.
"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.
+ "invitationId": "A String", # Unique identifier for this invitation.
+ #
+ # Read-only.
+ "invitedEmailAddress": "A String", # Email address that the invitation was sent to.
+ # This field is only visible to domain administrators.
+ "creationTime": "A String", # The time that this invitation was created.
+ #
+ # Read-only.
"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=,,...`
+ 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=<field1>,<field2>,...`
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 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.
+ { # An invitation to become the guardian of a specified user, sent to a specified
+ # email address.
"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.
+ "invitationId": "A String", # Unique identifier for this invitation.
+ #
+ # Read-only.
+ "invitedEmailAddress": "A String", # Email address that the invitation was sent to.
+ # This field is only visible to domain administrators.
+ "creationTime": "A String", # The time that this invitation was created.
+ #
+ # Read-only.
"state": "A String", # The state that this invitation is in.
}</pre>
</div>
diff --git a/docs/dyn/classroom_v1.userProfiles.guardians.html b/docs/dyn/classroom_v1.userProfiles.guardians.html
index eb3f628..d6b335f 100644
--- a/docs/dyn/classroom_v1.userProfiles.guardians.html
+++ b/docs/dyn/classroom_v1.userProfiles.guardians.html
@@ -75,104 +75,237 @@
<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 no user that matches the provided `student_id` is visible to the requesting user, 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 the requesting user is permitted to modify guardians for the requested `student_id`, but no `Guardian` record exists for that student with the provided `guardian_id`.</p>
+ <code><a href="#delete">delete(studentId=None, guardianId, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a guardian.</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 no user that matches the provided `student_id` is visible to the requesting user, 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 the requesting user is permitted to view guardians for the requested `student_id`, but no `Guardian` record exists for that student that matches the provided `guardian_id`.</p>
+ <code><a href="#get">get(studentId=None, guardianId, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns a specific guardian.</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>
+ <code><a href="#list">list(studentId=None, 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</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 no user that matches the provided `student_id` is visible to the requesting user, 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 the requesting user is permitted to modify guardians for the requested `student_id`, but no `Guardian` record exists for that student with the provided `guardian_id`.
+ <code class="details" id="delete">delete(studentId=None, 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 no user that matches the provided `student_id`
+ is visible to the requesting user, 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 the requesting user is permitted to modify guardians for
+ the requested `student_id`, but no `Guardian` record exists for that
+ student with the provided `guardian_id`.
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)
+ 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.
+ 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(studentId, guardianId, x__xgafv=None)</code>
- <pre>Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, 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 the requesting user is permitted to view guardians for the requested `student_id`, but no `Guardian` record exists for that student that matches the provided `guardian_id`.
+ <code class="details" id="get">get(studentId=None, guardianId, x__xgafv=None)</code>
+ <pre>Returns a specific guardian.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if no user that matches the provided `student_id`
+ is visible to the requesting user, 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 the requesting user is permitted to view guardians for
+ the requested `student_id`, but no `Guardian` record exists for that
+ student that matches the provided `guardian_id`.
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)
+ 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.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 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.
+ { # Association between a student and a guardian of that student. The guardian
+ # may receive information about the student's course work.
+ "studentId": "A String", # Identifier for the student to whom the guardian relationship applies.
"guardianId": "A String", # Identifier for the guardian.
+ "invitedEmailAddress": "A String", # The email address to which the initial guardian invitation was sent.
+ # This field is only visible to domain administrators.
"guardianProfile": { # Global information for a user. # User profile for the guardian.
- "permissions": [ # Global permissions of the user. Read-only.
+ "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.
+ },
+ "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.
+ <code class="details" id="list">list(studentId=None, 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.
+ 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.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 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.
+ "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.
+ "studentId": "A String", # Identifier for the student to whom the guardian relationship applies.
"guardianId": "A String", # Identifier for the guardian.
+ "invitedEmailAddress": "A String", # The email address to which the initial guardian invitation was sent.
+ # This field is only visible to domain administrators.
"guardianProfile": { # Global information for a user. # User profile for the guardian.
- "permissions": [ # Global permissions of the user. Read-only.
+ "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.
+ },
+ "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>
diff --git a/docs/dyn/classroom_v1.userProfiles.html b/docs/dyn/classroom_v1.userProfiles.html
index da139a5..7eefd0e 100644
--- a/docs/dyn/classroom_v1.userProfiles.html
+++ b/docs/dyn/classroom_v1.userProfiles.html
@@ -85,34 +85,65 @@
<p class="firstline">Returns the guardians Resource.</p>
<p class="toc_element">
- <code><a href="#get">get(userId, x__xgafv=None)</a></code></p>
-<p class="firstline">Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors.</p>
+ <code><a href="#get">get(userId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns a user profile.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="get">get(userId, x__xgafv=None)</code>
- <pre>Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors.
+ <code class="details" id="get">get(userId=None, x__xgafv=None)</code>
+ <pre>Returns a user profile.
+
+This method returns the following error codes:
+
+* `PERMISSION_DENIED` if the requesting user is not permitted to access
+this user profile, if no profile exists with the requested ID, or for
+access errors.
Args:
- userId: string, Identifier of the profile to return. 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 (required)
+ userId: string, Identifier of the profile to return. 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 (required)
x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # Global information for a user.
- "permissions": [ # Global permissions of the user. Read-only.
+ "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.
+ },
+ "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.
- },
}</pre>
</div>
diff --git a/docs/dyn/cloudbuild_v1.operations.html b/docs/dyn/cloudbuild_v1.operations.html
index cd0b53c..d6c21f0 100644
--- a/docs/dyn/cloudbuild_v1.operations.html
+++ b/docs/dyn/cloudbuild_v1.operations.html
@@ -256,7 +256,6 @@
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.
@@ -347,6 +346,7 @@
# `name` should have the format of `operations/some/unique/name`.
},
],
+ "nextPageToken": "A String", # The standard List next-page token.
}</pre>
</div>
diff --git a/docs/dyn/cloudbuild_v1.projects.builds.html b/docs/dyn/cloudbuild_v1.projects.builds.html
index 3aa52c4..87c4873 100644
--- a/docs/dyn/cloudbuild_v1.projects.builds.html
+++ b/docs/dyn/cloudbuild_v1.projects.builds.html
@@ -160,11 +160,23 @@
},
"statusDetail": "A String", # Customer-readable message about the current status.
# @OutputOnly
- "substitutions": { # Substitutions data for Build resource.
- "a_key": "A String",
+ "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
+ "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
+ "A String",
+ ],
},
"source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
# service.
+ "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
+ },
"storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
# Storage.
# Google Cloud Storage.
@@ -178,33 +190,17 @@
# [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
- "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
- },
},
"buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
# triggered automatically.
# @OutputOnly
- "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Requested verifiability options.
- "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
- "A String",
- ],
- },
"steps": [ # Describes the operations to be performed on the workspace.
{ # BuildStep describes a step to perform in the build pipeline.
- "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.
+ "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
+ # This build step will not start until all the build steps in wait_for
+ # have completed successfully. If wait_for is empty, this build step will
+ # start when all previous build steps in the Build.Steps list have completed
+ # successfully.
"A String",
],
"name": "A String", # The name of the container image that will run this particular build step.
@@ -215,19 +211,20 @@
#
# 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.
+ # ([https://github.com/GoogleCloudPlatform/cloud-builders](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.
- "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
- # This build step will not start until all the build steps in wait_for
- # have completed successfully. If wait_for is empty, this build step will
- # start when all previous build steps in the Build.Steps list have completed
- # successfully.
+ "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",
],
"entrypoint": "A String", # Optional entrypoint to be used instead of the build step image's default
@@ -247,18 +244,15 @@
"sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
# @OutputOnly
# some source was used for this build.
- "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
- # generations resolved.
- # Google Cloud Storage.
- "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
- # omitted, the latest generation will be used.
- "object": "A String", # Google Cloud Storage object containing source.
- #
- # This object must be a gzipped archive file (.tar.gz) containing source to
- # build.
- "bucket": "A String", # Google Cloud Storage bucket containing source (see
- # [Bucket Name
- # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+ "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
+ # revisions resolved.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
},
"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
# source integrity was maintained in the build. Note that FileHashes will
@@ -280,15 +274,18 @@
],
},
},
- "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
- # revisions resolved.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
+ # generations resolved.
+ # Google Cloud Storage.
+ "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
+ # omitted, the latest generation will be used.
+ "object": "A String", # Google Cloud Storage object containing source.
+ #
+ # This object must be a gzipped archive file (.tar.gz) containing source to
+ # build.
+ "bucket": "A String", # Google Cloud Storage bucket containing source (see
+ # [Bucket Name
+ # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
},
"logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
@@ -306,6 +303,9 @@
# If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
+ "substitutions": { # Substitutions data for Build resource.
+ "a_key": "A String",
+ },
"createTime": "A String", # Time at which the request to create the build was received.
# @OutputOnly
"logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
@@ -375,11 +375,23 @@
},
"statusDetail": "A String", # Customer-readable message about the current status.
# @OutputOnly
- "substitutions": { # Substitutions data for Build resource.
- "a_key": "A String",
+ "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
+ "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
+ "A String",
+ ],
},
"source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
# service.
+ "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
+ },
"storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
# Storage.
# Google Cloud Storage.
@@ -393,33 +405,17 @@
# [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
- "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
- },
},
"buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
# triggered automatically.
# @OutputOnly
- "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Requested verifiability options.
- "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
- "A String",
- ],
- },
"steps": [ # Describes the operations to be performed on the workspace.
{ # BuildStep describes a step to perform in the build pipeline.
- "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.
+ "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
+ # This build step will not start until all the build steps in wait_for
+ # have completed successfully. If wait_for is empty, this build step will
+ # start when all previous build steps in the Build.Steps list have completed
+ # successfully.
"A String",
],
"name": "A String", # The name of the container image that will run this particular build step.
@@ -430,19 +426,20 @@
#
# 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.
+ # ([https://github.com/GoogleCloudPlatform/cloud-builders](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.
- "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
- # This build step will not start until all the build steps in wait_for
- # have completed successfully. If wait_for is empty, this build step will
- # start when all previous build steps in the Build.Steps list have completed
- # successfully.
+ "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",
],
"entrypoint": "A String", # Optional entrypoint to be used instead of the build step image's default
@@ -462,18 +459,15 @@
"sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
# @OutputOnly
# some source was used for this build.
- "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
- # generations resolved.
- # Google Cloud Storage.
- "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
- # omitted, the latest generation will be used.
- "object": "A String", # Google Cloud Storage object containing source.
- #
- # This object must be a gzipped archive file (.tar.gz) containing source to
- # build.
- "bucket": "A String", # Google Cloud Storage bucket containing source (see
- # [Bucket Name
- # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+ "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
+ # revisions resolved.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
},
"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
# source integrity was maintained in the build. Note that FileHashes will
@@ -495,15 +489,18 @@
],
},
},
- "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
- # revisions resolved.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
+ # generations resolved.
+ # Google Cloud Storage.
+ "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
+ # omitted, the latest generation will be used.
+ "object": "A String", # Google Cloud Storage object containing source.
+ #
+ # This object must be a gzipped archive file (.tar.gz) containing source to
+ # build.
+ "bucket": "A String", # Google Cloud Storage bucket containing source (see
+ # [Bucket Name
+ # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
},
"logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
@@ -521,6 +518,9 @@
# If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
+ "substitutions": { # Substitutions data for Build resource.
+ "a_key": "A String",
+ },
"createTime": "A String", # Time at which the request to create the build was received.
# @OutputOnly
"logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
@@ -692,11 +692,23 @@
},
"statusDetail": "A String", # Customer-readable message about the current status.
# @OutputOnly
- "substitutions": { # Substitutions data for Build resource.
- "a_key": "A String",
+ "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
+ "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
+ "A String",
+ ],
},
"source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
# service.
+ "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
+ },
"storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
# Storage.
# Google Cloud Storage.
@@ -710,33 +722,17 @@
# [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
- "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
- },
},
"buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
# triggered automatically.
# @OutputOnly
- "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Requested verifiability options.
- "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
- "A String",
- ],
- },
"steps": [ # Describes the operations to be performed on the workspace.
{ # BuildStep describes a step to perform in the build pipeline.
- "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.
+ "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
+ # This build step will not start until all the build steps in wait_for
+ # have completed successfully. If wait_for is empty, this build step will
+ # start when all previous build steps in the Build.Steps list have completed
+ # successfully.
"A String",
],
"name": "A String", # The name of the container image that will run this particular build step.
@@ -747,19 +743,20 @@
#
# 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.
+ # ([https://github.com/GoogleCloudPlatform/cloud-builders](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.
- "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
- # This build step will not start until all the build steps in wait_for
- # have completed successfully. If wait_for is empty, this build step will
- # start when all previous build steps in the Build.Steps list have completed
- # successfully.
+ "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",
],
"entrypoint": "A String", # Optional entrypoint to be used instead of the build step image's default
@@ -779,18 +776,15 @@
"sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
# @OutputOnly
# some source was used for this build.
- "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
- # generations resolved.
- # Google Cloud Storage.
- "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
- # omitted, the latest generation will be used.
- "object": "A String", # Google Cloud Storage object containing source.
- #
- # This object must be a gzipped archive file (.tar.gz) containing source to
- # build.
- "bucket": "A String", # Google Cloud Storage bucket containing source (see
- # [Bucket Name
- # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+ "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
+ # revisions resolved.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
},
"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
# source integrity was maintained in the build. Note that FileHashes will
@@ -812,15 +806,18 @@
],
},
},
- "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
- # revisions resolved.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
+ # generations resolved.
+ # Google Cloud Storage.
+ "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
+ # omitted, the latest generation will be used.
+ "object": "A String", # Google Cloud Storage object containing source.
+ #
+ # This object must be a gzipped archive file (.tar.gz) containing source to
+ # build.
+ "bucket": "A String", # Google Cloud Storage bucket containing source (see
+ # [Bucket Name
+ # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
},
"logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
@@ -838,6 +835,9 @@
# If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
+ "substitutions": { # Substitutions data for Build resource.
+ "a_key": "A String",
+ },
"createTime": "A String", # Time at which the request to create the build was received.
# @OutputOnly
"logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
@@ -917,11 +917,23 @@
},
"statusDetail": "A String", # Customer-readable message about the current status.
# @OutputOnly
- "substitutions": { # Substitutions data for Build resource.
- "a_key": "A String",
+ "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
+ "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
+ "A String",
+ ],
},
"source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
# service.
+ "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
+ },
"storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
# Storage.
# Google Cloud Storage.
@@ -935,33 +947,17 @@
# [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
- "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
- },
},
"buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
# triggered automatically.
# @OutputOnly
- "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Requested verifiability options.
- "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
- "A String",
- ],
- },
"steps": [ # Describes the operations to be performed on the workspace.
{ # BuildStep describes a step to perform in the build pipeline.
- "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.
+ "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
+ # This build step will not start until all the build steps in wait_for
+ # have completed successfully. If wait_for is empty, this build step will
+ # start when all previous build steps in the Build.Steps list have completed
+ # successfully.
"A String",
],
"name": "A String", # The name of the container image that will run this particular build step.
@@ -972,19 +968,20 @@
#
# 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.
+ # ([https://github.com/GoogleCloudPlatform/cloud-builders](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.
- "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
- # This build step will not start until all the build steps in wait_for
- # have completed successfully. If wait_for is empty, this build step will
- # start when all previous build steps in the Build.Steps list have completed
- # successfully.
+ "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",
],
"entrypoint": "A String", # Optional entrypoint to be used instead of the build step image's default
@@ -1004,18 +1001,15 @@
"sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
# @OutputOnly
# some source was used for this build.
- "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
- # generations resolved.
- # Google Cloud Storage.
- "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
- # omitted, the latest generation will be used.
- "object": "A String", # Google Cloud Storage object containing source.
- #
- # This object must be a gzipped archive file (.tar.gz) containing source to
- # build.
- "bucket": "A String", # Google Cloud Storage bucket containing source (see
- # [Bucket Name
- # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+ "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
+ # revisions resolved.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
},
"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
# source integrity was maintained in the build. Note that FileHashes will
@@ -1037,15 +1031,18 @@
],
},
},
- "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
- # revisions resolved.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
+ # generations resolved.
+ # Google Cloud Storage.
+ "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
+ # omitted, the latest generation will be used.
+ "object": "A String", # Google Cloud Storage object containing source.
+ #
+ # This object must be a gzipped archive file (.tar.gz) containing source to
+ # build.
+ "bucket": "A String", # Google Cloud Storage bucket containing source (see
+ # [Bucket Name
+ # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
},
"logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
@@ -1063,6 +1060,9 @@
# If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
+ "substitutions": { # Substitutions data for Build resource.
+ "a_key": "A String",
+ },
"createTime": "A String", # Time at which the request to create the build was received.
# @OutputOnly
"logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
diff --git a/docs/dyn/cloudbuild_v1.projects.triggers.html b/docs/dyn/cloudbuild_v1.projects.triggers.html
index 6ca863a..a22109c 100644
--- a/docs/dyn/cloudbuild_v1.projects.triggers.html
+++ b/docs/dyn/cloudbuild_v1.projects.triggers.html
@@ -104,6 +104,9 @@
{ # Configuration for an automated build in response to source repository
# changes.
"description": "A String", # Human-readable description of this trigger.
+ "createTime": "A String", # Time when the trigger was created.
+ #
+ # @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
@@ -113,17 +116,14 @@
"projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
# the build is assumed.
"branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
"repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "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
+ "disabled": True or False, # If true, the trigger will never result in a build.
"substitutions": { # Substitutions data for Build resource.
"a_key": "A String",
},
- "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
@@ -173,11 +173,23 @@
},
"statusDetail": "A String", # Customer-readable message about the current status.
# @OutputOnly
- "substitutions": { # Substitutions data for Build resource.
- "a_key": "A String",
+ "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
+ "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
+ "A String",
+ ],
},
"source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
# service.
+ "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
+ },
"storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
# Storage.
# Google Cloud Storage.
@@ -191,33 +203,17 @@
# [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
- "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
- },
},
"buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
# triggered automatically.
# @OutputOnly
- "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Requested verifiability options.
- "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
- "A String",
- ],
- },
"steps": [ # Describes the operations to be performed on the workspace.
{ # BuildStep describes a step to perform in the build pipeline.
- "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.
+ "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
+ # This build step will not start until all the build steps in wait_for
+ # have completed successfully. If wait_for is empty, this build step will
+ # start when all previous build steps in the Build.Steps list have completed
+ # successfully.
"A String",
],
"name": "A String", # The name of the container image that will run this particular build step.
@@ -228,19 +224,20 @@
#
# 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.
+ # ([https://github.com/GoogleCloudPlatform/cloud-builders](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.
- "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
- # This build step will not start until all the build steps in wait_for
- # have completed successfully. If wait_for is empty, this build step will
- # start when all previous build steps in the Build.Steps list have completed
- # successfully.
+ "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",
],
"entrypoint": "A String", # Optional entrypoint to be used instead of the build step image's default
@@ -260,18 +257,15 @@
"sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
# @OutputOnly
# some source was used for this build.
- "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
- # generations resolved.
- # Google Cloud Storage.
- "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
- # omitted, the latest generation will be used.
- "object": "A String", # Google Cloud Storage object containing source.
- #
- # This object must be a gzipped archive file (.tar.gz) containing source to
- # build.
- "bucket": "A String", # Google Cloud Storage bucket containing source (see
- # [Bucket Name
- # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+ "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
+ # revisions resolved.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
},
"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
# source integrity was maintained in the build. Note that FileHashes will
@@ -293,15 +287,18 @@
],
},
},
- "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
- # revisions resolved.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
+ # generations resolved.
+ # Google Cloud Storage.
+ "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
+ # omitted, the latest generation will be used.
+ "object": "A String", # Google Cloud Storage object containing source.
+ #
+ # This object must be a gzipped archive file (.tar.gz) containing source to
+ # build.
+ "bucket": "A String", # Google Cloud Storage bucket containing source (see
+ # [Bucket Name
+ # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
},
"logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
@@ -319,6 +316,9 @@
# If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
+ "substitutions": { # Substitutions data for Build resource.
+ "a_key": "A String",
+ },
"createTime": "A String", # Time at which the request to create the build was received.
# @OutputOnly
"logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
@@ -342,6 +342,9 @@
{ # Configuration for an automated build in response to source repository
# changes.
"description": "A String", # Human-readable description of this trigger.
+ "createTime": "A String", # Time when the trigger was created.
+ #
+ # @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
@@ -351,17 +354,14 @@
"projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
# the build is assumed.
"branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
"repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "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
+ "disabled": True or False, # If true, the trigger will never result in a build.
"substitutions": { # Substitutions data for Build resource.
"a_key": "A String",
},
- "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
@@ -411,11 +411,23 @@
},
"statusDetail": "A String", # Customer-readable message about the current status.
# @OutputOnly
- "substitutions": { # Substitutions data for Build resource.
- "a_key": "A String",
+ "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
+ "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
+ "A String",
+ ],
},
"source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
# service.
+ "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
+ },
"storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
# Storage.
# Google Cloud Storage.
@@ -429,33 +441,17 @@
# [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
- "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
- },
},
"buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
# triggered automatically.
# @OutputOnly
- "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Requested verifiability options.
- "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
- "A String",
- ],
- },
"steps": [ # Describes the operations to be performed on the workspace.
{ # BuildStep describes a step to perform in the build pipeline.
- "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.
+ "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
+ # This build step will not start until all the build steps in wait_for
+ # have completed successfully. If wait_for is empty, this build step will
+ # start when all previous build steps in the Build.Steps list have completed
+ # successfully.
"A String",
],
"name": "A String", # The name of the container image that will run this particular build step.
@@ -466,19 +462,20 @@
#
# 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.
+ # ([https://github.com/GoogleCloudPlatform/cloud-builders](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.
- "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
- # This build step will not start until all the build steps in wait_for
- # have completed successfully. If wait_for is empty, this build step will
- # start when all previous build steps in the Build.Steps list have completed
- # successfully.
+ "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",
],
"entrypoint": "A String", # Optional entrypoint to be used instead of the build step image's default
@@ -498,18 +495,15 @@
"sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
# @OutputOnly
# some source was used for this build.
- "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
- # generations resolved.
- # Google Cloud Storage.
- "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
- # omitted, the latest generation will be used.
- "object": "A String", # Google Cloud Storage object containing source.
- #
- # This object must be a gzipped archive file (.tar.gz) containing source to
- # build.
- "bucket": "A String", # Google Cloud Storage bucket containing source (see
- # [Bucket Name
- # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+ "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
+ # revisions resolved.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
},
"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
# source integrity was maintained in the build. Note that FileHashes will
@@ -531,15 +525,18 @@
],
},
},
- "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
- # revisions resolved.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
+ # generations resolved.
+ # Google Cloud Storage.
+ "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
+ # omitted, the latest generation will be used.
+ "object": "A String", # Google Cloud Storage object containing source.
+ #
+ # This object must be a gzipped archive file (.tar.gz) containing source to
+ # build.
+ "bucket": "A String", # Google Cloud Storage bucket containing source (see
+ # [Bucket Name
+ # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
},
"logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
@@ -557,6 +554,9 @@
# If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
+ "substitutions": { # Substitutions data for Build resource.
+ "a_key": "A String",
+ },
"createTime": "A String", # Time at which the request to create the build was received.
# @OutputOnly
"logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
@@ -619,6 +619,9 @@
{ # Configuration for an automated build in response to source repository
# changes.
"description": "A String", # Human-readable description of this trigger.
+ "createTime": "A String", # Time when the trigger was created.
+ #
+ # @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
@@ -628,17 +631,14 @@
"projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
# the build is assumed.
"branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
"repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "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
+ "disabled": True or False, # If true, the trigger will never result in a build.
"substitutions": { # Substitutions data for Build resource.
"a_key": "A String",
},
- "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
@@ -688,11 +688,23 @@
},
"statusDetail": "A String", # Customer-readable message about the current status.
# @OutputOnly
- "substitutions": { # Substitutions data for Build resource.
- "a_key": "A String",
+ "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
+ "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
+ "A String",
+ ],
},
"source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
# service.
+ "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
+ },
"storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
# Storage.
# Google Cloud Storage.
@@ -706,33 +718,17 @@
# [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
- "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
- },
},
"buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
# triggered automatically.
# @OutputOnly
- "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Requested verifiability options.
- "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
- "A String",
- ],
- },
"steps": [ # Describes the operations to be performed on the workspace.
{ # BuildStep describes a step to perform in the build pipeline.
- "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.
+ "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
+ # This build step will not start until all the build steps in wait_for
+ # have completed successfully. If wait_for is empty, this build step will
+ # start when all previous build steps in the Build.Steps list have completed
+ # successfully.
"A String",
],
"name": "A String", # The name of the container image that will run this particular build step.
@@ -743,19 +739,20 @@
#
# 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.
+ # ([https://github.com/GoogleCloudPlatform/cloud-builders](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.
- "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
- # This build step will not start until all the build steps in wait_for
- # have completed successfully. If wait_for is empty, this build step will
- # start when all previous build steps in the Build.Steps list have completed
- # successfully.
+ "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",
],
"entrypoint": "A String", # Optional entrypoint to be used instead of the build step image's default
@@ -775,18 +772,15 @@
"sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
# @OutputOnly
# some source was used for this build.
- "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
- # generations resolved.
- # Google Cloud Storage.
- "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
- # omitted, the latest generation will be used.
- "object": "A String", # Google Cloud Storage object containing source.
- #
- # This object must be a gzipped archive file (.tar.gz) containing source to
- # build.
- "bucket": "A String", # Google Cloud Storage bucket containing source (see
- # [Bucket Name
- # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+ "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
+ # revisions resolved.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
},
"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
# source integrity was maintained in the build. Note that FileHashes will
@@ -808,15 +802,18 @@
],
},
},
- "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
- # revisions resolved.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
+ # generations resolved.
+ # Google Cloud Storage.
+ "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
+ # omitted, the latest generation will be used.
+ "object": "A String", # Google Cloud Storage object containing source.
+ #
+ # This object must be a gzipped archive file (.tar.gz) containing source to
+ # build.
+ "bucket": "A String", # Google Cloud Storage bucket containing source (see
+ # [Bucket Name
+ # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
},
"logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
@@ -834,6 +831,9 @@
# If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
+ "substitutions": { # Substitutions data for Build resource.
+ "a_key": "A String",
+ },
"createTime": "A String", # Time at which the request to create the build was received.
# @OutputOnly
"logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
@@ -868,6 +868,9 @@
{ # Configuration for an automated build in response to source repository
# changes.
"description": "A String", # Human-readable description of this trigger.
+ "createTime": "A String", # Time when the trigger was created.
+ #
+ # @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
@@ -877,17 +880,14 @@
"projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
# the build is assumed.
"branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
"repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "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
+ "disabled": True or False, # If true, the trigger will never result in a build.
"substitutions": { # Substitutions data for Build resource.
"a_key": "A String",
},
- "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
@@ -937,11 +937,23 @@
},
"statusDetail": "A String", # Customer-readable message about the current status.
# @OutputOnly
- "substitutions": { # Substitutions data for Build resource.
- "a_key": "A String",
+ "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
+ "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
+ "A String",
+ ],
},
"source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
# service.
+ "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
+ },
"storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
# Storage.
# Google Cloud Storage.
@@ -955,33 +967,17 @@
# [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
- "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
- },
},
"buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
# triggered automatically.
# @OutputOnly
- "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Requested verifiability options.
- "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
- "A String",
- ],
- },
"steps": [ # Describes the operations to be performed on the workspace.
{ # BuildStep describes a step to perform in the build pipeline.
- "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.
+ "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
+ # This build step will not start until all the build steps in wait_for
+ # have completed successfully. If wait_for is empty, this build step will
+ # start when all previous build steps in the Build.Steps list have completed
+ # successfully.
"A String",
],
"name": "A String", # The name of the container image that will run this particular build step.
@@ -992,19 +988,20 @@
#
# 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.
+ # ([https://github.com/GoogleCloudPlatform/cloud-builders](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.
- "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
- # This build step will not start until all the build steps in wait_for
- # have completed successfully. If wait_for is empty, this build step will
- # start when all previous build steps in the Build.Steps list have completed
- # successfully.
+ "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",
],
"entrypoint": "A String", # Optional entrypoint to be used instead of the build step image's default
@@ -1024,18 +1021,15 @@
"sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
# @OutputOnly
# some source was used for this build.
- "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
- # generations resolved.
- # Google Cloud Storage.
- "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
- # omitted, the latest generation will be used.
- "object": "A String", # Google Cloud Storage object containing source.
- #
- # This object must be a gzipped archive file (.tar.gz) containing source to
- # build.
- "bucket": "A String", # Google Cloud Storage bucket containing source (see
- # [Bucket Name
- # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+ "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
+ # revisions resolved.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
},
"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
# source integrity was maintained in the build. Note that FileHashes will
@@ -1057,15 +1051,18 @@
],
},
},
- "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
- # revisions resolved.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
+ # generations resolved.
+ # Google Cloud Storage.
+ "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
+ # omitted, the latest generation will be used.
+ "object": "A String", # Google Cloud Storage object containing source.
+ #
+ # This object must be a gzipped archive file (.tar.gz) containing source to
+ # build.
+ "bucket": "A String", # Google Cloud Storage bucket containing source (see
+ # [Bucket Name
+ # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
},
"logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
@@ -1083,6 +1080,9 @@
# If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
+ "substitutions": { # Substitutions data for Build resource.
+ "a_key": "A String",
+ },
"createTime": "A String", # Time at which the request to create the build was received.
# @OutputOnly
"logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
@@ -1113,6 +1113,9 @@
{ # Configuration for an automated build in response to source repository
# changes.
"description": "A String", # Human-readable description of this trigger.
+ "createTime": "A String", # Time when the trigger was created.
+ #
+ # @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
@@ -1122,17 +1125,14 @@
"projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
# the build is assumed.
"branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
"repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "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
+ "disabled": True or False, # If true, the trigger will never result in a build.
"substitutions": { # Substitutions data for Build resource.
"a_key": "A String",
},
- "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
@@ -1182,11 +1182,23 @@
},
"statusDetail": "A String", # Customer-readable message about the current status.
# @OutputOnly
- "substitutions": { # Substitutions data for Build resource.
- "a_key": "A String",
+ "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
+ "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
+ "A String",
+ ],
},
"source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
# service.
+ "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
+ },
"storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
# Storage.
# Google Cloud Storage.
@@ -1200,33 +1212,17 @@
# [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
- "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
- },
},
"buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
# triggered automatically.
# @OutputOnly
- "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Requested verifiability options.
- "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
- "A String",
- ],
- },
"steps": [ # Describes the operations to be performed on the workspace.
{ # BuildStep describes a step to perform in the build pipeline.
- "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.
+ "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
+ # This build step will not start until all the build steps in wait_for
+ # have completed successfully. If wait_for is empty, this build step will
+ # start when all previous build steps in the Build.Steps list have completed
+ # successfully.
"A String",
],
"name": "A String", # The name of the container image that will run this particular build step.
@@ -1237,19 +1233,20 @@
#
# 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.
+ # ([https://github.com/GoogleCloudPlatform/cloud-builders](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.
- "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
- # This build step will not start until all the build steps in wait_for
- # have completed successfully. If wait_for is empty, this build step will
- # start when all previous build steps in the Build.Steps list have completed
- # successfully.
+ "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",
],
"entrypoint": "A String", # Optional entrypoint to be used instead of the build step image's default
@@ -1269,18 +1266,15 @@
"sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
# @OutputOnly
# some source was used for this build.
- "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
- # generations resolved.
- # Google Cloud Storage.
- "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
- # omitted, the latest generation will be used.
- "object": "A String", # Google Cloud Storage object containing source.
- #
- # This object must be a gzipped archive file (.tar.gz) containing source to
- # build.
- "bucket": "A String", # Google Cloud Storage bucket containing source (see
- # [Bucket Name
- # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+ "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
+ # revisions resolved.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
},
"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
# source integrity was maintained in the build. Note that FileHashes will
@@ -1302,15 +1296,18 @@
],
},
},
- "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
- # revisions resolved.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
+ # generations resolved.
+ # Google Cloud Storage.
+ "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
+ # omitted, the latest generation will be used.
+ "object": "A String", # Google Cloud Storage object containing source.
+ #
+ # This object must be a gzipped archive file (.tar.gz) containing source to
+ # build.
+ "bucket": "A String", # Google Cloud Storage bucket containing source (see
+ # [Bucket Name
+ # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
},
"logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
@@ -1328,6 +1325,9 @@
# If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
+ "substitutions": { # Substitutions data for Build resource.
+ "a_key": "A String",
+ },
"createTime": "A String", # Time at which the request to create the build was received.
# @OutputOnly
"logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
@@ -1351,6 +1351,9 @@
{ # Configuration for an automated build in response to source repository
# changes.
"description": "A String", # Human-readable description of this trigger.
+ "createTime": "A String", # Time when the trigger was created.
+ #
+ # @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
@@ -1360,17 +1363,14 @@
"projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
# the build is assumed.
"branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
"repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "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
+ "disabled": True or False, # If true, the trigger will never result in a build.
"substitutions": { # Substitutions data for Build resource.
"a_key": "A String",
},
- "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
@@ -1420,11 +1420,23 @@
},
"statusDetail": "A String", # Customer-readable message about the current status.
# @OutputOnly
- "substitutions": { # Substitutions data for Build resource.
- "a_key": "A String",
+ "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
+ "requestedVerifyOption": "A String", # Requested verifiability options.
+ "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
+ "A String",
+ ],
},
"source": { # Source describes the location of the source in a supported storage # Describes where to find the source files to build.
# service.
+ "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
+ },
"storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
# Storage.
# Google Cloud Storage.
@@ -1438,33 +1450,17 @@
# [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
- "repoSource": { # RepoSource describes the location of the source in a Google Cloud Source # If provided, get source from this location in a Cloud Repo.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
- },
},
"buildTriggerId": "A String", # The ID of the BuildTrigger that triggered this build, if it was
# triggered automatically.
# @OutputOnly
- "options": { # Optional arguments to enable specific features of builds. # Special options for this build.
- "requestedVerifyOption": "A String", # Requested verifiability options.
- "sourceProvenanceHash": [ # Requested hash for SourceProvenance.
- "A String",
- ],
- },
"steps": [ # Describes the operations to be performed on the workspace.
{ # BuildStep describes a step to perform in the build pipeline.
- "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.
+ "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
+ # This build step will not start until all the build steps in wait_for
+ # have completed successfully. If wait_for is empty, this build step will
+ # start when all previous build steps in the Build.Steps list have completed
+ # successfully.
"A String",
],
"name": "A String", # The name of the container image that will run this particular build step.
@@ -1475,19 +1471,20 @@
#
# 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.
+ # ([https://github.com/GoogleCloudPlatform/cloud-builders](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.
- "waitFor": [ # The ID(s) of the step(s) that this build step depends on.
- # This build step will not start until all the build steps in wait_for
- # have completed successfully. If wait_for is empty, this build step will
- # start when all previous build steps in the Build.Steps list have completed
- # successfully.
+ "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",
],
"entrypoint": "A String", # Optional entrypoint to be used instead of the build step image's default
@@ -1507,18 +1504,15 @@
"sourceProvenance": { # Provenance of the source. Ways to find the original source, or verify that # A permanent fixed identifier for source.
# @OutputOnly
# some source was used for this build.
- "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
- # generations resolved.
- # Google Cloud Storage.
- "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
- # omitted, the latest generation will be used.
- "object": "A String", # Google Cloud Storage object containing source.
- #
- # This object must be a gzipped archive file (.tar.gz) containing source to
- # build.
- "bucket": "A String", # Google Cloud Storage bucket containing source (see
- # [Bucket Name
- # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+ "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
+ # revisions resolved.
+ # Repository.
+ "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
+ # the build is assumed.
+ "branchName": "A String", # Name of the branch to build.
+ "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "tagName": "A String", # Name of the tag to build.
+ "commitSha": "A String", # Explicit commit SHA to build.
},
"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
# source integrity was maintained in the build. Note that FileHashes will
@@ -1540,15 +1534,18 @@
],
},
},
- "resolvedRepoSource": { # RepoSource describes the location of the source in a Google Cloud Source # A copy of the build's source.repo_source, if exists, with any
- # revisions resolved.
- # Repository.
- "projectId": "A String", # ID of the project that owns the repo. If omitted, the project ID requesting
- # the build is assumed.
- "branchName": "A String", # Name of the branch to build.
- "commitSha": "A String", # Explicit commit SHA to build.
- "tagName": "A String", # Name of the tag to build.
- "repoName": "A String", # Name of the repo. If omitted, the name "default" is assumed.
+ "resolvedStorageSource": { # StorageSource describes the location of the source in an archive file in # A copy of the build's source.storage_source, if exists, with any
+ # generations resolved.
+ # Google Cloud Storage.
+ "generation": "A String", # Google Cloud Storage generation for the object. If the generation is
+ # omitted, the latest generation will be used.
+ "object": "A String", # Google Cloud Storage object containing source.
+ #
+ # This object must be a gzipped archive file (.tar.gz) containing source to
+ # build.
+ "bucket": "A String", # Google Cloud Storage bucket containing source (see
+ # [Bucket Name
+ # Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
},
},
"logsBucket": "A String", # Google Cloud Storage bucket where logs should be written (see
@@ -1566,6 +1563,9 @@
# If any of the images fail to be pushed, the build is marked FAILURE.
"A String",
],
+ "substitutions": { # Substitutions data for Build resource.
+ "a_key": "A String",
+ },
"createTime": "A String", # Time at which the request to create the build was received.
# @OutputOnly
"logUrl": "A String", # URL to logs for this build in Google Cloud Logging.
diff --git a/docs/dyn/clouddebugger_v2.controller.debuggees.breakpoints.html b/docs/dyn/clouddebugger_v2.controller.debuggees.breakpoints.html
index f447e28..641c2cc 100644
--- a/docs/dyn/clouddebugger_v2.controller.debuggees.breakpoints.html
+++ b/docs/dyn/clouddebugger_v2.controller.debuggees.breakpoints.html
@@ -335,195 +335,15 @@
# rather than a static type of an object.
},
],
- "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds
- # resolution.
+ "userEmail": "A String", # E-mail address of the user that created this breakpoint
"logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`.
"labels": { # A set of custom breakpoint properties, populated by the agent, to be
# displayed to the user.
"a_key": "A String",
},
- "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when
- # the breakpoint hits. The message may include parameter placeholders `$0`,
- # `$1`, etc. These placeholders are replaced with the evaluated value
- # of the appropriate expression. Expressions not referenced in
- # `log_message_format` are not logged.
- #
- # Example: `Message received, id = $0, count = $1` with
- # `expressions` = `[ message.id, message.count ]`.
- "userEmail": "A String", # E-mail address of the user that created this breakpoint
- "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
"stackFrames": [ # The stack at breakpoint time.
{ # Represents a stack frame context.
"function": "A String", # Demangled function name at the call site.
- "location": { # Represents a location in the source code. # Source location of the call site.
- "path": "A String", # Path to the source file within the source context of the target binary.
- "line": 42, # Line inside the file. The first line in the file has the value `1`.
- },
- "locals": [ # Set of local variables at the stack frame location.
- # Note that this might not be populated for all stack frames.
- { # Represents a variable or an argument possibly of a compound object type.
- # Note how the following variables are represented:
- #
- # 1) A simple variable:
- #
- # int x = 5
- #
- # { name: "x", value: "5", type: "int" } // Captured variable
- #
- # 2) A compound object:
- #
- # struct T {
- # int m1;
- # int m2;
- # };
- # T x = { 3, 7 };
- #
- # { // Captured variable
- # name: "x",
- # type: "T",
- # members { name: "m1", value: "3", type: "int" },
- # members { name: "m2", value: "7", type: "int" }
- # }
- #
- # 3) A pointer where the pointee was captured:
- #
- # T x = { 3, 7 };
- # T* p = &x;
- #
- # { // Captured variable
- # name: "p",
- # type: "T*",
- # value: "0x00500500",
- # members { name: "m1", value: "3", type: "int" },
- # members { name: "m2", value: "7", type: "int" }
- # }
- #
- # 4) A pointer where the pointee was not captured:
- #
- # T* p = new T;
- #
- # { // Captured variable
- # name: "p",
- # type: "T*",
- # value: "0x00400400"
- # status { is_error: true, description { format: "unavailable" } }
- # }
- #
- # The status should describe the reason for the missing value,
- # such as `<optimized out>`, `<inaccessible>`, `<pointers limit reached>`.
- #
- # Note that a null pointer should not have members.
- #
- # 5) An unnamed value:
- #
- # int* p = new int(7);
- #
- # { // Captured variable
- # name: "p",
- # value: "0x00500500",
- # type: "int*",
- # members { value: "7", type: "int" } }
- #
- # 6) An unnamed pointer where the pointee was not captured:
- #
- # int* p = new int(7);
- # int** pp = &p;
- #
- # { // Captured variable
- # name: "pp",
- # value: "0x00500500",
- # type: "int**",
- # members {
- # value: "0x00400400",
- # type: "int*"
- # status {
- # is_error: true,
- # description: { format: "unavailable" } }
- # }
- # }
- # }
- #
- # To optimize computation, memory and network traffic, variables that
- # repeat in the output multiple times can be stored once in a shared
- # variable table and be referenced using the `var_table_index` field. The
- # variables stored in the shared table are nameless and are essentially
- # a partition of the complete variable. To reconstruct the complete
- # variable, merge the referencing variable with the referenced variable.
- #
- # When using the shared variable table, the following variables:
- #
- # T x = { 3, 7 };
- # T* p = &x;
- # T& r = x;
- #
- # { name: "x", var_table_index: 3, type: "T" } // Captured variables
- # { name: "p", value "0x00500500", type="T*", var_table_index: 3 }
- # { name: "r", type="T&", var_table_index: 3 }
- #
- # { // Shared variable table entry #3:
- # members { name: "m1", value: "3", type: "int" },
- # members { name: "m2", value: "7", type: "int" }
- # }
- #
- # Note that the pointer address is stored with the referencing variable
- # and not with the referenced variable. This allows the referenced variable
- # to be shared between pointers and references.
- #
- # The type field is optional. The debugger agent may or may not support it.
- "status": { # Represents a contextual status message. # Status associated with the variable. This field will usually stay
- # unset. A status of a single variable only applies to that variable or
- # expression. The rest of breakpoint data still remains valid. Variables
- # might be reported in error state even when breakpoint is not in final
- # state.
- #
- # The message may refer to variable name with `refers_to` set to
- # `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.
- # In either case variable value and members will be unset.
- #
- # Example of error message applied to name: `Invalid expression syntax`.
- #
- # Example of information message applied to value: `Not captured`.
- #
- # Examples of error message applied to value:
- #
- # * `Malformed string`,
- # * `Field f not found in class C`
- # * `Null pointer dereference`
- # The message can indicate an error or informational status, and refer to
- # specific parts of the containing object.
- # For example, the `Breakpoint.status` field can indicate an error referring
- # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
- "isError": True or False, # Distinguishes errors from informational messages.
- "refersTo": "A String", # Reference to which the message applies.
- "description": { # Represents a message with parameters. # Status message text.
- "parameters": [ # Optional parameters to be embedded into the message.
- "A String",
- ],
- "format": "A String", # Format template for the message. The `format` uses placeholders `$0`,
- # `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
- # character.
- #
- # Examples:
- #
- # * `Failed to load '$0' which helps debug $1 the first time it
- # is loaded. Again, $0 is very important.`
- # * `Please pay $$10 to use $0 instead of $1.`
- },
- },
- "name": "A String", # Name of the variable, if any.
- "varTableIndex": 42, # Reference to a variable in the shared variable table. More than
- # one variable can reference the same variable in the table. The
- # `var_table_index` field is an index into `variable_table` in Breakpoint.
- "value": "A String", # Simple value of the variable.
- "members": [ # Members contained or pointed to by the variable.
- # Object with schema name: Variable
- ],
- "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with
- # `var_table_index`, `type` goes next to `value`. The interpretation of
- # a type is agent specific. It is recommended to include the dynamic type
- # rather than a static type of an object.
- },
- ],
"arguments": [ # Set of arguments passed to this function.
# Note that this might not be populated for all stack frames.
{ # Represents a variable or an argument possibly of a compound object type.
@@ -689,20 +509,200 @@
# rather than a static type of an object.
},
],
+ "locals": [ # Set of local variables at the stack frame location.
+ # Note that this might not be populated for all stack frames.
+ { # Represents a variable or an argument possibly of a compound object type.
+ # Note how the following variables are represented:
+ #
+ # 1) A simple variable:
+ #
+ # int x = 5
+ #
+ # { name: "x", value: "5", type: "int" } // Captured variable
+ #
+ # 2) A compound object:
+ #
+ # struct T {
+ # int m1;
+ # int m2;
+ # };
+ # T x = { 3, 7 };
+ #
+ # { // Captured variable
+ # name: "x",
+ # type: "T",
+ # members { name: "m1", value: "3", type: "int" },
+ # members { name: "m2", value: "7", type: "int" }
+ # }
+ #
+ # 3) A pointer where the pointee was captured:
+ #
+ # T x = { 3, 7 };
+ # T* p = &x;
+ #
+ # { // Captured variable
+ # name: "p",
+ # type: "T*",
+ # value: "0x00500500",
+ # members { name: "m1", value: "3", type: "int" },
+ # members { name: "m2", value: "7", type: "int" }
+ # }
+ #
+ # 4) A pointer where the pointee was not captured:
+ #
+ # T* p = new T;
+ #
+ # { // Captured variable
+ # name: "p",
+ # type: "T*",
+ # value: "0x00400400"
+ # status { is_error: true, description { format: "unavailable" } }
+ # }
+ #
+ # The status should describe the reason for the missing value,
+ # such as `<optimized out>`, `<inaccessible>`, `<pointers limit reached>`.
+ #
+ # Note that a null pointer should not have members.
+ #
+ # 5) An unnamed value:
+ #
+ # int* p = new int(7);
+ #
+ # { // Captured variable
+ # name: "p",
+ # value: "0x00500500",
+ # type: "int*",
+ # members { value: "7", type: "int" } }
+ #
+ # 6) An unnamed pointer where the pointee was not captured:
+ #
+ # int* p = new int(7);
+ # int** pp = &p;
+ #
+ # { // Captured variable
+ # name: "pp",
+ # value: "0x00500500",
+ # type: "int**",
+ # members {
+ # value: "0x00400400",
+ # type: "int*"
+ # status {
+ # is_error: true,
+ # description: { format: "unavailable" } }
+ # }
+ # }
+ # }
+ #
+ # To optimize computation, memory and network traffic, variables that
+ # repeat in the output multiple times can be stored once in a shared
+ # variable table and be referenced using the `var_table_index` field. The
+ # variables stored in the shared table are nameless and are essentially
+ # a partition of the complete variable. To reconstruct the complete
+ # variable, merge the referencing variable with the referenced variable.
+ #
+ # When using the shared variable table, the following variables:
+ #
+ # T x = { 3, 7 };
+ # T* p = &x;
+ # T& r = x;
+ #
+ # { name: "x", var_table_index: 3, type: "T" } // Captured variables
+ # { name: "p", value "0x00500500", type="T*", var_table_index: 3 }
+ # { name: "r", type="T&", var_table_index: 3 }
+ #
+ # { // Shared variable table entry #3:
+ # members { name: "m1", value: "3", type: "int" },
+ # members { name: "m2", value: "7", type: "int" }
+ # }
+ #
+ # Note that the pointer address is stored with the referencing variable
+ # and not with the referenced variable. This allows the referenced variable
+ # to be shared between pointers and references.
+ #
+ # The type field is optional. The debugger agent may or may not support it.
+ "status": { # Represents a contextual status message. # Status associated with the variable. This field will usually stay
+ # unset. A status of a single variable only applies to that variable or
+ # expression. The rest of breakpoint data still remains valid. Variables
+ # might be reported in error state even when breakpoint is not in final
+ # state.
+ #
+ # The message may refer to variable name with `refers_to` set to
+ # `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.
+ # In either case variable value and members will be unset.
+ #
+ # Example of error message applied to name: `Invalid expression syntax`.
+ #
+ # Example of information message applied to value: `Not captured`.
+ #
+ # Examples of error message applied to value:
+ #
+ # * `Malformed string`,
+ # * `Field f not found in class C`
+ # * `Null pointer dereference`
+ # The message can indicate an error or informational status, and refer to
+ # specific parts of the containing object.
+ # For example, the `Breakpoint.status` field can indicate an error referring
+ # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
+ "isError": True or False, # Distinguishes errors from informational messages.
+ "refersTo": "A String", # Reference to which the message applies.
+ "description": { # Represents a message with parameters. # Status message text.
+ "parameters": [ # Optional parameters to be embedded into the message.
+ "A String",
+ ],
+ "format": "A String", # Format template for the message. The `format` uses placeholders `$0`,
+ # `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
+ # character.
+ #
+ # Examples:
+ #
+ # * `Failed to load '$0' which helps debug $1 the first time it
+ # is loaded. Again, $0 is very important.`
+ # * `Please pay $$10 to use $0 instead of $1.`
+ },
+ },
+ "name": "A String", # Name of the variable, if any.
+ "varTableIndex": 42, # Reference to a variable in the shared variable table. More than
+ # one variable can reference the same variable in the table. The
+ # `var_table_index` field is an index into `variable_table` in Breakpoint.
+ "value": "A String", # Simple value of the variable.
+ "members": [ # Members contained or pointed to by the variable.
+ # Object with schema name: Variable
+ ],
+ "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with
+ # `var_table_index`, `type` goes next to `value`. The interpretation of
+ # a type is agent specific. It is recommended to include the dynamic type
+ # rather than a static type of an object.
+ },
+ ],
+ "location": { # Represents a location in the source code. # Source location of the call site.
+ "path": "A String", # Path to the source file within the source context of the target binary.
+ "line": 42, # Line inside the file. The first line in the file has the value `1`.
+ },
},
],
- "location": { # Represents a location in the source code. # Breakpoint source location.
- "path": "A String", # Path to the source file within the source context of the target binary.
- "line": 42, # Line inside the file. The first line in the file has the value `1`.
- },
- "action": "A String", # Action that the agent should perform when the code at the
- # breakpoint location is hit.
+ "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
"expressions": [ # List of read-only expressions to evaluate at the breakpoint location.
# The expressions are composed using expressions in the programming language
# at the source location. If the breakpoint action is `LOG`, the evaluated
# expressions are included in log statements.
"A String",
],
+ "location": { # Represents a location in the source code. # Breakpoint source location.
+ "path": "A String", # Path to the source file within the source context of the target binary.
+ "line": 42, # Line inside the file. The first line in the file has the value `1`.
+ },
+ "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds
+ # resolution.
+ "action": "A String", # Action that the agent should perform when the code at the
+ # breakpoint location is hit.
+ "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when
+ # the breakpoint hits. The message may include parameter placeholders `$0`,
+ # `$1`, etc. These placeholders are replaced with the evaluated value
+ # of the appropriate expression. Expressions not referenced in
+ # `log_message_format` are not logged.
+ #
+ # Example: `Message received, id = $0, count = $1` with
+ # `expressions` = `[ message.id, message.count ]`.
"isFinalState": True or False, # When true, indicates that this is a final result and the
# breakpoint state will not change from here on.
"evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time.
@@ -1116,195 +1116,15 @@
# rather than a static type of an object.
},
],
- "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds
- # resolution.
+ "userEmail": "A String", # E-mail address of the user that created this breakpoint
"logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`.
"labels": { # A set of custom breakpoint properties, populated by the agent, to be
# displayed to the user.
"a_key": "A String",
},
- "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when
- # the breakpoint hits. The message may include parameter placeholders `$0`,
- # `$1`, etc. These placeholders are replaced with the evaluated value
- # of the appropriate expression. Expressions not referenced in
- # `log_message_format` are not logged.
- #
- # Example: `Message received, id = $0, count = $1` with
- # `expressions` = `[ message.id, message.count ]`.
- "userEmail": "A String", # E-mail address of the user that created this breakpoint
- "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
"stackFrames": [ # The stack at breakpoint time.
{ # Represents a stack frame context.
"function": "A String", # Demangled function name at the call site.
- "location": { # Represents a location in the source code. # Source location of the call site.
- "path": "A String", # Path to the source file within the source context of the target binary.
- "line": 42, # Line inside the file. The first line in the file has the value `1`.
- },
- "locals": [ # Set of local variables at the stack frame location.
- # Note that this might not be populated for all stack frames.
- { # Represents a variable or an argument possibly of a compound object type.
- # Note how the following variables are represented:
- #
- # 1) A simple variable:
- #
- # int x = 5
- #
- # { name: "x", value: "5", type: "int" } // Captured variable
- #
- # 2) A compound object:
- #
- # struct T {
- # int m1;
- # int m2;
- # };
- # T x = { 3, 7 };
- #
- # { // Captured variable
- # name: "x",
- # type: "T",
- # members { name: "m1", value: "3", type: "int" },
- # members { name: "m2", value: "7", type: "int" }
- # }
- #
- # 3) A pointer where the pointee was captured:
- #
- # T x = { 3, 7 };
- # T* p = &x;
- #
- # { // Captured variable
- # name: "p",
- # type: "T*",
- # value: "0x00500500",
- # members { name: "m1", value: "3", type: "int" },
- # members { name: "m2", value: "7", type: "int" }
- # }
- #
- # 4) A pointer where the pointee was not captured:
- #
- # T* p = new T;
- #
- # { // Captured variable
- # name: "p",
- # type: "T*",
- # value: "0x00400400"
- # status { is_error: true, description { format: "unavailable" } }
- # }
- #
- # The status should describe the reason for the missing value,
- # such as `<optimized out>`, `<inaccessible>`, `<pointers limit reached>`.
- #
- # Note that a null pointer should not have members.
- #
- # 5) An unnamed value:
- #
- # int* p = new int(7);
- #
- # { // Captured variable
- # name: "p",
- # value: "0x00500500",
- # type: "int*",
- # members { value: "7", type: "int" } }
- #
- # 6) An unnamed pointer where the pointee was not captured:
- #
- # int* p = new int(7);
- # int** pp = &p;
- #
- # { // Captured variable
- # name: "pp",
- # value: "0x00500500",
- # type: "int**",
- # members {
- # value: "0x00400400",
- # type: "int*"
- # status {
- # is_error: true,
- # description: { format: "unavailable" } }
- # }
- # }
- # }
- #
- # To optimize computation, memory and network traffic, variables that
- # repeat in the output multiple times can be stored once in a shared
- # variable table and be referenced using the `var_table_index` field. The
- # variables stored in the shared table are nameless and are essentially
- # a partition of the complete variable. To reconstruct the complete
- # variable, merge the referencing variable with the referenced variable.
- #
- # When using the shared variable table, the following variables:
- #
- # T x = { 3, 7 };
- # T* p = &x;
- # T& r = x;
- #
- # { name: "x", var_table_index: 3, type: "T" } // Captured variables
- # { name: "p", value "0x00500500", type="T*", var_table_index: 3 }
- # { name: "r", type="T&", var_table_index: 3 }
- #
- # { // Shared variable table entry #3:
- # members { name: "m1", value: "3", type: "int" },
- # members { name: "m2", value: "7", type: "int" }
- # }
- #
- # Note that the pointer address is stored with the referencing variable
- # and not with the referenced variable. This allows the referenced variable
- # to be shared between pointers and references.
- #
- # The type field is optional. The debugger agent may or may not support it.
- "status": { # Represents a contextual status message. # Status associated with the variable. This field will usually stay
- # unset. A status of a single variable only applies to that variable or
- # expression. The rest of breakpoint data still remains valid. Variables
- # might be reported in error state even when breakpoint is not in final
- # state.
- #
- # The message may refer to variable name with `refers_to` set to
- # `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.
- # In either case variable value and members will be unset.
- #
- # Example of error message applied to name: `Invalid expression syntax`.
- #
- # Example of information message applied to value: `Not captured`.
- #
- # Examples of error message applied to value:
- #
- # * `Malformed string`,
- # * `Field f not found in class C`
- # * `Null pointer dereference`
- # The message can indicate an error or informational status, and refer to
- # specific parts of the containing object.
- # For example, the `Breakpoint.status` field can indicate an error referring
- # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
- "isError": True or False, # Distinguishes errors from informational messages.
- "refersTo": "A String", # Reference to which the message applies.
- "description": { # Represents a message with parameters. # Status message text.
- "parameters": [ # Optional parameters to be embedded into the message.
- "A String",
- ],
- "format": "A String", # Format template for the message. The `format` uses placeholders `$0`,
- # `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
- # character.
- #
- # Examples:
- #
- # * `Failed to load '$0' which helps debug $1 the first time it
- # is loaded. Again, $0 is very important.`
- # * `Please pay $$10 to use $0 instead of $1.`
- },
- },
- "name": "A String", # Name of the variable, if any.
- "varTableIndex": 42, # Reference to a variable in the shared variable table. More than
- # one variable can reference the same variable in the table. The
- # `var_table_index` field is an index into `variable_table` in Breakpoint.
- "value": "A String", # Simple value of the variable.
- "members": [ # Members contained or pointed to by the variable.
- # Object with schema name: Variable
- ],
- "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with
- # `var_table_index`, `type` goes next to `value`. The interpretation of
- # a type is agent specific. It is recommended to include the dynamic type
- # rather than a static type of an object.
- },
- ],
"arguments": [ # Set of arguments passed to this function.
# Note that this might not be populated for all stack frames.
{ # Represents a variable or an argument possibly of a compound object type.
@@ -1470,20 +1290,200 @@
# rather than a static type of an object.
},
],
+ "locals": [ # Set of local variables at the stack frame location.
+ # Note that this might not be populated for all stack frames.
+ { # Represents a variable or an argument possibly of a compound object type.
+ # Note how the following variables are represented:
+ #
+ # 1) A simple variable:
+ #
+ # int x = 5
+ #
+ # { name: "x", value: "5", type: "int" } // Captured variable
+ #
+ # 2) A compound object:
+ #
+ # struct T {
+ # int m1;
+ # int m2;
+ # };
+ # T x = { 3, 7 };
+ #
+ # { // Captured variable
+ # name: "x",
+ # type: "T",
+ # members { name: "m1", value: "3", type: "int" },
+ # members { name: "m2", value: "7", type: "int" }
+ # }
+ #
+ # 3) A pointer where the pointee was captured:
+ #
+ # T x = { 3, 7 };
+ # T* p = &x;
+ #
+ # { // Captured variable
+ # name: "p",
+ # type: "T*",
+ # value: "0x00500500",
+ # members { name: "m1", value: "3", type: "int" },
+ # members { name: "m2", value: "7", type: "int" }
+ # }
+ #
+ # 4) A pointer where the pointee was not captured:
+ #
+ # T* p = new T;
+ #
+ # { // Captured variable
+ # name: "p",
+ # type: "T*",
+ # value: "0x00400400"
+ # status { is_error: true, description { format: "unavailable" } }
+ # }
+ #
+ # The status should describe the reason for the missing value,
+ # such as `<optimized out>`, `<inaccessible>`, `<pointers limit reached>`.
+ #
+ # Note that a null pointer should not have members.
+ #
+ # 5) An unnamed value:
+ #
+ # int* p = new int(7);
+ #
+ # { // Captured variable
+ # name: "p",
+ # value: "0x00500500",
+ # type: "int*",
+ # members { value: "7", type: "int" } }
+ #
+ # 6) An unnamed pointer where the pointee was not captured:
+ #
+ # int* p = new int(7);
+ # int** pp = &p;
+ #
+ # { // Captured variable
+ # name: "pp",
+ # value: "0x00500500",
+ # type: "int**",
+ # members {
+ # value: "0x00400400",
+ # type: "int*"
+ # status {
+ # is_error: true,
+ # description: { format: "unavailable" } }
+ # }
+ # }
+ # }
+ #
+ # To optimize computation, memory and network traffic, variables that
+ # repeat in the output multiple times can be stored once in a shared
+ # variable table and be referenced using the `var_table_index` field. The
+ # variables stored in the shared table are nameless and are essentially
+ # a partition of the complete variable. To reconstruct the complete
+ # variable, merge the referencing variable with the referenced variable.
+ #
+ # When using the shared variable table, the following variables:
+ #
+ # T x = { 3, 7 };
+ # T* p = &x;
+ # T& r = x;
+ #
+ # { name: "x", var_table_index: 3, type: "T" } // Captured variables
+ # { name: "p", value "0x00500500", type="T*", var_table_index: 3 }
+ # { name: "r", type="T&", var_table_index: 3 }
+ #
+ # { // Shared variable table entry #3:
+ # members { name: "m1", value: "3", type: "int" },
+ # members { name: "m2", value: "7", type: "int" }
+ # }
+ #
+ # Note that the pointer address is stored with the referencing variable
+ # and not with the referenced variable. This allows the referenced variable
+ # to be shared between pointers and references.
+ #
+ # The type field is optional. The debugger agent may or may not support it.
+ "status": { # Represents a contextual status message. # Status associated with the variable. This field will usually stay
+ # unset. A status of a single variable only applies to that variable or
+ # expression. The rest of breakpoint data still remains valid. Variables
+ # might be reported in error state even when breakpoint is not in final
+ # state.
+ #
+ # The message may refer to variable name with `refers_to` set to
+ # `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.
+ # In either case variable value and members will be unset.
+ #
+ # Example of error message applied to name: `Invalid expression syntax`.
+ #
+ # Example of information message applied to value: `Not captured`.
+ #
+ # Examples of error message applied to value:
+ #
+ # * `Malformed string`,
+ # * `Field f not found in class C`
+ # * `Null pointer dereference`
+ # The message can indicate an error or informational status, and refer to
+ # specific parts of the containing object.
+ # For example, the `Breakpoint.status` field can indicate an error referring
+ # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
+ "isError": True or False, # Distinguishes errors from informational messages.
+ "refersTo": "A String", # Reference to which the message applies.
+ "description": { # Represents a message with parameters. # Status message text.
+ "parameters": [ # Optional parameters to be embedded into the message.
+ "A String",
+ ],
+ "format": "A String", # Format template for the message. The `format` uses placeholders `$0`,
+ # `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
+ # character.
+ #
+ # Examples:
+ #
+ # * `Failed to load '$0' which helps debug $1 the first time it
+ # is loaded. Again, $0 is very important.`
+ # * `Please pay $$10 to use $0 instead of $1.`
+ },
+ },
+ "name": "A String", # Name of the variable, if any.
+ "varTableIndex": 42, # Reference to a variable in the shared variable table. More than
+ # one variable can reference the same variable in the table. The
+ # `var_table_index` field is an index into `variable_table` in Breakpoint.
+ "value": "A String", # Simple value of the variable.
+ "members": [ # Members contained or pointed to by the variable.
+ # Object with schema name: Variable
+ ],
+ "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with
+ # `var_table_index`, `type` goes next to `value`. The interpretation of
+ # a type is agent specific. It is recommended to include the dynamic type
+ # rather than a static type of an object.
+ },
+ ],
+ "location": { # Represents a location in the source code. # Source location of the call site.
+ "path": "A String", # Path to the source file within the source context of the target binary.
+ "line": 42, # Line inside the file. The first line in the file has the value `1`.
+ },
},
],
- "location": { # Represents a location in the source code. # Breakpoint source location.
- "path": "A String", # Path to the source file within the source context of the target binary.
- "line": 42, # Line inside the file. The first line in the file has the value `1`.
- },
- "action": "A String", # Action that the agent should perform when the code at the
- # breakpoint location is hit.
+ "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
"expressions": [ # List of read-only expressions to evaluate at the breakpoint location.
# The expressions are composed using expressions in the programming language
# at the source location. If the breakpoint action is `LOG`, the evaluated
# expressions are included in log statements.
"A String",
],
+ "location": { # Represents a location in the source code. # Breakpoint source location.
+ "path": "A String", # Path to the source file within the source context of the target binary.
+ "line": 42, # Line inside the file. The first line in the file has the value `1`.
+ },
+ "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds
+ # resolution.
+ "action": "A String", # Action that the agent should perform when the code at the
+ # breakpoint location is hit.
+ "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when
+ # the breakpoint hits. The message may include parameter placeholders `$0`,
+ # `$1`, etc. These placeholders are replaced with the evaluated value
+ # of the appropriate expression. Expressions not referenced in
+ # `log_message_format` are not logged.
+ #
+ # Example: `Message received, id = $0, count = $1` with
+ # `expressions` = `[ message.id, message.count ]`.
"isFinalState": True or False, # When true, indicates that this is a final result and the
# breakpoint state will not change from here on.
"evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time.
diff --git a/docs/dyn/clouddebugger_v2.controller.debuggees.html b/docs/dyn/clouddebugger_v2.controller.debuggees.html
index 9c11afe..46ed047 100644
--- a/docs/dyn/clouddebugger_v2.controller.debuggees.html
+++ b/docs/dyn/clouddebugger_v2.controller.debuggees.html
@@ -160,16 +160,16 @@
"workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
# A cloud workspace is a place associated with a repo where modified files
# can be stored before they are committed.
+ "name": "A String", # The unique name of the workspace within the repo. This is the name
+ # chosen by the client in the Source API's CreateWorkspace method.
"repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
- "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
# (e.g. winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
+ "uid": "A String", # A server-assigned, globally unique identifier.
},
- "name": "A String", # The unique name of the workspace within the repo. This is the name
- # chosen by the client in the Source API's CreateWorkspace method.
},
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
@@ -181,12 +181,12 @@
"revisionId": "A String", # A revision ID.
"aliasName": "A String", # The name of an alias (branch, tag, etc.).
"repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
# (e.g. winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
+ "uid": "A String", # A server-assigned, globally unique identifier.
},
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).
@@ -201,11 +201,11 @@
"name": "A String", # The alias name.
},
"revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- "aliasName": "A String", # The name of an alias (branch, tag, etc.).
"gerritProject": "A String", # The full project name within the host. Projects may be nested, so
# "project/subproject" is a valid project name.
# The "repo name" is hostURI/project.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "aliasName": "A String", # The name of an alias (branch, tag, etc.).
},
},
],
@@ -228,16 +228,16 @@
"workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
# A cloud workspace is a place associated with a repo where modified files
# can be stored before they are committed.
+ "name": "A String", # The unique name of the workspace within the repo. This is the name
+ # chosen by the client in the Source API's CreateWorkspace method.
"repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
- "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
# (e.g. winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
+ "uid": "A String", # A server-assigned, globally unique identifier.
},
- "name": "A String", # The unique name of the workspace within the repo. This is the name
- # chosen by the client in the Source API's CreateWorkspace method.
},
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
@@ -249,12 +249,12 @@
"revisionId": "A String", # A revision ID.
"aliasName": "A String", # The name of an alias (branch, tag, etc.).
"repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
# (e.g. winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
+ "uid": "A String", # A server-assigned, globally unique identifier.
},
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).
@@ -269,11 +269,11 @@
"name": "A String", # The alias name.
},
"revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- "aliasName": "A String", # The name of an alias (branch, tag, etc.).
"gerritProject": "A String", # The full project name within the host. Projects may be nested, so
# "project/subproject" is a valid project name.
# The "repo name" is hostURI/project.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "aliasName": "A String", # The name of an alias (branch, tag, etc.).
},
},
},
@@ -354,16 +354,16 @@
"workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
# A cloud workspace is a place associated with a repo where modified files
# can be stored before they are committed.
+ "name": "A String", # The unique name of the workspace within the repo. This is the name
+ # chosen by the client in the Source API's CreateWorkspace method.
"repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
- "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
# (e.g. winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
+ "uid": "A String", # A server-assigned, globally unique identifier.
},
- "name": "A String", # The unique name of the workspace within the repo. This is the name
- # chosen by the client in the Source API's CreateWorkspace method.
},
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
@@ -375,12 +375,12 @@
"revisionId": "A String", # A revision ID.
"aliasName": "A String", # The name of an alias (branch, tag, etc.).
"repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
# (e.g. winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
+ "uid": "A String", # A server-assigned, globally unique identifier.
},
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).
@@ -395,11 +395,11 @@
"name": "A String", # The alias name.
},
"revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- "aliasName": "A String", # The name of an alias (branch, tag, etc.).
"gerritProject": "A String", # The full project name within the host. Projects may be nested, so
# "project/subproject" is a valid project name.
# The "repo name" is hostURI/project.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "aliasName": "A String", # The name of an alias (branch, tag, etc.).
},
},
],
@@ -422,16 +422,16 @@
"workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
# A cloud workspace is a place associated with a repo where modified files
# can be stored before they are committed.
+ "name": "A String", # The unique name of the workspace within the repo. This is the name
+ # chosen by the client in the Source API's CreateWorkspace method.
"repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
- "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
# (e.g. winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
+ "uid": "A String", # A server-assigned, globally unique identifier.
},
- "name": "A String", # The unique name of the workspace within the repo. This is the name
- # chosen by the client in the Source API's CreateWorkspace method.
},
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
@@ -443,12 +443,12 @@
"revisionId": "A String", # A revision ID.
"aliasName": "A String", # The name of an alias (branch, tag, etc.).
"repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
# (e.g. winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
+ "uid": "A String", # A server-assigned, globally unique identifier.
},
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).
@@ -463,11 +463,11 @@
"name": "A String", # The alias name.
},
"revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- "aliasName": "A String", # The name of an alias (branch, tag, etc.).
"gerritProject": "A String", # The full project name within the host. Projects may be nested, so
# "project/subproject" is a valid project name.
# The "repo name" is hostURI/project.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "aliasName": "A String", # The name of an alias (branch, tag, etc.).
},
},
},
diff --git a/docs/dyn/clouddebugger_v2.debugger.debuggees.breakpoints.html b/docs/dyn/clouddebugger_v2.debugger.debuggees.breakpoints.html
index d84c5dd..081f52d 100644
--- a/docs/dyn/clouddebugger_v2.debugger.debuggees.breakpoints.html
+++ b/docs/dyn/clouddebugger_v2.debugger.debuggees.breakpoints.html
@@ -347,195 +347,15 @@
# rather than a static type of an object.
},
],
- "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds
- # resolution.
+ "userEmail": "A String", # E-mail address of the user that created this breakpoint
"logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`.
"labels": { # A set of custom breakpoint properties, populated by the agent, to be
# displayed to the user.
"a_key": "A String",
},
- "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when
- # the breakpoint hits. The message may include parameter placeholders `$0`,
- # `$1`, etc. These placeholders are replaced with the evaluated value
- # of the appropriate expression. Expressions not referenced in
- # `log_message_format` are not logged.
- #
- # Example: `Message received, id = $0, count = $1` with
- # `expressions` = `[ message.id, message.count ]`.
- "userEmail": "A String", # E-mail address of the user that created this breakpoint
- "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
"stackFrames": [ # The stack at breakpoint time.
{ # Represents a stack frame context.
"function": "A String", # Demangled function name at the call site.
- "location": { # Represents a location in the source code. # Source location of the call site.
- "path": "A String", # Path to the source file within the source context of the target binary.
- "line": 42, # Line inside the file. The first line in the file has the value `1`.
- },
- "locals": [ # Set of local variables at the stack frame location.
- # Note that this might not be populated for all stack frames.
- { # Represents a variable or an argument possibly of a compound object type.
- # Note how the following variables are represented:
- #
- # 1) A simple variable:
- #
- # int x = 5
- #
- # { name: "x", value: "5", type: "int" } // Captured variable
- #
- # 2) A compound object:
- #
- # struct T {
- # int m1;
- # int m2;
- # };
- # T x = { 3, 7 };
- #
- # { // Captured variable
- # name: "x",
- # type: "T",
- # members { name: "m1", value: "3", type: "int" },
- # members { name: "m2", value: "7", type: "int" }
- # }
- #
- # 3) A pointer where the pointee was captured:
- #
- # T x = { 3, 7 };
- # T* p = &x;
- #
- # { // Captured variable
- # name: "p",
- # type: "T*",
- # value: "0x00500500",
- # members { name: "m1", value: "3", type: "int" },
- # members { name: "m2", value: "7", type: "int" }
- # }
- #
- # 4) A pointer where the pointee was not captured:
- #
- # T* p = new T;
- #
- # { // Captured variable
- # name: "p",
- # type: "T*",
- # value: "0x00400400"
- # status { is_error: true, description { format: "unavailable" } }
- # }
- #
- # The status should describe the reason for the missing value,
- # such as `<optimized out>`, `<inaccessible>`, `<pointers limit reached>`.
- #
- # Note that a null pointer should not have members.
- #
- # 5) An unnamed value:
- #
- # int* p = new int(7);
- #
- # { // Captured variable
- # name: "p",
- # value: "0x00500500",
- # type: "int*",
- # members { value: "7", type: "int" } }
- #
- # 6) An unnamed pointer where the pointee was not captured:
- #
- # int* p = new int(7);
- # int** pp = &p;
- #
- # { // Captured variable
- # name: "pp",
- # value: "0x00500500",
- # type: "int**",
- # members {
- # value: "0x00400400",
- # type: "int*"
- # status {
- # is_error: true,
- # description: { format: "unavailable" } }
- # }
- # }
- # }
- #
- # To optimize computation, memory and network traffic, variables that
- # repeat in the output multiple times can be stored once in a shared
- # variable table and be referenced using the `var_table_index` field. The
- # variables stored in the shared table are nameless and are essentially
- # a partition of the complete variable. To reconstruct the complete
- # variable, merge the referencing variable with the referenced variable.
- #
- # When using the shared variable table, the following variables:
- #
- # T x = { 3, 7 };
- # T* p = &x;
- # T& r = x;
- #
- # { name: "x", var_table_index: 3, type: "T" } // Captured variables
- # { name: "p", value "0x00500500", type="T*", var_table_index: 3 }
- # { name: "r", type="T&", var_table_index: 3 }
- #
- # { // Shared variable table entry #3:
- # members { name: "m1", value: "3", type: "int" },
- # members { name: "m2", value: "7", type: "int" }
- # }
- #
- # Note that the pointer address is stored with the referencing variable
- # and not with the referenced variable. This allows the referenced variable
- # to be shared between pointers and references.
- #
- # The type field is optional. The debugger agent may or may not support it.
- "status": { # Represents a contextual status message. # Status associated with the variable. This field will usually stay
- # unset. A status of a single variable only applies to that variable or
- # expression. The rest of breakpoint data still remains valid. Variables
- # might be reported in error state even when breakpoint is not in final
- # state.
- #
- # The message may refer to variable name with `refers_to` set to
- # `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.
- # In either case variable value and members will be unset.
- #
- # Example of error message applied to name: `Invalid expression syntax`.
- #
- # Example of information message applied to value: `Not captured`.
- #
- # Examples of error message applied to value:
- #
- # * `Malformed string`,
- # * `Field f not found in class C`
- # * `Null pointer dereference`
- # The message can indicate an error or informational status, and refer to
- # specific parts of the containing object.
- # For example, the `Breakpoint.status` field can indicate an error referring
- # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
- "isError": True or False, # Distinguishes errors from informational messages.
- "refersTo": "A String", # Reference to which the message applies.
- "description": { # Represents a message with parameters. # Status message text.
- "parameters": [ # Optional parameters to be embedded into the message.
- "A String",
- ],
- "format": "A String", # Format template for the message. The `format` uses placeholders `$0`,
- # `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
- # character.
- #
- # Examples:
- #
- # * `Failed to load '$0' which helps debug $1 the first time it
- # is loaded. Again, $0 is very important.`
- # * `Please pay $$10 to use $0 instead of $1.`
- },
- },
- "name": "A String", # Name of the variable, if any.
- "varTableIndex": 42, # Reference to a variable in the shared variable table. More than
- # one variable can reference the same variable in the table. The
- # `var_table_index` field is an index into `variable_table` in Breakpoint.
- "value": "A String", # Simple value of the variable.
- "members": [ # Members contained or pointed to by the variable.
- # Object with schema name: Variable
- ],
- "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with
- # `var_table_index`, `type` goes next to `value`. The interpretation of
- # a type is agent specific. It is recommended to include the dynamic type
- # rather than a static type of an object.
- },
- ],
"arguments": [ # Set of arguments passed to this function.
# Note that this might not be populated for all stack frames.
{ # Represents a variable or an argument possibly of a compound object type.
@@ -701,20 +521,200 @@
# rather than a static type of an object.
},
],
+ "locals": [ # Set of local variables at the stack frame location.
+ # Note that this might not be populated for all stack frames.
+ { # Represents a variable or an argument possibly of a compound object type.
+ # Note how the following variables are represented:
+ #
+ # 1) A simple variable:
+ #
+ # int x = 5
+ #
+ # { name: "x", value: "5", type: "int" } // Captured variable
+ #
+ # 2) A compound object:
+ #
+ # struct T {
+ # int m1;
+ # int m2;
+ # };
+ # T x = { 3, 7 };
+ #
+ # { // Captured variable
+ # name: "x",
+ # type: "T",
+ # members { name: "m1", value: "3", type: "int" },
+ # members { name: "m2", value: "7", type: "int" }
+ # }
+ #
+ # 3) A pointer where the pointee was captured:
+ #
+ # T x = { 3, 7 };
+ # T* p = &x;
+ #
+ # { // Captured variable
+ # name: "p",
+ # type: "T*",
+ # value: "0x00500500",
+ # members { name: "m1", value: "3", type: "int" },
+ # members { name: "m2", value: "7", type: "int" }
+ # }
+ #
+ # 4) A pointer where the pointee was not captured:
+ #
+ # T* p = new T;
+ #
+ # { // Captured variable
+ # name: "p",
+ # type: "T*",
+ # value: "0x00400400"
+ # status { is_error: true, description { format: "unavailable" } }
+ # }
+ #
+ # The status should describe the reason for the missing value,
+ # such as `<optimized out>`, `<inaccessible>`, `<pointers limit reached>`.
+ #
+ # Note that a null pointer should not have members.
+ #
+ # 5) An unnamed value:
+ #
+ # int* p = new int(7);
+ #
+ # { // Captured variable
+ # name: "p",
+ # value: "0x00500500",
+ # type: "int*",
+ # members { value: "7", type: "int" } }
+ #
+ # 6) An unnamed pointer where the pointee was not captured:
+ #
+ # int* p = new int(7);
+ # int** pp = &p;
+ #
+ # { // Captured variable
+ # name: "pp",
+ # value: "0x00500500",
+ # type: "int**",
+ # members {
+ # value: "0x00400400",
+ # type: "int*"
+ # status {
+ # is_error: true,
+ # description: { format: "unavailable" } }
+ # }
+ # }
+ # }
+ #
+ # To optimize computation, memory and network traffic, variables that
+ # repeat in the output multiple times can be stored once in a shared
+ # variable table and be referenced using the `var_table_index` field. The
+ # variables stored in the shared table are nameless and are essentially
+ # a partition of the complete variable. To reconstruct the complete
+ # variable, merge the referencing variable with the referenced variable.
+ #
+ # When using the shared variable table, the following variables:
+ #
+ # T x = { 3, 7 };
+ # T* p = &x;
+ # T& r = x;
+ #
+ # { name: "x", var_table_index: 3, type: "T" } // Captured variables
+ # { name: "p", value "0x00500500", type="T*", var_table_index: 3 }
+ # { name: "r", type="T&", var_table_index: 3 }
+ #
+ # { // Shared variable table entry #3:
+ # members { name: "m1", value: "3", type: "int" },
+ # members { name: "m2", value: "7", type: "int" }
+ # }
+ #
+ # Note that the pointer address is stored with the referencing variable
+ # and not with the referenced variable. This allows the referenced variable
+ # to be shared between pointers and references.
+ #
+ # The type field is optional. The debugger agent may or may not support it.
+ "status": { # Represents a contextual status message. # Status associated with the variable. This field will usually stay
+ # unset. A status of a single variable only applies to that variable or
+ # expression. The rest of breakpoint data still remains valid. Variables
+ # might be reported in error state even when breakpoint is not in final
+ # state.
+ #
+ # The message may refer to variable name with `refers_to` set to
+ # `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.
+ # In either case variable value and members will be unset.
+ #
+ # Example of error message applied to name: `Invalid expression syntax`.
+ #
+ # Example of information message applied to value: `Not captured`.
+ #
+ # Examples of error message applied to value:
+ #
+ # * `Malformed string`,
+ # * `Field f not found in class C`
+ # * `Null pointer dereference`
+ # The message can indicate an error or informational status, and refer to
+ # specific parts of the containing object.
+ # For example, the `Breakpoint.status` field can indicate an error referring
+ # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
+ "isError": True or False, # Distinguishes errors from informational messages.
+ "refersTo": "A String", # Reference to which the message applies.
+ "description": { # Represents a message with parameters. # Status message text.
+ "parameters": [ # Optional parameters to be embedded into the message.
+ "A String",
+ ],
+ "format": "A String", # Format template for the message. The `format` uses placeholders `$0`,
+ # `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
+ # character.
+ #
+ # Examples:
+ #
+ # * `Failed to load '$0' which helps debug $1 the first time it
+ # is loaded. Again, $0 is very important.`
+ # * `Please pay $$10 to use $0 instead of $1.`
+ },
+ },
+ "name": "A String", # Name of the variable, if any.
+ "varTableIndex": 42, # Reference to a variable in the shared variable table. More than
+ # one variable can reference the same variable in the table. The
+ # `var_table_index` field is an index into `variable_table` in Breakpoint.
+ "value": "A String", # Simple value of the variable.
+ "members": [ # Members contained or pointed to by the variable.
+ # Object with schema name: Variable
+ ],
+ "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with
+ # `var_table_index`, `type` goes next to `value`. The interpretation of
+ # a type is agent specific. It is recommended to include the dynamic type
+ # rather than a static type of an object.
+ },
+ ],
+ "location": { # Represents a location in the source code. # Source location of the call site.
+ "path": "A String", # Path to the source file within the source context of the target binary.
+ "line": 42, # Line inside the file. The first line in the file has the value `1`.
+ },
},
],
- "location": { # Represents a location in the source code. # Breakpoint source location.
- "path": "A String", # Path to the source file within the source context of the target binary.
- "line": 42, # Line inside the file. The first line in the file has the value `1`.
- },
- "action": "A String", # Action that the agent should perform when the code at the
- # breakpoint location is hit.
+ "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
"expressions": [ # List of read-only expressions to evaluate at the breakpoint location.
# The expressions are composed using expressions in the programming language
# at the source location. If the breakpoint action is `LOG`, the evaluated
# expressions are included in log statements.
"A String",
],
+ "location": { # Represents a location in the source code. # Breakpoint source location.
+ "path": "A String", # Path to the source file within the source context of the target binary.
+ "line": 42, # Line inside the file. The first line in the file has the value `1`.
+ },
+ "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds
+ # resolution.
+ "action": "A String", # Action that the agent should perform when the code at the
+ # breakpoint location is hit.
+ "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when
+ # the breakpoint hits. The message may include parameter placeholders `$0`,
+ # `$1`, etc. These placeholders are replaced with the evaluated value
+ # of the appropriate expression. Expressions not referenced in
+ # `log_message_format` are not logged.
+ #
+ # Example: `Message received, id = $0, count = $1` with
+ # `expressions` = `[ message.id, message.count ]`.
"isFinalState": True or False, # When true, indicates that this is a final result and the
# breakpoint state will not change from here on.
"evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time.
@@ -1142,195 +1142,15 @@
# rather than a static type of an object.
},
],
- "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds
- # resolution.
+ "userEmail": "A String", # E-mail address of the user that created this breakpoint
"logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`.
"labels": { # A set of custom breakpoint properties, populated by the agent, to be
# displayed to the user.
"a_key": "A String",
},
- "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when
- # the breakpoint hits. The message may include parameter placeholders `$0`,
- # `$1`, etc. These placeholders are replaced with the evaluated value
- # of the appropriate expression. Expressions not referenced in
- # `log_message_format` are not logged.
- #
- # Example: `Message received, id = $0, count = $1` with
- # `expressions` = `[ message.id, message.count ]`.
- "userEmail": "A String", # E-mail address of the user that created this breakpoint
- "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
"stackFrames": [ # The stack at breakpoint time.
{ # Represents a stack frame context.
"function": "A String", # Demangled function name at the call site.
- "location": { # Represents a location in the source code. # Source location of the call site.
- "path": "A String", # Path to the source file within the source context of the target binary.
- "line": 42, # Line inside the file. The first line in the file has the value `1`.
- },
- "locals": [ # Set of local variables at the stack frame location.
- # Note that this might not be populated for all stack frames.
- { # Represents a variable or an argument possibly of a compound object type.
- # Note how the following variables are represented:
- #
- # 1) A simple variable:
- #
- # int x = 5
- #
- # { name: "x", value: "5", type: "int" } // Captured variable
- #
- # 2) A compound object:
- #
- # struct T {
- # int m1;
- # int m2;
- # };
- # T x = { 3, 7 };
- #
- # { // Captured variable
- # name: "x",
- # type: "T",
- # members { name: "m1", value: "3", type: "int" },
- # members { name: "m2", value: "7", type: "int" }
- # }
- #
- # 3) A pointer where the pointee was captured:
- #
- # T x = { 3, 7 };
- # T* p = &x;
- #
- # { // Captured variable
- # name: "p",
- # type: "T*",
- # value: "0x00500500",
- # members { name: "m1", value: "3", type: "int" },
- # members { name: "m2", value: "7", type: "int" }
- # }
- #
- # 4) A pointer where the pointee was not captured:
- #
- # T* p = new T;
- #
- # { // Captured variable
- # name: "p",
- # type: "T*",
- # value: "0x00400400"
- # status { is_error: true, description { format: "unavailable" } }
- # }
- #
- # The status should describe the reason for the missing value,
- # such as `<optimized out>`, `<inaccessible>`, `<pointers limit reached>`.
- #
- # Note that a null pointer should not have members.
- #
- # 5) An unnamed value:
- #
- # int* p = new int(7);
- #
- # { // Captured variable
- # name: "p",
- # value: "0x00500500",
- # type: "int*",
- # members { value: "7", type: "int" } }
- #
- # 6) An unnamed pointer where the pointee was not captured:
- #
- # int* p = new int(7);
- # int** pp = &p;
- #
- # { // Captured variable
- # name: "pp",
- # value: "0x00500500",
- # type: "int**",
- # members {
- # value: "0x00400400",
- # type: "int*"
- # status {
- # is_error: true,
- # description: { format: "unavailable" } }
- # }
- # }
- # }
- #
- # To optimize computation, memory and network traffic, variables that
- # repeat in the output multiple times can be stored once in a shared
- # variable table and be referenced using the `var_table_index` field. The
- # variables stored in the shared table are nameless and are essentially
- # a partition of the complete variable. To reconstruct the complete
- # variable, merge the referencing variable with the referenced variable.
- #
- # When using the shared variable table, the following variables:
- #
- # T x = { 3, 7 };
- # T* p = &x;
- # T& r = x;
- #
- # { name: "x", var_table_index: 3, type: "T" } // Captured variables
- # { name: "p", value "0x00500500", type="T*", var_table_index: 3 }
- # { name: "r", type="T&", var_table_index: 3 }
- #
- # { // Shared variable table entry #3:
- # members { name: "m1", value: "3", type: "int" },
- # members { name: "m2", value: "7", type: "int" }
- # }
- #
- # Note that the pointer address is stored with the referencing variable
- # and not with the referenced variable. This allows the referenced variable
- # to be shared between pointers and references.
- #
- # The type field is optional. The debugger agent may or may not support it.
- "status": { # Represents a contextual status message. # Status associated with the variable. This field will usually stay
- # unset. A status of a single variable only applies to that variable or
- # expression. The rest of breakpoint data still remains valid. Variables
- # might be reported in error state even when breakpoint is not in final
- # state.
- #
- # The message may refer to variable name with `refers_to` set to
- # `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.
- # In either case variable value and members will be unset.
- #
- # Example of error message applied to name: `Invalid expression syntax`.
- #
- # Example of information message applied to value: `Not captured`.
- #
- # Examples of error message applied to value:
- #
- # * `Malformed string`,
- # * `Field f not found in class C`
- # * `Null pointer dereference`
- # The message can indicate an error or informational status, and refer to
- # specific parts of the containing object.
- # For example, the `Breakpoint.status` field can indicate an error referring
- # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
- "isError": True or False, # Distinguishes errors from informational messages.
- "refersTo": "A String", # Reference to which the message applies.
- "description": { # Represents a message with parameters. # Status message text.
- "parameters": [ # Optional parameters to be embedded into the message.
- "A String",
- ],
- "format": "A String", # Format template for the message. The `format` uses placeholders `$0`,
- # `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
- # character.
- #
- # Examples:
- #
- # * `Failed to load '$0' which helps debug $1 the first time it
- # is loaded. Again, $0 is very important.`
- # * `Please pay $$10 to use $0 instead of $1.`
- },
- },
- "name": "A String", # Name of the variable, if any.
- "varTableIndex": 42, # Reference to a variable in the shared variable table. More than
- # one variable can reference the same variable in the table. The
- # `var_table_index` field is an index into `variable_table` in Breakpoint.
- "value": "A String", # Simple value of the variable.
- "members": [ # Members contained or pointed to by the variable.
- # Object with schema name: Variable
- ],
- "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with
- # `var_table_index`, `type` goes next to `value`. The interpretation of
- # a type is agent specific. It is recommended to include the dynamic type
- # rather than a static type of an object.
- },
- ],
"arguments": [ # Set of arguments passed to this function.
# Note that this might not be populated for all stack frames.
{ # Represents a variable or an argument possibly of a compound object type.
@@ -1496,20 +1316,200 @@
# rather than a static type of an object.
},
],
+ "locals": [ # Set of local variables at the stack frame location.
+ # Note that this might not be populated for all stack frames.
+ { # Represents a variable or an argument possibly of a compound object type.
+ # Note how the following variables are represented:
+ #
+ # 1) A simple variable:
+ #
+ # int x = 5
+ #
+ # { name: "x", value: "5", type: "int" } // Captured variable
+ #
+ # 2) A compound object:
+ #
+ # struct T {
+ # int m1;
+ # int m2;
+ # };
+ # T x = { 3, 7 };
+ #
+ # { // Captured variable
+ # name: "x",
+ # type: "T",
+ # members { name: "m1", value: "3", type: "int" },
+ # members { name: "m2", value: "7", type: "int" }
+ # }
+ #
+ # 3) A pointer where the pointee was captured:
+ #
+ # T x = { 3, 7 };
+ # T* p = &x;
+ #
+ # { // Captured variable
+ # name: "p",
+ # type: "T*",
+ # value: "0x00500500",
+ # members { name: "m1", value: "3", type: "int" },
+ # members { name: "m2", value: "7", type: "int" }
+ # }
+ #
+ # 4) A pointer where the pointee was not captured:
+ #
+ # T* p = new T;
+ #
+ # { // Captured variable
+ # name: "p",
+ # type: "T*",
+ # value: "0x00400400"
+ # status { is_error: true, description { format: "unavailable" } }
+ # }
+ #
+ # The status should describe the reason for the missing value,
+ # such as `<optimized out>`, `<inaccessible>`, `<pointers limit reached>`.
+ #
+ # Note that a null pointer should not have members.
+ #
+ # 5) An unnamed value:
+ #
+ # int* p = new int(7);
+ #
+ # { // Captured variable
+ # name: "p",
+ # value: "0x00500500",
+ # type: "int*",
+ # members { value: "7", type: "int" } }
+ #
+ # 6) An unnamed pointer where the pointee was not captured:
+ #
+ # int* p = new int(7);
+ # int** pp = &p;
+ #
+ # { // Captured variable
+ # name: "pp",
+ # value: "0x00500500",
+ # type: "int**",
+ # members {
+ # value: "0x00400400",
+ # type: "int*"
+ # status {
+ # is_error: true,
+ # description: { format: "unavailable" } }
+ # }
+ # }
+ # }
+ #
+ # To optimize computation, memory and network traffic, variables that
+ # repeat in the output multiple times can be stored once in a shared
+ # variable table and be referenced using the `var_table_index` field. The
+ # variables stored in the shared table are nameless and are essentially
+ # a partition of the complete variable. To reconstruct the complete
+ # variable, merge the referencing variable with the referenced variable.
+ #
+ # When using the shared variable table, the following variables:
+ #
+ # T x = { 3, 7 };
+ # T* p = &x;
+ # T& r = x;
+ #
+ # { name: "x", var_table_index: 3, type: "T" } // Captured variables
+ # { name: "p", value "0x00500500", type="T*", var_table_index: 3 }
+ # { name: "r", type="T&", var_table_index: 3 }
+ #
+ # { // Shared variable table entry #3:
+ # members { name: "m1", value: "3", type: "int" },
+ # members { name: "m2", value: "7", type: "int" }
+ # }
+ #
+ # Note that the pointer address is stored with the referencing variable
+ # and not with the referenced variable. This allows the referenced variable
+ # to be shared between pointers and references.
+ #
+ # The type field is optional. The debugger agent may or may not support it.
+ "status": { # Represents a contextual status message. # Status associated with the variable. This field will usually stay
+ # unset. A status of a single variable only applies to that variable or
+ # expression. The rest of breakpoint data still remains valid. Variables
+ # might be reported in error state even when breakpoint is not in final
+ # state.
+ #
+ # The message may refer to variable name with `refers_to` set to
+ # `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.
+ # In either case variable value and members will be unset.
+ #
+ # Example of error message applied to name: `Invalid expression syntax`.
+ #
+ # Example of information message applied to value: `Not captured`.
+ #
+ # Examples of error message applied to value:
+ #
+ # * `Malformed string`,
+ # * `Field f not found in class C`
+ # * `Null pointer dereference`
+ # The message can indicate an error or informational status, and refer to
+ # specific parts of the containing object.
+ # For example, the `Breakpoint.status` field can indicate an error referring
+ # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
+ "isError": True or False, # Distinguishes errors from informational messages.
+ "refersTo": "A String", # Reference to which the message applies.
+ "description": { # Represents a message with parameters. # Status message text.
+ "parameters": [ # Optional parameters to be embedded into the message.
+ "A String",
+ ],
+ "format": "A String", # Format template for the message. The `format` uses placeholders `$0`,
+ # `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
+ # character.
+ #
+ # Examples:
+ #
+ # * `Failed to load '$0' which helps debug $1 the first time it
+ # is loaded. Again, $0 is very important.`
+ # * `Please pay $$10 to use $0 instead of $1.`
+ },
+ },
+ "name": "A String", # Name of the variable, if any.
+ "varTableIndex": 42, # Reference to a variable in the shared variable table. More than
+ # one variable can reference the same variable in the table. The
+ # `var_table_index` field is an index into `variable_table` in Breakpoint.
+ "value": "A String", # Simple value of the variable.
+ "members": [ # Members contained or pointed to by the variable.
+ # Object with schema name: Variable
+ ],
+ "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with
+ # `var_table_index`, `type` goes next to `value`. The interpretation of
+ # a type is agent specific. It is recommended to include the dynamic type
+ # rather than a static type of an object.
+ },
+ ],
+ "location": { # Represents a location in the source code. # Source location of the call site.
+ "path": "A String", # Path to the source file within the source context of the target binary.
+ "line": 42, # Line inside the file. The first line in the file has the value `1`.
+ },
},
],
- "location": { # Represents a location in the source code. # Breakpoint source location.
- "path": "A String", # Path to the source file within the source context of the target binary.
- "line": 42, # Line inside the file. The first line in the file has the value `1`.
- },
- "action": "A String", # Action that the agent should perform when the code at the
- # breakpoint location is hit.
+ "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
"expressions": [ # List of read-only expressions to evaluate at the breakpoint location.
# The expressions are composed using expressions in the programming language
# at the source location. If the breakpoint action is `LOG`, the evaluated
# expressions are included in log statements.
"A String",
],
+ "location": { # Represents a location in the source code. # Breakpoint source location.
+ "path": "A String", # Path to the source file within the source context of the target binary.
+ "line": 42, # Line inside the file. The first line in the file has the value `1`.
+ },
+ "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds
+ # resolution.
+ "action": "A String", # Action that the agent should perform when the code at the
+ # breakpoint location is hit.
+ "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when
+ # the breakpoint hits. The message may include parameter placeholders `$0`,
+ # `$1`, etc. These placeholders are replaced with the evaluated value
+ # of the appropriate expression. Expressions not referenced in
+ # `log_message_format` are not logged.
+ #
+ # Example: `Message received, id = $0, count = $1` with
+ # `expressions` = `[ message.id, message.count ]`.
"isFinalState": True or False, # When true, indicates that this is a final result and the
# breakpoint state will not change from here on.
"evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time.
@@ -1912,195 +1912,15 @@
# rather than a static type of an object.
},
],
- "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds
- # resolution.
+ "userEmail": "A String", # E-mail address of the user that created this breakpoint
"logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`.
"labels": { # A set of custom breakpoint properties, populated by the agent, to be
# displayed to the user.
"a_key": "A String",
},
- "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when
- # the breakpoint hits. The message may include parameter placeholders `$0`,
- # `$1`, etc. These placeholders are replaced with the evaluated value
- # of the appropriate expression. Expressions not referenced in
- # `log_message_format` are not logged.
- #
- # Example: `Message received, id = $0, count = $1` with
- # `expressions` = `[ message.id, message.count ]`.
- "userEmail": "A String", # E-mail address of the user that created this breakpoint
- "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
"stackFrames": [ # The stack at breakpoint time.
{ # Represents a stack frame context.
"function": "A String", # Demangled function name at the call site.
- "location": { # Represents a location in the source code. # Source location of the call site.
- "path": "A String", # Path to the source file within the source context of the target binary.
- "line": 42, # Line inside the file. The first line in the file has the value `1`.
- },
- "locals": [ # Set of local variables at the stack frame location.
- # Note that this might not be populated for all stack frames.
- { # Represents a variable or an argument possibly of a compound object type.
- # Note how the following variables are represented:
- #
- # 1) A simple variable:
- #
- # int x = 5
- #
- # { name: "x", value: "5", type: "int" } // Captured variable
- #
- # 2) A compound object:
- #
- # struct T {
- # int m1;
- # int m2;
- # };
- # T x = { 3, 7 };
- #
- # { // Captured variable
- # name: "x",
- # type: "T",
- # members { name: "m1", value: "3", type: "int" },
- # members { name: "m2", value: "7", type: "int" }
- # }
- #
- # 3) A pointer where the pointee was captured:
- #
- # T x = { 3, 7 };
- # T* p = &x;
- #
- # { // Captured variable
- # name: "p",
- # type: "T*",
- # value: "0x00500500",
- # members { name: "m1", value: "3", type: "int" },
- # members { name: "m2", value: "7", type: "int" }
- # }
- #
- # 4) A pointer where the pointee was not captured:
- #
- # T* p = new T;
- #
- # { // Captured variable
- # name: "p",
- # type: "T*",
- # value: "0x00400400"
- # status { is_error: true, description { format: "unavailable" } }
- # }
- #
- # The status should describe the reason for the missing value,
- # such as `<optimized out>`, `<inaccessible>`, `<pointers limit reached>`.
- #
- # Note that a null pointer should not have members.
- #
- # 5) An unnamed value:
- #
- # int* p = new int(7);
- #
- # { // Captured variable
- # name: "p",
- # value: "0x00500500",
- # type: "int*",
- # members { value: "7", type: "int" } }
- #
- # 6) An unnamed pointer where the pointee was not captured:
- #
- # int* p = new int(7);
- # int** pp = &p;
- #
- # { // Captured variable
- # name: "pp",
- # value: "0x00500500",
- # type: "int**",
- # members {
- # value: "0x00400400",
- # type: "int*"
- # status {
- # is_error: true,
- # description: { format: "unavailable" } }
- # }
- # }
- # }
- #
- # To optimize computation, memory and network traffic, variables that
- # repeat in the output multiple times can be stored once in a shared
- # variable table and be referenced using the `var_table_index` field. The
- # variables stored in the shared table are nameless and are essentially
- # a partition of the complete variable. To reconstruct the complete
- # variable, merge the referencing variable with the referenced variable.
- #
- # When using the shared variable table, the following variables:
- #
- # T x = { 3, 7 };
- # T* p = &x;
- # T& r = x;
- #
- # { name: "x", var_table_index: 3, type: "T" } // Captured variables
- # { name: "p", value "0x00500500", type="T*", var_table_index: 3 }
- # { name: "r", type="T&", var_table_index: 3 }
- #
- # { // Shared variable table entry #3:
- # members { name: "m1", value: "3", type: "int" },
- # members { name: "m2", value: "7", type: "int" }
- # }
- #
- # Note that the pointer address is stored with the referencing variable
- # and not with the referenced variable. This allows the referenced variable
- # to be shared between pointers and references.
- #
- # The type field is optional. The debugger agent may or may not support it.
- "status": { # Represents a contextual status message. # Status associated with the variable. This field will usually stay
- # unset. A status of a single variable only applies to that variable or
- # expression. The rest of breakpoint data still remains valid. Variables
- # might be reported in error state even when breakpoint is not in final
- # state.
- #
- # The message may refer to variable name with `refers_to` set to
- # `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.
- # In either case variable value and members will be unset.
- #
- # Example of error message applied to name: `Invalid expression syntax`.
- #
- # Example of information message applied to value: `Not captured`.
- #
- # Examples of error message applied to value:
- #
- # * `Malformed string`,
- # * `Field f not found in class C`
- # * `Null pointer dereference`
- # The message can indicate an error or informational status, and refer to
- # specific parts of the containing object.
- # For example, the `Breakpoint.status` field can indicate an error referring
- # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
- "isError": True or False, # Distinguishes errors from informational messages.
- "refersTo": "A String", # Reference to which the message applies.
- "description": { # Represents a message with parameters. # Status message text.
- "parameters": [ # Optional parameters to be embedded into the message.
- "A String",
- ],
- "format": "A String", # Format template for the message. The `format` uses placeholders `$0`,
- # `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
- # character.
- #
- # Examples:
- #
- # * `Failed to load '$0' which helps debug $1 the first time it
- # is loaded. Again, $0 is very important.`
- # * `Please pay $$10 to use $0 instead of $1.`
- },
- },
- "name": "A String", # Name of the variable, if any.
- "varTableIndex": 42, # Reference to a variable in the shared variable table. More than
- # one variable can reference the same variable in the table. The
- # `var_table_index` field is an index into `variable_table` in Breakpoint.
- "value": "A String", # Simple value of the variable.
- "members": [ # Members contained or pointed to by the variable.
- # Object with schema name: Variable
- ],
- "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with
- # `var_table_index`, `type` goes next to `value`. The interpretation of
- # a type is agent specific. It is recommended to include the dynamic type
- # rather than a static type of an object.
- },
- ],
"arguments": [ # Set of arguments passed to this function.
# Note that this might not be populated for all stack frames.
{ # Represents a variable or an argument possibly of a compound object type.
@@ -2266,20 +2086,200 @@
# rather than a static type of an object.
},
],
+ "locals": [ # Set of local variables at the stack frame location.
+ # Note that this might not be populated for all stack frames.
+ { # Represents a variable or an argument possibly of a compound object type.
+ # Note how the following variables are represented:
+ #
+ # 1) A simple variable:
+ #
+ # int x = 5
+ #
+ # { name: "x", value: "5", type: "int" } // Captured variable
+ #
+ # 2) A compound object:
+ #
+ # struct T {
+ # int m1;
+ # int m2;
+ # };
+ # T x = { 3, 7 };
+ #
+ # { // Captured variable
+ # name: "x",
+ # type: "T",
+ # members { name: "m1", value: "3", type: "int" },
+ # members { name: "m2", value: "7", type: "int" }
+ # }
+ #
+ # 3) A pointer where the pointee was captured:
+ #
+ # T x = { 3, 7 };
+ # T* p = &x;
+ #
+ # { // Captured variable
+ # name: "p",
+ # type: "T*",
+ # value: "0x00500500",
+ # members { name: "m1", value: "3", type: "int" },
+ # members { name: "m2", value: "7", type: "int" }
+ # }
+ #
+ # 4) A pointer where the pointee was not captured:
+ #
+ # T* p = new T;
+ #
+ # { // Captured variable
+ # name: "p",
+ # type: "T*",
+ # value: "0x00400400"
+ # status { is_error: true, description { format: "unavailable" } }
+ # }
+ #
+ # The status should describe the reason for the missing value,
+ # such as `<optimized out>`, `<inaccessible>`, `<pointers limit reached>`.
+ #
+ # Note that a null pointer should not have members.
+ #
+ # 5) An unnamed value:
+ #
+ # int* p = new int(7);
+ #
+ # { // Captured variable
+ # name: "p",
+ # value: "0x00500500",
+ # type: "int*",
+ # members { value: "7", type: "int" } }
+ #
+ # 6) An unnamed pointer where the pointee was not captured:
+ #
+ # int* p = new int(7);
+ # int** pp = &p;
+ #
+ # { // Captured variable
+ # name: "pp",
+ # value: "0x00500500",
+ # type: "int**",
+ # members {
+ # value: "0x00400400",
+ # type: "int*"
+ # status {
+ # is_error: true,
+ # description: { format: "unavailable" } }
+ # }
+ # }
+ # }
+ #
+ # To optimize computation, memory and network traffic, variables that
+ # repeat in the output multiple times can be stored once in a shared
+ # variable table and be referenced using the `var_table_index` field. The
+ # variables stored in the shared table are nameless and are essentially
+ # a partition of the complete variable. To reconstruct the complete
+ # variable, merge the referencing variable with the referenced variable.
+ #
+ # When using the shared variable table, the following variables:
+ #
+ # T x = { 3, 7 };
+ # T* p = &x;
+ # T& r = x;
+ #
+ # { name: "x", var_table_index: 3, type: "T" } // Captured variables
+ # { name: "p", value "0x00500500", type="T*", var_table_index: 3 }
+ # { name: "r", type="T&", var_table_index: 3 }
+ #
+ # { // Shared variable table entry #3:
+ # members { name: "m1", value: "3", type: "int" },
+ # members { name: "m2", value: "7", type: "int" }
+ # }
+ #
+ # Note that the pointer address is stored with the referencing variable
+ # and not with the referenced variable. This allows the referenced variable
+ # to be shared between pointers and references.
+ #
+ # The type field is optional. The debugger agent may or may not support it.
+ "status": { # Represents a contextual status message. # Status associated with the variable. This field will usually stay
+ # unset. A status of a single variable only applies to that variable or
+ # expression. The rest of breakpoint data still remains valid. Variables
+ # might be reported in error state even when breakpoint is not in final
+ # state.
+ #
+ # The message may refer to variable name with `refers_to` set to
+ # `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.
+ # In either case variable value and members will be unset.
+ #
+ # Example of error message applied to name: `Invalid expression syntax`.
+ #
+ # Example of information message applied to value: `Not captured`.
+ #
+ # Examples of error message applied to value:
+ #
+ # * `Malformed string`,
+ # * `Field f not found in class C`
+ # * `Null pointer dereference`
+ # The message can indicate an error or informational status, and refer to
+ # specific parts of the containing object.
+ # For example, the `Breakpoint.status` field can indicate an error referring
+ # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
+ "isError": True or False, # Distinguishes errors from informational messages.
+ "refersTo": "A String", # Reference to which the message applies.
+ "description": { # Represents a message with parameters. # Status message text.
+ "parameters": [ # Optional parameters to be embedded into the message.
+ "A String",
+ ],
+ "format": "A String", # Format template for the message. The `format` uses placeholders `$0`,
+ # `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
+ # character.
+ #
+ # Examples:
+ #
+ # * `Failed to load '$0' which helps debug $1 the first time it
+ # is loaded. Again, $0 is very important.`
+ # * `Please pay $$10 to use $0 instead of $1.`
+ },
+ },
+ "name": "A String", # Name of the variable, if any.
+ "varTableIndex": 42, # Reference to a variable in the shared variable table. More than
+ # one variable can reference the same variable in the table. The
+ # `var_table_index` field is an index into `variable_table` in Breakpoint.
+ "value": "A String", # Simple value of the variable.
+ "members": [ # Members contained or pointed to by the variable.
+ # Object with schema name: Variable
+ ],
+ "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with
+ # `var_table_index`, `type` goes next to `value`. The interpretation of
+ # a type is agent specific. It is recommended to include the dynamic type
+ # rather than a static type of an object.
+ },
+ ],
+ "location": { # Represents a location in the source code. # Source location of the call site.
+ "path": "A String", # Path to the source file within the source context of the target binary.
+ "line": 42, # Line inside the file. The first line in the file has the value `1`.
+ },
},
],
- "location": { # Represents a location in the source code. # Breakpoint source location.
- "path": "A String", # Path to the source file within the source context of the target binary.
- "line": 42, # Line inside the file. The first line in the file has the value `1`.
- },
- "action": "A String", # Action that the agent should perform when the code at the
- # breakpoint location is hit.
+ "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
"expressions": [ # List of read-only expressions to evaluate at the breakpoint location.
# The expressions are composed using expressions in the programming language
# at the source location. If the breakpoint action is `LOG`, the evaluated
# expressions are included in log statements.
"A String",
],
+ "location": { # Represents a location in the source code. # Breakpoint source location.
+ "path": "A String", # Path to the source file within the source context of the target binary.
+ "line": 42, # Line inside the file. The first line in the file has the value `1`.
+ },
+ "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds
+ # resolution.
+ "action": "A String", # Action that the agent should perform when the code at the
+ # breakpoint location is hit.
+ "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when
+ # the breakpoint hits. The message may include parameter placeholders `$0`,
+ # `$1`, etc. These placeholders are replaced with the evaluated value
+ # of the appropriate expression. Expressions not referenced in
+ # `log_message_format` are not logged.
+ #
+ # Example: `Message received, id = $0, count = $1` with
+ # `expressions` = `[ message.id, message.count ]`.
"isFinalState": True or False, # When true, indicates that this is a final result and the
# breakpoint state will not change from here on.
"evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time.
@@ -2682,195 +2682,15 @@
# rather than a static type of an object.
},
],
- "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds
- # resolution.
+ "userEmail": "A String", # E-mail address of the user that created this breakpoint
"logLevel": "A String", # Indicates the severity of the log. Only relevant when action is `LOG`.
"labels": { # A set of custom breakpoint properties, populated by the agent, to be
# displayed to the user.
"a_key": "A String",
},
- "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when
- # the breakpoint hits. The message may include parameter placeholders `$0`,
- # `$1`, etc. These placeholders are replaced with the evaluated value
- # of the appropriate expression. Expressions not referenced in
- # `log_message_format` are not logged.
- #
- # Example: `Message received, id = $0, count = $1` with
- # `expressions` = `[ message.id, message.count ]`.
- "userEmail": "A String", # E-mail address of the user that created this breakpoint
- "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
"stackFrames": [ # The stack at breakpoint time.
{ # Represents a stack frame context.
"function": "A String", # Demangled function name at the call site.
- "location": { # Represents a location in the source code. # Source location of the call site.
- "path": "A String", # Path to the source file within the source context of the target binary.
- "line": 42, # Line inside the file. The first line in the file has the value `1`.
- },
- "locals": [ # Set of local variables at the stack frame location.
- # Note that this might not be populated for all stack frames.
- { # Represents a variable or an argument possibly of a compound object type.
- # Note how the following variables are represented:
- #
- # 1) A simple variable:
- #
- # int x = 5
- #
- # { name: "x", value: "5", type: "int" } // Captured variable
- #
- # 2) A compound object:
- #
- # struct T {
- # int m1;
- # int m2;
- # };
- # T x = { 3, 7 };
- #
- # { // Captured variable
- # name: "x",
- # type: "T",
- # members { name: "m1", value: "3", type: "int" },
- # members { name: "m2", value: "7", type: "int" }
- # }
- #
- # 3) A pointer where the pointee was captured:
- #
- # T x = { 3, 7 };
- # T* p = &x;
- #
- # { // Captured variable
- # name: "p",
- # type: "T*",
- # value: "0x00500500",
- # members { name: "m1", value: "3", type: "int" },
- # members { name: "m2", value: "7", type: "int" }
- # }
- #
- # 4) A pointer where the pointee was not captured:
- #
- # T* p = new T;
- #
- # { // Captured variable
- # name: "p",
- # type: "T*",
- # value: "0x00400400"
- # status { is_error: true, description { format: "unavailable" } }
- # }
- #
- # The status should describe the reason for the missing value,
- # such as `<optimized out>`, `<inaccessible>`, `<pointers limit reached>`.
- #
- # Note that a null pointer should not have members.
- #
- # 5) An unnamed value:
- #
- # int* p = new int(7);
- #
- # { // Captured variable
- # name: "p",
- # value: "0x00500500",
- # type: "int*",
- # members { value: "7", type: "int" } }
- #
- # 6) An unnamed pointer where the pointee was not captured:
- #
- # int* p = new int(7);
- # int** pp = &p;
- #
- # { // Captured variable
- # name: "pp",
- # value: "0x00500500",
- # type: "int**",
- # members {
- # value: "0x00400400",
- # type: "int*"
- # status {
- # is_error: true,
- # description: { format: "unavailable" } }
- # }
- # }
- # }
- #
- # To optimize computation, memory and network traffic, variables that
- # repeat in the output multiple times can be stored once in a shared
- # variable table and be referenced using the `var_table_index` field. The
- # variables stored in the shared table are nameless and are essentially
- # a partition of the complete variable. To reconstruct the complete
- # variable, merge the referencing variable with the referenced variable.
- #
- # When using the shared variable table, the following variables:
- #
- # T x = { 3, 7 };
- # T* p = &x;
- # T& r = x;
- #
- # { name: "x", var_table_index: 3, type: "T" } // Captured variables
- # { name: "p", value "0x00500500", type="T*", var_table_index: 3 }
- # { name: "r", type="T&", var_table_index: 3 }
- #
- # { // Shared variable table entry #3:
- # members { name: "m1", value: "3", type: "int" },
- # members { name: "m2", value: "7", type: "int" }
- # }
- #
- # Note that the pointer address is stored with the referencing variable
- # and not with the referenced variable. This allows the referenced variable
- # to be shared between pointers and references.
- #
- # The type field is optional. The debugger agent may or may not support it.
- "status": { # Represents a contextual status message. # Status associated with the variable. This field will usually stay
- # unset. A status of a single variable only applies to that variable or
- # expression. The rest of breakpoint data still remains valid. Variables
- # might be reported in error state even when breakpoint is not in final
- # state.
- #
- # The message may refer to variable name with `refers_to` set to
- # `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.
- # In either case variable value and members will be unset.
- #
- # Example of error message applied to name: `Invalid expression syntax`.
- #
- # Example of information message applied to value: `Not captured`.
- #
- # Examples of error message applied to value:
- #
- # * `Malformed string`,
- # * `Field f not found in class C`
- # * `Null pointer dereference`
- # The message can indicate an error or informational status, and refer to
- # specific parts of the containing object.
- # For example, the `Breakpoint.status` field can indicate an error referring
- # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
- "isError": True or False, # Distinguishes errors from informational messages.
- "refersTo": "A String", # Reference to which the message applies.
- "description": { # Represents a message with parameters. # Status message text.
- "parameters": [ # Optional parameters to be embedded into the message.
- "A String",
- ],
- "format": "A String", # Format template for the message. The `format` uses placeholders `$0`,
- # `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
- # character.
- #
- # Examples:
- #
- # * `Failed to load '$0' which helps debug $1 the first time it
- # is loaded. Again, $0 is very important.`
- # * `Please pay $$10 to use $0 instead of $1.`
- },
- },
- "name": "A String", # Name of the variable, if any.
- "varTableIndex": 42, # Reference to a variable in the shared variable table. More than
- # one variable can reference the same variable in the table. The
- # `var_table_index` field is an index into `variable_table` in Breakpoint.
- "value": "A String", # Simple value of the variable.
- "members": [ # Members contained or pointed to by the variable.
- # Object with schema name: Variable
- ],
- "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with
- # `var_table_index`, `type` goes next to `value`. The interpretation of
- # a type is agent specific. It is recommended to include the dynamic type
- # rather than a static type of an object.
- },
- ],
"arguments": [ # Set of arguments passed to this function.
# Note that this might not be populated for all stack frames.
{ # Represents a variable or an argument possibly of a compound object type.
@@ -3036,20 +2856,200 @@
# rather than a static type of an object.
},
],
+ "locals": [ # Set of local variables at the stack frame location.
+ # Note that this might not be populated for all stack frames.
+ { # Represents a variable or an argument possibly of a compound object type.
+ # Note how the following variables are represented:
+ #
+ # 1) A simple variable:
+ #
+ # int x = 5
+ #
+ # { name: "x", value: "5", type: "int" } // Captured variable
+ #
+ # 2) A compound object:
+ #
+ # struct T {
+ # int m1;
+ # int m2;
+ # };
+ # T x = { 3, 7 };
+ #
+ # { // Captured variable
+ # name: "x",
+ # type: "T",
+ # members { name: "m1", value: "3", type: "int" },
+ # members { name: "m2", value: "7", type: "int" }
+ # }
+ #
+ # 3) A pointer where the pointee was captured:
+ #
+ # T x = { 3, 7 };
+ # T* p = &x;
+ #
+ # { // Captured variable
+ # name: "p",
+ # type: "T*",
+ # value: "0x00500500",
+ # members { name: "m1", value: "3", type: "int" },
+ # members { name: "m2", value: "7", type: "int" }
+ # }
+ #
+ # 4) A pointer where the pointee was not captured:
+ #
+ # T* p = new T;
+ #
+ # { // Captured variable
+ # name: "p",
+ # type: "T*",
+ # value: "0x00400400"
+ # status { is_error: true, description { format: "unavailable" } }
+ # }
+ #
+ # The status should describe the reason for the missing value,
+ # such as `<optimized out>`, `<inaccessible>`, `<pointers limit reached>`.
+ #
+ # Note that a null pointer should not have members.
+ #
+ # 5) An unnamed value:
+ #
+ # int* p = new int(7);
+ #
+ # { // Captured variable
+ # name: "p",
+ # value: "0x00500500",
+ # type: "int*",
+ # members { value: "7", type: "int" } }
+ #
+ # 6) An unnamed pointer where the pointee was not captured:
+ #
+ # int* p = new int(7);
+ # int** pp = &p;
+ #
+ # { // Captured variable
+ # name: "pp",
+ # value: "0x00500500",
+ # type: "int**",
+ # members {
+ # value: "0x00400400",
+ # type: "int*"
+ # status {
+ # is_error: true,
+ # description: { format: "unavailable" } }
+ # }
+ # }
+ # }
+ #
+ # To optimize computation, memory and network traffic, variables that
+ # repeat in the output multiple times can be stored once in a shared
+ # variable table and be referenced using the `var_table_index` field. The
+ # variables stored in the shared table are nameless and are essentially
+ # a partition of the complete variable. To reconstruct the complete
+ # variable, merge the referencing variable with the referenced variable.
+ #
+ # When using the shared variable table, the following variables:
+ #
+ # T x = { 3, 7 };
+ # T* p = &x;
+ # T& r = x;
+ #
+ # { name: "x", var_table_index: 3, type: "T" } // Captured variables
+ # { name: "p", value "0x00500500", type="T*", var_table_index: 3 }
+ # { name: "r", type="T&", var_table_index: 3 }
+ #
+ # { // Shared variable table entry #3:
+ # members { name: "m1", value: "3", type: "int" },
+ # members { name: "m2", value: "7", type: "int" }
+ # }
+ #
+ # Note that the pointer address is stored with the referencing variable
+ # and not with the referenced variable. This allows the referenced variable
+ # to be shared between pointers and references.
+ #
+ # The type field is optional. The debugger agent may or may not support it.
+ "status": { # Represents a contextual status message. # Status associated with the variable. This field will usually stay
+ # unset. A status of a single variable only applies to that variable or
+ # expression. The rest of breakpoint data still remains valid. Variables
+ # might be reported in error state even when breakpoint is not in final
+ # state.
+ #
+ # The message may refer to variable name with `refers_to` set to
+ # `VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.
+ # In either case variable value and members will be unset.
+ #
+ # Example of error message applied to name: `Invalid expression syntax`.
+ #
+ # Example of information message applied to value: `Not captured`.
+ #
+ # Examples of error message applied to value:
+ #
+ # * `Malformed string`,
+ # * `Field f not found in class C`
+ # * `Null pointer dereference`
+ # The message can indicate an error or informational status, and refer to
+ # specific parts of the containing object.
+ # For example, the `Breakpoint.status` field can indicate an error referring
+ # to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.
+ "isError": True or False, # Distinguishes errors from informational messages.
+ "refersTo": "A String", # Reference to which the message applies.
+ "description": { # Represents a message with parameters. # Status message text.
+ "parameters": [ # Optional parameters to be embedded into the message.
+ "A String",
+ ],
+ "format": "A String", # Format template for the message. The `format` uses placeholders `$0`,
+ # `$1`, etc. to reference parameters. `$$` can be used to denote the `$`
+ # character.
+ #
+ # Examples:
+ #
+ # * `Failed to load '$0' which helps debug $1 the first time it
+ # is loaded. Again, $0 is very important.`
+ # * `Please pay $$10 to use $0 instead of $1.`
+ },
+ },
+ "name": "A String", # Name of the variable, if any.
+ "varTableIndex": 42, # Reference to a variable in the shared variable table. More than
+ # one variable can reference the same variable in the table. The
+ # `var_table_index` field is an index into `variable_table` in Breakpoint.
+ "value": "A String", # Simple value of the variable.
+ "members": [ # Members contained or pointed to by the variable.
+ # Object with schema name: Variable
+ ],
+ "type": "A String", # Variable type (e.g. `MyClass`). If the variable is split with
+ # `var_table_index`, `type` goes next to `value`. The interpretation of
+ # a type is agent specific. It is recommended to include the dynamic type
+ # rather than a static type of an object.
+ },
+ ],
+ "location": { # Represents a location in the source code. # Source location of the call site.
+ "path": "A String", # Path to the source file within the source context of the target binary.
+ "line": 42, # Line inside the file. The first line in the file has the value `1`.
+ },
},
],
- "location": { # Represents a location in the source code. # Breakpoint source location.
- "path": "A String", # Path to the source file within the source context of the target binary.
- "line": 42, # Line inside the file. The first line in the file has the value `1`.
- },
- "action": "A String", # Action that the agent should perform when the code at the
- # breakpoint location is hit.
+ "createTime": "A String", # Time this breakpoint was created by the server in seconds resolution.
"expressions": [ # List of read-only expressions to evaluate at the breakpoint location.
# The expressions are composed using expressions in the programming language
# at the source location. If the breakpoint action is `LOG`, the evaluated
# expressions are included in log statements.
"A String",
],
+ "location": { # Represents a location in the source code. # Breakpoint source location.
+ "path": "A String", # Path to the source file within the source context of the target binary.
+ "line": 42, # Line inside the file. The first line in the file has the value `1`.
+ },
+ "finalTime": "A String", # Time this breakpoint was finalized as seen by the server in seconds
+ # resolution.
+ "action": "A String", # Action that the agent should perform when the code at the
+ # breakpoint location is hit.
+ "logMessageFormat": "A String", # Only relevant when action is `LOG`. Defines the message to log when
+ # the breakpoint hits. The message may include parameter placeholders `$0`,
+ # `$1`, etc. These placeholders are replaced with the evaluated value
+ # of the appropriate expression. Expressions not referenced in
+ # `log_message_format` are not logged.
+ #
+ # Example: `Message received, id = $0, count = $1` with
+ # `expressions` = `[ message.id, message.count ]`.
"isFinalState": True or False, # When true, indicates that this is a final result and the
# breakpoint state will not change from here on.
"evaluatedExpressions": [ # Values of evaluated expressions at breakpoint time.
diff --git a/docs/dyn/clouddebugger_v2.debugger.debuggees.html b/docs/dyn/clouddebugger_v2.debugger.debuggees.html
index 589aed2..78a862b 100644
--- a/docs/dyn/clouddebugger_v2.debugger.debuggees.html
+++ b/docs/dyn/clouddebugger_v2.debugger.debuggees.html
@@ -164,16 +164,16 @@
"workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
# A cloud workspace is a place associated with a repo where modified files
# can be stored before they are committed.
+ "name": "A String", # The unique name of the workspace within the repo. This is the name
+ # chosen by the client in the Source API's CreateWorkspace method.
"repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
- "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
# (e.g. winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
+ "uid": "A String", # A server-assigned, globally unique identifier.
},
- "name": "A String", # The unique name of the workspace within the repo. This is the name
- # chosen by the client in the Source API's CreateWorkspace method.
},
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
@@ -185,12 +185,12 @@
"revisionId": "A String", # A revision ID.
"aliasName": "A String", # The name of an alias (branch, tag, etc.).
"repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
# (e.g. winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
+ "uid": "A String", # A server-assigned, globally unique identifier.
},
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).
@@ -205,11 +205,11 @@
"name": "A String", # The alias name.
},
"revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- "aliasName": "A String", # The name of an alias (branch, tag, etc.).
"gerritProject": "A String", # The full project name within the host. Projects may be nested, so
# "project/subproject" is a valid project name.
# The "repo name" is hostURI/project.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "aliasName": "A String", # The name of an alias (branch, tag, etc.).
},
},
],
@@ -232,16 +232,16 @@
"workspaceId": { # A CloudWorkspaceId is a unique identifier for a cloud workspace. # The ID of the workspace.
# A cloud workspace is a place associated with a repo where modified files
# can be stored before they are committed.
+ "name": "A String", # The unique name of the workspace within the repo. This is the name
+ # chosen by the client in the Source API's CreateWorkspace method.
"repoId": { # A unique identifier for a cloud repo. # The ID of the repo containing the workspace.
- "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
# (e.g. winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
+ "uid": "A String", # A server-assigned, globally unique identifier.
},
- "name": "A String", # The unique name of the workspace within the repo. This is the name
- # chosen by the client in the Source API's CreateWorkspace method.
},
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a cloud # A SourceContext referring to a revision in a cloud repo.
@@ -253,12 +253,12 @@
"revisionId": "A String", # A revision ID.
"aliasName": "A String", # The name of an alias (branch, tag, etc.).
"repoId": { # A unique identifier for a cloud repo. # The ID of the repo.
- "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID # A combination of a project ID and a repo name.
# (e.g. winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
+ "uid": "A String", # A server-assigned, globally unique identifier.
},
},
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g. GitHub).
@@ -273,11 +273,11 @@
"name": "A String", # The alias name.
},
"revisionId": "A String", # A revision (commit) ID.
- "hostUri": "A String", # The URI of a running Gerrit instance.
- "aliasName": "A String", # The name of an alias (branch, tag, etc.).
"gerritProject": "A String", # The full project name within the host. Projects may be nested, so
# "project/subproject" is a valid project name.
# The "repo name" is hostURI/project.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
+ "aliasName": "A String", # The name of an alias (branch, tag, etc.).
},
},
},
diff --git a/docs/dyn/clouderrorreporting_v1beta1.projects.events.html b/docs/dyn/clouderrorreporting_v1beta1.projects.events.html
index 2aa6fa4..3a304ad 100644
--- a/docs/dyn/clouderrorreporting_v1beta1.projects.events.html
+++ b/docs/dyn/clouderrorreporting_v1beta1.projects.events.html
@@ -135,10 +135,10 @@
# Contains the service name for error reports extracted from Google
# App Engine logs or `default` if the App Engine default service is used.
},
+ "message": "A String", # The stack trace that was reported or logged by the service.
"eventTime": "A String", # Time when the event occurred as provided in the error report.
# If the report did not contain a timestamp, the time the error was received
# by the Error Reporting system is used.
- "message": "A String", # The stack trace that was reported or logged by the service.
"context": { # A description of the context in which an error occurred. # Data about the context in which the error occurred.
# This data should be provided by the application when reporting an error,
# unless the
@@ -241,9 +241,6 @@
# Contains the service name for error reports extracted from Google
# App Engine logs or `default` if the App Engine default service is used.
},
- "eventTime": "A String", # [Optional] Time when the event occurred.
- # If not provided, the time when the event was received by the
- # Error Reporting system will be used.
"message": "A String", # [Required] The error message.
# If no `context.reportLocation` is provided, the message must contain a
# header (typically consisting of the exception type name and an error
@@ -261,6 +258,9 @@
# * **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)`
# and contain the result of [`(string)$exception`](http://php.net/manual/en/exception.tostring.php).
# * **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).
+ "eventTime": "A String", # [Optional] Time when the event occurred.
+ # If not provided, the time when the event was received by the
+ # Error Reporting system will be used.
"context": { # A description of the context in which an error occurred. # [Optional] A description of the context in which the error occurred.
# This data should be provided by the application when reporting an error,
# unless the
diff --git a/docs/dyn/clouderrorreporting_v1beta1.projects.groupStats.html b/docs/dyn/clouderrorreporting_v1beta1.projects.groupStats.html
index 7b8f72d..931fc84 100644
--- a/docs/dyn/clouderrorreporting_v1beta1.projects.groupStats.html
+++ b/docs/dyn/clouderrorreporting_v1beta1.projects.groupStats.html
@@ -145,27 +145,18 @@
# 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.
- "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.
- # Its version changes over time and multiple versions can run in parallel.
- "resourceType": "A String", # Type of the MonitoredResource. List of possible values:
- # https://cloud.google.com/monitoring/api/resources
- #
- # Value is set automatically for incoming errors and must not be set when
- # reporting errors.
- "version": "A String", # Represents the source code version that the developer provided,
- # which could represent a version label or a Git SHA-1 hash, for example.
- "service": "A String", # An identifier of the service, such as the name of the
- # executable, job, or Google App Engine service name. This field is expected
- # to have a low number of values that are relatively stable over time, as
- # opposed to `version`, which can be changed whenever new code is deployed.
- #
- # Contains the service name for error reports extracted from Google
- # App Engine logs or `default` if the App Engine default service is used.
- },
- ],
+ "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.
+ # Example: https://github.com/user/project/issues/4
+ },
+ ],
+ "groupId": "A String", # Group IDs are unique for a given project. If the same kind of error
+ # occurs in different service contexts, it will receive the same group ID.
+ "name": "A String", # The group resource name.
+ # Example: <code>projects/my-project-123/groups/my-groupid</code>
+ },
"timedCounts": [ # Approximate number of occurrences over time.
# Timed counts returned by ListGroups are guaranteed to be:
#
@@ -205,10 +196,10 @@
# Contains the service name for error reports extracted from Google
# App Engine logs or `default` if the App Engine default service is used.
},
+ "message": "A String", # The stack trace that was reported or logged by the service.
"eventTime": "A String", # Time when the event occurred as provided in the error report.
# If the report did not contain a timestamp, the time the error was received
# by the Error Reporting system is used.
- "message": "A String", # The stack trace that was reported or logged by the service.
"context": { # A description of the context in which an error occurred. # Data about the context in which the error occurred.
# This data should be provided by the application when reporting an error,
# unless the
@@ -257,18 +248,27 @@
},
"numAffectedServices": 42, # The total number of services with a non-zero error count for the given
# filter 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.
- # Example: https://github.com/user/project/issues/4
- },
- ],
- "groupId": "A String", # Group IDs are unique for a given project. If the same kind of error
- # occurs in different service contexts, it will receive the same group ID.
- "name": "A String", # The group resource name.
- # Example: <code>projects/my-project-123/groups/my-groupid</code>
- },
+ "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.
+ # Its version changes over time and multiple versions can run in parallel.
+ "resourceType": "A String", # Type of the MonitoredResource. List of possible values:
+ # https://cloud.google.com/monitoring/api/resources
+ #
+ # Value is set automatically for incoming errors and must not be set when
+ # reporting errors.
+ "version": "A String", # Represents the source code version that the developer provided,
+ # which could represent a version label or a Git SHA-1 hash, for example.
+ "service": "A String", # An identifier of the service, such as the name of the
+ # executable, job, or Google App Engine service name. This field is expected
+ # to have a low number of values that are relatively stable over time, as
+ # opposed to `version`, which can be changed whenever new code is deployed.
+ #
+ # Contains the service name for error reports extracted from Google
+ # App Engine logs or `default` if the App Engine default service is used.
+ },
+ ],
},
],
"timeRangeBegin": "A String", # The timestamp specifies the start time to which the request was restricted.
diff --git a/docs/dyn/cloudfunctions_v1.html b/docs/dyn/cloudfunctions_v1.html
new file mode 100644
index 0000000..d3f6ab8
--- /dev/null
+++ b/docs/dyn/cloudfunctions_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="cloudfunctions_v1.html">Google Cloud Functions API</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="cloudfunctions_v1.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/cloudfunctions_v1.projects.html b/docs/dyn/cloudfunctions_v1.projects.html
new file mode 100644
index 0000000..764c5b0
--- /dev/null
+++ b/docs/dyn/cloudfunctions_v1.projects.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="cloudfunctions_v1.html">Google Cloud Functions API</a> . <a href="cloudfunctions_v1.projects.html">projects</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="cloudfunctions_v1.projects.locations.html">locations()</a></code>
+</p>
+<p class="firstline">Returns the locations Resource.</p>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/cloudfunctions_v1.projects.locations.html b/docs/dyn/cloudfunctions_v1.projects.locations.html
new file mode 100644
index 0000000..1d0fed4
--- /dev/null
+++ b/docs/dyn/cloudfunctions_v1.projects.locations.html
@@ -0,0 +1,111 @@
+<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="cloudfunctions_v1.html">Google Cloud Functions API</a> . <a href="cloudfunctions_v1.projects.html">projects</a> . <a href="cloudfunctions_v1.projects.locations.html">locations</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">Get information about a location.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(name, x__xgafv=None)</code>
+ <pre>Get information about a location.
+
+Args:
+ name: string, Resource name for the location. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A resource that represents Google Cloud Platform location.
+ "labels": { # Cross-service attributes for the location. For example
+ #
+ # {"cloud.googleapis.com/region": "us-east1"}
+ "a_key": "A String",
+ },
+ "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+ "name": "A String", # Resource name for the location, which may vary between implementations.
+ # For example: `"projects/example-project/locations/us-east1"`
+ "metadata": { # Service-specific metadata. For example the available capacity at the given
+ # location.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/cloudfunctions_v1beta2.operations.html b/docs/dyn/cloudfunctions_v1beta2.operations.html
index 8625e39..3a2025f 100644
--- a/docs/dyn/cloudfunctions_v1beta2.operations.html
+++ b/docs/dyn/cloudfunctions_v1beta2.operations.html
@@ -108,22 +108,6 @@
# 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 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:
@@ -187,6 +171,22 @@
},
],
},
+ "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`.
}</pre>
</div>
@@ -212,7 +212,6 @@
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.
@@ -222,22 +221,6 @@
# 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 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:
@@ -301,8 +284,25 @@
},
],
},
+ "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`.
},
],
+ "nextPageToken": "A String", # The standard List next-page token.
}</pre>
</div>
diff --git a/docs/dyn/cloudfunctions_v1beta2.projects.locations.functions.html b/docs/dyn/cloudfunctions_v1beta2.projects.locations.functions.html
index 16ee7c4..7cddd05 100644
--- a/docs/dyn/cloudfunctions_v1beta2.projects.locations.functions.html
+++ b/docs/dyn/cloudfunctions_v1beta2.projects.locations.functions.html
@@ -220,22 +220,6 @@
# 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 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:
@@ -299,6 +283,22 @@
},
],
},
+ "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`.
}</pre>
</div>
@@ -326,22 +326,6 @@
# 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 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:
@@ -405,6 +389,22 @@
},
],
},
+ "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`.
}</pre>
</div>
@@ -688,22 +688,6 @@
# 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 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:
@@ -767,6 +751,22 @@
},
],
},
+ "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`.
}</pre>
</div>
diff --git a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html
index 660dacb..54dbdc4 100644
--- a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html
+++ b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html
@@ -117,15 +117,15 @@
# parent CryptoKey, in which case the server will choose the appropriate
# version for the operation.
"state": "A String", # The current state of the CryptoKeyVersion.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
}
x__xgafv: string, V1 error format.
@@ -143,15 +143,15 @@
# parent CryptoKey, in which case the server will choose the appropriate
# version for the operation.
"state": "A String", # The current state of the CryptoKeyVersion.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
}</pre>
</div>
@@ -193,15 +193,15 @@
# parent CryptoKey, in which case the server will choose the appropriate
# version for the operation.
"state": "A String", # The current state of the CryptoKeyVersion.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
}</pre>
</div>
@@ -226,15 +226,15 @@
# parent CryptoKey, in which case the server will choose the appropriate
# version for the operation.
"state": "A String", # The current state of the CryptoKeyVersion.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
}</pre>
</div>
@@ -274,15 +274,15 @@
# parent CryptoKey, in which case the server will choose the appropriate
# version for the operation.
"state": "A String", # The current state of the CryptoKeyVersion.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
},
],
}</pre>
@@ -325,15 +325,15 @@
# parent CryptoKey, in which case the server will choose the appropriate
# version for the operation.
"state": "A String", # The current state of the CryptoKeyVersion.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
}
updateMask: string, Required list of fields to be updated in this request.
@@ -352,15 +352,15 @@
# parent CryptoKey, in which case the server will choose the appropriate
# version for the operation.
"state": "A String", # The current state of the CryptoKeyVersion.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
}</pre>
</div>
@@ -397,15 +397,15 @@
# parent CryptoKey, in which case the server will choose the appropriate
# version for the operation.
"state": "A String", # The current state of the CryptoKeyVersion.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
}</pre>
</div>
diff --git a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.html b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.html
index 7f85952..f091223 100644
--- a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.html
+++ b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.html
@@ -148,15 +148,15 @@
# parent CryptoKey, in which case the server will choose the appropriate
# version for the operation.
"state": "A String", # The current state of the CryptoKeyVersion.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
},
"purpose": "A String", # The immutable purpose of this CryptoKey. Currently, the only acceptable
# purpose is ENCRYPT_DECRYPT.
@@ -205,15 +205,15 @@
# parent CryptoKey, in which case the server will choose the appropriate
# version for the operation.
"state": "A String", # The current state of the CryptoKeyVersion.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
},
"purpose": "A String", # The immutable purpose of this CryptoKey. Currently, the only acceptable
# purpose is ENCRYPT_DECRYPT.
@@ -332,15 +332,15 @@
# parent CryptoKey, in which case the server will choose the appropriate
# version for the operation.
"state": "A String", # The current state of the CryptoKeyVersion.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
},
"purpose": "A String", # The immutable purpose of this CryptoKey. Currently, the only acceptable
# purpose is ENCRYPT_DECRYPT.
@@ -407,8 +407,8 @@
# [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -487,11 +487,10 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
- "version": 42, # Version of the `Policy`. The default version is 0.
"rules": [ # If more than one rule is specified, the rules are applied in the following
# manner:
# - All matching LOG rules are always applied.
@@ -530,28 +529,6 @@
"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 the only supported field names are
- # - "iam_principal", corresponding to IAMContext.principal;
- # - "" (empty string), resulting in one aggretated counter with no field.
- #
- # 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.
@@ -569,6 +546,7 @@
],
},
],
+ "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
@@ -664,15 +642,15 @@
# parent CryptoKey, in which case the server will choose the appropriate
# version for the operation.
"state": "A String", # The current state of the CryptoKeyVersion.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
},
"purpose": "A String", # The immutable purpose of this CryptoKey. Currently, the only acceptable
# purpose is ENCRYPT_DECRYPT.
@@ -739,15 +717,15 @@
# parent CryptoKey, in which case the server will choose the appropriate
# version for the operation.
"state": "A String", # The current state of the CryptoKeyVersion.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
},
"purpose": "A String", # The immutable purpose of this CryptoKey. Currently, the only acceptable
# purpose is ENCRYPT_DECRYPT.
@@ -795,15 +773,15 @@
# parent CryptoKey, in which case the server will choose the appropriate
# version for the operation.
"state": "A String", # The current state of the CryptoKeyVersion.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
},
"purpose": "A String", # The immutable purpose of this CryptoKey. Currently, the only acceptable
# purpose is ENCRYPT_DECRYPT.
@@ -868,8 +846,8 @@
# [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -948,11 +926,10 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
- "version": 42, # Version of the `Policy`. The default version is 0.
"rules": [ # If more than one rule is specified, the rules are applied in the following
# manner:
# - All matching LOG rules are always applied.
@@ -991,28 +968,6 @@
"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 the only supported field names are
- # - "iam_principal", corresponding to IAMContext.principal;
- # - "" (empty string), resulting in one aggretated counter with no field.
- #
- # 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.
@@ -1030,6 +985,7 @@
],
},
],
+ "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
@@ -1076,8 +1032,8 @@
"iamOwned": True or False,
},
"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
- # the fields in the mask will be modified. If no mask is provided, a default
- # mask is used:
+ # the fields in the mask will be modified. If no mask is provided, the
+ # following default mask is used:
# paths: "bindings, etag"
# This field is only used by Cloud IAM.
}
@@ -1123,8 +1079,8 @@
# [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -1203,11 +1159,10 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
- "version": 42, # Version of the `Policy`. The default version is 0.
"rules": [ # If more than one rule is specified, the rules are applied in the following
# manner:
# - All matching LOG rules are always applied.
@@ -1246,28 +1201,6 @@
"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 the only supported field names are
- # - "iam_principal", corresponding to IAMContext.principal;
- # - "" (empty string), resulting in one aggretated counter with no field.
- #
- # 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.
@@ -1285,6 +1218,7 @@
],
},
],
+ "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
@@ -1417,15 +1351,15 @@
# parent CryptoKey, in which case the server will choose the appropriate
# version for the operation.
"state": "A String", # The current state of the CryptoKeyVersion.
- "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
- "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
- # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled
# for destruction. Only present if state is
# DESTROY_SCHEDULED.
+ "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
"destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was
# destroyed. Only present if state is
# DESTROYED.
+ "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format
+ # `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
},
"purpose": "A String", # The immutable purpose of this CryptoKey. Currently, the only acceptable
# purpose is ENCRYPT_DECRYPT.
diff --git a/docs/dyn/cloudkms_v1.projects.locations.keyRings.html b/docs/dyn/cloudkms_v1.projects.locations.keyRings.html
index ff8e157..bf8034c 100644
--- a/docs/dyn/cloudkms_v1.projects.locations.keyRings.html
+++ b/docs/dyn/cloudkms_v1.projects.locations.keyRings.html
@@ -205,8 +205,8 @@
# [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -285,11 +285,10 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
- "version": 42, # Version of the `Policy`. The default version is 0.
"rules": [ # If more than one rule is specified, the rules are applied in the following
# manner:
# - All matching LOG rules are always applied.
@@ -328,28 +327,6 @@
"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 the only supported field names are
- # - "iam_principal", corresponding to IAMContext.principal;
- # - "" (empty string), resulting in one aggretated counter with no field.
- #
- # 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.
@@ -367,6 +344,7 @@
],
},
],
+ "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
@@ -511,8 +489,8 @@
# [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -591,11 +569,10 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
- "version": 42, # Version of the `Policy`. The default version is 0.
"rules": [ # If more than one rule is specified, the rules are applied in the following
# manner:
# - All matching LOG rules are always applied.
@@ -634,28 +611,6 @@
"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 the only supported field names are
- # - "iam_principal", corresponding to IAMContext.principal;
- # - "" (empty string), resulting in one aggretated counter with no field.
- #
- # 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.
@@ -673,6 +628,7 @@
],
},
],
+ "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
@@ -719,8 +675,8 @@
"iamOwned": True or False,
},
"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
- # the fields in the mask will be modified. If no mask is provided, a default
- # mask is used:
+ # the fields in the mask will be modified. If no mask is provided, the
+ # following default mask is used:
# paths: "bindings, etag"
# This field is only used by Cloud IAM.
}
@@ -766,8 +722,8 @@
# [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -846,11 +802,10 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
- "version": 42, # Version of the `Policy`. The default version is 0.
"rules": [ # If more than one rule is specified, the rules are applied in the following
# manner:
# - All matching LOG rules are always applied.
@@ -889,28 +844,6 @@
"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 the only supported field names are
- # - "iam_principal", corresponding to IAMContext.principal;
- # - "" (empty string), resulting in one aggretated counter with no field.
- #
- # 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.
@@ -928,6 +861,7 @@
],
},
],
+ "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
diff --git a/docs/dyn/cloudresourcemanager_v1.folders.html b/docs/dyn/cloudresourcemanager_v1.folders.html
new file mode 100644
index 0000000..9b909ec
--- /dev/null
+++ b/docs/dyn/cloudresourcemanager_v1.folders.html
@@ -0,0 +1,2233 @@
+<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.folders.html">folders</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#clearOrgPolicy">clearOrgPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Clears a `Policy` from a resource.</p>
+<p class="toc_element">
+ <code><a href="#clearOrgPolicyV1">clearOrgPolicyV1(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Clears a `Policy` from a resource.</p>
+<p class="toc_element">
+ <code><a href="#getEffectiveOrgPolicy">getEffectiveOrgPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the effective `Policy` on a resource. This is the result of merging</p>
+<p class="toc_element">
+ <code><a href="#getEffectiveOrgPolicyV1">getEffectiveOrgPolicyV1(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the effective `Policy` on a resource. This is the result of merging</p>
+<p class="toc_element">
+ <code><a href="#getOrgPolicy">getOrgPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets a `Policy` on a resource.</p>
+<p class="toc_element">
+ <code><a href="#getOrgPolicyV1">getOrgPolicyV1(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets a `Policy` on a resource.</p>
+<p class="toc_element">
+ <code><a href="#listAvailableOrgPolicyConstraints">listAvailableOrgPolicyConstraints(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists `Constraints` that could be applied on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#listAvailableOrgPolicyConstraints_next">listAvailableOrgPolicyConstraints_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="#listOrgPolicies">listOrgPolicies(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists all the `Policies` set for a particular resource.</p>
+<p class="toc_element">
+ <code><a href="#listOrgPolicies_next">listOrgPolicies_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="#setOrgPolicy">setOrgPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates the specified `Policy` on the resource. Creates a new `Policy` for</p>
+<p class="toc_element">
+ <code><a href="#setOrgPolicyV1">setOrgPolicyV1(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates the specified `Policy` on the resource. Creates a new `Policy` for</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="clearOrgPolicy">clearOrgPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Clears a `Policy` from a resource.
+
+Args:
+ resource: string, Name of the resource for the `Policy` to clear. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the ClearOrgPolicy method.
+ "etag": "A String", # The current version, for concurrency control. Not sending an `etag`
+ # will cause the `Policy` to be cleared blindly.
+ "constraint": "A String", # Name of the `Constraint` of the `Policy` to clear.
+ }
+
+ 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="clearOrgPolicyV1">clearOrgPolicyV1(resource, body, x__xgafv=None)</code>
+ <pre>Clears a `Policy` from a resource.
+
+Args:
+ resource: string, Name of the resource for the `Policy` to clear. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the ClearOrgPolicy method.
+ "etag": "A String", # The current version, for concurrency control. Not sending an `etag`
+ # will cause the `Policy` to be cleared blindly.
+ "constraint": "A String", # Name of the `Constraint` of the `Policy` to clear.
+ }
+
+ 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="getEffectiveOrgPolicy">getEffectiveOrgPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Gets the effective `Policy` on a resource. This is the result of merging
+`Policies` in the resource hierarchy. The returned `Policy` will not have
+an `etag`set because it is a computed `Policy` across multiple resources.
+
+Args:
+ resource: string, The name of the resource to start computing the effective `Policy`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the GetEffectiveOrgPolicy method.
+ "constraint": "A String", # The name of the `Constraint` to compute the effective `Policy`.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getEffectiveOrgPolicyV1">getEffectiveOrgPolicyV1(resource, body, x__xgafv=None)</code>
+ <pre>Gets the effective `Policy` on a resource. This is the result of merging
+`Policies` in the resource hierarchy. The returned `Policy` will not have
+an `etag`set because it is a computed `Policy` across multiple resources.
+
+Args:
+ resource: string, The name of the resource to start computing the effective `Policy`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the GetEffectiveOrgPolicy method.
+ "constraint": "A String", # The name of the `Constraint` to compute the effective `Policy`.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getOrgPolicy">getOrgPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Gets a `Policy` on a resource.
+
+If no `Policy` is set on the resource, a `Policy` is returned with default
+values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The
+`etag` value can be used with `SetOrgPolicy()` to create or update a
+`Policy` during read-modify-write.
+
+Args:
+ resource: string, Name of the resource the `Policy` is set on. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the GetOrgPolicy method.
+ "constraint": "A String", # Name of the `Constraint` to get the `Policy`.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getOrgPolicyV1">getOrgPolicyV1(resource, body, x__xgafv=None)</code>
+ <pre>Gets a `Policy` on a resource.
+
+If no `Policy` is set on the resource, a `Policy` is returned with default
+values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The
+`etag` value can be used with `SetOrgPolicy()` to create or update a
+`Policy` during read-modify-write.
+
+Args:
+ resource: string, Name of the resource the `Policy` is set on. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the GetOrgPolicy method.
+ "constraint": "A String", # Name of the `Constraint` to get the `Policy`.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listAvailableOrgPolicyConstraints">listAvailableOrgPolicyConstraints(resource, body, x__xgafv=None)</code>
+ <pre>Lists `Constraints` that could be applied on the specified resource.
+
+Args:
+ resource: string, Name of the resource to list `Constraints` for. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the [ListAvailableOrgPolicyConstraints]
+ # google.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method.
+ "pageToken": "A String", # Page token used to retrieve the next page. This is currently unsupported
+ # and will be ignored. The server may at any point start using this field.
+ "pageSize": 42, # Size of the pages to be returned. This is currently unsupported and will
+ # be ignored. The server may at any point start using this field to limit
+ # page size.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response returned from the ListAvailableOrgPolicyConstraints method.
+ # Returns all `Constraints` that could be set at this level of the hierarchy
+ # (contrast with the response from `ListPolicies`, which returns all policies
+ # which are set).
+ "nextPageToken": "A String", # Page token used to retrieve the next page. This is currently not used.
+ "constraints": [ # The collection of constraints that are settable on the request resource.
+ { # A `Constraint` describes a way in which a resource's configuration can be
+ # restricted. For example, it controls which cloud services can be activated
+ # across an organization, or whether a Compute Engine instance can have
+ # serial port connections established. `Constraints` can be configured by the
+ # organization's policy adminstrator to fit the needs of the organzation by
+ # setting Policies for `Constraints` at different locations in the
+ # organization's resource hierarchy. Policies are inherited down the resource
+ # hierarchy from higher levels, but can also be overridden. For details about
+ # the inheritance rules please read about
+ # Policies.
+ #
+ # `Constraints` have a default behavior determined by the `constraint_default`
+ # field, which is the enforcement behavior that is used in the absence of a
+ # `Policy` being defined or inherited for the resource in question.
+ "constraintDefault": "A String", # The evaluation behavior of this constraint in the absense of 'Policy'.
+ "displayName": "A String", # The human readable name.
+ #
+ # Mutable.
+ "name": "A String", # Immutable value, required to globally be unique. For example,
+ # `constraints/serviceuser.services`
+ "booleanConstraint": { # A `Constraint` that is either enforced or not. # Defines this constraint as being a BooleanConstraint.
+ #
+ # For example a constraint `constraints/compute.disableSerialPortAccess`.
+ # If it is enforced on a VM instance, serial port connections will not be
+ # opened to that instance.
+ },
+ "version": 42, # Version of the `Constraint`. Default version is 0;
+ "listConstraint": { # A `Constraint` that allows or disallows a list of string values, which are # Defines this constraint as being a ListConstraint.
+ # configured by an Organization's policy administrator with a `Policy`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Constraint`.
+ },
+ "description": "A String", # Detailed description of what this `Constraint` controls as well as how and
+ # where it is enforced.
+ #
+ # Mutable.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listAvailableOrgPolicyConstraints_next">listAvailableOrgPolicyConstraints_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="listOrgPolicies">listOrgPolicies(resource, body, x__xgafv=None)</code>
+ <pre>Lists all the `Policies` set for a particular resource.
+
+Args:
+ resource: string, Name of the resource to list Policies for. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the ListOrgPolicies method.
+ "pageToken": "A String", # Page token used to retrieve the next page. This is currently unsupported
+ # and will be ignored. The server may at any point start using this field.
+ "pageSize": 42, # Size of the pages to be returned. This is currently unsupported and will
+ # be ignored. The server may at any point start using this field to limit
+ # page size.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response returned from the ListOrgPolicies method. It will be empty
+ # if no `Policies` are set on the resource.
+ "nextPageToken": "A String", # Page token used to retrieve the next page. This is currently not used, but
+ # the server may at any point start supplying a valid token.
+ "policies": [ # The `Policies` that are set on the resource. It will be empty if no
+ # `Policies` are set.
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listOrgPolicies_next">listOrgPolicies_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="setOrgPolicy">setOrgPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Updates the specified `Policy` on the resource. Creates a new `Policy` for
+that `Constraint` on the resource if one does not exist.
+
+Not supplying an `etag` on the request `Policy` results in an unconditional
+write of the `Policy`.
+
+Args:
+ resource: string, Resource name of the resource to attach the `Policy`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the SetOrgPolicyRequest method.
+ "policy": { # Defines a Cloud Organization `Policy` which is used to specify `Constraints` # `Policy` to set on the resource.
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setOrgPolicyV1">setOrgPolicyV1(resource, body, x__xgafv=None)</code>
+ <pre>Updates the specified `Policy` on the resource. Creates a new `Policy` for
+that `Constraint` on the resource if one does not exist.
+
+Not supplying an `etag` on the request `Policy` results in an unconditional
+write of the `Policy`.
+
+Args:
+ resource: string, Resource name of the resource to attach the `Policy`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the SetOrgPolicyRequest method.
+ "policy": { # Defines a Cloud Organization `Policy` which is used to specify `Constraints` # `Policy` to set on the resource.
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/cloudresourcemanager_v1.html b/docs/dyn/cloudresourcemanager_v1.html
index 7bd7d05..0170acb 100644
--- a/docs/dyn/cloudresourcemanager_v1.html
+++ b/docs/dyn/cloudresourcemanager_v1.html
@@ -75,6 +75,11 @@
<h1><a href="cloudresourcemanager_v1.html">Google Cloud Resource Manager API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="cloudresourcemanager_v1.folders.html">folders()</a></code>
+</p>
+<p class="firstline">Returns the folders Resource.</p>
+
+<p class="toc_element">
<code><a href="cloudresourcemanager_v1.liens.html">liens()</a></code>
</p>
<p class="firstline">Returns the liens Resource.</p>
diff --git a/docs/dyn/cloudresourcemanager_v1.operations.html b/docs/dyn/cloudresourcemanager_v1.operations.html
index dd1970c..c936baa 100644
--- a/docs/dyn/cloudresourcemanager_v1.operations.html
+++ b/docs/dyn/cloudresourcemanager_v1.operations.html
@@ -102,6 +102,22 @@
# 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 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:
@@ -165,22 +181,6 @@
},
],
},
- "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`.
}</pre>
</div>
diff --git a/docs/dyn/cloudresourcemanager_v1.organizations.html b/docs/dyn/cloudresourcemanager_v1.organizations.html
index 365ffba..aed61e1 100644
--- a/docs/dyn/cloudresourcemanager_v1.organizations.html
+++ b/docs/dyn/cloudresourcemanager_v1.organizations.html
@@ -75,12 +75,42 @@
<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="#clearOrgPolicy">clearOrgPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Clears a `Policy` from a resource.</p>
+<p class="toc_element">
+ <code><a href="#clearOrgPolicyV1">clearOrgPolicyV1(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Clears a `Policy` from a resource.</p>
+<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="#getEffectiveOrgPolicy">getEffectiveOrgPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the effective `Policy` on a resource. This is the result of merging</p>
+<p class="toc_element">
+ <code><a href="#getEffectiveOrgPolicyV1">getEffectiveOrgPolicyV1(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the effective `Policy` on a resource. This is the result of merging</p>
+<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for an Organization resource. May be empty</p>
<p class="toc_element">
+ <code><a href="#getOrgPolicy">getOrgPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets a `Policy` on a resource.</p>
+<p class="toc_element">
+ <code><a href="#getOrgPolicyV1">getOrgPolicyV1(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets a `Policy` on a resource.</p>
+<p class="toc_element">
+ <code><a href="#listAvailableOrgPolicyConstraints">listAvailableOrgPolicyConstraints(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists `Constraints` that could be applied on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#listAvailableOrgPolicyConstraints_next">listAvailableOrgPolicyConstraints_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="#listOrgPolicies">listOrgPolicies(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists all the `Policies` set for a particular resource.</p>
+<p class="toc_element">
+ <code><a href="#listOrgPolicies_next">listOrgPolicies_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(body, x__xgafv=None)</a></code></p>
<p class="firstline">Searches Organization resources that are visible to the user and satisfy</p>
<p class="toc_element">
@@ -90,10 +120,86 @@
<code><a href="#setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on an Organization resource. Replaces any</p>
<p class="toc_element">
+ <code><a href="#setOrgPolicy">setOrgPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates the specified `Policy` on the resource. Creates a new `Policy` for</p>
+<p class="toc_element">
+ <code><a href="#setOrgPolicyV1">setOrgPolicyV1(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates the specified `Policy` on the resource. Creates a new `Policy` for</p>
+<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified Organization.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="clearOrgPolicy">clearOrgPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Clears a `Policy` from a resource.
+
+Args:
+ resource: string, Name of the resource for the `Policy` to clear. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the ClearOrgPolicy method.
+ "etag": "A String", # The current version, for concurrency control. Not sending an `etag`
+ # will cause the `Policy` to be cleared blindly.
+ "constraint": "A String", # Name of the `Constraint` of the `Policy` to clear.
+ }
+
+ 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="clearOrgPolicyV1">clearOrgPolicyV1(resource, body, x__xgafv=None)</code>
+ <pre>Clears a `Policy` from a resource.
+
+Args:
+ resource: string, Name of the resource for the `Policy` to clear. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the ClearOrgPolicy method.
+ "etag": "A String", # The current version, for concurrency control. Not sending an `etag`
+ # will cause the `Policy` to be cleared blindly.
+ "constraint": "A String", # Name of the `Constraint` of the `Policy` to clear.
+ }
+
+ 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>Fetches an Organization resource identified by the specified resource name.
@@ -117,12 +223,12 @@
# be deleted.
"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 primary domain of the G Suite
# customer that owns the organization.
# @OutputOnly
- "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server.
- # @OutputOnly
"lifecycleState": "A String", # The organization's current lifecycle state. Assigned by the server.
# @OutputOnly
"name": "A String", # Output Only. The resource name of the organization. This is the
@@ -132,6 +238,446 @@
</div>
<div class="method">
+ <code class="details" id="getEffectiveOrgPolicy">getEffectiveOrgPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Gets the effective `Policy` on a resource. This is the result of merging
+`Policies` in the resource hierarchy. The returned `Policy` will not have
+an `etag`set because it is a computed `Policy` across multiple resources.
+
+Args:
+ resource: string, The name of the resource to start computing the effective `Policy`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the GetEffectiveOrgPolicy method.
+ "constraint": "A String", # The name of the `Constraint` to compute the effective `Policy`.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getEffectiveOrgPolicyV1">getEffectiveOrgPolicyV1(resource, body, x__xgafv=None)</code>
+ <pre>Gets the effective `Policy` on a resource. This is the result of merging
+`Policies` in the resource hierarchy. The returned `Policy` will not have
+an `etag`set because it is a computed `Policy` across multiple resources.
+
+Args:
+ resource: string, The name of the resource to start computing the effective `Policy`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the GetEffectiveOrgPolicy method.
+ "constraint": "A String", # The name of the `Constraint` to compute the effective `Policy`.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource=None, 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
@@ -187,8 +733,8 @@
# [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -264,7 +810,7 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
@@ -316,6 +862,783 @@
</div>
<div class="method">
+ <code class="details" id="getOrgPolicy">getOrgPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Gets a `Policy` on a resource.
+
+If no `Policy` is set on the resource, a `Policy` is returned with default
+values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The
+`etag` value can be used with `SetOrgPolicy()` to create or update a
+`Policy` during read-modify-write.
+
+Args:
+ resource: string, Name of the resource the `Policy` is set on. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the GetOrgPolicy method.
+ "constraint": "A String", # Name of the `Constraint` to get the `Policy`.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getOrgPolicyV1">getOrgPolicyV1(resource, body, x__xgafv=None)</code>
+ <pre>Gets a `Policy` on a resource.
+
+If no `Policy` is set on the resource, a `Policy` is returned with default
+values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The
+`etag` value can be used with `SetOrgPolicy()` to create or update a
+`Policy` during read-modify-write.
+
+Args:
+ resource: string, Name of the resource the `Policy` is set on. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the GetOrgPolicy method.
+ "constraint": "A String", # Name of the `Constraint` to get the `Policy`.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listAvailableOrgPolicyConstraints">listAvailableOrgPolicyConstraints(resource, body, x__xgafv=None)</code>
+ <pre>Lists `Constraints` that could be applied on the specified resource.
+
+Args:
+ resource: string, Name of the resource to list `Constraints` for. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the [ListAvailableOrgPolicyConstraints]
+ # google.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method.
+ "pageToken": "A String", # Page token used to retrieve the next page. This is currently unsupported
+ # and will be ignored. The server may at any point start using this field.
+ "pageSize": 42, # Size of the pages to be returned. This is currently unsupported and will
+ # be ignored. The server may at any point start using this field to limit
+ # page size.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response returned from the ListAvailableOrgPolicyConstraints method.
+ # Returns all `Constraints` that could be set at this level of the hierarchy
+ # (contrast with the response from `ListPolicies`, which returns all policies
+ # which are set).
+ "nextPageToken": "A String", # Page token used to retrieve the next page. This is currently not used.
+ "constraints": [ # The collection of constraints that are settable on the request resource.
+ { # A `Constraint` describes a way in which a resource's configuration can be
+ # restricted. For example, it controls which cloud services can be activated
+ # across an organization, or whether a Compute Engine instance can have
+ # serial port connections established. `Constraints` can be configured by the
+ # organization's policy adminstrator to fit the needs of the organzation by
+ # setting Policies for `Constraints` at different locations in the
+ # organization's resource hierarchy. Policies are inherited down the resource
+ # hierarchy from higher levels, but can also be overridden. For details about
+ # the inheritance rules please read about
+ # Policies.
+ #
+ # `Constraints` have a default behavior determined by the `constraint_default`
+ # field, which is the enforcement behavior that is used in the absence of a
+ # `Policy` being defined or inherited for the resource in question.
+ "constraintDefault": "A String", # The evaluation behavior of this constraint in the absense of 'Policy'.
+ "displayName": "A String", # The human readable name.
+ #
+ # Mutable.
+ "name": "A String", # Immutable value, required to globally be unique. For example,
+ # `constraints/serviceuser.services`
+ "booleanConstraint": { # A `Constraint` that is either enforced or not. # Defines this constraint as being a BooleanConstraint.
+ #
+ # For example a constraint `constraints/compute.disableSerialPortAccess`.
+ # If it is enforced on a VM instance, serial port connections will not be
+ # opened to that instance.
+ },
+ "version": 42, # Version of the `Constraint`. Default version is 0;
+ "listConstraint": { # A `Constraint` that allows or disallows a list of string values, which are # Defines this constraint as being a ListConstraint.
+ # configured by an Organization's policy administrator with a `Policy`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Constraint`.
+ },
+ "description": "A String", # Detailed description of what this `Constraint` controls as well as how and
+ # where it is enforced.
+ #
+ # Mutable.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listAvailableOrgPolicyConstraints_next">listAvailableOrgPolicyConstraints_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="listOrgPolicies">listOrgPolicies(resource, body, x__xgafv=None)</code>
+ <pre>Lists all the `Policies` set for a particular resource.
+
+Args:
+ resource: string, Name of the resource to list Policies for. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the ListOrgPolicies method.
+ "pageToken": "A String", # Page token used to retrieve the next page. This is currently unsupported
+ # and will be ignored. The server may at any point start using this field.
+ "pageSize": 42, # Size of the pages to be returned. This is currently unsupported and will
+ # be ignored. The server may at any point start using this field to limit
+ # page size.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response returned from the ListOrgPolicies method. It will be empty
+ # if no `Policies` are set on the resource.
+ "nextPageToken": "A String", # Page token used to retrieve the next page. This is currently not used, but
+ # the server may at any point start supplying a valid token.
+ "policies": [ # The `Policies` that are set on the resource. It will be empty if no
+ # `Policies` are set.
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listOrgPolicies_next">listOrgPolicies_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(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
@@ -374,12 +1697,12 @@
# be deleted.
"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 primary domain of the G Suite
# customer that owns the organization.
# @OutputOnly
- "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server.
- # @OutputOnly
"lifecycleState": "A String", # The organization's current lifecycle state. Assigned by the server.
# @OutputOnly
"name": "A String", # Output Only. The resource name of the organization. This is the
@@ -453,8 +1776,8 @@
# [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -530,7 +1853,7 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
@@ -580,8 +1903,8 @@
"version": 42, # Version of the `Policy`. The default version is 0.
},
"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
- # the fields in the mask will be modified. If no mask is provided, a default
- # mask is used:
+ # the fields in the mask will be modified. If no mask is provided, the
+ # following default mask is used:
# paths: "bindings, etag"
# This field is only used by Cloud IAM.
}
@@ -627,8 +1950,8 @@
# [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -704,7 +2027,7 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
@@ -756,6 +2079,838 @@
</div>
<div class="method">
+ <code class="details" id="setOrgPolicy">setOrgPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Updates the specified `Policy` on the resource. Creates a new `Policy` for
+that `Constraint` on the resource if one does not exist.
+
+Not supplying an `etag` on the request `Policy` results in an unconditional
+write of the `Policy`.
+
+Args:
+ resource: string, Resource name of the resource to attach the `Policy`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the SetOrgPolicyRequest method.
+ "policy": { # Defines a Cloud Organization `Policy` which is used to specify `Constraints` # `Policy` to set on the resource.
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setOrgPolicyV1">setOrgPolicyV1(resource, body, x__xgafv=None)</code>
+ <pre>Updates the specified `Policy` on the resource. Creates a new `Policy` for
+that `Constraint` on the resource if one does not exist.
+
+Not supplying an `etag` on the request `Policy` results in an unconditional
+write of the `Policy`.
+
+Args:
+ resource: string, Resource name of the resource to attach the `Policy`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the SetOrgPolicyRequest method.
+ "policy": { # Defines a Cloud Organization `Policy` which is used to specify `Constraints` # `Policy` to set on the resource.
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="testIamPermissions">testIamPermissions(resource=None, 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,
diff --git a/docs/dyn/cloudresourcemanager_v1.projects.html b/docs/dyn/cloudresourcemanager_v1.projects.html
index a01bda5..661a574 100644
--- a/docs/dyn/cloudresourcemanager_v1.projects.html
+++ b/docs/dyn/cloudresourcemanager_v1.projects.html
@@ -75,6 +75,12 @@
<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="#clearOrgPolicy">clearOrgPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Clears a `Policy` from a resource.</p>
+<p class="toc_element">
+ <code><a href="#clearOrgPolicyV1">clearOrgPolicyV1(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Clears a `Policy` from a resource.</p>
+<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</p>
<p class="toc_element">
@@ -87,18 +93,48 @@
<code><a href="#getAncestry">getAncestry(projectId=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a list of ancestors in the resource hierarchy for the Project</p>
<p class="toc_element">
+ <code><a href="#getEffectiveOrgPolicy">getEffectiveOrgPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the effective `Policy` on a resource. This is the result of merging</p>
+<p class="toc_element">
+ <code><a href="#getEffectiveOrgPolicyV1">getEffectiveOrgPolicyV1(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the effective `Policy` on a resource. This is the result of merging</p>
+<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the IAM access control policy for the specified Project.</p>
<p class="toc_element">
+ <code><a href="#getOrgPolicy">getOrgPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets a `Policy` on a resource.</p>
+<p class="toc_element">
+ <code><a href="#getOrgPolicyV1">getOrgPolicyV1(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets a `Policy` on a resource.</p>
+<p class="toc_element">
<code><a href="#list">list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Projects that are visible to the user and satisfy the</p>
<p class="toc_element">
+ <code><a href="#listAvailableOrgPolicyConstraints">listAvailableOrgPolicyConstraints(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists `Constraints` that could be applied on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#listAvailableOrgPolicyConstraints_next">listAvailableOrgPolicyConstraints_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="#listOrgPolicies">listOrgPolicies(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists all the `Policies` set for a particular resource.</p>
+<p class="toc_element">
+ <code><a href="#listOrgPolicies_next">listOrgPolicies_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="#setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the IAM access control policy for the specified Project. Replaces</p>
<p class="toc_element">
+ <code><a href="#setOrgPolicy">setOrgPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates the specified `Policy` on the resource. Creates a new `Policy` for</p>
+<p class="toc_element">
+ <code><a href="#setOrgPolicyV1">setOrgPolicyV1(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates the specified `Policy` on the resource. Creates a new `Policy` for</p>
+<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified Project.</p>
<p class="toc_element">
@@ -109,6 +145,76 @@
<p class="firstline">Updates the attributes of the Project identified by the specified</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="clearOrgPolicy">clearOrgPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Clears a `Policy` from a resource.
+
+Args:
+ resource: string, Name of the resource for the `Policy` to clear. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the ClearOrgPolicy method.
+ "etag": "A String", # The current version, for concurrency control. Not sending an `etag`
+ # will cause the `Policy` to be cleared blindly.
+ "constraint": "A String", # Name of the `Constraint` of the `Policy` to clear.
+ }
+
+ 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="clearOrgPolicyV1">clearOrgPolicyV1(resource, body, x__xgafv=None)</code>
+ <pre>Clears a `Policy` from a resource.
+
+Args:
+ resource: string, Name of the resource for the `Policy` to clear. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the ClearOrgPolicy method.
+ "etag": "A String", # The current version, for concurrency control. Not sending an `etag`
+ # will cause the `Policy` to be cleared blindly.
+ "constraint": "A String", # Name of the `Constraint` of the `Policy` to clear.
+ }
+
+ 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(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
@@ -201,6 +307,22 @@
# 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 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:
@@ -264,22 +386,6 @@
},
],
},
- "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`.
}</pre>
</div>
@@ -463,6 +569,446 @@
</div>
<div class="method">
+ <code class="details" id="getEffectiveOrgPolicy">getEffectiveOrgPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Gets the effective `Policy` on a resource. This is the result of merging
+`Policies` in the resource hierarchy. The returned `Policy` will not have
+an `etag`set because it is a computed `Policy` across multiple resources.
+
+Args:
+ resource: string, The name of the resource to start computing the effective `Policy`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the GetEffectiveOrgPolicy method.
+ "constraint": "A String", # The name of the `Constraint` to compute the effective `Policy`.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getEffectiveOrgPolicyV1">getEffectiveOrgPolicyV1(resource, body, x__xgafv=None)</code>
+ <pre>Gets the effective `Policy` on a resource. This is the result of merging
+`Policies` in the resource hierarchy. The returned `Policy` will not have
+an `etag`set because it is a computed `Policy` across multiple resources.
+
+Args:
+ resource: string, The name of the resource to start computing the effective `Policy`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the GetEffectiveOrgPolicy method.
+ "constraint": "A String", # The name of the `Constraint` to compute the effective `Policy`.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource=None, body, x__xgafv=None)</code>
<pre>Returns the IAM access control policy for the specified Project.
Permission is denied if the policy or the resource does not exist.
@@ -517,8 +1063,8 @@
# [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -594,7 +1140,7 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
@@ -646,6 +1192,452 @@
</div>
<div class="method">
+ <code class="details" id="getOrgPolicy">getOrgPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Gets a `Policy` on a resource.
+
+If no `Policy` is set on the resource, a `Policy` is returned with default
+values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The
+`etag` value can be used with `SetOrgPolicy()` to create or update a
+`Policy` during read-modify-write.
+
+Args:
+ resource: string, Name of the resource the `Policy` is set on. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the GetOrgPolicy method.
+ "constraint": "A String", # Name of the `Constraint` to get the `Policy`.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getOrgPolicyV1">getOrgPolicyV1(resource, body, x__xgafv=None)</code>
+ <pre>Gets a `Policy` on a resource.
+
+If no `Policy` is set on the resource, a `Policy` is returned with default
+values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The
+`etag` value can be used with `SetOrgPolicy()` to create or update a
+`Policy` during read-modify-write.
+
+Args:
+ resource: string, Name of the resource the `Policy` is set on. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the GetOrgPolicy method.
+ "constraint": "A String", # Name of the `Constraint` to get the `Policy`.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="list">list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Projects that are visible to the user and satisfy the
specified filter. This method returns Projects in an unspecified order.
@@ -674,7 +1666,7 @@
|NAME:howl|Equivalent to above.|
|labels.color:*|The project has the label `color`.|
|labels.color:red|The project's label `color` has the value `red`.|
-|labels.color:red label.size:big|The project's label `color` has the
+|labels.color:red labels.size:big|The project's label `color` has the
value `red` and its label `size` has the value `big`.
Optional.
@@ -776,6 +1768,337 @@
</div>
<div class="method">
+ <code class="details" id="listAvailableOrgPolicyConstraints">listAvailableOrgPolicyConstraints(resource, body, x__xgafv=None)</code>
+ <pre>Lists `Constraints` that could be applied on the specified resource.
+
+Args:
+ resource: string, Name of the resource to list `Constraints` for. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the [ListAvailableOrgPolicyConstraints]
+ # google.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method.
+ "pageToken": "A String", # Page token used to retrieve the next page. This is currently unsupported
+ # and will be ignored. The server may at any point start using this field.
+ "pageSize": 42, # Size of the pages to be returned. This is currently unsupported and will
+ # be ignored. The server may at any point start using this field to limit
+ # page size.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response returned from the ListAvailableOrgPolicyConstraints method.
+ # Returns all `Constraints` that could be set at this level of the hierarchy
+ # (contrast with the response from `ListPolicies`, which returns all policies
+ # which are set).
+ "nextPageToken": "A String", # Page token used to retrieve the next page. This is currently not used.
+ "constraints": [ # The collection of constraints that are settable on the request resource.
+ { # A `Constraint` describes a way in which a resource's configuration can be
+ # restricted. For example, it controls which cloud services can be activated
+ # across an organization, or whether a Compute Engine instance can have
+ # serial port connections established. `Constraints` can be configured by the
+ # organization's policy adminstrator to fit the needs of the organzation by
+ # setting Policies for `Constraints` at different locations in the
+ # organization's resource hierarchy. Policies are inherited down the resource
+ # hierarchy from higher levels, but can also be overridden. For details about
+ # the inheritance rules please read about
+ # Policies.
+ #
+ # `Constraints` have a default behavior determined by the `constraint_default`
+ # field, which is the enforcement behavior that is used in the absence of a
+ # `Policy` being defined or inherited for the resource in question.
+ "constraintDefault": "A String", # The evaluation behavior of this constraint in the absense of 'Policy'.
+ "displayName": "A String", # The human readable name.
+ #
+ # Mutable.
+ "name": "A String", # Immutable value, required to globally be unique. For example,
+ # `constraints/serviceuser.services`
+ "booleanConstraint": { # A `Constraint` that is either enforced or not. # Defines this constraint as being a BooleanConstraint.
+ #
+ # For example a constraint `constraints/compute.disableSerialPortAccess`.
+ # If it is enforced on a VM instance, serial port connections will not be
+ # opened to that instance.
+ },
+ "version": 42, # Version of the `Constraint`. Default version is 0;
+ "listConstraint": { # A `Constraint` that allows or disallows a list of string values, which are # Defines this constraint as being a ListConstraint.
+ # configured by an Organization's policy administrator with a `Policy`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Constraint`.
+ },
+ "description": "A String", # Detailed description of what this `Constraint` controls as well as how and
+ # where it is enforced.
+ #
+ # Mutable.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listAvailableOrgPolicyConstraints_next">listAvailableOrgPolicyConstraints_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="listOrgPolicies">listOrgPolicies(resource, body, x__xgafv=None)</code>
+ <pre>Lists all the `Policies` set for a particular resource.
+
+Args:
+ resource: string, Name of the resource to list Policies for. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the ListOrgPolicies method.
+ "pageToken": "A String", # Page token used to retrieve the next page. This is currently unsupported
+ # and will be ignored. The server may at any point start using this field.
+ "pageSize": 42, # Size of the pages to be returned. This is currently unsupported and will
+ # be ignored. The server may at any point start using this field to limit
+ # page size.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response returned from the ListOrgPolicies method. It will be empty
+ # if no `Policies` are set on the resource.
+ "nextPageToken": "A String", # Page token used to retrieve the next page. This is currently not used, but
+ # the server may at any point start supplying a valid token.
+ "policies": [ # The `Policies` that are set on the resource. It will be empty if no
+ # `Policies` are set.
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listOrgPolicies_next">listOrgPolicies_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="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
@@ -818,7 +2141,7 @@
+ 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
+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.
@@ -873,8 +2196,8 @@
# [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -950,7 +2273,7 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
@@ -1000,8 +2323,8 @@
"version": 42, # Version of the `Policy`. The default version is 0.
},
"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
- # the fields in the mask will be modified. If no mask is provided, a default
- # mask is used:
+ # the fields in the mask will be modified. If no mask is provided, the
+ # following default mask is used:
# paths: "bindings, etag"
# This field is only used by Cloud IAM.
}
@@ -1047,8 +2370,8 @@
# [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -1124,7 +2447,7 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
@@ -1176,6 +2499,838 @@
</div>
<div class="method">
+ <code class="details" id="setOrgPolicy">setOrgPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Updates the specified `Policy` on the resource. Creates a new `Policy` for
+that `Constraint` on the resource if one does not exist.
+
+Not supplying an `etag` on the request `Policy` results in an unconditional
+write of the `Policy`.
+
+Args:
+ resource: string, Resource name of the resource to attach the `Policy`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the SetOrgPolicyRequest method.
+ "policy": { # Defines a Cloud Organization `Policy` which is used to specify `Constraints` # `Policy` to set on the resource.
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setOrgPolicyV1">setOrgPolicyV1(resource, body, x__xgafv=None)</code>
+ <pre>Updates the specified `Policy` on the resource. Creates a new `Policy` for
+that `Constraint` on the resource if one does not exist.
+
+Not supplying an `etag` on the request `Policy` results in an unconditional
+write of the `Policy`.
+
+Args:
+ resource: string, Resource name of the resource to attach the `Policy`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the SetOrgPolicyRequest method.
+ "policy": { # Defines a Cloud Organization `Policy` which is used to specify `Constraints` # `Policy` to set on the resource.
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</code>
<pre>Returns permissions that a caller has on the specified Project.
diff --git a/docs/dyn/cloudresourcemanager_v1beta1.organizations.html b/docs/dyn/cloudresourcemanager_v1beta1.organizations.html
index 6e1267b..dec04fa 100644
--- a/docs/dyn/cloudresourcemanager_v1beta1.organizations.html
+++ b/docs/dyn/cloudresourcemanager_v1beta1.organizations.html
@@ -75,21 +75,57 @@
<h1><a href="cloudresourcemanager_v1beta1.html">Google Cloud Resource Manager API</a> . <a href="cloudresourcemanager_v1beta1.organizations.html">organizations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#clearOrgPolicy">clearOrgPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Clears a `Policy` from a resource.</p>
+<p class="toc_element">
+ <code><a href="#clearOrgPolicyV1">clearOrgPolicyV1(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Clears a `Policy` from a resource.</p>
+<p class="toc_element">
<code><a href="#get">get(name, organizationId=None, 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="#getEffectiveOrgPolicy">getEffectiveOrgPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the effective `Policy` on a resource. This is the result of merging</p>
+<p class="toc_element">
+ <code><a href="#getEffectiveOrgPolicyV1">getEffectiveOrgPolicyV1(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the effective `Policy` on a resource. This is the result of merging</p>
+<p class="toc_element">
<code><a href="#getIamPolicy">getIamPolicy(resource=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for an Organization resource. May be empty</p>
<p class="toc_element">
+ <code><a href="#getOrgPolicy">getOrgPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets a `Policy` on a resource.</p>
+<p class="toc_element">
+ <code><a href="#getOrgPolicyV1">getOrgPolicyV1(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets a `Policy` on a resource.</p>
+<p class="toc_element">
<code><a href="#list">list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Organization resources that are visible to the user and satisfy</p>
<p class="toc_element">
+ <code><a href="#listAvailableOrgPolicyConstraints">listAvailableOrgPolicyConstraints(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists `Constraints` that could be applied on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#listAvailableOrgPolicyConstraints_next">listAvailableOrgPolicyConstraints_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="#listOrgPolicies">listOrgPolicies(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists all the `Policies` set for a particular resource.</p>
+<p class="toc_element">
+ <code><a href="#listOrgPolicies_next">listOrgPolicies_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="#setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on an Organization resource. Replaces any</p>
<p class="toc_element">
+ <code><a href="#setOrgPolicy">setOrgPolicy(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates the specified `Policy` on the resource. Creates a new `Policy` for</p>
+<p class="toc_element">
+ <code><a href="#setOrgPolicyV1">setOrgPolicyV1(resource, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Updates the specified `Policy` on the resource. Creates a new `Policy` for</p>
+<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified Organization.</p>
<p class="toc_element">
@@ -97,6 +133,76 @@
<p class="firstline">Updates an Organization resource identified by the specified resource name.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="clearOrgPolicy">clearOrgPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Clears a `Policy` from a resource.
+
+Args:
+ resource: string, Name of the resource for the `Policy` to clear. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the ClearOrgPolicy method.
+ "etag": "A String", # The current version, for concurrency control. Not sending an `etag`
+ # will cause the `Policy` to be cleared blindly.
+ "constraint": "A String", # Name of the `Constraint` of the `Policy` to clear.
+ }
+
+ 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="clearOrgPolicyV1">clearOrgPolicyV1(resource, body, x__xgafv=None)</code>
+ <pre>Clears a `Policy` from a resource.
+
+Args:
+ resource: string, Name of the resource for the `Policy` to clear. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the ClearOrgPolicy method.
+ "etag": "A String", # The current version, for concurrency control. Not sending an `etag`
+ # will cause the `Policy` to be cleared blindly.
+ "constraint": "A String", # Name of the `Constraint` of the `Policy` to clear.
+ }
+
+ 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, organizationId=None, x__xgafv=None)</code>
<pre>Fetches an Organization resource identified by the specified resource name.
@@ -141,6 +247,446 @@
</div>
<div class="method">
+ <code class="details" id="getEffectiveOrgPolicy">getEffectiveOrgPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Gets the effective `Policy` on a resource. This is the result of merging
+`Policies` in the resource hierarchy. The returned `Policy` will not have
+an `etag`set because it is a computed `Policy` across multiple resources.
+
+Args:
+ resource: string, The name of the resource to start computing the effective `Policy`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the GetEffectiveOrgPolicy method.
+ "constraint": "A String", # The name of the `Constraint` to compute the effective `Policy`.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getEffectiveOrgPolicyV1">getEffectiveOrgPolicyV1(resource, body, x__xgafv=None)</code>
+ <pre>Gets the effective `Policy` on a resource. This is the result of merging
+`Policies` in the resource hierarchy. The returned `Policy` will not have
+an `etag`set because it is a computed `Policy` across multiple resources.
+
+Args:
+ resource: string, The name of the resource to start computing the effective `Policy`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the GetEffectiveOrgPolicy method.
+ "constraint": "A String", # The name of the `Constraint` to compute the effective `Policy`.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="getIamPolicy">getIamPolicy(resource=None, 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
@@ -229,8 +775,8 @@
],
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -306,7 +852,7 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
@@ -325,6 +871,452 @@
</div>
<div class="method">
+ <code class="details" id="getOrgPolicy">getOrgPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Gets a `Policy` on a resource.
+
+If no `Policy` is set on the resource, a `Policy` is returned with default
+values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The
+`etag` value can be used with `SetOrgPolicy()` to create or update a
+`Policy` during read-modify-write.
+
+Args:
+ resource: string, Name of the resource the `Policy` is set on. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the GetOrgPolicy method.
+ "constraint": "A String", # Name of the `Constraint` to get the `Policy`.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getOrgPolicyV1">getOrgPolicyV1(resource, body, x__xgafv=None)</code>
+ <pre>Gets a `Policy` on a resource.
+
+If no `Policy` is set on the resource, a `Policy` is returned with default
+values including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The
+`etag` value can be used with `SetOrgPolicy()` to create or update a
+`Policy` during read-modify-write.
+
+Args:
+ resource: string, Name of the resource the `Policy` is set on. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the GetOrgPolicy method.
+ "constraint": "A String", # Name of the `Constraint` to get the `Policy`.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="list">list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Organization resources that are visible to the user and satisfy
the specified filter. This method returns Organizations in an unspecified
@@ -395,6 +1387,337 @@
</div>
<div class="method">
+ <code class="details" id="listAvailableOrgPolicyConstraints">listAvailableOrgPolicyConstraints(resource, body, x__xgafv=None)</code>
+ <pre>Lists `Constraints` that could be applied on the specified resource.
+
+Args:
+ resource: string, Name of the resource to list `Constraints` for. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the [ListAvailableOrgPolicyConstraints]
+ # google.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method.
+ "pageToken": "A String", # Page token used to retrieve the next page. This is currently unsupported
+ # and will be ignored. The server may at any point start using this field.
+ "pageSize": 42, # Size of the pages to be returned. This is currently unsupported and will
+ # be ignored. The server may at any point start using this field to limit
+ # page size.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response returned from the ListAvailableOrgPolicyConstraints method.
+ # Returns all `Constraints` that could be set at this level of the hierarchy
+ # (contrast with the response from `ListPolicies`, which returns all policies
+ # which are set).
+ "nextPageToken": "A String", # Page token used to retrieve the next page. This is currently not used.
+ "constraints": [ # The collection of constraints that are settable on the request resource.
+ { # A `Constraint` describes a way in which a resource's configuration can be
+ # restricted. For example, it controls which cloud services can be activated
+ # across an organization, or whether a Compute Engine instance can have
+ # serial port connections established. `Constraints` can be configured by the
+ # organization's policy adminstrator to fit the needs of the organzation by
+ # setting Policies for `Constraints` at different locations in the
+ # organization's resource hierarchy. Policies are inherited down the resource
+ # hierarchy from higher levels, but can also be overridden. For details about
+ # the inheritance rules please read about
+ # Policies.
+ #
+ # `Constraints` have a default behavior determined by the `constraint_default`
+ # field, which is the enforcement behavior that is used in the absence of a
+ # `Policy` being defined or inherited for the resource in question.
+ "constraintDefault": "A String", # The evaluation behavior of this constraint in the absense of 'Policy'.
+ "displayName": "A String", # The human readable name.
+ #
+ # Mutable.
+ "description": "A String", # Detailed description of what this `Constraint` controls as well as how and
+ # where it is enforced.
+ #
+ # Mutable.
+ "booleanConstraint": { # A `Constraint` that is either enforced or not. # Defines this constraint as being a BooleanConstraint.
+ #
+ # For example a constraint `constraints/compute.disableSerialPortAccess`.
+ # If it is enforced on a VM instance, serial port connections will not be
+ # opened to that instance.
+ },
+ "version": 42, # Version of the `Constraint`. Default version is 0;
+ "listConstraint": { # A `Constraint` that allows or disallows a list of string values, which are # Defines this constraint as being a ListConstraint.
+ # configured by an Organization's policy administrator with a `Policy`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Constraint`.
+ },
+ "name": "A String", # Immutable value, required to globally be unique. For example,
+ # `constraints/serviceuser.services`
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listAvailableOrgPolicyConstraints_next">listAvailableOrgPolicyConstraints_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="listOrgPolicies">listOrgPolicies(resource, body, x__xgafv=None)</code>
+ <pre>Lists all the `Policies` set for a particular resource.
+
+Args:
+ resource: string, Name of the resource to list Policies for. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the ListOrgPolicies method.
+ "pageToken": "A String", # Page token used to retrieve the next page. This is currently unsupported
+ # and will be ignored. The server may at any point start using this field.
+ "pageSize": 42, # Size of the pages to be returned. This is currently unsupported and will
+ # be ignored. The server may at any point start using this field to limit
+ # page size.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response returned from the ListOrgPolicies method. It will be empty
+ # if no `Policies` are set on the resource.
+ "nextPageToken": "A String", # Page token used to retrieve the next page. This is currently not used, but
+ # the server may at any point start supplying a valid token.
+ "policies": [ # The `Policies` that are set on the resource. It will be empty if no
+ # `Policies` are set.
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listOrgPolicies_next">listOrgPolicies_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="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
@@ -490,8 +1813,8 @@
],
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -567,7 +1890,7 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
@@ -584,8 +1907,8 @@
"version": 42, # Version of the `Policy`. The default version is 0.
},
"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
- # the fields in the mask will be modified. If no mask is provided, a default
- # mask is used:
+ # the fields in the mask will be modified. If no mask is provided, the
+ # following default mask is used:
# paths: "bindings, etag"
# This field is only used by Cloud IAM.
}
@@ -664,8 +1987,8 @@
],
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -741,7 +2064,7 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
@@ -760,6 +2083,838 @@
</div>
<div class="method">
+ <code class="details" id="setOrgPolicy">setOrgPolicy(resource, body, x__xgafv=None)</code>
+ <pre>Updates the specified `Policy` on the resource. Creates a new `Policy` for
+that `Constraint` on the resource if one does not exist.
+
+Not supplying an `etag` on the request `Policy` results in an unconditional
+write of the `Policy`.
+
+Args:
+ resource: string, Resource name of the resource to attach the `Policy`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the SetOrgPolicyRequest method.
+ "policy": { # Defines a Cloud Organization `Policy` which is used to specify `Constraints` # `Policy` to set on the resource.
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setOrgPolicyV1">setOrgPolicyV1(resource, body, x__xgafv=None)</code>
+ <pre>Updates the specified `Policy` on the resource. Creates a new `Policy` for
+that `Constraint` on the resource if one does not exist.
+
+Not supplying an `etag` on the request `Policy` results in an unconditional
+write of the `Policy`.
+
+Args:
+ resource: string, Resource name of the resource to attach the `Policy`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request sent to the SetOrgPolicyRequest method.
+ "policy": { # Defines a Cloud Organization `Policy` which is used to specify `Constraints` # `Policy` to set on the resource.
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
+ # for configurations of Cloud Platform resources.
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ # server, not specified by the caller, and represents the last time a call to
+ # `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
+ # be ignored.
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ # `Constraint` type.
+ # `constraint_default` enforcement behavior of the specific `Constraint` at
+ # this resource.
+ #
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ # resource.
+ #
+ # A `ListPolicy` can define specific values that are allowed or denied by
+ # setting either the `allowed_values` or `denied_values` fields. It can also
+ # be used to allow or deny all values, by setting the `all_values` field. If
+ # `all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`
+ # or `denied_values` must be set (attempting to set both or neither will
+ # result in a failed request). If `all_values` is set to either `ALLOW` or
+ # `DENY`, `allowed_values` and `denied_values` must be unset.
+ "allValues": "A String", # The policy all_values state.
+ "allowedValues": [ # List of values allowed at this resource. an only be set if no values are
+ # set for `denied_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ #
+ # By default, a `ListPolicy` set at a resource supercedes any `Policy` set
+ # anywhere up the resource hierarchy. However, if `inherit_from_parent` is
+ # set to `true`, then the values from the effective `Policy` of the parent
+ # resource are inherited, meaning the values set in this `Policy` are
+ # added to the values inherited up the hierarchy.
+ #
+ # Setting `Policy` hierarchies that inherit both allowed values and denied
+ # values isn't recommended in most circumstances to keep the configuration
+ # simple and understandable. However, it is possible to set a `Policy` with
+ # `allowed_values` set that inherits a `Policy` with `denied_values` set.
+ # In this case, the values that are allowed must be in `allowed_values` and
+ # not present in `denied_values`.
+ #
+ # For example, suppose you have a `Constraint`
+ # `constraints/serviceuser.services`, which has a `constraint_type` of
+ # `list_constraint`, and with `constraint_default` set to `ALLOW`.
+ # Suppose that at the Organization level, a `Policy` is applied that
+ # restricts the allowed API activations to {`E1`, `E2`}. Then, if a
+ # `Policy` is applied to a project below the Organization that has
+ # `inherit_from_parent` set to `false` and field all_values set to DENY,
+ # then an attempt to activate any API will be denied.
+ #
+ # The following examples demonstrate different possible layerings:
+ #
+ # Example 1 (no inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # ``projects/bar`` has `inherit_from_parent` `false` and values:
+ # {allowed_values: "E3" allowed_values: "E4"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E3`, and `E4`.
+ #
+ # Example 2 (inherited values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {value: “E3” value: ”E4” inherit_from_parent: true}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
+ #
+ # Example 3 (inheriting both allowed and denied values):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: "E1" allowed_values: "E2"}
+ # `projects/bar` has a `Policy` with:
+ # {denied_values: "E1"}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The value accepted at `projects/bar` is `E2`.
+ #
+ # Example 4 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values:”E2”}
+ # `projects/bar` has a `Policy` with values:
+ # {RestoreDefault: {}}
+ # The accepted values at `organizations/foo` are `E1`, `E2`.
+ # The accepted values at `projects/bar` are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 5 (no policy inherits parent policy):
+ # `organizations/foo` has no `Policy` set.
+ # `projects/bar` has no `Policy` set.
+ # The accepted values at both levels are either all or none depending on
+ # the value of `constraint_default` (if `ALLOW`, all; if
+ # `DENY`, none).
+ #
+ # Example 6 (ListConstraint allowing all):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: ALLOW}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # Any value is accepted at `projects/bar`.
+ #
+ # Example 7 (ListConstraint allowing none):
+ # `organizations/foo` has a `Policy` with values:
+ # {allowed_values: “E1” allowed_values: ”E2”}
+ # `projects/bar` has a `Policy` with:
+ # {all: DENY}
+ # The accepted values at `organizations/foo` are `E1`, E2`.
+ # No value is accepted at `projects/bar`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "deniedValues": [ # List of values denied at this resource. Can only be set if no values are
+ # set for `allowed_values` and `all_values` is set to
+ # `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ },
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ # resource.
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ # configuration is acceptable.
+ #
+ # Suppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`
+ # with `constraint_default` set to `ALLOW`. A `Policy` for that
+ # `Constraint` exhibits the following behavior:
+ # - If the `Policy` at this resource has enforced set to `false`, serial
+ # port connection attempts will be allowed.
+ # - If the `Policy` at this resource has enforced set to `true`, serial
+ # port connection attempts will be refused.
+ # - If the `Policy` at this resource is `RestoreDefault`, serial port
+ # connection attempts will be allowed.
+ # - If no `Policy` is set at this resource or anywhere higher in the
+ # resource hierarchy, serial port connection attempts will be allowed.
+ # - If no `Policy` is set at this resource, but one exists higher in the
+ # resource hierarchy, the behavior is as if the`Policy` were set at
+ # this resource.
+ #
+ # The following examples demonstrate the different possible layerings:
+ #
+ # Example 1 (nearest `Constraint` wins):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has no `Policy` set.
+ # The constraint at `projects/bar` and `organizations/foo` will not be
+ # enforced.
+ #
+ # Example 2 (enforcement gets replaced):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: false}
+ # `projects/bar` has a `Policy` with:
+ # {enforced: true}
+ # The constraint at `organizations/foo` is not enforced.
+ # The constraint at `projects/bar` is enforced.
+ #
+ # Example 3 (RestoreDefault):
+ # `organizations/foo` has a `Policy` with:
+ # {enforced: true}
+ # `projects/bar` has a `Policy` with:
+ # {RestoreDefault: {}}
+ # The constraint at `organizations/foo` is enforced.
+ # The constraint at `projects/bar` is not enforced, because
+ # `constraint_default` for the `Constraint` is `ALLOW`.
+ },
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="testIamPermissions">testIamPermissions(resource=None, 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,
diff --git a/docs/dyn/cloudresourcemanager_v1beta1.projects.html b/docs/dyn/cloudresourcemanager_v1beta1.projects.html
index 96b2efc..95d1923 100644
--- a/docs/dyn/cloudresourcemanager_v1beta1.projects.html
+++ b/docs/dyn/cloudresourcemanager_v1beta1.projects.html
@@ -524,8 +524,8 @@
],
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -601,7 +601,7 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
@@ -648,7 +648,7 @@
|NAME:howl|Equivalent to above.|
|labels.color:*|The project has the label `color`.|
|labels.color:red|The project's label `color` has the value `red`.|
-|labels.color:red label.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.
+|labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.
Optional.
pageToken: string, A pagination token returned from a previous call to ListProjects
@@ -782,15 +782,15 @@
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.
++ 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
+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.
@@ -799,7 +799,8 @@
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.
+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.
@@ -877,8 +878,8 @@
],
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -954,7 +955,7 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
@@ -971,8 +972,8 @@
"version": 42, # Version of the `Policy`. The default version is 0.
},
"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
- # the fields in the mask will be modified. If no mask is provided, a default
- # mask is used:
+ # the fields in the mask will be modified. If no mask is provided, the
+ # following default mask is used:
# paths: "bindings, etag"
# This field is only used by Cloud IAM.
}
@@ -1051,8 +1052,8 @@
],
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -1128,7 +1129,7 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
diff --git a/docs/dyn/compute_alpha.autoscalers.html b/docs/dyn/compute_alpha.autoscalers.html
index b19765c..33698a1 100644
--- a/docs/dyn/compute_alpha.autoscalers.html
+++ b/docs/dyn/compute_alpha.autoscalers.html
@@ -96,7 +96,7 @@
<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, zone, autoscaler, body, requestId=None)</a></code></p>
+ <code><a href="#patch">patch(project, zone, body, requestId=None, autoscaler=None)</a></code></p>
<p class="firstline">Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body)</a></code></p>
@@ -587,13 +587,12 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(project, zone, autoscaler, body, requestId=None)</code>
+ <code class="details" id="patch">patch(project, zone, body, requestId=None, autoscaler=None)</code>
<pre>Updates an autoscaler 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)
zone: string, Name of the zone for this request. (required)
- autoscaler: string, Name of the autoscaler to update. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -656,6 +655,7 @@
}
requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
+ autoscaler: string, Name of the autoscaler to patch.
Returns:
An object of the form:
diff --git a/docs/dyn/compute_alpha.regionAutoscalers.html b/docs/dyn/compute_alpha.regionAutoscalers.html
index 75bd53e..e35607f 100644
--- a/docs/dyn/compute_alpha.regionAutoscalers.html
+++ b/docs/dyn/compute_alpha.regionAutoscalers.html
@@ -90,7 +90,7 @@
<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, autoscaler, body, requestId=None)</a></code></p>
+ <code><a href="#patch">patch(project, region, body, requestId=None, autoscaler=None)</a></code></p>
<p class="firstline">Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
@@ -459,13 +459,12 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(project, region, autoscaler, body, requestId=None)</code>
+ <code class="details" id="patch">patch(project, region, body, requestId=None, autoscaler=None)</code>
<pre>Updates an autoscaler 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)
region: string, Name of the region scoping this request. (required)
- autoscaler: string, Name of the autoscaler to update. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -528,6 +527,7 @@
}
requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.
+ autoscaler: string, Name of the autoscaler to patch.
Returns:
An object of the form:
diff --git a/docs/dyn/compute_beta.firewalls.html b/docs/dyn/compute_beta.firewalls.html
index 5e53c52..e5d237c 100644
--- a/docs/dyn/compute_beta.firewalls.html
+++ b/docs/dyn/compute_beta.firewalls.html
@@ -169,14 +169,29 @@
An object of the form:
{ # Represents a Firewall resource.
- "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
+ "direction": "A String", # Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "destinationRanges": [ # If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
+ "A String",
+ ],
"sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
"A String",
],
+ "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ {
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
+ #
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+ "A String",
+ ],
+ },
+ ],
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
"sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported.
"A String",
],
+ "priority": 42, # Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority.
"network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
# global/networks/default
# If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
@@ -186,7 +201,7 @@
"targetTags": [ # A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
"A String",
],
- "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ "denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
{
"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
@@ -213,14 +228,29 @@
The object takes the form of:
{ # Represents a Firewall resource.
- "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
+ "direction": "A String", # Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "destinationRanges": [ # If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
+ "A String",
+ ],
"sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
"A String",
],
+ "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ {
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
+ #
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+ "A String",
+ ],
+ },
+ ],
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
"sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported.
"A String",
],
+ "priority": 42, # Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority.
"network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
# global/networks/default
# If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
@@ -230,7 +260,7 @@
"targetTags": [ # A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
"A String",
],
- "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ "denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
{
"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
@@ -327,14 +357,29 @@
"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": [ # [Output Only] A list of Firewall resources.
{ # Represents a Firewall resource.
- "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
+ "direction": "A String", # Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "destinationRanges": [ # If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
+ "A String",
+ ],
"sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
"A String",
],
+ "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ {
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
+ #
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+ "A String",
+ ],
+ },
+ ],
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
"sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported.
"A String",
],
+ "priority": 42, # Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority.
"network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
# global/networks/default
# If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
@@ -344,7 +389,7 @@
"targetTags": [ # A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
"A String",
],
- "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ "denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
{
"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
@@ -386,19 +431,34 @@
Args:
project: string, Project ID for this request. (required)
- firewall: string, Name of the firewall rule to update. (required)
+ firewall: string, Name of the firewall rule to patch. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Represents a Firewall resource.
- "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
+ "direction": "A String", # Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "destinationRanges": [ # If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
+ "A String",
+ ],
"sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
"A String",
],
+ "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ {
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
+ #
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+ "A String",
+ ],
+ },
+ ],
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
"sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported.
"A String",
],
+ "priority": 42, # Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority.
"network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
# global/networks/default
# If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
@@ -408,7 +468,7 @@
"targetTags": [ # A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
"A String",
],
- "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ "denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
{
"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
@@ -513,14 +573,29 @@
The object takes the form of:
{ # Represents a Firewall resource.
- "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
+ "direction": "A String", # Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "destinationRanges": [ # If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.
+ "A String",
+ ],
"sourceTags": [ # If source tags are specified, the firewall will apply only to traffic with source IP that belongs to a tag listed in source tags. Source tags cannot be used to control traffic to an instance's external IP address. Because tags are associated with an instance, not an IP address. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply.
"A String",
],
+ "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ {
+ "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
+ "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
+ #
+ # Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+ "A String",
+ ],
+ },
+ ],
+ "kind": "compute#firewall", # [Output Ony] Type of the resource. Always compute#firewall for firewall rules.
"sourceRanges": [ # If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported.
"A String",
],
+ "priority": 42, # Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority.
"network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:
# global/networks/default
# If you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
@@ -530,7 +605,7 @@
"targetTags": [ # A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.
"A String",
],
- "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
+ "denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.
{
"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp), or the IP protocol number.
"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.
diff --git a/docs/dyn/compute_beta.instanceGroupManagers.html b/docs/dyn/compute_beta.instanceGroupManagers.html
index e633eda..24794f3 100644
--- a/docs/dyn/compute_beta.instanceGroupManagers.html
+++ b/docs/dyn/compute_beta.instanceGroupManagers.html
@@ -700,16 +700,7 @@
{
"managedInstances": [ # [Output Only] The list of instances in the managed instance group.
{
- "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
- # - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
- # - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
- # - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.
- # - RECREATING The managed instance group is recreating this instance.
- # - DELETING The managed instance group is permanently deleting this instance.
- # - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
- # - RESTARTING The managed instance group is restarting the instance.
- # - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
- "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
+ "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
"lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.
"errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
@@ -721,8 +712,21 @@
],
},
},
+ "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
+ "version": { # [Output Only] Intended version of this instance.
+ "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.
+ "name": "A String", # [Output Only] Name of the version.
+ },
+ "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
+ # - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
+ # - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
+ # - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.
+ # - RECREATING The managed instance group is recreating this instance.
+ # - DELETING The managed instance group is permanently deleting this instance.
+ # - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
+ # - RESTARTING The managed instance group is restarting the instance.
+ # - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
"id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
- "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
},
],
}</pre>
diff --git a/docs/dyn/compute_beta.regionInstanceGroupManagers.html b/docs/dyn/compute_beta.regionInstanceGroupManagers.html
index 693777d..92e6996 100644
--- a/docs/dyn/compute_beta.regionInstanceGroupManagers.html
+++ b/docs/dyn/compute_beta.regionInstanceGroupManagers.html
@@ -582,16 +582,7 @@
{
"managedInstances": [ # List of managed instances.
{
- "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
- # - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
- # - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
- # - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.
- # - RECREATING The managed instance group is recreating this instance.
- # - DELETING The managed instance group is permanently deleting this instance.
- # - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
- # - RESTARTING The managed instance group is restarting the instance.
- # - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
- "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
+ "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
"lastAttempt": { # [Output Only] Information about the last attempt to create or delete the instance.
"errors": { # [Output Only] Encountered errors during the last attempt to create or delete the instance.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
@@ -603,8 +594,21 @@
],
},
},
+ "instance": "A String", # [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.
+ "version": { # [Output Only] Intended version of this instance.
+ "instanceTemplate": "A String", # [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.
+ "name": "A String", # [Output Only] Name of the version.
+ },
+ "currentAction": "A String", # [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values:
+ # - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance.
+ # - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.
+ # - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead.
+ # - RECREATING The managed instance group is recreating this instance.
+ # - DELETING The managed instance group is permanently deleting this instance.
+ # - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.
+ # - RESTARTING The managed instance group is restarting the instance.
+ # - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.
"id": "A String", # [Output only] The unique identifier for this resource. This field is empty when instance does not exist.
- "instanceStatus": "A String", # [Output Only] The status of the instance. This field is empty when the instance does not exist.
},
],
}</pre>
diff --git a/docs/dyn/compute_beta.subnetworks.html b/docs/dyn/compute_beta.subnetworks.html
index a4b3b6c..420a1ea 100644
--- a/docs/dyn/compute_beta.subnetworks.html
+++ b/docs/dyn/compute_beta.subnetworks.html
@@ -105,6 +105,9 @@
<code><a href="#setIamPolicy">setIamPolicy(project, region, 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="#setPrivateIpGoogleAccess">setPrivateIpGoogleAccess(project, region, subnetwork, body)</a></code></p>
+<p class="firstline">Set whether VMs in this subnet can access Google services without assigning external IP addresses through Cloudpath.</p>
+<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
<h3>Method Details</h3>
@@ -822,6 +825,72 @@
</div>
<div class="method">
+ <code class="details" id="setPrivateIpGoogleAccess">setPrivateIpGoogleAccess(project, region, subnetwork, body)</code>
+ <pre>Set whether VMs in this subnet can access Google services without assigning external IP addresses through Cloudpath.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region scoping this request. (required)
+ subnetwork: string, Name of the Subnetwork resource. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "privateIpGoogleAccess": True or False,
+ }
+
+
+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", # [Deprecated] This field is deprecated.
+ "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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
<pre>Returns permissions that a caller has on the specified resource.
diff --git a/docs/dyn/dataflow_v1b3.projects.html b/docs/dyn/dataflow_v1b3.projects.html
index a723b9e..6ec61ab 100644
--- a/docs/dyn/dataflow_v1b3.projects.html
+++ b/docs/dyn/dataflow_v1b3.projects.html
@@ -109,6 +109,10 @@
#
# The VM should be identified by the labels attached to the WorkerMessage that
# this health ping belongs to.
+ "vmStartupTime": "A String", # The time the VM was booted.
+ "reportInterval": "A String", # The interval at which the worker is sending health reports.
+ # The default value of 0 should be interpreted as the field is not being
+ # explicitly set by the worker.
"pods": [ # The pods running on the worker. See:
# http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod
#
@@ -118,10 +122,6 @@
"a_key": "", # Properties of the object.
},
],
- "reportInterval": "A String", # The interval at which the worker is sending health reports.
- # The default value of 0 should be interpreted as the field is not being
- # explicitly set by the worker.
- "vmStartupTime": "A String", # The time the VM was booted.
"vmIsHealthy": True or False, # Whether the VM is healthy.
},
"labels": { # Labels are used to group WorkerMessages.
diff --git a/docs/dyn/dataflow_v1b3.projects.jobs.html b/docs/dyn/dataflow_v1b3.projects.jobs.html
index 0c87e36..75c7d0c 100644
--- a/docs/dyn/dataflow_v1b3.projects.jobs.html
+++ b/docs/dyn/dataflow_v1b3.projects.jobs.html
@@ -156,13 +156,12 @@
# size.
"a_key": "A String",
},
- "location": "A String", # The location that contains this job.
- "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
- # Cloud Dataflow service.
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the
# corresponding name prefixes of the new job.
"a_key": "A String",
},
+ "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
+ # Cloud Dataflow service.
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
"version": { # A structure describing which components and their versions of the service
# are required in order to run the job.
@@ -216,49 +215,6 @@
# multiple pools, in order to match the various computational
# requirements of the various stages of the job.
"diskSourceImage": "A String", # Fully qualified source image for disks.
- "ipConfiguration": "A String", # Configuration for VM IPs.
- "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
- # are supported.
- "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
- # service will attempt to choose a reasonable default.
- "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
- # the service will use the network "default".
- "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
- # will attempt to choose a reasonable default.
- "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
- "metadata": { # Metadata to set on the Google Compute Engine VMs.
- "a_key": "A String",
- },
- "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
- # Compute Engine API.
- "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
- # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
- # `TEARDOWN_NEVER`.
- # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
- # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
- # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
- # down.
- #
- # If the workers are not torn down by the service, they will
- # continue to run and use Google Compute Engine VM resources in the
- # user's project until they are explicitly terminated by the user.
- # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
- # policy except for small, manually supervised test jobs.
- #
- # If unknown or unspecified, the service will attempt to choose a reasonable
- # default.
- "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
- # service will choose a number of threads (according to the number of cores
- # on the selected machine type for batch, or 1 by convention for streaming).
- "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
- # the form "regions/REGION/subnetworks/SUBNETWORK".
- "poolArgs": { # Extra arguments for this worker pool.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
- # execute the job. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when
# using the standard Dataflow task runner. Users should ignore
# this field.
@@ -271,24 +227,17 @@
# Google Cloud Storage:
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
- "commandlinesFileName": "A String", # The file to store preprocessing commands in.
- "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
- "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
- "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
- "vmId": "A String", # The ID string of the VM.
- "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
- # taskrunner; e.g. "wheel".
"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by
# taskrunner; e.g. "root".
+ "commandlinesFileName": "A String", # The file to store preprocessing commands in.
+ "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
+ "vmId": "A String", # The ID string of the VM.
+ "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
+ "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to
# access the Cloud Dataflow API.
"A String",
],
- "languageHint": "A String", # The suggested backend language.
- "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
- # console.
- "streamingWorkerMainClass": "A String", # The streaming worker main class name.
- "logDir": "A String", # The directory on the VM to store logs.
"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.
"reportingEnabled": True or False, # Whether to send work progress updates to the service.
"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example,
@@ -315,16 +264,14 @@
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
},
+ "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
+ # taskrunner; e.g. "wheel".
+ "languageHint": "A String", # The suggested backend language.
+ "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
+ # console.
+ "streamingWorkerMainClass": "A String", # The streaming worker main class name.
+ "logDir": "A String", # The directory on the VM to store logs.
"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"
- "harnessCommand": "A String", # The command to launch the worker harness.
- "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
- # temporary storage.
- #
- # The supported resource type is:
- #
- # Google Cloud Storage:
- # storage.googleapis.com/{bucket}/{object}
- # bucket.storage.googleapis.com/{object}
"baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs.
#
# When workers access Google Cloud APIs, they logically do so via
@@ -334,33 +281,26 @@
# Locators".
#
# If not specified, the default value is "http://www.googleapis.com/"
- },
- "defaultPackageSet": "A String", # The default package set to install. This allows the service to
- # select a default set of packages which are useful to worker
- # harnesses written in a particular language.
- "packages": [ # Packages to be installed on workers.
- { # The packages that must be installed in order for a worker to run the
- # steps of the Cloud Dataflow job that will be assigned to its worker
- # pool.
+ "harnessCommand": "A String", # The command to launch the worker harness.
+ "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
+ # temporary storage.
#
- # This is the mechanism by which the Cloud Dataflow SDK causes code to
- # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
- # might use this to install jars containing the user's code and all of the
- # various dependencies (libraries, data files, etc.) required in order
- # for that code to run.
- "location": "A String", # The resource to read the package from. The supported resource type is:
- #
- # Google Cloud Storage:
- #
- # storage.googleapis.com/{bucket}
- # bucket.storage.googleapis.com/
- "name": "A String", # The name of the package.
- },
- ],
- "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
- "algorithm": "A String", # The algorithm to use for autoscaling.
- "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ # The supported resource type is:
+ #
+ # Google Cloud Storage:
+ # storage.googleapis.com/{bucket}/{object}
+ # bucket.storage.googleapis.com/{object}
},
+ "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
+ # are supported.
+ "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
+ # service will attempt to choose a reasonable default.
+ "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
+ # the service will use the network "default".
+ "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
+ # will attempt to choose a reasonable default.
+ "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
+ # attempt to choose a reasonable default.
"dataDisks": [ # Data disks that are used by a VM in this workflow.
{ # Describes the data disk used by a workflow job.
"mountPoint": "A String", # Directory in a VM where disk is mounted.
@@ -386,13 +326,78 @@
# compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard
},
],
- "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
+ # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
+ # `TEARDOWN_NEVER`.
+ # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
+ # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
+ # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
+ # down.
+ #
+ # If the workers are not torn down by the service, they will
+ # continue to run and use Google Compute Engine VM resources in the
+ # user's project until they are explicitly terminated by the user.
+ # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
+ # policy except for small, manually supervised test jobs.
+ #
+ # If unknown or unspecified, the service will attempt to choose a reasonable
+ # default.
+ "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
+ # Compute Engine API.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
+ # service will choose a number of threads (according to the number of cores
+ # on the selected machine type for batch, or 1 by convention for streaming).
+ "poolArgs": { # Extra arguments for this worker pool.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
+ # execute the job. If zero or unspecified, the service will
# attempt to choose a reasonable default.
"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker
# harness, residing in Google Container Registry.
+ "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
+ # the form "regions/REGION/subnetworks/SUBNETWORK".
+ "packages": [ # Packages to be installed on workers.
+ { # The packages that must be installed in order for a worker to run the
+ # steps of the Cloud Dataflow job that will be assigned to its worker
+ # pool.
+ #
+ # This is the mechanism by which the Cloud Dataflow SDK causes code to
+ # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
+ # might use this to install jars containing the user's code and all of the
+ # various dependencies (libraries, data files, etc.) required in order
+ # for that code to run.
+ "location": "A String", # The resource to read the package from. The supported resource type is:
+ #
+ # Google Cloud Storage:
+ #
+ # storage.googleapis.com/{bucket}
+ # bucket.storage.googleapis.com/
+ "name": "A String", # The name of the package.
+ },
+ ],
+ "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
+ "algorithm": "A String", # The algorithm to use for autoscaling.
+ "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ },
+ "defaultPackageSet": "A String", # The default package set to install. This allows the service to
+ # select a default set of packages which are useful to worker
+ # harnesses written in a particular language.
+ "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ # attempt to choose a reasonable default.
+ "metadata": { # Metadata to set on the Google Compute Engine VMs.
+ "a_key": "A String",
+ },
},
],
},
+ "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
+ # of the job it replaced.
+ #
+ # When sending a `CreateJobRequest`, you can update a job by specifying it
+ # here. The job named here is stopped, and its intermediate state is
+ # transferred to this job.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed # Preliminary field: The format of this data may change at any time.
# A description of the user pipeline and stages through which it is executed.
# Created by Cloud Dataflow service. Only retrieved with
@@ -408,9 +413,6 @@
],
"displayData": [ # Transform-specific display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -418,6 +420,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -428,7 +431,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -440,9 +445,6 @@
],
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -450,6 +452,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -460,7 +463,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -482,19 +487,19 @@
"outputSource": [ # Output sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"inputSource": [ # Input sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"componentTransform": [ # Transforms that comprise this execution stage.
@@ -536,26 +541,16 @@
# Note that the Cloud Dataflow service may be used to run many different
# types of jobs, not just Map-Reduce.
"kind": "A String", # The kind of step in the Cloud Dataflow job.
+ "name": "A String", # The name that identifies the step. This must be unique for each
+ # step with respect to all other steps in the Cloud Dataflow job.
"properties": { # Named properties associated with the step. Each kind of
# predefined step has its own required set of properties.
# Must be provided on Create. Only retrieved with JOB_VIEW_ALL.
"a_key": "", # Properties of the object.
},
- "name": "A String", # The name that identifies the step. This must be unique for each
- # step with respect to all other steps in the Cloud Dataflow job.
},
],
- "currentState": "A String", # The current state of the job.
- #
- # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
- # specified.
- #
- # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
- # terminal state. After a job has reached a terminal state, no
- # further state updates may be made.
- #
- # This field may be mutated by the Cloud Dataflow service;
- # callers cannot mutate it.
+ "location": "A String", # The location that contains this job.
"tempFiles": [ # A set of files the system should be aware of that are used
# for temporary storage. These temporary files will be
# removed on job completion.
@@ -575,12 +570,17 @@
#
# This field is set by the Cloud Dataflow service when the Job is
# created, and is immutable for the life of the job.
- "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
- # of the job it replaced.
+ "currentState": "A String", # The current state of the job.
#
- # When sending a `CreateJobRequest`, you can update a job by specifying it
- # here. The job named here is stopped, and its intermediate state is
- # transferred to this job.
+ # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
+ # specified.
+ #
+ # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
+ # terminal state. After a job has reached a terminal state, no
+ # further state updates may be made.
+ #
+ # This field may be mutated by the Cloud Dataflow service;
+ # callers cannot mutate it.
"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that # Deprecated.
# isn't contained in the submitted job.
"stages": { # A mapping from each stage to the information about that stage.
@@ -646,13 +646,12 @@
# size.
"a_key": "A String",
},
- "location": "A String", # The location that contains this job.
- "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
- # Cloud Dataflow service.
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the
# corresponding name prefixes of the new job.
"a_key": "A String",
},
+ "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
+ # Cloud Dataflow service.
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
"version": { # A structure describing which components and their versions of the service
# are required in order to run the job.
@@ -706,49 +705,6 @@
# multiple pools, in order to match the various computational
# requirements of the various stages of the job.
"diskSourceImage": "A String", # Fully qualified source image for disks.
- "ipConfiguration": "A String", # Configuration for VM IPs.
- "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
- # are supported.
- "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
- # service will attempt to choose a reasonable default.
- "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
- # the service will use the network "default".
- "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
- # will attempt to choose a reasonable default.
- "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
- "metadata": { # Metadata to set on the Google Compute Engine VMs.
- "a_key": "A String",
- },
- "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
- # Compute Engine API.
- "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
- # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
- # `TEARDOWN_NEVER`.
- # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
- # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
- # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
- # down.
- #
- # If the workers are not torn down by the service, they will
- # continue to run and use Google Compute Engine VM resources in the
- # user's project until they are explicitly terminated by the user.
- # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
- # policy except for small, manually supervised test jobs.
- #
- # If unknown or unspecified, the service will attempt to choose a reasonable
- # default.
- "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
- # service will choose a number of threads (according to the number of cores
- # on the selected machine type for batch, or 1 by convention for streaming).
- "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
- # the form "regions/REGION/subnetworks/SUBNETWORK".
- "poolArgs": { # Extra arguments for this worker pool.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
- # execute the job. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when
# using the standard Dataflow task runner. Users should ignore
# this field.
@@ -761,24 +717,17 @@
# Google Cloud Storage:
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
- "commandlinesFileName": "A String", # The file to store preprocessing commands in.
- "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
- "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
- "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
- "vmId": "A String", # The ID string of the VM.
- "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
- # taskrunner; e.g. "wheel".
"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by
# taskrunner; e.g. "root".
+ "commandlinesFileName": "A String", # The file to store preprocessing commands in.
+ "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
+ "vmId": "A String", # The ID string of the VM.
+ "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
+ "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to
# access the Cloud Dataflow API.
"A String",
],
- "languageHint": "A String", # The suggested backend language.
- "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
- # console.
- "streamingWorkerMainClass": "A String", # The streaming worker main class name.
- "logDir": "A String", # The directory on the VM to store logs.
"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.
"reportingEnabled": True or False, # Whether to send work progress updates to the service.
"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example,
@@ -805,16 +754,14 @@
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
},
+ "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
+ # taskrunner; e.g. "wheel".
+ "languageHint": "A String", # The suggested backend language.
+ "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
+ # console.
+ "streamingWorkerMainClass": "A String", # The streaming worker main class name.
+ "logDir": "A String", # The directory on the VM to store logs.
"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"
- "harnessCommand": "A String", # The command to launch the worker harness.
- "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
- # temporary storage.
- #
- # The supported resource type is:
- #
- # Google Cloud Storage:
- # storage.googleapis.com/{bucket}/{object}
- # bucket.storage.googleapis.com/{object}
"baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs.
#
# When workers access Google Cloud APIs, they logically do so via
@@ -824,33 +771,26 @@
# Locators".
#
# If not specified, the default value is "http://www.googleapis.com/"
- },
- "defaultPackageSet": "A String", # The default package set to install. This allows the service to
- # select a default set of packages which are useful to worker
- # harnesses written in a particular language.
- "packages": [ # Packages to be installed on workers.
- { # The packages that must be installed in order for a worker to run the
- # steps of the Cloud Dataflow job that will be assigned to its worker
- # pool.
+ "harnessCommand": "A String", # The command to launch the worker harness.
+ "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
+ # temporary storage.
#
- # This is the mechanism by which the Cloud Dataflow SDK causes code to
- # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
- # might use this to install jars containing the user's code and all of the
- # various dependencies (libraries, data files, etc.) required in order
- # for that code to run.
- "location": "A String", # The resource to read the package from. The supported resource type is:
- #
- # Google Cloud Storage:
- #
- # storage.googleapis.com/{bucket}
- # bucket.storage.googleapis.com/
- "name": "A String", # The name of the package.
- },
- ],
- "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
- "algorithm": "A String", # The algorithm to use for autoscaling.
- "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ # The supported resource type is:
+ #
+ # Google Cloud Storage:
+ # storage.googleapis.com/{bucket}/{object}
+ # bucket.storage.googleapis.com/{object}
},
+ "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
+ # are supported.
+ "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
+ # service will attempt to choose a reasonable default.
+ "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
+ # the service will use the network "default".
+ "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
+ # will attempt to choose a reasonable default.
+ "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
+ # attempt to choose a reasonable default.
"dataDisks": [ # Data disks that are used by a VM in this workflow.
{ # Describes the data disk used by a workflow job.
"mountPoint": "A String", # Directory in a VM where disk is mounted.
@@ -876,13 +816,78 @@
# compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard
},
],
- "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
+ # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
+ # `TEARDOWN_NEVER`.
+ # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
+ # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
+ # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
+ # down.
+ #
+ # If the workers are not torn down by the service, they will
+ # continue to run and use Google Compute Engine VM resources in the
+ # user's project until they are explicitly terminated by the user.
+ # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
+ # policy except for small, manually supervised test jobs.
+ #
+ # If unknown or unspecified, the service will attempt to choose a reasonable
+ # default.
+ "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
+ # Compute Engine API.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
+ # service will choose a number of threads (according to the number of cores
+ # on the selected machine type for batch, or 1 by convention for streaming).
+ "poolArgs": { # Extra arguments for this worker pool.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
+ # execute the job. If zero or unspecified, the service will
# attempt to choose a reasonable default.
"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker
# harness, residing in Google Container Registry.
+ "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
+ # the form "regions/REGION/subnetworks/SUBNETWORK".
+ "packages": [ # Packages to be installed on workers.
+ { # The packages that must be installed in order for a worker to run the
+ # steps of the Cloud Dataflow job that will be assigned to its worker
+ # pool.
+ #
+ # This is the mechanism by which the Cloud Dataflow SDK causes code to
+ # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
+ # might use this to install jars containing the user's code and all of the
+ # various dependencies (libraries, data files, etc.) required in order
+ # for that code to run.
+ "location": "A String", # The resource to read the package from. The supported resource type is:
+ #
+ # Google Cloud Storage:
+ #
+ # storage.googleapis.com/{bucket}
+ # bucket.storage.googleapis.com/
+ "name": "A String", # The name of the package.
+ },
+ ],
+ "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
+ "algorithm": "A String", # The algorithm to use for autoscaling.
+ "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ },
+ "defaultPackageSet": "A String", # The default package set to install. This allows the service to
+ # select a default set of packages which are useful to worker
+ # harnesses written in a particular language.
+ "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ # attempt to choose a reasonable default.
+ "metadata": { # Metadata to set on the Google Compute Engine VMs.
+ "a_key": "A String",
+ },
},
],
},
+ "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
+ # of the job it replaced.
+ #
+ # When sending a `CreateJobRequest`, you can update a job by specifying it
+ # here. The job named here is stopped, and its intermediate state is
+ # transferred to this job.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed # Preliminary field: The format of this data may change at any time.
# A description of the user pipeline and stages through which it is executed.
# Created by Cloud Dataflow service. Only retrieved with
@@ -898,9 +903,6 @@
],
"displayData": [ # Transform-specific display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -908,6 +910,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -918,7 +921,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -930,9 +935,6 @@
],
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -940,6 +942,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -950,7 +953,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -972,19 +977,19 @@
"outputSource": [ # Output sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"inputSource": [ # Input sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"componentTransform": [ # Transforms that comprise this execution stage.
@@ -1026,26 +1031,16 @@
# Note that the Cloud Dataflow service may be used to run many different
# types of jobs, not just Map-Reduce.
"kind": "A String", # The kind of step in the Cloud Dataflow job.
+ "name": "A String", # The name that identifies the step. This must be unique for each
+ # step with respect to all other steps in the Cloud Dataflow job.
"properties": { # Named properties associated with the step. Each kind of
# predefined step has its own required set of properties.
# Must be provided on Create. Only retrieved with JOB_VIEW_ALL.
"a_key": "", # Properties of the object.
},
- "name": "A String", # The name that identifies the step. This must be unique for each
- # step with respect to all other steps in the Cloud Dataflow job.
},
],
- "currentState": "A String", # The current state of the job.
- #
- # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
- # specified.
- #
- # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
- # terminal state. After a job has reached a terminal state, no
- # further state updates may be made.
- #
- # This field may be mutated by the Cloud Dataflow service;
- # callers cannot mutate it.
+ "location": "A String", # The location that contains this job.
"tempFiles": [ # A set of files the system should be aware of that are used
# for temporary storage. These temporary files will be
# removed on job completion.
@@ -1065,12 +1060,17 @@
#
# This field is set by the Cloud Dataflow service when the Job is
# created, and is immutable for the life of the job.
- "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
- # of the job it replaced.
+ "currentState": "A String", # The current state of the job.
#
- # When sending a `CreateJobRequest`, you can update a job by specifying it
- # here. The job named here is stopped, and its intermediate state is
- # transferred to this job.
+ # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
+ # specified.
+ #
+ # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
+ # terminal state. After a job has reached a terminal state, no
+ # further state updates may be made.
+ #
+ # This field may be mutated by the Cloud Dataflow service;
+ # callers cannot mutate it.
"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that # Deprecated.
# isn't contained in the submitted job.
"stages": { # A mapping from each stage to the information about that stage.
@@ -1143,13 +1143,12 @@
# size.
"a_key": "A String",
},
- "location": "A String", # The location that contains this job.
- "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
- # Cloud Dataflow service.
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the
# corresponding name prefixes of the new job.
"a_key": "A String",
},
+ "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
+ # Cloud Dataflow service.
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
"version": { # A structure describing which components and their versions of the service
# are required in order to run the job.
@@ -1203,49 +1202,6 @@
# multiple pools, in order to match the various computational
# requirements of the various stages of the job.
"diskSourceImage": "A String", # Fully qualified source image for disks.
- "ipConfiguration": "A String", # Configuration for VM IPs.
- "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
- # are supported.
- "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
- # service will attempt to choose a reasonable default.
- "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
- # the service will use the network "default".
- "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
- # will attempt to choose a reasonable default.
- "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
- "metadata": { # Metadata to set on the Google Compute Engine VMs.
- "a_key": "A String",
- },
- "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
- # Compute Engine API.
- "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
- # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
- # `TEARDOWN_NEVER`.
- # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
- # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
- # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
- # down.
- #
- # If the workers are not torn down by the service, they will
- # continue to run and use Google Compute Engine VM resources in the
- # user's project until they are explicitly terminated by the user.
- # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
- # policy except for small, manually supervised test jobs.
- #
- # If unknown or unspecified, the service will attempt to choose a reasonable
- # default.
- "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
- # service will choose a number of threads (according to the number of cores
- # on the selected machine type for batch, or 1 by convention for streaming).
- "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
- # the form "regions/REGION/subnetworks/SUBNETWORK".
- "poolArgs": { # Extra arguments for this worker pool.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
- # execute the job. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when
# using the standard Dataflow task runner. Users should ignore
# this field.
@@ -1258,24 +1214,17 @@
# Google Cloud Storage:
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
- "commandlinesFileName": "A String", # The file to store preprocessing commands in.
- "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
- "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
- "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
- "vmId": "A String", # The ID string of the VM.
- "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
- # taskrunner; e.g. "wheel".
"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by
# taskrunner; e.g. "root".
+ "commandlinesFileName": "A String", # The file to store preprocessing commands in.
+ "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
+ "vmId": "A String", # The ID string of the VM.
+ "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
+ "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to
# access the Cloud Dataflow API.
"A String",
],
- "languageHint": "A String", # The suggested backend language.
- "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
- # console.
- "streamingWorkerMainClass": "A String", # The streaming worker main class name.
- "logDir": "A String", # The directory on the VM to store logs.
"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.
"reportingEnabled": True or False, # Whether to send work progress updates to the service.
"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example,
@@ -1302,16 +1251,14 @@
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
},
+ "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
+ # taskrunner; e.g. "wheel".
+ "languageHint": "A String", # The suggested backend language.
+ "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
+ # console.
+ "streamingWorkerMainClass": "A String", # The streaming worker main class name.
+ "logDir": "A String", # The directory on the VM to store logs.
"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"
- "harnessCommand": "A String", # The command to launch the worker harness.
- "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
- # temporary storage.
- #
- # The supported resource type is:
- #
- # Google Cloud Storage:
- # storage.googleapis.com/{bucket}/{object}
- # bucket.storage.googleapis.com/{object}
"baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs.
#
# When workers access Google Cloud APIs, they logically do so via
@@ -1321,33 +1268,26 @@
# Locators".
#
# If not specified, the default value is "http://www.googleapis.com/"
- },
- "defaultPackageSet": "A String", # The default package set to install. This allows the service to
- # select a default set of packages which are useful to worker
- # harnesses written in a particular language.
- "packages": [ # Packages to be installed on workers.
- { # The packages that must be installed in order for a worker to run the
- # steps of the Cloud Dataflow job that will be assigned to its worker
- # pool.
+ "harnessCommand": "A String", # The command to launch the worker harness.
+ "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
+ # temporary storage.
#
- # This is the mechanism by which the Cloud Dataflow SDK causes code to
- # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
- # might use this to install jars containing the user's code and all of the
- # various dependencies (libraries, data files, etc.) required in order
- # for that code to run.
- "location": "A String", # The resource to read the package from. The supported resource type is:
- #
- # Google Cloud Storage:
- #
- # storage.googleapis.com/{bucket}
- # bucket.storage.googleapis.com/
- "name": "A String", # The name of the package.
- },
- ],
- "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
- "algorithm": "A String", # The algorithm to use for autoscaling.
- "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ # The supported resource type is:
+ #
+ # Google Cloud Storage:
+ # storage.googleapis.com/{bucket}/{object}
+ # bucket.storage.googleapis.com/{object}
},
+ "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
+ # are supported.
+ "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
+ # service will attempt to choose a reasonable default.
+ "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
+ # the service will use the network "default".
+ "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
+ # will attempt to choose a reasonable default.
+ "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
+ # attempt to choose a reasonable default.
"dataDisks": [ # Data disks that are used by a VM in this workflow.
{ # Describes the data disk used by a workflow job.
"mountPoint": "A String", # Directory in a VM where disk is mounted.
@@ -1373,13 +1313,78 @@
# compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard
},
],
- "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
+ # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
+ # `TEARDOWN_NEVER`.
+ # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
+ # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
+ # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
+ # down.
+ #
+ # If the workers are not torn down by the service, they will
+ # continue to run and use Google Compute Engine VM resources in the
+ # user's project until they are explicitly terminated by the user.
+ # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
+ # policy except for small, manually supervised test jobs.
+ #
+ # If unknown or unspecified, the service will attempt to choose a reasonable
+ # default.
+ "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
+ # Compute Engine API.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
+ # service will choose a number of threads (according to the number of cores
+ # on the selected machine type for batch, or 1 by convention for streaming).
+ "poolArgs": { # Extra arguments for this worker pool.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
+ # execute the job. If zero or unspecified, the service will
# attempt to choose a reasonable default.
"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker
# harness, residing in Google Container Registry.
+ "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
+ # the form "regions/REGION/subnetworks/SUBNETWORK".
+ "packages": [ # Packages to be installed on workers.
+ { # The packages that must be installed in order for a worker to run the
+ # steps of the Cloud Dataflow job that will be assigned to its worker
+ # pool.
+ #
+ # This is the mechanism by which the Cloud Dataflow SDK causes code to
+ # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
+ # might use this to install jars containing the user's code and all of the
+ # various dependencies (libraries, data files, etc.) required in order
+ # for that code to run.
+ "location": "A String", # The resource to read the package from. The supported resource type is:
+ #
+ # Google Cloud Storage:
+ #
+ # storage.googleapis.com/{bucket}
+ # bucket.storage.googleapis.com/
+ "name": "A String", # The name of the package.
+ },
+ ],
+ "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
+ "algorithm": "A String", # The algorithm to use for autoscaling.
+ "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ },
+ "defaultPackageSet": "A String", # The default package set to install. This allows the service to
+ # select a default set of packages which are useful to worker
+ # harnesses written in a particular language.
+ "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ # attempt to choose a reasonable default.
+ "metadata": { # Metadata to set on the Google Compute Engine VMs.
+ "a_key": "A String",
+ },
},
],
},
+ "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
+ # of the job it replaced.
+ #
+ # When sending a `CreateJobRequest`, you can update a job by specifying it
+ # here. The job named here is stopped, and its intermediate state is
+ # transferred to this job.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed # Preliminary field: The format of this data may change at any time.
# A description of the user pipeline and stages through which it is executed.
# Created by Cloud Dataflow service. Only retrieved with
@@ -1395,9 +1400,6 @@
],
"displayData": [ # Transform-specific display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -1405,6 +1407,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -1415,7 +1418,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -1427,9 +1432,6 @@
],
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -1437,6 +1439,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -1447,7 +1450,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -1469,19 +1474,19 @@
"outputSource": [ # Output sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"inputSource": [ # Input sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"componentTransform": [ # Transforms that comprise this execution stage.
@@ -1523,26 +1528,16 @@
# Note that the Cloud Dataflow service may be used to run many different
# types of jobs, not just Map-Reduce.
"kind": "A String", # The kind of step in the Cloud Dataflow job.
+ "name": "A String", # The name that identifies the step. This must be unique for each
+ # step with respect to all other steps in the Cloud Dataflow job.
"properties": { # Named properties associated with the step. Each kind of
# predefined step has its own required set of properties.
# Must be provided on Create. Only retrieved with JOB_VIEW_ALL.
"a_key": "", # Properties of the object.
},
- "name": "A String", # The name that identifies the step. This must be unique for each
- # step with respect to all other steps in the Cloud Dataflow job.
},
],
- "currentState": "A String", # The current state of the job.
- #
- # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
- # specified.
- #
- # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
- # terminal state. After a job has reached a terminal state, no
- # further state updates may be made.
- #
- # This field may be mutated by the Cloud Dataflow service;
- # callers cannot mutate it.
+ "location": "A String", # The location that contains this job.
"tempFiles": [ # A set of files the system should be aware of that are used
# for temporary storage. These temporary files will be
# removed on job completion.
@@ -1562,12 +1557,17 @@
#
# This field is set by the Cloud Dataflow service when the Job is
# created, and is immutable for the life of the job.
- "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
- # of the job it replaced.
+ "currentState": "A String", # The current state of the job.
#
- # When sending a `CreateJobRequest`, you can update a job by specifying it
- # here. The job named here is stopped, and its intermediate state is
- # transferred to this job.
+ # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
+ # specified.
+ #
+ # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
+ # terminal state. After a job has reached a terminal state, no
+ # further state updates may be made.
+ #
+ # This field may be mutated by the Cloud Dataflow service;
+ # callers cannot mutate it.
"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that # Deprecated.
# isn't contained in the submitted job.
"stages": { # A mapping from each stage to the information about that stage.
@@ -1685,11 +1685,6 @@
{ # Response to a request to list Cloud Dataflow jobs. This may be a partial
# response, depending on the page size in the ListJobsRequest.
"nextPageToken": "A String", # Set if there may be more results than fit in this response.
- "failedLocation": [ # Zero or more messages describing locations that failed to respond.
- { # Indicates which location failed to respond to a request for data.
- "name": "A String", # The name of the failed location.
- },
- ],
"jobs": [ # A subset of the requested job information.
{ # Defines a job to be run by the Cloud Dataflow service.
"clientRequestId": "A String", # The client's unique identifier of the job, re-used across retried attempts.
@@ -1730,13 +1725,12 @@
# size.
"a_key": "A String",
},
- "location": "A String", # The location that contains this job.
- "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
- # Cloud Dataflow service.
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the
# corresponding name prefixes of the new job.
"a_key": "A String",
},
+ "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
+ # Cloud Dataflow service.
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
"version": { # A structure describing which components and their versions of the service
# are required in order to run the job.
@@ -1790,49 +1784,6 @@
# multiple pools, in order to match the various computational
# requirements of the various stages of the job.
"diskSourceImage": "A String", # Fully qualified source image for disks.
- "ipConfiguration": "A String", # Configuration for VM IPs.
- "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
- # are supported.
- "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
- # service will attempt to choose a reasonable default.
- "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
- # the service will use the network "default".
- "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
- # will attempt to choose a reasonable default.
- "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
- "metadata": { # Metadata to set on the Google Compute Engine VMs.
- "a_key": "A String",
- },
- "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
- # Compute Engine API.
- "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
- # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
- # `TEARDOWN_NEVER`.
- # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
- # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
- # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
- # down.
- #
- # If the workers are not torn down by the service, they will
- # continue to run and use Google Compute Engine VM resources in the
- # user's project until they are explicitly terminated by the user.
- # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
- # policy except for small, manually supervised test jobs.
- #
- # If unknown or unspecified, the service will attempt to choose a reasonable
- # default.
- "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
- # service will choose a number of threads (according to the number of cores
- # on the selected machine type for batch, or 1 by convention for streaming).
- "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
- # the form "regions/REGION/subnetworks/SUBNETWORK".
- "poolArgs": { # Extra arguments for this worker pool.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
- # execute the job. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when
# using the standard Dataflow task runner. Users should ignore
# this field.
@@ -1845,24 +1796,17 @@
# Google Cloud Storage:
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
- "commandlinesFileName": "A String", # The file to store preprocessing commands in.
- "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
- "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
- "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
- "vmId": "A String", # The ID string of the VM.
- "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
- # taskrunner; e.g. "wheel".
"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by
# taskrunner; e.g. "root".
+ "commandlinesFileName": "A String", # The file to store preprocessing commands in.
+ "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
+ "vmId": "A String", # The ID string of the VM.
+ "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
+ "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to
# access the Cloud Dataflow API.
"A String",
],
- "languageHint": "A String", # The suggested backend language.
- "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
- # console.
- "streamingWorkerMainClass": "A String", # The streaming worker main class name.
- "logDir": "A String", # The directory on the VM to store logs.
"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.
"reportingEnabled": True or False, # Whether to send work progress updates to the service.
"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example,
@@ -1889,16 +1833,14 @@
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
},
+ "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
+ # taskrunner; e.g. "wheel".
+ "languageHint": "A String", # The suggested backend language.
+ "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
+ # console.
+ "streamingWorkerMainClass": "A String", # The streaming worker main class name.
+ "logDir": "A String", # The directory on the VM to store logs.
"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"
- "harnessCommand": "A String", # The command to launch the worker harness.
- "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
- # temporary storage.
- #
- # The supported resource type is:
- #
- # Google Cloud Storage:
- # storage.googleapis.com/{bucket}/{object}
- # bucket.storage.googleapis.com/{object}
"baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs.
#
# When workers access Google Cloud APIs, they logically do so via
@@ -1908,33 +1850,26 @@
# Locators".
#
# If not specified, the default value is "http://www.googleapis.com/"
- },
- "defaultPackageSet": "A String", # The default package set to install. This allows the service to
- # select a default set of packages which are useful to worker
- # harnesses written in a particular language.
- "packages": [ # Packages to be installed on workers.
- { # The packages that must be installed in order for a worker to run the
- # steps of the Cloud Dataflow job that will be assigned to its worker
- # pool.
+ "harnessCommand": "A String", # The command to launch the worker harness.
+ "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
+ # temporary storage.
#
- # This is the mechanism by which the Cloud Dataflow SDK causes code to
- # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
- # might use this to install jars containing the user's code and all of the
- # various dependencies (libraries, data files, etc.) required in order
- # for that code to run.
- "location": "A String", # The resource to read the package from. The supported resource type is:
- #
- # Google Cloud Storage:
- #
- # storage.googleapis.com/{bucket}
- # bucket.storage.googleapis.com/
- "name": "A String", # The name of the package.
- },
- ],
- "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
- "algorithm": "A String", # The algorithm to use for autoscaling.
- "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ # The supported resource type is:
+ #
+ # Google Cloud Storage:
+ # storage.googleapis.com/{bucket}/{object}
+ # bucket.storage.googleapis.com/{object}
},
+ "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
+ # are supported.
+ "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
+ # service will attempt to choose a reasonable default.
+ "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
+ # the service will use the network "default".
+ "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
+ # will attempt to choose a reasonable default.
+ "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
+ # attempt to choose a reasonable default.
"dataDisks": [ # Data disks that are used by a VM in this workflow.
{ # Describes the data disk used by a workflow job.
"mountPoint": "A String", # Directory in a VM where disk is mounted.
@@ -1960,13 +1895,78 @@
# compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard
},
],
- "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
+ # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
+ # `TEARDOWN_NEVER`.
+ # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
+ # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
+ # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
+ # down.
+ #
+ # If the workers are not torn down by the service, they will
+ # continue to run and use Google Compute Engine VM resources in the
+ # user's project until they are explicitly terminated by the user.
+ # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
+ # policy except for small, manually supervised test jobs.
+ #
+ # If unknown or unspecified, the service will attempt to choose a reasonable
+ # default.
+ "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
+ # Compute Engine API.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
+ # service will choose a number of threads (according to the number of cores
+ # on the selected machine type for batch, or 1 by convention for streaming).
+ "poolArgs": { # Extra arguments for this worker pool.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
+ # execute the job. If zero or unspecified, the service will
# attempt to choose a reasonable default.
"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker
# harness, residing in Google Container Registry.
+ "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
+ # the form "regions/REGION/subnetworks/SUBNETWORK".
+ "packages": [ # Packages to be installed on workers.
+ { # The packages that must be installed in order for a worker to run the
+ # steps of the Cloud Dataflow job that will be assigned to its worker
+ # pool.
+ #
+ # This is the mechanism by which the Cloud Dataflow SDK causes code to
+ # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
+ # might use this to install jars containing the user's code and all of the
+ # various dependencies (libraries, data files, etc.) required in order
+ # for that code to run.
+ "location": "A String", # The resource to read the package from. The supported resource type is:
+ #
+ # Google Cloud Storage:
+ #
+ # storage.googleapis.com/{bucket}
+ # bucket.storage.googleapis.com/
+ "name": "A String", # The name of the package.
+ },
+ ],
+ "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
+ "algorithm": "A String", # The algorithm to use for autoscaling.
+ "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ },
+ "defaultPackageSet": "A String", # The default package set to install. This allows the service to
+ # select a default set of packages which are useful to worker
+ # harnesses written in a particular language.
+ "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ # attempt to choose a reasonable default.
+ "metadata": { # Metadata to set on the Google Compute Engine VMs.
+ "a_key": "A String",
+ },
},
],
},
+ "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
+ # of the job it replaced.
+ #
+ # When sending a `CreateJobRequest`, you can update a job by specifying it
+ # here. The job named here is stopped, and its intermediate state is
+ # transferred to this job.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed # Preliminary field: The format of this data may change at any time.
# A description of the user pipeline and stages through which it is executed.
# Created by Cloud Dataflow service. Only retrieved with
@@ -1982,9 +1982,6 @@
],
"displayData": [ # Transform-specific display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -1992,6 +1989,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -2002,7 +2000,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -2014,9 +2014,6 @@
],
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -2024,6 +2021,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -2034,7 +2032,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -2056,19 +2056,19 @@
"outputSource": [ # Output sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"inputSource": [ # Input sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"componentTransform": [ # Transforms that comprise this execution stage.
@@ -2110,26 +2110,16 @@
# Note that the Cloud Dataflow service may be used to run many different
# types of jobs, not just Map-Reduce.
"kind": "A String", # The kind of step in the Cloud Dataflow job.
+ "name": "A String", # The name that identifies the step. This must be unique for each
+ # step with respect to all other steps in the Cloud Dataflow job.
"properties": { # Named properties associated with the step. Each kind of
# predefined step has its own required set of properties.
# Must be provided on Create. Only retrieved with JOB_VIEW_ALL.
"a_key": "", # Properties of the object.
},
- "name": "A String", # The name that identifies the step. This must be unique for each
- # step with respect to all other steps in the Cloud Dataflow job.
},
],
- "currentState": "A String", # The current state of the job.
- #
- # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
- # specified.
- #
- # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
- # terminal state. After a job has reached a terminal state, no
- # further state updates may be made.
- #
- # This field may be mutated by the Cloud Dataflow service;
- # callers cannot mutate it.
+ "location": "A String", # The location that contains this job.
"tempFiles": [ # A set of files the system should be aware of that are used
# for temporary storage. These temporary files will be
# removed on job completion.
@@ -2149,12 +2139,17 @@
#
# This field is set by the Cloud Dataflow service when the Job is
# created, and is immutable for the life of the job.
- "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
- # of the job it replaced.
+ "currentState": "A String", # The current state of the job.
#
- # When sending a `CreateJobRequest`, you can update a job by specifying it
- # here. The job named here is stopped, and its intermediate state is
- # transferred to this job.
+ # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
+ # specified.
+ #
+ # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
+ # terminal state. After a job has reached a terminal state, no
+ # further state updates may be made.
+ #
+ # This field may be mutated by the Cloud Dataflow service;
+ # callers cannot mutate it.
"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that # Deprecated.
# isn't contained in the submitted job.
"stages": { # A mapping from each stage to the information about that stage.
@@ -2170,6 +2165,11 @@
},
},
],
+ "failedLocation": [ # Zero or more messages describing locations that failed to respond.
+ { # Indicates which location failed to respond to a request for data.
+ "name": "A String", # The name of the failed location.
+ },
+ ],
}</pre>
</div>
@@ -2236,13 +2236,12 @@
# size.
"a_key": "A String",
},
- "location": "A String", # The location that contains this job.
- "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
- # Cloud Dataflow service.
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the
# corresponding name prefixes of the new job.
"a_key": "A String",
},
+ "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
+ # Cloud Dataflow service.
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
"version": { # A structure describing which components and their versions of the service
# are required in order to run the job.
@@ -2296,49 +2295,6 @@
# multiple pools, in order to match the various computational
# requirements of the various stages of the job.
"diskSourceImage": "A String", # Fully qualified source image for disks.
- "ipConfiguration": "A String", # Configuration for VM IPs.
- "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
- # are supported.
- "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
- # service will attempt to choose a reasonable default.
- "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
- # the service will use the network "default".
- "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
- # will attempt to choose a reasonable default.
- "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
- "metadata": { # Metadata to set on the Google Compute Engine VMs.
- "a_key": "A String",
- },
- "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
- # Compute Engine API.
- "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
- # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
- # `TEARDOWN_NEVER`.
- # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
- # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
- # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
- # down.
- #
- # If the workers are not torn down by the service, they will
- # continue to run and use Google Compute Engine VM resources in the
- # user's project until they are explicitly terminated by the user.
- # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
- # policy except for small, manually supervised test jobs.
- #
- # If unknown or unspecified, the service will attempt to choose a reasonable
- # default.
- "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
- # service will choose a number of threads (according to the number of cores
- # on the selected machine type for batch, or 1 by convention for streaming).
- "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
- # the form "regions/REGION/subnetworks/SUBNETWORK".
- "poolArgs": { # Extra arguments for this worker pool.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
- # execute the job. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when
# using the standard Dataflow task runner. Users should ignore
# this field.
@@ -2351,24 +2307,17 @@
# Google Cloud Storage:
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
- "commandlinesFileName": "A String", # The file to store preprocessing commands in.
- "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
- "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
- "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
- "vmId": "A String", # The ID string of the VM.
- "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
- # taskrunner; e.g. "wheel".
"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by
# taskrunner; e.g. "root".
+ "commandlinesFileName": "A String", # The file to store preprocessing commands in.
+ "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
+ "vmId": "A String", # The ID string of the VM.
+ "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
+ "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to
# access the Cloud Dataflow API.
"A String",
],
- "languageHint": "A String", # The suggested backend language.
- "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
- # console.
- "streamingWorkerMainClass": "A String", # The streaming worker main class name.
- "logDir": "A String", # The directory on the VM to store logs.
"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.
"reportingEnabled": True or False, # Whether to send work progress updates to the service.
"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example,
@@ -2395,16 +2344,14 @@
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
},
+ "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
+ # taskrunner; e.g. "wheel".
+ "languageHint": "A String", # The suggested backend language.
+ "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
+ # console.
+ "streamingWorkerMainClass": "A String", # The streaming worker main class name.
+ "logDir": "A String", # The directory on the VM to store logs.
"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"
- "harnessCommand": "A String", # The command to launch the worker harness.
- "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
- # temporary storage.
- #
- # The supported resource type is:
- #
- # Google Cloud Storage:
- # storage.googleapis.com/{bucket}/{object}
- # bucket.storage.googleapis.com/{object}
"baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs.
#
# When workers access Google Cloud APIs, they logically do so via
@@ -2414,33 +2361,26 @@
# Locators".
#
# If not specified, the default value is "http://www.googleapis.com/"
- },
- "defaultPackageSet": "A String", # The default package set to install. This allows the service to
- # select a default set of packages which are useful to worker
- # harnesses written in a particular language.
- "packages": [ # Packages to be installed on workers.
- { # The packages that must be installed in order for a worker to run the
- # steps of the Cloud Dataflow job that will be assigned to its worker
- # pool.
+ "harnessCommand": "A String", # The command to launch the worker harness.
+ "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
+ # temporary storage.
#
- # This is the mechanism by which the Cloud Dataflow SDK causes code to
- # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
- # might use this to install jars containing the user's code and all of the
- # various dependencies (libraries, data files, etc.) required in order
- # for that code to run.
- "location": "A String", # The resource to read the package from. The supported resource type is:
- #
- # Google Cloud Storage:
- #
- # storage.googleapis.com/{bucket}
- # bucket.storage.googleapis.com/
- "name": "A String", # The name of the package.
- },
- ],
- "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
- "algorithm": "A String", # The algorithm to use for autoscaling.
- "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ # The supported resource type is:
+ #
+ # Google Cloud Storage:
+ # storage.googleapis.com/{bucket}/{object}
+ # bucket.storage.googleapis.com/{object}
},
+ "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
+ # are supported.
+ "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
+ # service will attempt to choose a reasonable default.
+ "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
+ # the service will use the network "default".
+ "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
+ # will attempt to choose a reasonable default.
+ "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
+ # attempt to choose a reasonable default.
"dataDisks": [ # Data disks that are used by a VM in this workflow.
{ # Describes the data disk used by a workflow job.
"mountPoint": "A String", # Directory in a VM where disk is mounted.
@@ -2466,13 +2406,78 @@
# compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard
},
],
- "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
+ # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
+ # `TEARDOWN_NEVER`.
+ # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
+ # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
+ # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
+ # down.
+ #
+ # If the workers are not torn down by the service, they will
+ # continue to run and use Google Compute Engine VM resources in the
+ # user's project until they are explicitly terminated by the user.
+ # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
+ # policy except for small, manually supervised test jobs.
+ #
+ # If unknown or unspecified, the service will attempt to choose a reasonable
+ # default.
+ "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
+ # Compute Engine API.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
+ # service will choose a number of threads (according to the number of cores
+ # on the selected machine type for batch, or 1 by convention for streaming).
+ "poolArgs": { # Extra arguments for this worker pool.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
+ # execute the job. If zero or unspecified, the service will
# attempt to choose a reasonable default.
"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker
# harness, residing in Google Container Registry.
+ "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
+ # the form "regions/REGION/subnetworks/SUBNETWORK".
+ "packages": [ # Packages to be installed on workers.
+ { # The packages that must be installed in order for a worker to run the
+ # steps of the Cloud Dataflow job that will be assigned to its worker
+ # pool.
+ #
+ # This is the mechanism by which the Cloud Dataflow SDK causes code to
+ # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
+ # might use this to install jars containing the user's code and all of the
+ # various dependencies (libraries, data files, etc.) required in order
+ # for that code to run.
+ "location": "A String", # The resource to read the package from. The supported resource type is:
+ #
+ # Google Cloud Storage:
+ #
+ # storage.googleapis.com/{bucket}
+ # bucket.storage.googleapis.com/
+ "name": "A String", # The name of the package.
+ },
+ ],
+ "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
+ "algorithm": "A String", # The algorithm to use for autoscaling.
+ "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ },
+ "defaultPackageSet": "A String", # The default package set to install. This allows the service to
+ # select a default set of packages which are useful to worker
+ # harnesses written in a particular language.
+ "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ # attempt to choose a reasonable default.
+ "metadata": { # Metadata to set on the Google Compute Engine VMs.
+ "a_key": "A String",
+ },
},
],
},
+ "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
+ # of the job it replaced.
+ #
+ # When sending a `CreateJobRequest`, you can update a job by specifying it
+ # here. The job named here is stopped, and its intermediate state is
+ # transferred to this job.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed # Preliminary field: The format of this data may change at any time.
# A description of the user pipeline and stages through which it is executed.
# Created by Cloud Dataflow service. Only retrieved with
@@ -2488,9 +2493,6 @@
],
"displayData": [ # Transform-specific display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -2498,6 +2500,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -2508,7 +2511,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -2520,9 +2525,6 @@
],
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -2530,6 +2532,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -2540,7 +2543,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -2562,19 +2567,19 @@
"outputSource": [ # Output sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"inputSource": [ # Input sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"componentTransform": [ # Transforms that comprise this execution stage.
@@ -2616,26 +2621,16 @@
# Note that the Cloud Dataflow service may be used to run many different
# types of jobs, not just Map-Reduce.
"kind": "A String", # The kind of step in the Cloud Dataflow job.
+ "name": "A String", # The name that identifies the step. This must be unique for each
+ # step with respect to all other steps in the Cloud Dataflow job.
"properties": { # Named properties associated with the step. Each kind of
# predefined step has its own required set of properties.
# Must be provided on Create. Only retrieved with JOB_VIEW_ALL.
"a_key": "", # Properties of the object.
},
- "name": "A String", # The name that identifies the step. This must be unique for each
- # step with respect to all other steps in the Cloud Dataflow job.
},
],
- "currentState": "A String", # The current state of the job.
- #
- # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
- # specified.
- #
- # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
- # terminal state. After a job has reached a terminal state, no
- # further state updates may be made.
- #
- # This field may be mutated by the Cloud Dataflow service;
- # callers cannot mutate it.
+ "location": "A String", # The location that contains this job.
"tempFiles": [ # A set of files the system should be aware of that are used
# for temporary storage. These temporary files will be
# removed on job completion.
@@ -2655,12 +2650,17 @@
#
# This field is set by the Cloud Dataflow service when the Job is
# created, and is immutable for the life of the job.
- "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
- # of the job it replaced.
+ "currentState": "A String", # The current state of the job.
#
- # When sending a `CreateJobRequest`, you can update a job by specifying it
- # here. The job named here is stopped, and its intermediate state is
- # transferred to this job.
+ # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
+ # specified.
+ #
+ # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
+ # terminal state. After a job has reached a terminal state, no
+ # further state updates may be made.
+ #
+ # This field may be mutated by the Cloud Dataflow service;
+ # callers cannot mutate it.
"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that # Deprecated.
# isn't contained in the submitted job.
"stages": { # A mapping from each stage to the information about that stage.
@@ -2724,13 +2724,12 @@
# size.
"a_key": "A String",
},
- "location": "A String", # The location that contains this job.
- "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
- # Cloud Dataflow service.
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the
# corresponding name prefixes of the new job.
"a_key": "A String",
},
+ "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
+ # Cloud Dataflow service.
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
"version": { # A structure describing which components and their versions of the service
# are required in order to run the job.
@@ -2784,49 +2783,6 @@
# multiple pools, in order to match the various computational
# requirements of the various stages of the job.
"diskSourceImage": "A String", # Fully qualified source image for disks.
- "ipConfiguration": "A String", # Configuration for VM IPs.
- "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
- # are supported.
- "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
- # service will attempt to choose a reasonable default.
- "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
- # the service will use the network "default".
- "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
- # will attempt to choose a reasonable default.
- "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
- "metadata": { # Metadata to set on the Google Compute Engine VMs.
- "a_key": "A String",
- },
- "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
- # Compute Engine API.
- "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
- # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
- # `TEARDOWN_NEVER`.
- # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
- # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
- # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
- # down.
- #
- # If the workers are not torn down by the service, they will
- # continue to run and use Google Compute Engine VM resources in the
- # user's project until they are explicitly terminated by the user.
- # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
- # policy except for small, manually supervised test jobs.
- #
- # If unknown or unspecified, the service will attempt to choose a reasonable
- # default.
- "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
- # service will choose a number of threads (according to the number of cores
- # on the selected machine type for batch, or 1 by convention for streaming).
- "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
- # the form "regions/REGION/subnetworks/SUBNETWORK".
- "poolArgs": { # Extra arguments for this worker pool.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
- # execute the job. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when
# using the standard Dataflow task runner. Users should ignore
# this field.
@@ -2839,24 +2795,17 @@
# Google Cloud Storage:
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
- "commandlinesFileName": "A String", # The file to store preprocessing commands in.
- "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
- "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
- "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
- "vmId": "A String", # The ID string of the VM.
- "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
- # taskrunner; e.g. "wheel".
"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by
# taskrunner; e.g. "root".
+ "commandlinesFileName": "A String", # The file to store preprocessing commands in.
+ "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
+ "vmId": "A String", # The ID string of the VM.
+ "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
+ "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to
# access the Cloud Dataflow API.
"A String",
],
- "languageHint": "A String", # The suggested backend language.
- "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
- # console.
- "streamingWorkerMainClass": "A String", # The streaming worker main class name.
- "logDir": "A String", # The directory on the VM to store logs.
"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.
"reportingEnabled": True or False, # Whether to send work progress updates to the service.
"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example,
@@ -2883,16 +2832,14 @@
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
},
+ "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
+ # taskrunner; e.g. "wheel".
+ "languageHint": "A String", # The suggested backend language.
+ "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
+ # console.
+ "streamingWorkerMainClass": "A String", # The streaming worker main class name.
+ "logDir": "A String", # The directory on the VM to store logs.
"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"
- "harnessCommand": "A String", # The command to launch the worker harness.
- "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
- # temporary storage.
- #
- # The supported resource type is:
- #
- # Google Cloud Storage:
- # storage.googleapis.com/{bucket}/{object}
- # bucket.storage.googleapis.com/{object}
"baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs.
#
# When workers access Google Cloud APIs, they logically do so via
@@ -2902,33 +2849,26 @@
# Locators".
#
# If not specified, the default value is "http://www.googleapis.com/"
- },
- "defaultPackageSet": "A String", # The default package set to install. This allows the service to
- # select a default set of packages which are useful to worker
- # harnesses written in a particular language.
- "packages": [ # Packages to be installed on workers.
- { # The packages that must be installed in order for a worker to run the
- # steps of the Cloud Dataflow job that will be assigned to its worker
- # pool.
+ "harnessCommand": "A String", # The command to launch the worker harness.
+ "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
+ # temporary storage.
#
- # This is the mechanism by which the Cloud Dataflow SDK causes code to
- # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
- # might use this to install jars containing the user's code and all of the
- # various dependencies (libraries, data files, etc.) required in order
- # for that code to run.
- "location": "A String", # The resource to read the package from. The supported resource type is:
- #
- # Google Cloud Storage:
- #
- # storage.googleapis.com/{bucket}
- # bucket.storage.googleapis.com/
- "name": "A String", # The name of the package.
- },
- ],
- "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
- "algorithm": "A String", # The algorithm to use for autoscaling.
- "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ # The supported resource type is:
+ #
+ # Google Cloud Storage:
+ # storage.googleapis.com/{bucket}/{object}
+ # bucket.storage.googleapis.com/{object}
},
+ "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
+ # are supported.
+ "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
+ # service will attempt to choose a reasonable default.
+ "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
+ # the service will use the network "default".
+ "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
+ # will attempt to choose a reasonable default.
+ "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
+ # attempt to choose a reasonable default.
"dataDisks": [ # Data disks that are used by a VM in this workflow.
{ # Describes the data disk used by a workflow job.
"mountPoint": "A String", # Directory in a VM where disk is mounted.
@@ -2954,13 +2894,78 @@
# compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard
},
],
- "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
+ # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
+ # `TEARDOWN_NEVER`.
+ # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
+ # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
+ # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
+ # down.
+ #
+ # If the workers are not torn down by the service, they will
+ # continue to run and use Google Compute Engine VM resources in the
+ # user's project until they are explicitly terminated by the user.
+ # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
+ # policy except for small, manually supervised test jobs.
+ #
+ # If unknown or unspecified, the service will attempt to choose a reasonable
+ # default.
+ "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
+ # Compute Engine API.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
+ # service will choose a number of threads (according to the number of cores
+ # on the selected machine type for batch, or 1 by convention for streaming).
+ "poolArgs": { # Extra arguments for this worker pool.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
+ # execute the job. If zero or unspecified, the service will
# attempt to choose a reasonable default.
"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker
# harness, residing in Google Container Registry.
+ "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
+ # the form "regions/REGION/subnetworks/SUBNETWORK".
+ "packages": [ # Packages to be installed on workers.
+ { # The packages that must be installed in order for a worker to run the
+ # steps of the Cloud Dataflow job that will be assigned to its worker
+ # pool.
+ #
+ # This is the mechanism by which the Cloud Dataflow SDK causes code to
+ # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
+ # might use this to install jars containing the user's code and all of the
+ # various dependencies (libraries, data files, etc.) required in order
+ # for that code to run.
+ "location": "A String", # The resource to read the package from. The supported resource type is:
+ #
+ # Google Cloud Storage:
+ #
+ # storage.googleapis.com/{bucket}
+ # bucket.storage.googleapis.com/
+ "name": "A String", # The name of the package.
+ },
+ ],
+ "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
+ "algorithm": "A String", # The algorithm to use for autoscaling.
+ "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ },
+ "defaultPackageSet": "A String", # The default package set to install. This allows the service to
+ # select a default set of packages which are useful to worker
+ # harnesses written in a particular language.
+ "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ # attempt to choose a reasonable default.
+ "metadata": { # Metadata to set on the Google Compute Engine VMs.
+ "a_key": "A String",
+ },
},
],
},
+ "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
+ # of the job it replaced.
+ #
+ # When sending a `CreateJobRequest`, you can update a job by specifying it
+ # here. The job named here is stopped, and its intermediate state is
+ # transferred to this job.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed # Preliminary field: The format of this data may change at any time.
# A description of the user pipeline and stages through which it is executed.
# Created by Cloud Dataflow service. Only retrieved with
@@ -2976,9 +2981,6 @@
],
"displayData": [ # Transform-specific display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -2986,6 +2988,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -2996,7 +2999,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -3008,9 +3013,6 @@
],
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -3018,6 +3020,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -3028,7 +3031,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -3050,19 +3055,19 @@
"outputSource": [ # Output sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"inputSource": [ # Input sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"componentTransform": [ # Transforms that comprise this execution stage.
@@ -3104,26 +3109,16 @@
# Note that the Cloud Dataflow service may be used to run many different
# types of jobs, not just Map-Reduce.
"kind": "A String", # The kind of step in the Cloud Dataflow job.
+ "name": "A String", # The name that identifies the step. This must be unique for each
+ # step with respect to all other steps in the Cloud Dataflow job.
"properties": { # Named properties associated with the step. Each kind of
# predefined step has its own required set of properties.
# Must be provided on Create. Only retrieved with JOB_VIEW_ALL.
"a_key": "", # Properties of the object.
},
- "name": "A String", # The name that identifies the step. This must be unique for each
- # step with respect to all other steps in the Cloud Dataflow job.
},
],
- "currentState": "A String", # The current state of the job.
- #
- # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
- # specified.
- #
- # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
- # terminal state. After a job has reached a terminal state, no
- # further state updates may be made.
- #
- # This field may be mutated by the Cloud Dataflow service;
- # callers cannot mutate it.
+ "location": "A String", # The location that contains this job.
"tempFiles": [ # A set of files the system should be aware of that are used
# for temporary storage. These temporary files will be
# removed on job completion.
@@ -3143,12 +3138,17 @@
#
# This field is set by the Cloud Dataflow service when the Job is
# created, and is immutable for the life of the job.
- "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
- # of the job it replaced.
+ "currentState": "A String", # The current state of the job.
#
- # When sending a `CreateJobRequest`, you can update a job by specifying it
- # here. The job named here is stopped, and its intermediate state is
- # transferred to this job.
+ # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
+ # specified.
+ #
+ # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
+ # terminal state. After a job has reached a terminal state, no
+ # further state updates may be made.
+ #
+ # This field may be mutated by the Cloud Dataflow service;
+ # callers cannot mutate it.
"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that # Deprecated.
# isn't contained in the submitted job.
"stages": { # A mapping from each stage to the information about that stage.
diff --git a/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html b/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html
index e539ec3..debf158 100644
--- a/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html
+++ b/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html
@@ -118,26 +118,6 @@
"workItems": [ # A list of the leased WorkItems.
{ # WorkItem represents basic information about a WorkItem to be executed
# in the cloud.
- "packages": [ # Any required packages that need to be fetched in order to execute
- # this WorkItem.
- { # The packages that must be installed in order for a worker to run the
- # steps of the Cloud Dataflow job that will be assigned to its worker
- # pool.
- #
- # This is the mechanism by which the Cloud Dataflow SDK causes code to
- # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
- # might use this to install jars containing the user's code and all of the
- # various dependencies (libraries, data files, etc.) required in order
- # for that code to run.
- "location": "A String", # The resource to read the package from. The supported resource type is:
- #
- # Google Cloud Storage:
- #
- # storage.googleapis.com/{bucket}
- # bucket.storage.googleapis.com/
- "name": "A String", # The name of the package.
- },
- ],
"reportStatusInterval": "A String", # Recommended reporting interval.
"leaseExpireTime": "A String", # Time when the lease on this Work will expire.
"seqMapTask": { # Describes a particular function to invoke. # Additional information for SeqMapTask WorkItems.
@@ -665,25 +645,13 @@
],
},
"jobId": "A String", # Identifies the workflow job this WorkItem belongs to.
+ "configuration": "A String", # Work item-specific configuration as an opaque blob.
"streamingSetupTask": { # A task which initializes part of a streaming Dataflow job. # Additional information for StreamingSetupTask WorkItems.
"workerHarnessPort": 42, # The TCP port used by the worker to communicate with the Dataflow
# worker harness.
"drain": True or False, # The user has requested drain.
"streamingComputationTopology": { # Global topology of the streaming Dataflow job, including all # The global topology of the streaming Dataflow job.
# computations and their sharded locations.
- "dataDiskAssignments": [ # The disks assigned to a streaming Dataflow job.
- { # Data disk assignment for a given VM instance.
- "vmInstance": "A String", # VM instance name the data disks mounted to, for example
- # "myproject-1014-104817-4c2-harness-0".
- "dataDisks": [ # Mounted data disks. The order is important a data disk's 0-based index in
- # this list defines which persistent directory the disk is mounted to, for
- # example the list of { "myproject-1014-104817-4c2-harness-0-disk-0" },
- # { "myproject-1014-104817-4c2-harness-0-disk-1" }.
- "A String",
- ],
- },
- ],
- "persistentStateVersion": 42, # Version number for persistent state.
"computations": [ # The computations associated with a streaming Dataflow job.
{ # All configuration data for a particular Computation.
"inputs": [ # The inputs to the computation.
@@ -719,6 +687,24 @@
},
},
],
+ "systemStageName": "A String", # The system stage name.
+ "keyRanges": [ # The key ranges processed by the computation.
+ { # Location information for a specific key-range of a sharded computation.
+ # Currently we only support UTF-8 character splits to simplify encoding into
+ # JSON.
+ "deprecatedPersistentDirectory": "A String", # DEPRECATED. The location of the persistent state for this range, as a
+ # persistent directory in the worker local filesystem.
+ "start": "A String", # The start (inclusive) of the key range.
+ "deliveryEndpoint": "A String", # The physical location of this range assignment to be used for
+ # streaming computation cross-worker message delivery.
+ "end": "A String", # The end (exclusive) of the key range.
+ "dataDisk": "A String", # The name of the data disk where data for this range is stored.
+ # This name is local to the Google Cloud Platform project and uniquely
+ # identifies the disk within that project, for example
+ # "myproject-1014-104817-4c2-harness-0-disk-1".
+ },
+ ],
+ "computationId": "A String", # The ID of the computation.
"outputs": [ # The outputs from the computation.
{ # Describes a stream of data, either as input to be processed or as
# output of a streaming Dataflow job.
@@ -752,24 +738,6 @@
},
},
],
- "keyRanges": [ # The key ranges processed by the computation.
- { # Location information for a specific key-range of a sharded computation.
- # Currently we only support UTF-8 character splits to simplify encoding into
- # JSON.
- "start": "A String", # The start (inclusive) of the key range.
- "persistentDirectory": "A String", # The location of the persistent state for this range, as a
- # persistent directory in the worker local filesystem.
- "end": "A String", # The end (exclusive) of the key range.
- "deliveryEndpoint": "A String", # The physical location of this range assignment to be used for
- # streaming computation cross-worker message delivery.
- "dataDisk": "A String", # The name of the data disk where data for this range is stored.
- # This name is local to the Google Cloud Platform project and uniquely
- # identifies the disk within that project, for example
- # "myproject-1014-104817-4c2-harness-0-disk-1".
- },
- ],
- "computationId": "A String", # The ID of the computation.
- "systemStageName": "A String", # The system stage name.
"userStageName": "A String", # The user stage name.
"stateFamilies": [ # The state family values.
{ # State family configuration.
@@ -779,10 +747,23 @@
],
},
],
+ "dataDiskAssignments": [ # The disks assigned to a streaming Dataflow job.
+ { # Data disk assignment for a given VM instance.
+ "vmInstance": "A String", # VM instance name the data disks mounted to, for example
+ # "myproject-1014-104817-4c2-harness-0".
+ "dataDisks": [ # Mounted data disks. The order is important a data disk's 0-based index in
+ # this list defines which persistent directory the disk is mounted to, for
+ # example the list of { "myproject-1014-104817-4c2-harness-0-disk-0" },
+ # { "myproject-1014-104817-4c2-harness-0-disk-1" }.
+ "A String",
+ ],
+ },
+ ],
+ "forwardingKeyBits": 42, # The size (in bits) of keys that will be assigned to source messages.
"userStageToComputationNameMap": { # Maps user stage names to stable computation names.
"a_key": "A String",
},
- "forwardingKeyBits": 42, # The size (in bits) of keys that will be assigned to source messages.
+ "persistentStateVersion": 42, # Version number for persistent state.
},
"receiveWorkPort": 42, # The TCP port on which the worker should listen for messages from
# other streaming computation workers.
@@ -1089,14 +1070,40 @@
},
],
},
- "configuration": "A String", # Work item-specific configuration as an opaque blob.
+ "packages": [ # Any required packages that need to be fetched in order to execute
+ # this WorkItem.
+ { # The packages that must be installed in order for a worker to run the
+ # steps of the Cloud Dataflow job that will be assigned to its worker
+ # pool.
+ #
+ # This is the mechanism by which the Cloud Dataflow SDK causes code to
+ # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
+ # might use this to install jars containing the user's code and all of the
+ # various dependencies (libraries, data files, etc.) required in order
+ # for that code to run.
+ "location": "A String", # The resource to read the package from. The supported resource type is:
+ #
+ # Google Cloud Storage:
+ #
+ # storage.googleapis.com/{bucket}
+ # bucket.storage.googleapis.com/
+ "name": "A String", # The name of the package.
+ },
+ ],
"shellTask": { # A task which consists of a shell command for the worker to execute. # Additional information for ShellTask WorkItems.
"command": "A String", # The shell command to run.
"exitCode": 42, # Exit code for the task.
},
"streamingComputationTask": { # A task which describes what action should be performed for the specified # Additional information for StreamingComputationTask WorkItems.
# streaming computation ranges.
- "taskType": "A String", # A type of streaming computation task.
+ "dataDisks": [ # Describes the set of data disks this task should apply to.
+ { # Describes mounted data disk.
+ "dataDisk": "A String", # The name of the data disk.
+ # This name is local to the Google Cloud Platform project and uniquely
+ # identifies the disk within that project, for example
+ # "myproject-1014-104817-4c2-harness-0-disk-1".
+ },
+ ],
"computationRanges": [ # Contains ranges of a streaming computation this task should apply to.
{ # Describes full or partial data disk assignment information of the computation
# ranges.
@@ -1116,14 +1123,7 @@
"computationId": "A String", # The ID of the computation.
},
],
- "dataDisks": [ # Describes the set of data disks this task should apply to.
- { # Describes mounted data disk.
- "dataDisk": "A String", # The name of the data disk.
- # This name is local to the Google Cloud Platform project and uniquely
- # identifies the disk within that project, for example
- # "myproject-1014-104817-4c2-harness-0-disk-1".
- },
- ],
+ "taskType": "A String", # A type of streaming computation task.
},
},
],
@@ -1414,8 +1414,8 @@
"concatPosition": { # A position that encapsulates an inner position and an index for the inner # CloudPosition is a concat position.
# position. A ConcatPosition can be used by a reader of a source that
# encapsulates a set of other sources.
- "index": 42, # Index of the inner source.
"position": # Object with schema name: Position # Position within the inner source.
+ "index": 42, # Index of the inner source.
},
"shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED
# sharding).
@@ -1658,8 +1658,9 @@
"dynamicSourceSplit": { # When a task splits using WorkItemStatus.dynamic_source_split, this # See documentation of stop_position.
# message describes the two parts of the split relative to the
# description of the current task's input.
- "residual": { # Specification of one of the bundles produced as a result of splitting # Residual part (returned to the pool of work).
+ "primary": { # Specification of one of the bundles produced as a result of splitting # Primary part (continued to be processed by worker).
# Specified relative to the previously-current source.
+ # Becomes current.
# a Source (e.g. when executing a SourceSplitRequest, or when
# splitting an active task using WorkItemStatus.dynamic_source_split),
# relative to the source being split.
@@ -1718,9 +1719,8 @@
},
},
},
- "primary": { # Specification of one of the bundles produced as a result of splitting # Primary part (continued to be processed by worker).
+ "residual": { # Specification of one of the bundles produced as a result of splitting # Residual part (returned to the pool of work).
# Specified relative to the previously-current source.
- # Becomes current.
# a Source (e.g. when executing a SourceSplitRequest, or when
# splitting an active task using WorkItemStatus.dynamic_source_split),
# relative to the source being split.
@@ -1800,6 +1800,7 @@
"highBits": 42, # The high order bits, including the sign: n >> 32.
},
},
+ "boolean": True or False, # Boolean value for And, Or.
"integerList": { # A metric value representing a list of integers. # List of integers, for Set.
"elements": [ # Elements of the list.
{ # A representation of an int64, n, that is immune to precision loss when
@@ -1813,14 +1814,6 @@
# value accumulated since the worker started working on this WorkItem.
# By default this is false, indicating that this counter is reported
# as a delta.
- "shortId": "A String", # The service-generated short identifier for this counter.
- # The short_id -> (name, metadata) mapping is constant for the lifetime of
- # a job.
- "stringList": { # A metric value representing a list of strings. # List of strings, for Set.
- "elements": [ # Elements of the list.
- "A String",
- ],
- },
"floatingPointMean": { # A representation of a floating point mean metric contribution. # Floating point mean aggregation value for Mean.
"count": { # A representation of an int64, n, that is immune to precision loss when # The number of values being aggregated.
# encoded in JSON.
@@ -1829,7 +1822,10 @@
},
"sum": 3.14, # The sum of all values being aggregated.
},
- "boolean": True or False, # Boolean value for And, Or.
+ "shortId": "A String", # The service-generated short identifier for this counter.
+ # The short_id -> (name, metadata) mapping is constant for the lifetime of
+ # a job.
+ "internal": "", # Value for internally-defined counters used by the Dataflow service.
"structuredNameAndMetadata": { # A single message which encapsulates structured name and metadata for a given # Counter structured name and metadata.
# counter.
"name": { # Identifies a counter within a per-job namespace. Counters whose structured # Structured name of the counter.
@@ -1849,8 +1845,8 @@
"metadata": { # CounterMetadata includes all static non-name non-value counter attributes. # Metadata associated with a counter
"standardUnits": "A String", # System defined Units, see above enum.
"kind": "A String", # Counter aggregation kind.
- "description": "A String", # Human-readable description of the counter semantics.
"otherUnits": "A String", # A string referring to the unit type.
+ "description": "A String", # Human-readable description of the counter semantics.
},
},
"integer": { # A representation of an int64, n, that is immune to precision loss when # Integer value for Sum, Max, Min.
@@ -1886,7 +1882,11 @@
"highBits": 42, # The high order bits, including the sign: n >> 32.
},
},
- "internal": "", # Value for internally-defined counters used by the Dataflow service.
+ "stringList": { # A metric value representing a list of strings. # List of strings, for Set.
+ "elements": [ # Elements of the list.
+ "A String",
+ ],
+ },
},
],
"progress": { # Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest. # DEPRECATED in favor of reported_progress.
@@ -1901,8 +1901,8 @@
"concatPosition": { # A position that encapsulates an inner position and an index for the inner # CloudPosition is a concat position.
# position. A ConcatPosition can be used by a reader of a source that
# encapsulates a set of other sources.
- "index": 42, # Index of the inner source.
"position": # Object with schema name: Position # Position within the inner source.
+ "index": 42, # Index of the inner source.
},
"shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED
# sharding).
@@ -1971,8 +1971,8 @@
"concatPosition": { # A position that encapsulates an inner position and an index for the inner # CloudPosition is a concat position.
# position. A ConcatPosition can be used by a reader of a source that
# encapsulates a set of other sources.
- "index": 42, # Index of the inner source.
"position": # Object with schema name: Position # Position within the inner source.
+ "index": 42, # Index of the inner source.
},
"shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED
# sharding).
@@ -2059,20 +2059,20 @@
"concatPosition": { # A position that encapsulates an inner position and an index for the inner # CloudPosition is a concat position.
# position. A ConcatPosition can be used by a reader of a source that
# encapsulates a set of other sources.
- "index": 42, # Index of the inner source.
"position": # Object with schema name: Position # Position within the inner source.
+ "index": 42, # Index of the inner source.
},
"shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED
# sharding).
},
- "leaseExpireTime": "A String", # Time at which the current lease will expire.
- "nextReportIndex": "A String", # The index value to use for the next report sent by the worker.
- # Note: If the report call fails for whatever reason, the worker should
- # reuse this index for subsequent report attempts.
"harnessData": { # Other data returned by the service, specific to the particular
# worker harness.
"a_key": "", # Properties of the object.
},
+ "nextReportIndex": "A String", # The index value to use for the next report sent by the worker.
+ # Note: If the report call fails for whatever reason, the worker should
+ # reuse this index for subsequent report attempts.
+ "leaseExpireTime": "A String", # Time at which the current lease will expire.
"metricShortId": [ # The short ids that workers should use in subsequent metric updates.
# Workers should strive to use short ids whenever possible, but it is ok
# to request the short_id again if a worker lost track of it
@@ -2101,8 +2101,8 @@
"concatPosition": { # A position that encapsulates an inner position and an index for the inner # CloudPosition is a concat position.
# position. A ConcatPosition can be used by a reader of a source that
# encapsulates a set of other sources.
- "index": 42, # Index of the inner source.
"position": # Object with schema name: Position # Position within the inner source.
+ "index": 42, # Index of the inner source.
},
"shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED
# sharding).
@@ -2120,8 +2120,8 @@
"concatPosition": { # A position that encapsulates an inner position and an index for the inner # CloudPosition is a concat position.
# position. A ConcatPosition can be used by a reader of a source that
# encapsulates a set of other sources.
- "index": 42, # Index of the inner source.
"position": # Object with schema name: Position # Position within the inner source.
+ "index": 42, # Index of the inner source.
},
"shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED
# sharding).
diff --git a/docs/dyn/dataflow_v1b3.projects.locations.jobs.html b/docs/dyn/dataflow_v1b3.projects.locations.jobs.html
index a098380..e7ad6bb 100644
--- a/docs/dyn/dataflow_v1b3.projects.locations.jobs.html
+++ b/docs/dyn/dataflow_v1b3.projects.locations.jobs.html
@@ -152,13 +152,12 @@
# size.
"a_key": "A String",
},
- "location": "A String", # The location that contains this job.
- "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
- # Cloud Dataflow service.
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the
# corresponding name prefixes of the new job.
"a_key": "A String",
},
+ "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
+ # Cloud Dataflow service.
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
"version": { # A structure describing which components and their versions of the service
# are required in order to run the job.
@@ -212,49 +211,6 @@
# multiple pools, in order to match the various computational
# requirements of the various stages of the job.
"diskSourceImage": "A String", # Fully qualified source image for disks.
- "ipConfiguration": "A String", # Configuration for VM IPs.
- "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
- # are supported.
- "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
- # service will attempt to choose a reasonable default.
- "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
- # the service will use the network "default".
- "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
- # will attempt to choose a reasonable default.
- "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
- "metadata": { # Metadata to set on the Google Compute Engine VMs.
- "a_key": "A String",
- },
- "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
- # Compute Engine API.
- "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
- # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
- # `TEARDOWN_NEVER`.
- # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
- # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
- # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
- # down.
- #
- # If the workers are not torn down by the service, they will
- # continue to run and use Google Compute Engine VM resources in the
- # user's project until they are explicitly terminated by the user.
- # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
- # policy except for small, manually supervised test jobs.
- #
- # If unknown or unspecified, the service will attempt to choose a reasonable
- # default.
- "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
- # service will choose a number of threads (according to the number of cores
- # on the selected machine type for batch, or 1 by convention for streaming).
- "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
- # the form "regions/REGION/subnetworks/SUBNETWORK".
- "poolArgs": { # Extra arguments for this worker pool.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
- # execute the job. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when
# using the standard Dataflow task runner. Users should ignore
# this field.
@@ -267,24 +223,17 @@
# Google Cloud Storage:
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
- "commandlinesFileName": "A String", # The file to store preprocessing commands in.
- "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
- "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
- "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
- "vmId": "A String", # The ID string of the VM.
- "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
- # taskrunner; e.g. "wheel".
"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by
# taskrunner; e.g. "root".
+ "commandlinesFileName": "A String", # The file to store preprocessing commands in.
+ "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
+ "vmId": "A String", # The ID string of the VM.
+ "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
+ "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to
# access the Cloud Dataflow API.
"A String",
],
- "languageHint": "A String", # The suggested backend language.
- "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
- # console.
- "streamingWorkerMainClass": "A String", # The streaming worker main class name.
- "logDir": "A String", # The directory on the VM to store logs.
"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.
"reportingEnabled": True or False, # Whether to send work progress updates to the service.
"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example,
@@ -311,16 +260,14 @@
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
},
+ "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
+ # taskrunner; e.g. "wheel".
+ "languageHint": "A String", # The suggested backend language.
+ "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
+ # console.
+ "streamingWorkerMainClass": "A String", # The streaming worker main class name.
+ "logDir": "A String", # The directory on the VM to store logs.
"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"
- "harnessCommand": "A String", # The command to launch the worker harness.
- "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
- # temporary storage.
- #
- # The supported resource type is:
- #
- # Google Cloud Storage:
- # storage.googleapis.com/{bucket}/{object}
- # bucket.storage.googleapis.com/{object}
"baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs.
#
# When workers access Google Cloud APIs, they logically do so via
@@ -330,33 +277,26 @@
# Locators".
#
# If not specified, the default value is "http://www.googleapis.com/"
- },
- "defaultPackageSet": "A String", # The default package set to install. This allows the service to
- # select a default set of packages which are useful to worker
- # harnesses written in a particular language.
- "packages": [ # Packages to be installed on workers.
- { # The packages that must be installed in order for a worker to run the
- # steps of the Cloud Dataflow job that will be assigned to its worker
- # pool.
+ "harnessCommand": "A String", # The command to launch the worker harness.
+ "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
+ # temporary storage.
#
- # This is the mechanism by which the Cloud Dataflow SDK causes code to
- # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
- # might use this to install jars containing the user's code and all of the
- # various dependencies (libraries, data files, etc.) required in order
- # for that code to run.
- "location": "A String", # The resource to read the package from. The supported resource type is:
- #
- # Google Cloud Storage:
- #
- # storage.googleapis.com/{bucket}
- # bucket.storage.googleapis.com/
- "name": "A String", # The name of the package.
- },
- ],
- "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
- "algorithm": "A String", # The algorithm to use for autoscaling.
- "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ # The supported resource type is:
+ #
+ # Google Cloud Storage:
+ # storage.googleapis.com/{bucket}/{object}
+ # bucket.storage.googleapis.com/{object}
},
+ "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
+ # are supported.
+ "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
+ # service will attempt to choose a reasonable default.
+ "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
+ # the service will use the network "default".
+ "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
+ # will attempt to choose a reasonable default.
+ "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
+ # attempt to choose a reasonable default.
"dataDisks": [ # Data disks that are used by a VM in this workflow.
{ # Describes the data disk used by a workflow job.
"mountPoint": "A String", # Directory in a VM where disk is mounted.
@@ -382,13 +322,78 @@
# compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard
},
],
- "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
+ # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
+ # `TEARDOWN_NEVER`.
+ # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
+ # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
+ # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
+ # down.
+ #
+ # If the workers are not torn down by the service, they will
+ # continue to run and use Google Compute Engine VM resources in the
+ # user's project until they are explicitly terminated by the user.
+ # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
+ # policy except for small, manually supervised test jobs.
+ #
+ # If unknown or unspecified, the service will attempt to choose a reasonable
+ # default.
+ "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
+ # Compute Engine API.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
+ # service will choose a number of threads (according to the number of cores
+ # on the selected machine type for batch, or 1 by convention for streaming).
+ "poolArgs": { # Extra arguments for this worker pool.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
+ # execute the job. If zero or unspecified, the service will
# attempt to choose a reasonable default.
"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker
# harness, residing in Google Container Registry.
+ "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
+ # the form "regions/REGION/subnetworks/SUBNETWORK".
+ "packages": [ # Packages to be installed on workers.
+ { # The packages that must be installed in order for a worker to run the
+ # steps of the Cloud Dataflow job that will be assigned to its worker
+ # pool.
+ #
+ # This is the mechanism by which the Cloud Dataflow SDK causes code to
+ # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
+ # might use this to install jars containing the user's code and all of the
+ # various dependencies (libraries, data files, etc.) required in order
+ # for that code to run.
+ "location": "A String", # The resource to read the package from. The supported resource type is:
+ #
+ # Google Cloud Storage:
+ #
+ # storage.googleapis.com/{bucket}
+ # bucket.storage.googleapis.com/
+ "name": "A String", # The name of the package.
+ },
+ ],
+ "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
+ "algorithm": "A String", # The algorithm to use for autoscaling.
+ "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ },
+ "defaultPackageSet": "A String", # The default package set to install. This allows the service to
+ # select a default set of packages which are useful to worker
+ # harnesses written in a particular language.
+ "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ # attempt to choose a reasonable default.
+ "metadata": { # Metadata to set on the Google Compute Engine VMs.
+ "a_key": "A String",
+ },
},
],
},
+ "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
+ # of the job it replaced.
+ #
+ # When sending a `CreateJobRequest`, you can update a job by specifying it
+ # here. The job named here is stopped, and its intermediate state is
+ # transferred to this job.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed # Preliminary field: The format of this data may change at any time.
# A description of the user pipeline and stages through which it is executed.
# Created by Cloud Dataflow service. Only retrieved with
@@ -404,9 +409,6 @@
],
"displayData": [ # Transform-specific display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -414,6 +416,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -424,7 +427,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -436,9 +441,6 @@
],
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -446,6 +448,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -456,7 +459,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -478,19 +483,19 @@
"outputSource": [ # Output sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"inputSource": [ # Input sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"componentTransform": [ # Transforms that comprise this execution stage.
@@ -532,26 +537,16 @@
# Note that the Cloud Dataflow service may be used to run many different
# types of jobs, not just Map-Reduce.
"kind": "A String", # The kind of step in the Cloud Dataflow job.
+ "name": "A String", # The name that identifies the step. This must be unique for each
+ # step with respect to all other steps in the Cloud Dataflow job.
"properties": { # Named properties associated with the step. Each kind of
# predefined step has its own required set of properties.
# Must be provided on Create. Only retrieved with JOB_VIEW_ALL.
"a_key": "", # Properties of the object.
},
- "name": "A String", # The name that identifies the step. This must be unique for each
- # step with respect to all other steps in the Cloud Dataflow job.
},
],
- "currentState": "A String", # The current state of the job.
- #
- # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
- # specified.
- #
- # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
- # terminal state. After a job has reached a terminal state, no
- # further state updates may be made.
- #
- # This field may be mutated by the Cloud Dataflow service;
- # callers cannot mutate it.
+ "location": "A String", # The location that contains this job.
"tempFiles": [ # A set of files the system should be aware of that are used
# for temporary storage. These temporary files will be
# removed on job completion.
@@ -571,12 +566,17 @@
#
# This field is set by the Cloud Dataflow service when the Job is
# created, and is immutable for the life of the job.
- "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
- # of the job it replaced.
+ "currentState": "A String", # The current state of the job.
#
- # When sending a `CreateJobRequest`, you can update a job by specifying it
- # here. The job named here is stopped, and its intermediate state is
- # transferred to this job.
+ # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
+ # specified.
+ #
+ # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
+ # terminal state. After a job has reached a terminal state, no
+ # further state updates may be made.
+ #
+ # This field may be mutated by the Cloud Dataflow service;
+ # callers cannot mutate it.
"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that # Deprecated.
# isn't contained in the submitted job.
"stages": { # A mapping from each stage to the information about that stage.
@@ -641,13 +641,12 @@
# size.
"a_key": "A String",
},
- "location": "A String", # The location that contains this job.
- "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
- # Cloud Dataflow service.
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the
# corresponding name prefixes of the new job.
"a_key": "A String",
},
+ "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
+ # Cloud Dataflow service.
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
"version": { # A structure describing which components and their versions of the service
# are required in order to run the job.
@@ -701,49 +700,6 @@
# multiple pools, in order to match the various computational
# requirements of the various stages of the job.
"diskSourceImage": "A String", # Fully qualified source image for disks.
- "ipConfiguration": "A String", # Configuration for VM IPs.
- "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
- # are supported.
- "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
- # service will attempt to choose a reasonable default.
- "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
- # the service will use the network "default".
- "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
- # will attempt to choose a reasonable default.
- "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
- "metadata": { # Metadata to set on the Google Compute Engine VMs.
- "a_key": "A String",
- },
- "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
- # Compute Engine API.
- "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
- # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
- # `TEARDOWN_NEVER`.
- # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
- # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
- # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
- # down.
- #
- # If the workers are not torn down by the service, they will
- # continue to run and use Google Compute Engine VM resources in the
- # user's project until they are explicitly terminated by the user.
- # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
- # policy except for small, manually supervised test jobs.
- #
- # If unknown or unspecified, the service will attempt to choose a reasonable
- # default.
- "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
- # service will choose a number of threads (according to the number of cores
- # on the selected machine type for batch, or 1 by convention for streaming).
- "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
- # the form "regions/REGION/subnetworks/SUBNETWORK".
- "poolArgs": { # Extra arguments for this worker pool.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
- # execute the job. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when
# using the standard Dataflow task runner. Users should ignore
# this field.
@@ -756,24 +712,17 @@
# Google Cloud Storage:
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
- "commandlinesFileName": "A String", # The file to store preprocessing commands in.
- "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
- "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
- "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
- "vmId": "A String", # The ID string of the VM.
- "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
- # taskrunner; e.g. "wheel".
"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by
# taskrunner; e.g. "root".
+ "commandlinesFileName": "A String", # The file to store preprocessing commands in.
+ "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
+ "vmId": "A String", # The ID string of the VM.
+ "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
+ "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to
# access the Cloud Dataflow API.
"A String",
],
- "languageHint": "A String", # The suggested backend language.
- "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
- # console.
- "streamingWorkerMainClass": "A String", # The streaming worker main class name.
- "logDir": "A String", # The directory on the VM to store logs.
"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.
"reportingEnabled": True or False, # Whether to send work progress updates to the service.
"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example,
@@ -800,16 +749,14 @@
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
},
+ "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
+ # taskrunner; e.g. "wheel".
+ "languageHint": "A String", # The suggested backend language.
+ "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
+ # console.
+ "streamingWorkerMainClass": "A String", # The streaming worker main class name.
+ "logDir": "A String", # The directory on the VM to store logs.
"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"
- "harnessCommand": "A String", # The command to launch the worker harness.
- "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
- # temporary storage.
- #
- # The supported resource type is:
- #
- # Google Cloud Storage:
- # storage.googleapis.com/{bucket}/{object}
- # bucket.storage.googleapis.com/{object}
"baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs.
#
# When workers access Google Cloud APIs, they logically do so via
@@ -819,33 +766,26 @@
# Locators".
#
# If not specified, the default value is "http://www.googleapis.com/"
- },
- "defaultPackageSet": "A String", # The default package set to install. This allows the service to
- # select a default set of packages which are useful to worker
- # harnesses written in a particular language.
- "packages": [ # Packages to be installed on workers.
- { # The packages that must be installed in order for a worker to run the
- # steps of the Cloud Dataflow job that will be assigned to its worker
- # pool.
+ "harnessCommand": "A String", # The command to launch the worker harness.
+ "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
+ # temporary storage.
#
- # This is the mechanism by which the Cloud Dataflow SDK causes code to
- # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
- # might use this to install jars containing the user's code and all of the
- # various dependencies (libraries, data files, etc.) required in order
- # for that code to run.
- "location": "A String", # The resource to read the package from. The supported resource type is:
- #
- # Google Cloud Storage:
- #
- # storage.googleapis.com/{bucket}
- # bucket.storage.googleapis.com/
- "name": "A String", # The name of the package.
- },
- ],
- "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
- "algorithm": "A String", # The algorithm to use for autoscaling.
- "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ # The supported resource type is:
+ #
+ # Google Cloud Storage:
+ # storage.googleapis.com/{bucket}/{object}
+ # bucket.storage.googleapis.com/{object}
},
+ "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
+ # are supported.
+ "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
+ # service will attempt to choose a reasonable default.
+ "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
+ # the service will use the network "default".
+ "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
+ # will attempt to choose a reasonable default.
+ "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
+ # attempt to choose a reasonable default.
"dataDisks": [ # Data disks that are used by a VM in this workflow.
{ # Describes the data disk used by a workflow job.
"mountPoint": "A String", # Directory in a VM where disk is mounted.
@@ -871,13 +811,78 @@
# compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard
},
],
- "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
+ # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
+ # `TEARDOWN_NEVER`.
+ # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
+ # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
+ # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
+ # down.
+ #
+ # If the workers are not torn down by the service, they will
+ # continue to run and use Google Compute Engine VM resources in the
+ # user's project until they are explicitly terminated by the user.
+ # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
+ # policy except for small, manually supervised test jobs.
+ #
+ # If unknown or unspecified, the service will attempt to choose a reasonable
+ # default.
+ "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
+ # Compute Engine API.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
+ # service will choose a number of threads (according to the number of cores
+ # on the selected machine type for batch, or 1 by convention for streaming).
+ "poolArgs": { # Extra arguments for this worker pool.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
+ # execute the job. If zero or unspecified, the service will
# attempt to choose a reasonable default.
"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker
# harness, residing in Google Container Registry.
+ "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
+ # the form "regions/REGION/subnetworks/SUBNETWORK".
+ "packages": [ # Packages to be installed on workers.
+ { # The packages that must be installed in order for a worker to run the
+ # steps of the Cloud Dataflow job that will be assigned to its worker
+ # pool.
+ #
+ # This is the mechanism by which the Cloud Dataflow SDK causes code to
+ # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
+ # might use this to install jars containing the user's code and all of the
+ # various dependencies (libraries, data files, etc.) required in order
+ # for that code to run.
+ "location": "A String", # The resource to read the package from. The supported resource type is:
+ #
+ # Google Cloud Storage:
+ #
+ # storage.googleapis.com/{bucket}
+ # bucket.storage.googleapis.com/
+ "name": "A String", # The name of the package.
+ },
+ ],
+ "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
+ "algorithm": "A String", # The algorithm to use for autoscaling.
+ "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ },
+ "defaultPackageSet": "A String", # The default package set to install. This allows the service to
+ # select a default set of packages which are useful to worker
+ # harnesses written in a particular language.
+ "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ # attempt to choose a reasonable default.
+ "metadata": { # Metadata to set on the Google Compute Engine VMs.
+ "a_key": "A String",
+ },
},
],
},
+ "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
+ # of the job it replaced.
+ #
+ # When sending a `CreateJobRequest`, you can update a job by specifying it
+ # here. The job named here is stopped, and its intermediate state is
+ # transferred to this job.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed # Preliminary field: The format of this data may change at any time.
# A description of the user pipeline and stages through which it is executed.
# Created by Cloud Dataflow service. Only retrieved with
@@ -893,9 +898,6 @@
],
"displayData": [ # Transform-specific display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -903,6 +905,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -913,7 +916,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -925,9 +930,6 @@
],
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -935,6 +937,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -945,7 +948,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -967,19 +972,19 @@
"outputSource": [ # Output sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"inputSource": [ # Input sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"componentTransform": [ # Transforms that comprise this execution stage.
@@ -1021,26 +1026,16 @@
# Note that the Cloud Dataflow service may be used to run many different
# types of jobs, not just Map-Reduce.
"kind": "A String", # The kind of step in the Cloud Dataflow job.
+ "name": "A String", # The name that identifies the step. This must be unique for each
+ # step with respect to all other steps in the Cloud Dataflow job.
"properties": { # Named properties associated with the step. Each kind of
# predefined step has its own required set of properties.
# Must be provided on Create. Only retrieved with JOB_VIEW_ALL.
"a_key": "", # Properties of the object.
},
- "name": "A String", # The name that identifies the step. This must be unique for each
- # step with respect to all other steps in the Cloud Dataflow job.
},
],
- "currentState": "A String", # The current state of the job.
- #
- # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
- # specified.
- #
- # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
- # terminal state. After a job has reached a terminal state, no
- # further state updates may be made.
- #
- # This field may be mutated by the Cloud Dataflow service;
- # callers cannot mutate it.
+ "location": "A String", # The location that contains this job.
"tempFiles": [ # A set of files the system should be aware of that are used
# for temporary storage. These temporary files will be
# removed on job completion.
@@ -1060,12 +1055,17 @@
#
# This field is set by the Cloud Dataflow service when the Job is
# created, and is immutable for the life of the job.
- "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
- # of the job it replaced.
+ "currentState": "A String", # The current state of the job.
#
- # When sending a `CreateJobRequest`, you can update a job by specifying it
- # here. The job named here is stopped, and its intermediate state is
- # transferred to this job.
+ # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
+ # specified.
+ #
+ # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
+ # terminal state. After a job has reached a terminal state, no
+ # further state updates may be made.
+ #
+ # This field may be mutated by the Cloud Dataflow service;
+ # callers cannot mutate it.
"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that # Deprecated.
# isn't contained in the submitted job.
"stages": { # A mapping from each stage to the information about that stage.
@@ -1138,13 +1138,12 @@
# size.
"a_key": "A String",
},
- "location": "A String", # The location that contains this job.
- "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
- # Cloud Dataflow service.
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the
# corresponding name prefixes of the new job.
"a_key": "A String",
},
+ "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
+ # Cloud Dataflow service.
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
"version": { # A structure describing which components and their versions of the service
# are required in order to run the job.
@@ -1198,49 +1197,6 @@
# multiple pools, in order to match the various computational
# requirements of the various stages of the job.
"diskSourceImage": "A String", # Fully qualified source image for disks.
- "ipConfiguration": "A String", # Configuration for VM IPs.
- "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
- # are supported.
- "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
- # service will attempt to choose a reasonable default.
- "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
- # the service will use the network "default".
- "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
- # will attempt to choose a reasonable default.
- "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
- "metadata": { # Metadata to set on the Google Compute Engine VMs.
- "a_key": "A String",
- },
- "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
- # Compute Engine API.
- "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
- # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
- # `TEARDOWN_NEVER`.
- # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
- # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
- # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
- # down.
- #
- # If the workers are not torn down by the service, they will
- # continue to run and use Google Compute Engine VM resources in the
- # user's project until they are explicitly terminated by the user.
- # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
- # policy except for small, manually supervised test jobs.
- #
- # If unknown or unspecified, the service will attempt to choose a reasonable
- # default.
- "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
- # service will choose a number of threads (according to the number of cores
- # on the selected machine type for batch, or 1 by convention for streaming).
- "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
- # the form "regions/REGION/subnetworks/SUBNETWORK".
- "poolArgs": { # Extra arguments for this worker pool.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
- # execute the job. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when
# using the standard Dataflow task runner. Users should ignore
# this field.
@@ -1253,24 +1209,17 @@
# Google Cloud Storage:
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
- "commandlinesFileName": "A String", # The file to store preprocessing commands in.
- "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
- "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
- "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
- "vmId": "A String", # The ID string of the VM.
- "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
- # taskrunner; e.g. "wheel".
"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by
# taskrunner; e.g. "root".
+ "commandlinesFileName": "A String", # The file to store preprocessing commands in.
+ "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
+ "vmId": "A String", # The ID string of the VM.
+ "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
+ "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to
# access the Cloud Dataflow API.
"A String",
],
- "languageHint": "A String", # The suggested backend language.
- "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
- # console.
- "streamingWorkerMainClass": "A String", # The streaming worker main class name.
- "logDir": "A String", # The directory on the VM to store logs.
"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.
"reportingEnabled": True or False, # Whether to send work progress updates to the service.
"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example,
@@ -1297,16 +1246,14 @@
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
},
+ "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
+ # taskrunner; e.g. "wheel".
+ "languageHint": "A String", # The suggested backend language.
+ "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
+ # console.
+ "streamingWorkerMainClass": "A String", # The streaming worker main class name.
+ "logDir": "A String", # The directory on the VM to store logs.
"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"
- "harnessCommand": "A String", # The command to launch the worker harness.
- "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
- # temporary storage.
- #
- # The supported resource type is:
- #
- # Google Cloud Storage:
- # storage.googleapis.com/{bucket}/{object}
- # bucket.storage.googleapis.com/{object}
"baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs.
#
# When workers access Google Cloud APIs, they logically do so via
@@ -1316,33 +1263,26 @@
# Locators".
#
# If not specified, the default value is "http://www.googleapis.com/"
- },
- "defaultPackageSet": "A String", # The default package set to install. This allows the service to
- # select a default set of packages which are useful to worker
- # harnesses written in a particular language.
- "packages": [ # Packages to be installed on workers.
- { # The packages that must be installed in order for a worker to run the
- # steps of the Cloud Dataflow job that will be assigned to its worker
- # pool.
+ "harnessCommand": "A String", # The command to launch the worker harness.
+ "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
+ # temporary storage.
#
- # This is the mechanism by which the Cloud Dataflow SDK causes code to
- # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
- # might use this to install jars containing the user's code and all of the
- # various dependencies (libraries, data files, etc.) required in order
- # for that code to run.
- "location": "A String", # The resource to read the package from. The supported resource type is:
- #
- # Google Cloud Storage:
- #
- # storage.googleapis.com/{bucket}
- # bucket.storage.googleapis.com/
- "name": "A String", # The name of the package.
- },
- ],
- "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
- "algorithm": "A String", # The algorithm to use for autoscaling.
- "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ # The supported resource type is:
+ #
+ # Google Cloud Storage:
+ # storage.googleapis.com/{bucket}/{object}
+ # bucket.storage.googleapis.com/{object}
},
+ "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
+ # are supported.
+ "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
+ # service will attempt to choose a reasonable default.
+ "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
+ # the service will use the network "default".
+ "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
+ # will attempt to choose a reasonable default.
+ "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
+ # attempt to choose a reasonable default.
"dataDisks": [ # Data disks that are used by a VM in this workflow.
{ # Describes the data disk used by a workflow job.
"mountPoint": "A String", # Directory in a VM where disk is mounted.
@@ -1368,13 +1308,78 @@
# compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard
},
],
- "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
+ # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
+ # `TEARDOWN_NEVER`.
+ # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
+ # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
+ # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
+ # down.
+ #
+ # If the workers are not torn down by the service, they will
+ # continue to run and use Google Compute Engine VM resources in the
+ # user's project until they are explicitly terminated by the user.
+ # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
+ # policy except for small, manually supervised test jobs.
+ #
+ # If unknown or unspecified, the service will attempt to choose a reasonable
+ # default.
+ "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
+ # Compute Engine API.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
+ # service will choose a number of threads (according to the number of cores
+ # on the selected machine type for batch, or 1 by convention for streaming).
+ "poolArgs": { # Extra arguments for this worker pool.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
+ # execute the job. If zero or unspecified, the service will
# attempt to choose a reasonable default.
"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker
# harness, residing in Google Container Registry.
+ "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
+ # the form "regions/REGION/subnetworks/SUBNETWORK".
+ "packages": [ # Packages to be installed on workers.
+ { # The packages that must be installed in order for a worker to run the
+ # steps of the Cloud Dataflow job that will be assigned to its worker
+ # pool.
+ #
+ # This is the mechanism by which the Cloud Dataflow SDK causes code to
+ # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
+ # might use this to install jars containing the user's code and all of the
+ # various dependencies (libraries, data files, etc.) required in order
+ # for that code to run.
+ "location": "A String", # The resource to read the package from. The supported resource type is:
+ #
+ # Google Cloud Storage:
+ #
+ # storage.googleapis.com/{bucket}
+ # bucket.storage.googleapis.com/
+ "name": "A String", # The name of the package.
+ },
+ ],
+ "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
+ "algorithm": "A String", # The algorithm to use for autoscaling.
+ "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ },
+ "defaultPackageSet": "A String", # The default package set to install. This allows the service to
+ # select a default set of packages which are useful to worker
+ # harnesses written in a particular language.
+ "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ # attempt to choose a reasonable default.
+ "metadata": { # Metadata to set on the Google Compute Engine VMs.
+ "a_key": "A String",
+ },
},
],
},
+ "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
+ # of the job it replaced.
+ #
+ # When sending a `CreateJobRequest`, you can update a job by specifying it
+ # here. The job named here is stopped, and its intermediate state is
+ # transferred to this job.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed # Preliminary field: The format of this data may change at any time.
# A description of the user pipeline and stages through which it is executed.
# Created by Cloud Dataflow service. Only retrieved with
@@ -1390,9 +1395,6 @@
],
"displayData": [ # Transform-specific display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -1400,6 +1402,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -1410,7 +1413,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -1422,9 +1427,6 @@
],
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -1432,6 +1434,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -1442,7 +1445,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -1464,19 +1469,19 @@
"outputSource": [ # Output sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"inputSource": [ # Input sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"componentTransform": [ # Transforms that comprise this execution stage.
@@ -1518,26 +1523,16 @@
# Note that the Cloud Dataflow service may be used to run many different
# types of jobs, not just Map-Reduce.
"kind": "A String", # The kind of step in the Cloud Dataflow job.
+ "name": "A String", # The name that identifies the step. This must be unique for each
+ # step with respect to all other steps in the Cloud Dataflow job.
"properties": { # Named properties associated with the step. Each kind of
# predefined step has its own required set of properties.
# Must be provided on Create. Only retrieved with JOB_VIEW_ALL.
"a_key": "", # Properties of the object.
},
- "name": "A String", # The name that identifies the step. This must be unique for each
- # step with respect to all other steps in the Cloud Dataflow job.
},
],
- "currentState": "A String", # The current state of the job.
- #
- # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
- # specified.
- #
- # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
- # terminal state. After a job has reached a terminal state, no
- # further state updates may be made.
- #
- # This field may be mutated by the Cloud Dataflow service;
- # callers cannot mutate it.
+ "location": "A String", # The location that contains this job.
"tempFiles": [ # A set of files the system should be aware of that are used
# for temporary storage. These temporary files will be
# removed on job completion.
@@ -1557,12 +1552,17 @@
#
# This field is set by the Cloud Dataflow service when the Job is
# created, and is immutable for the life of the job.
- "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
- # of the job it replaced.
+ "currentState": "A String", # The current state of the job.
#
- # When sending a `CreateJobRequest`, you can update a job by specifying it
- # here. The job named here is stopped, and its intermediate state is
- # transferred to this job.
+ # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
+ # specified.
+ #
+ # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
+ # terminal state. After a job has reached a terminal state, no
+ # further state updates may be made.
+ #
+ # This field may be mutated by the Cloud Dataflow service;
+ # callers cannot mutate it.
"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that # Deprecated.
# isn't contained in the submitted job.
"stages": { # A mapping from each stage to the information about that stage.
@@ -1680,11 +1680,6 @@
{ # Response to a request to list Cloud Dataflow jobs. This may be a partial
# response, depending on the page size in the ListJobsRequest.
"nextPageToken": "A String", # Set if there may be more results than fit in this response.
- "failedLocation": [ # Zero or more messages describing locations that failed to respond.
- { # Indicates which location failed to respond to a request for data.
- "name": "A String", # The name of the failed location.
- },
- ],
"jobs": [ # A subset of the requested job information.
{ # Defines a job to be run by the Cloud Dataflow service.
"clientRequestId": "A String", # The client's unique identifier of the job, re-used across retried attempts.
@@ -1725,13 +1720,12 @@
# size.
"a_key": "A String",
},
- "location": "A String", # The location that contains this job.
- "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
- # Cloud Dataflow service.
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the
# corresponding name prefixes of the new job.
"a_key": "A String",
},
+ "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
+ # Cloud Dataflow service.
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
"version": { # A structure describing which components and their versions of the service
# are required in order to run the job.
@@ -1785,49 +1779,6 @@
# multiple pools, in order to match the various computational
# requirements of the various stages of the job.
"diskSourceImage": "A String", # Fully qualified source image for disks.
- "ipConfiguration": "A String", # Configuration for VM IPs.
- "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
- # are supported.
- "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
- # service will attempt to choose a reasonable default.
- "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
- # the service will use the network "default".
- "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
- # will attempt to choose a reasonable default.
- "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
- "metadata": { # Metadata to set on the Google Compute Engine VMs.
- "a_key": "A String",
- },
- "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
- # Compute Engine API.
- "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
- # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
- # `TEARDOWN_NEVER`.
- # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
- # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
- # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
- # down.
- #
- # If the workers are not torn down by the service, they will
- # continue to run and use Google Compute Engine VM resources in the
- # user's project until they are explicitly terminated by the user.
- # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
- # policy except for small, manually supervised test jobs.
- #
- # If unknown or unspecified, the service will attempt to choose a reasonable
- # default.
- "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
- # service will choose a number of threads (according to the number of cores
- # on the selected machine type for batch, or 1 by convention for streaming).
- "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
- # the form "regions/REGION/subnetworks/SUBNETWORK".
- "poolArgs": { # Extra arguments for this worker pool.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
- # execute the job. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when
# using the standard Dataflow task runner. Users should ignore
# this field.
@@ -1840,24 +1791,17 @@
# Google Cloud Storage:
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
- "commandlinesFileName": "A String", # The file to store preprocessing commands in.
- "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
- "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
- "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
- "vmId": "A String", # The ID string of the VM.
- "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
- # taskrunner; e.g. "wheel".
"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by
# taskrunner; e.g. "root".
+ "commandlinesFileName": "A String", # The file to store preprocessing commands in.
+ "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
+ "vmId": "A String", # The ID string of the VM.
+ "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
+ "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to
# access the Cloud Dataflow API.
"A String",
],
- "languageHint": "A String", # The suggested backend language.
- "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
- # console.
- "streamingWorkerMainClass": "A String", # The streaming worker main class name.
- "logDir": "A String", # The directory on the VM to store logs.
"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.
"reportingEnabled": True or False, # Whether to send work progress updates to the service.
"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example,
@@ -1884,16 +1828,14 @@
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
},
+ "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
+ # taskrunner; e.g. "wheel".
+ "languageHint": "A String", # The suggested backend language.
+ "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
+ # console.
+ "streamingWorkerMainClass": "A String", # The streaming worker main class name.
+ "logDir": "A String", # The directory on the VM to store logs.
"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"
- "harnessCommand": "A String", # The command to launch the worker harness.
- "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
- # temporary storage.
- #
- # The supported resource type is:
- #
- # Google Cloud Storage:
- # storage.googleapis.com/{bucket}/{object}
- # bucket.storage.googleapis.com/{object}
"baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs.
#
# When workers access Google Cloud APIs, they logically do so via
@@ -1903,33 +1845,26 @@
# Locators".
#
# If not specified, the default value is "http://www.googleapis.com/"
- },
- "defaultPackageSet": "A String", # The default package set to install. This allows the service to
- # select a default set of packages which are useful to worker
- # harnesses written in a particular language.
- "packages": [ # Packages to be installed on workers.
- { # The packages that must be installed in order for a worker to run the
- # steps of the Cloud Dataflow job that will be assigned to its worker
- # pool.
+ "harnessCommand": "A String", # The command to launch the worker harness.
+ "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
+ # temporary storage.
#
- # This is the mechanism by which the Cloud Dataflow SDK causes code to
- # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
- # might use this to install jars containing the user's code and all of the
- # various dependencies (libraries, data files, etc.) required in order
- # for that code to run.
- "location": "A String", # The resource to read the package from. The supported resource type is:
- #
- # Google Cloud Storage:
- #
- # storage.googleapis.com/{bucket}
- # bucket.storage.googleapis.com/
- "name": "A String", # The name of the package.
- },
- ],
- "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
- "algorithm": "A String", # The algorithm to use for autoscaling.
- "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ # The supported resource type is:
+ #
+ # Google Cloud Storage:
+ # storage.googleapis.com/{bucket}/{object}
+ # bucket.storage.googleapis.com/{object}
},
+ "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
+ # are supported.
+ "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
+ # service will attempt to choose a reasonable default.
+ "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
+ # the service will use the network "default".
+ "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
+ # will attempt to choose a reasonable default.
+ "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
+ # attempt to choose a reasonable default.
"dataDisks": [ # Data disks that are used by a VM in this workflow.
{ # Describes the data disk used by a workflow job.
"mountPoint": "A String", # Directory in a VM where disk is mounted.
@@ -1955,13 +1890,78 @@
# compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard
},
],
- "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
+ # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
+ # `TEARDOWN_NEVER`.
+ # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
+ # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
+ # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
+ # down.
+ #
+ # If the workers are not torn down by the service, they will
+ # continue to run and use Google Compute Engine VM resources in the
+ # user's project until they are explicitly terminated by the user.
+ # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
+ # policy except for small, manually supervised test jobs.
+ #
+ # If unknown or unspecified, the service will attempt to choose a reasonable
+ # default.
+ "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
+ # Compute Engine API.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
+ # service will choose a number of threads (according to the number of cores
+ # on the selected machine type for batch, or 1 by convention for streaming).
+ "poolArgs": { # Extra arguments for this worker pool.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
+ # execute the job. If zero or unspecified, the service will
# attempt to choose a reasonable default.
"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker
# harness, residing in Google Container Registry.
+ "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
+ # the form "regions/REGION/subnetworks/SUBNETWORK".
+ "packages": [ # Packages to be installed on workers.
+ { # The packages that must be installed in order for a worker to run the
+ # steps of the Cloud Dataflow job that will be assigned to its worker
+ # pool.
+ #
+ # This is the mechanism by which the Cloud Dataflow SDK causes code to
+ # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
+ # might use this to install jars containing the user's code and all of the
+ # various dependencies (libraries, data files, etc.) required in order
+ # for that code to run.
+ "location": "A String", # The resource to read the package from. The supported resource type is:
+ #
+ # Google Cloud Storage:
+ #
+ # storage.googleapis.com/{bucket}
+ # bucket.storage.googleapis.com/
+ "name": "A String", # The name of the package.
+ },
+ ],
+ "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
+ "algorithm": "A String", # The algorithm to use for autoscaling.
+ "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ },
+ "defaultPackageSet": "A String", # The default package set to install. This allows the service to
+ # select a default set of packages which are useful to worker
+ # harnesses written in a particular language.
+ "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ # attempt to choose a reasonable default.
+ "metadata": { # Metadata to set on the Google Compute Engine VMs.
+ "a_key": "A String",
+ },
},
],
},
+ "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
+ # of the job it replaced.
+ #
+ # When sending a `CreateJobRequest`, you can update a job by specifying it
+ # here. The job named here is stopped, and its intermediate state is
+ # transferred to this job.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed # Preliminary field: The format of this data may change at any time.
# A description of the user pipeline and stages through which it is executed.
# Created by Cloud Dataflow service. Only retrieved with
@@ -1977,9 +1977,6 @@
],
"displayData": [ # Transform-specific display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -1987,6 +1984,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -1997,7 +1995,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -2009,9 +2009,6 @@
],
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -2019,6 +2016,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -2029,7 +2027,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -2051,19 +2051,19 @@
"outputSource": [ # Output sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"inputSource": [ # Input sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"componentTransform": [ # Transforms that comprise this execution stage.
@@ -2105,26 +2105,16 @@
# Note that the Cloud Dataflow service may be used to run many different
# types of jobs, not just Map-Reduce.
"kind": "A String", # The kind of step in the Cloud Dataflow job.
+ "name": "A String", # The name that identifies the step. This must be unique for each
+ # step with respect to all other steps in the Cloud Dataflow job.
"properties": { # Named properties associated with the step. Each kind of
# predefined step has its own required set of properties.
# Must be provided on Create. Only retrieved with JOB_VIEW_ALL.
"a_key": "", # Properties of the object.
},
- "name": "A String", # The name that identifies the step. This must be unique for each
- # step with respect to all other steps in the Cloud Dataflow job.
},
],
- "currentState": "A String", # The current state of the job.
- #
- # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
- # specified.
- #
- # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
- # terminal state. After a job has reached a terminal state, no
- # further state updates may be made.
- #
- # This field may be mutated by the Cloud Dataflow service;
- # callers cannot mutate it.
+ "location": "A String", # The location that contains this job.
"tempFiles": [ # A set of files the system should be aware of that are used
# for temporary storage. These temporary files will be
# removed on job completion.
@@ -2144,12 +2134,17 @@
#
# This field is set by the Cloud Dataflow service when the Job is
# created, and is immutable for the life of the job.
- "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
- # of the job it replaced.
+ "currentState": "A String", # The current state of the job.
#
- # When sending a `CreateJobRequest`, you can update a job by specifying it
- # here. The job named here is stopped, and its intermediate state is
- # transferred to this job.
+ # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
+ # specified.
+ #
+ # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
+ # terminal state. After a job has reached a terminal state, no
+ # further state updates may be made.
+ #
+ # This field may be mutated by the Cloud Dataflow service;
+ # callers cannot mutate it.
"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that # Deprecated.
# isn't contained in the submitted job.
"stages": { # A mapping from each stage to the information about that stage.
@@ -2165,6 +2160,11 @@
},
},
],
+ "failedLocation": [ # Zero or more messages describing locations that failed to respond.
+ { # Indicates which location failed to respond to a request for data.
+ "name": "A String", # The name of the failed location.
+ },
+ ],
}</pre>
</div>
@@ -2232,13 +2232,12 @@
# size.
"a_key": "A String",
},
- "location": "A String", # The location that contains this job.
- "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
- # Cloud Dataflow service.
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the
# corresponding name prefixes of the new job.
"a_key": "A String",
},
+ "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
+ # Cloud Dataflow service.
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
"version": { # A structure describing which components and their versions of the service
# are required in order to run the job.
@@ -2292,49 +2291,6 @@
# multiple pools, in order to match the various computational
# requirements of the various stages of the job.
"diskSourceImage": "A String", # Fully qualified source image for disks.
- "ipConfiguration": "A String", # Configuration for VM IPs.
- "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
- # are supported.
- "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
- # service will attempt to choose a reasonable default.
- "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
- # the service will use the network "default".
- "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
- # will attempt to choose a reasonable default.
- "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
- "metadata": { # Metadata to set on the Google Compute Engine VMs.
- "a_key": "A String",
- },
- "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
- # Compute Engine API.
- "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
- # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
- # `TEARDOWN_NEVER`.
- # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
- # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
- # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
- # down.
- #
- # If the workers are not torn down by the service, they will
- # continue to run and use Google Compute Engine VM resources in the
- # user's project until they are explicitly terminated by the user.
- # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
- # policy except for small, manually supervised test jobs.
- #
- # If unknown or unspecified, the service will attempt to choose a reasonable
- # default.
- "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
- # service will choose a number of threads (according to the number of cores
- # on the selected machine type for batch, or 1 by convention for streaming).
- "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
- # the form "regions/REGION/subnetworks/SUBNETWORK".
- "poolArgs": { # Extra arguments for this worker pool.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
- # execute the job. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when
# using the standard Dataflow task runner. Users should ignore
# this field.
@@ -2347,24 +2303,17 @@
# Google Cloud Storage:
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
- "commandlinesFileName": "A String", # The file to store preprocessing commands in.
- "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
- "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
- "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
- "vmId": "A String", # The ID string of the VM.
- "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
- # taskrunner; e.g. "wheel".
"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by
# taskrunner; e.g. "root".
+ "commandlinesFileName": "A String", # The file to store preprocessing commands in.
+ "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
+ "vmId": "A String", # The ID string of the VM.
+ "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
+ "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to
# access the Cloud Dataflow API.
"A String",
],
- "languageHint": "A String", # The suggested backend language.
- "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
- # console.
- "streamingWorkerMainClass": "A String", # The streaming worker main class name.
- "logDir": "A String", # The directory on the VM to store logs.
"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.
"reportingEnabled": True or False, # Whether to send work progress updates to the service.
"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example,
@@ -2391,16 +2340,14 @@
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
},
+ "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
+ # taskrunner; e.g. "wheel".
+ "languageHint": "A String", # The suggested backend language.
+ "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
+ # console.
+ "streamingWorkerMainClass": "A String", # The streaming worker main class name.
+ "logDir": "A String", # The directory on the VM to store logs.
"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"
- "harnessCommand": "A String", # The command to launch the worker harness.
- "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
- # temporary storage.
- #
- # The supported resource type is:
- #
- # Google Cloud Storage:
- # storage.googleapis.com/{bucket}/{object}
- # bucket.storage.googleapis.com/{object}
"baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs.
#
# When workers access Google Cloud APIs, they logically do so via
@@ -2410,33 +2357,26 @@
# Locators".
#
# If not specified, the default value is "http://www.googleapis.com/"
- },
- "defaultPackageSet": "A String", # The default package set to install. This allows the service to
- # select a default set of packages which are useful to worker
- # harnesses written in a particular language.
- "packages": [ # Packages to be installed on workers.
- { # The packages that must be installed in order for a worker to run the
- # steps of the Cloud Dataflow job that will be assigned to its worker
- # pool.
+ "harnessCommand": "A String", # The command to launch the worker harness.
+ "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
+ # temporary storage.
#
- # This is the mechanism by which the Cloud Dataflow SDK causes code to
- # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
- # might use this to install jars containing the user's code and all of the
- # various dependencies (libraries, data files, etc.) required in order
- # for that code to run.
- "location": "A String", # The resource to read the package from. The supported resource type is:
- #
- # Google Cloud Storage:
- #
- # storage.googleapis.com/{bucket}
- # bucket.storage.googleapis.com/
- "name": "A String", # The name of the package.
- },
- ],
- "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
- "algorithm": "A String", # The algorithm to use for autoscaling.
- "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ # The supported resource type is:
+ #
+ # Google Cloud Storage:
+ # storage.googleapis.com/{bucket}/{object}
+ # bucket.storage.googleapis.com/{object}
},
+ "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
+ # are supported.
+ "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
+ # service will attempt to choose a reasonable default.
+ "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
+ # the service will use the network "default".
+ "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
+ # will attempt to choose a reasonable default.
+ "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
+ # attempt to choose a reasonable default.
"dataDisks": [ # Data disks that are used by a VM in this workflow.
{ # Describes the data disk used by a workflow job.
"mountPoint": "A String", # Directory in a VM where disk is mounted.
@@ -2462,13 +2402,78 @@
# compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard
},
],
- "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
+ # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
+ # `TEARDOWN_NEVER`.
+ # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
+ # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
+ # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
+ # down.
+ #
+ # If the workers are not torn down by the service, they will
+ # continue to run and use Google Compute Engine VM resources in the
+ # user's project until they are explicitly terminated by the user.
+ # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
+ # policy except for small, manually supervised test jobs.
+ #
+ # If unknown or unspecified, the service will attempt to choose a reasonable
+ # default.
+ "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
+ # Compute Engine API.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
+ # service will choose a number of threads (according to the number of cores
+ # on the selected machine type for batch, or 1 by convention for streaming).
+ "poolArgs": { # Extra arguments for this worker pool.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
+ # execute the job. If zero or unspecified, the service will
# attempt to choose a reasonable default.
"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker
# harness, residing in Google Container Registry.
+ "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
+ # the form "regions/REGION/subnetworks/SUBNETWORK".
+ "packages": [ # Packages to be installed on workers.
+ { # The packages that must be installed in order for a worker to run the
+ # steps of the Cloud Dataflow job that will be assigned to its worker
+ # pool.
+ #
+ # This is the mechanism by which the Cloud Dataflow SDK causes code to
+ # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
+ # might use this to install jars containing the user's code and all of the
+ # various dependencies (libraries, data files, etc.) required in order
+ # for that code to run.
+ "location": "A String", # The resource to read the package from. The supported resource type is:
+ #
+ # Google Cloud Storage:
+ #
+ # storage.googleapis.com/{bucket}
+ # bucket.storage.googleapis.com/
+ "name": "A String", # The name of the package.
+ },
+ ],
+ "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
+ "algorithm": "A String", # The algorithm to use for autoscaling.
+ "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ },
+ "defaultPackageSet": "A String", # The default package set to install. This allows the service to
+ # select a default set of packages which are useful to worker
+ # harnesses written in a particular language.
+ "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ # attempt to choose a reasonable default.
+ "metadata": { # Metadata to set on the Google Compute Engine VMs.
+ "a_key": "A String",
+ },
},
],
},
+ "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
+ # of the job it replaced.
+ #
+ # When sending a `CreateJobRequest`, you can update a job by specifying it
+ # here. The job named here is stopped, and its intermediate state is
+ # transferred to this job.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed # Preliminary field: The format of this data may change at any time.
# A description of the user pipeline and stages through which it is executed.
# Created by Cloud Dataflow service. Only retrieved with
@@ -2484,9 +2489,6 @@
],
"displayData": [ # Transform-specific display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -2494,6 +2496,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -2504,7 +2507,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -2516,9 +2521,6 @@
],
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -2526,6 +2528,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -2536,7 +2539,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -2558,19 +2563,19 @@
"outputSource": [ # Output sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"inputSource": [ # Input sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"componentTransform": [ # Transforms that comprise this execution stage.
@@ -2612,26 +2617,16 @@
# Note that the Cloud Dataflow service may be used to run many different
# types of jobs, not just Map-Reduce.
"kind": "A String", # The kind of step in the Cloud Dataflow job.
+ "name": "A String", # The name that identifies the step. This must be unique for each
+ # step with respect to all other steps in the Cloud Dataflow job.
"properties": { # Named properties associated with the step. Each kind of
# predefined step has its own required set of properties.
# Must be provided on Create. Only retrieved with JOB_VIEW_ALL.
"a_key": "", # Properties of the object.
},
- "name": "A String", # The name that identifies the step. This must be unique for each
- # step with respect to all other steps in the Cloud Dataflow job.
},
],
- "currentState": "A String", # The current state of the job.
- #
- # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
- # specified.
- #
- # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
- # terminal state. After a job has reached a terminal state, no
- # further state updates may be made.
- #
- # This field may be mutated by the Cloud Dataflow service;
- # callers cannot mutate it.
+ "location": "A String", # The location that contains this job.
"tempFiles": [ # A set of files the system should be aware of that are used
# for temporary storage. These temporary files will be
# removed on job completion.
@@ -2651,12 +2646,17 @@
#
# This field is set by the Cloud Dataflow service when the Job is
# created, and is immutable for the life of the job.
- "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
- # of the job it replaced.
+ "currentState": "A String", # The current state of the job.
#
- # When sending a `CreateJobRequest`, you can update a job by specifying it
- # here. The job named here is stopped, and its intermediate state is
- # transferred to this job.
+ # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
+ # specified.
+ #
+ # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
+ # terminal state. After a job has reached a terminal state, no
+ # further state updates may be made.
+ #
+ # This field may be mutated by the Cloud Dataflow service;
+ # callers cannot mutate it.
"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that # Deprecated.
# isn't contained in the submitted job.
"stages": { # A mapping from each stage to the information about that stage.
@@ -2719,13 +2719,12 @@
# size.
"a_key": "A String",
},
- "location": "A String", # The location that contains this job.
- "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
- # Cloud Dataflow service.
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the
# corresponding name prefixes of the new job.
"a_key": "A String",
},
+ "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
+ # Cloud Dataflow service.
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
"version": { # A structure describing which components and their versions of the service
# are required in order to run the job.
@@ -2779,49 +2778,6 @@
# multiple pools, in order to match the various computational
# requirements of the various stages of the job.
"diskSourceImage": "A String", # Fully qualified source image for disks.
- "ipConfiguration": "A String", # Configuration for VM IPs.
- "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
- # are supported.
- "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
- # service will attempt to choose a reasonable default.
- "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
- # the service will use the network "default".
- "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
- # will attempt to choose a reasonable default.
- "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
- "metadata": { # Metadata to set on the Google Compute Engine VMs.
- "a_key": "A String",
- },
- "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
- # Compute Engine API.
- "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
- # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
- # `TEARDOWN_NEVER`.
- # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
- # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
- # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
- # down.
- #
- # If the workers are not torn down by the service, they will
- # continue to run and use Google Compute Engine VM resources in the
- # user's project until they are explicitly terminated by the user.
- # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
- # policy except for small, manually supervised test jobs.
- #
- # If unknown or unspecified, the service will attempt to choose a reasonable
- # default.
- "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
- # service will choose a number of threads (according to the number of cores
- # on the selected machine type for batch, or 1 by convention for streaming).
- "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
- # the form "regions/REGION/subnetworks/SUBNETWORK".
- "poolArgs": { # Extra arguments for this worker pool.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
- # execute the job. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when
# using the standard Dataflow task runner. Users should ignore
# this field.
@@ -2834,24 +2790,17 @@
# Google Cloud Storage:
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
- "commandlinesFileName": "A String", # The file to store preprocessing commands in.
- "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
- "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
- "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
- "vmId": "A String", # The ID string of the VM.
- "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
- # taskrunner; e.g. "wheel".
"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by
# taskrunner; e.g. "root".
+ "commandlinesFileName": "A String", # The file to store preprocessing commands in.
+ "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
+ "vmId": "A String", # The ID string of the VM.
+ "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
+ "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to
# access the Cloud Dataflow API.
"A String",
],
- "languageHint": "A String", # The suggested backend language.
- "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
- # console.
- "streamingWorkerMainClass": "A String", # The streaming worker main class name.
- "logDir": "A String", # The directory on the VM to store logs.
"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.
"reportingEnabled": True or False, # Whether to send work progress updates to the service.
"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example,
@@ -2878,16 +2827,14 @@
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
},
+ "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
+ # taskrunner; e.g. "wheel".
+ "languageHint": "A String", # The suggested backend language.
+ "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
+ # console.
+ "streamingWorkerMainClass": "A String", # The streaming worker main class name.
+ "logDir": "A String", # The directory on the VM to store logs.
"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"
- "harnessCommand": "A String", # The command to launch the worker harness.
- "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
- # temporary storage.
- #
- # The supported resource type is:
- #
- # Google Cloud Storage:
- # storage.googleapis.com/{bucket}/{object}
- # bucket.storage.googleapis.com/{object}
"baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs.
#
# When workers access Google Cloud APIs, they logically do so via
@@ -2897,33 +2844,26 @@
# Locators".
#
# If not specified, the default value is "http://www.googleapis.com/"
- },
- "defaultPackageSet": "A String", # The default package set to install. This allows the service to
- # select a default set of packages which are useful to worker
- # harnesses written in a particular language.
- "packages": [ # Packages to be installed on workers.
- { # The packages that must be installed in order for a worker to run the
- # steps of the Cloud Dataflow job that will be assigned to its worker
- # pool.
+ "harnessCommand": "A String", # The command to launch the worker harness.
+ "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
+ # temporary storage.
#
- # This is the mechanism by which the Cloud Dataflow SDK causes code to
- # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
- # might use this to install jars containing the user's code and all of the
- # various dependencies (libraries, data files, etc.) required in order
- # for that code to run.
- "location": "A String", # The resource to read the package from. The supported resource type is:
- #
- # Google Cloud Storage:
- #
- # storage.googleapis.com/{bucket}
- # bucket.storage.googleapis.com/
- "name": "A String", # The name of the package.
- },
- ],
- "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
- "algorithm": "A String", # The algorithm to use for autoscaling.
- "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ # The supported resource type is:
+ #
+ # Google Cloud Storage:
+ # storage.googleapis.com/{bucket}/{object}
+ # bucket.storage.googleapis.com/{object}
},
+ "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
+ # are supported.
+ "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
+ # service will attempt to choose a reasonable default.
+ "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
+ # the service will use the network "default".
+ "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
+ # will attempt to choose a reasonable default.
+ "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
+ # attempt to choose a reasonable default.
"dataDisks": [ # Data disks that are used by a VM in this workflow.
{ # Describes the data disk used by a workflow job.
"mountPoint": "A String", # Directory in a VM where disk is mounted.
@@ -2949,13 +2889,78 @@
# compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard
},
],
- "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
+ # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
+ # `TEARDOWN_NEVER`.
+ # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
+ # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
+ # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
+ # down.
+ #
+ # If the workers are not torn down by the service, they will
+ # continue to run and use Google Compute Engine VM resources in the
+ # user's project until they are explicitly terminated by the user.
+ # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
+ # policy except for small, manually supervised test jobs.
+ #
+ # If unknown or unspecified, the service will attempt to choose a reasonable
+ # default.
+ "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
+ # Compute Engine API.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
+ # service will choose a number of threads (according to the number of cores
+ # on the selected machine type for batch, or 1 by convention for streaming).
+ "poolArgs": { # Extra arguments for this worker pool.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
+ # execute the job. If zero or unspecified, the service will
# attempt to choose a reasonable default.
"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker
# harness, residing in Google Container Registry.
+ "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
+ # the form "regions/REGION/subnetworks/SUBNETWORK".
+ "packages": [ # Packages to be installed on workers.
+ { # The packages that must be installed in order for a worker to run the
+ # steps of the Cloud Dataflow job that will be assigned to its worker
+ # pool.
+ #
+ # This is the mechanism by which the Cloud Dataflow SDK causes code to
+ # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
+ # might use this to install jars containing the user's code and all of the
+ # various dependencies (libraries, data files, etc.) required in order
+ # for that code to run.
+ "location": "A String", # The resource to read the package from. The supported resource type is:
+ #
+ # Google Cloud Storage:
+ #
+ # storage.googleapis.com/{bucket}
+ # bucket.storage.googleapis.com/
+ "name": "A String", # The name of the package.
+ },
+ ],
+ "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
+ "algorithm": "A String", # The algorithm to use for autoscaling.
+ "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ },
+ "defaultPackageSet": "A String", # The default package set to install. This allows the service to
+ # select a default set of packages which are useful to worker
+ # harnesses written in a particular language.
+ "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ # attempt to choose a reasonable default.
+ "metadata": { # Metadata to set on the Google Compute Engine VMs.
+ "a_key": "A String",
+ },
},
],
},
+ "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
+ # of the job it replaced.
+ #
+ # When sending a `CreateJobRequest`, you can update a job by specifying it
+ # here. The job named here is stopped, and its intermediate state is
+ # transferred to this job.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed # Preliminary field: The format of this data may change at any time.
# A description of the user pipeline and stages through which it is executed.
# Created by Cloud Dataflow service. Only retrieved with
@@ -2971,9 +2976,6 @@
],
"displayData": [ # Transform-specific display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -2981,6 +2983,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -2991,7 +2994,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -3003,9 +3008,6 @@
],
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -3013,6 +3015,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -3023,7 +3026,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -3045,19 +3050,19 @@
"outputSource": [ # Output sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"inputSource": [ # Input sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"componentTransform": [ # Transforms that comprise this execution stage.
@@ -3099,26 +3104,16 @@
# Note that the Cloud Dataflow service may be used to run many different
# types of jobs, not just Map-Reduce.
"kind": "A String", # The kind of step in the Cloud Dataflow job.
+ "name": "A String", # The name that identifies the step. This must be unique for each
+ # step with respect to all other steps in the Cloud Dataflow job.
"properties": { # Named properties associated with the step. Each kind of
# predefined step has its own required set of properties.
# Must be provided on Create. Only retrieved with JOB_VIEW_ALL.
"a_key": "", # Properties of the object.
},
- "name": "A String", # The name that identifies the step. This must be unique for each
- # step with respect to all other steps in the Cloud Dataflow job.
},
],
- "currentState": "A String", # The current state of the job.
- #
- # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
- # specified.
- #
- # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
- # terminal state. After a job has reached a terminal state, no
- # further state updates may be made.
- #
- # This field may be mutated by the Cloud Dataflow service;
- # callers cannot mutate it.
+ "location": "A String", # The location that contains this job.
"tempFiles": [ # A set of files the system should be aware of that are used
# for temporary storage. These temporary files will be
# removed on job completion.
@@ -3138,12 +3133,17 @@
#
# This field is set by the Cloud Dataflow service when the Job is
# created, and is immutable for the life of the job.
- "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
- # of the job it replaced.
+ "currentState": "A String", # The current state of the job.
#
- # When sending a `CreateJobRequest`, you can update a job by specifying it
- # here. The job named here is stopped, and its intermediate state is
- # transferred to this job.
+ # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
+ # specified.
+ #
+ # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
+ # terminal state. After a job has reached a terminal state, no
+ # further state updates may be made.
+ #
+ # This field may be mutated by the Cloud Dataflow service;
+ # callers cannot mutate it.
"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that # Deprecated.
# isn't contained in the submitted job.
"stages": { # A mapping from each stage to the information about that stage.
diff --git a/docs/dyn/dataflow_v1b3.projects.locations.jobs.workItems.html b/docs/dyn/dataflow_v1b3.projects.locations.jobs.workItems.html
index 1bdc4ed..031c10c 100644
--- a/docs/dyn/dataflow_v1b3.projects.locations.jobs.workItems.html
+++ b/docs/dyn/dataflow_v1b3.projects.locations.jobs.workItems.html
@@ -119,26 +119,6 @@
"workItems": [ # A list of the leased WorkItems.
{ # WorkItem represents basic information about a WorkItem to be executed
# in the cloud.
- "packages": [ # Any required packages that need to be fetched in order to execute
- # this WorkItem.
- { # The packages that must be installed in order for a worker to run the
- # steps of the Cloud Dataflow job that will be assigned to its worker
- # pool.
- #
- # This is the mechanism by which the Cloud Dataflow SDK causes code to
- # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
- # might use this to install jars containing the user's code and all of the
- # various dependencies (libraries, data files, etc.) required in order
- # for that code to run.
- "location": "A String", # The resource to read the package from. The supported resource type is:
- #
- # Google Cloud Storage:
- #
- # storage.googleapis.com/{bucket}
- # bucket.storage.googleapis.com/
- "name": "A String", # The name of the package.
- },
- ],
"reportStatusInterval": "A String", # Recommended reporting interval.
"leaseExpireTime": "A String", # Time when the lease on this Work will expire.
"seqMapTask": { # Describes a particular function to invoke. # Additional information for SeqMapTask WorkItems.
@@ -666,25 +646,13 @@
],
},
"jobId": "A String", # Identifies the workflow job this WorkItem belongs to.
+ "configuration": "A String", # Work item-specific configuration as an opaque blob.
"streamingSetupTask": { # A task which initializes part of a streaming Dataflow job. # Additional information for StreamingSetupTask WorkItems.
"workerHarnessPort": 42, # The TCP port used by the worker to communicate with the Dataflow
# worker harness.
"drain": True or False, # The user has requested drain.
"streamingComputationTopology": { # Global topology of the streaming Dataflow job, including all # The global topology of the streaming Dataflow job.
# computations and their sharded locations.
- "dataDiskAssignments": [ # The disks assigned to a streaming Dataflow job.
- { # Data disk assignment for a given VM instance.
- "vmInstance": "A String", # VM instance name the data disks mounted to, for example
- # "myproject-1014-104817-4c2-harness-0".
- "dataDisks": [ # Mounted data disks. The order is important a data disk's 0-based index in
- # this list defines which persistent directory the disk is mounted to, for
- # example the list of { "myproject-1014-104817-4c2-harness-0-disk-0" },
- # { "myproject-1014-104817-4c2-harness-0-disk-1" }.
- "A String",
- ],
- },
- ],
- "persistentStateVersion": 42, # Version number for persistent state.
"computations": [ # The computations associated with a streaming Dataflow job.
{ # All configuration data for a particular Computation.
"inputs": [ # The inputs to the computation.
@@ -720,6 +688,24 @@
},
},
],
+ "systemStageName": "A String", # The system stage name.
+ "keyRanges": [ # The key ranges processed by the computation.
+ { # Location information for a specific key-range of a sharded computation.
+ # Currently we only support UTF-8 character splits to simplify encoding into
+ # JSON.
+ "deprecatedPersistentDirectory": "A String", # DEPRECATED. The location of the persistent state for this range, as a
+ # persistent directory in the worker local filesystem.
+ "start": "A String", # The start (inclusive) of the key range.
+ "deliveryEndpoint": "A String", # The physical location of this range assignment to be used for
+ # streaming computation cross-worker message delivery.
+ "end": "A String", # The end (exclusive) of the key range.
+ "dataDisk": "A String", # The name of the data disk where data for this range is stored.
+ # This name is local to the Google Cloud Platform project and uniquely
+ # identifies the disk within that project, for example
+ # "myproject-1014-104817-4c2-harness-0-disk-1".
+ },
+ ],
+ "computationId": "A String", # The ID of the computation.
"outputs": [ # The outputs from the computation.
{ # Describes a stream of data, either as input to be processed or as
# output of a streaming Dataflow job.
@@ -753,24 +739,6 @@
},
},
],
- "keyRanges": [ # The key ranges processed by the computation.
- { # Location information for a specific key-range of a sharded computation.
- # Currently we only support UTF-8 character splits to simplify encoding into
- # JSON.
- "start": "A String", # The start (inclusive) of the key range.
- "persistentDirectory": "A String", # The location of the persistent state for this range, as a
- # persistent directory in the worker local filesystem.
- "end": "A String", # The end (exclusive) of the key range.
- "deliveryEndpoint": "A String", # The physical location of this range assignment to be used for
- # streaming computation cross-worker message delivery.
- "dataDisk": "A String", # The name of the data disk where data for this range is stored.
- # This name is local to the Google Cloud Platform project and uniquely
- # identifies the disk within that project, for example
- # "myproject-1014-104817-4c2-harness-0-disk-1".
- },
- ],
- "computationId": "A String", # The ID of the computation.
- "systemStageName": "A String", # The system stage name.
"userStageName": "A String", # The user stage name.
"stateFamilies": [ # The state family values.
{ # State family configuration.
@@ -780,10 +748,23 @@
],
},
],
+ "dataDiskAssignments": [ # The disks assigned to a streaming Dataflow job.
+ { # Data disk assignment for a given VM instance.
+ "vmInstance": "A String", # VM instance name the data disks mounted to, for example
+ # "myproject-1014-104817-4c2-harness-0".
+ "dataDisks": [ # Mounted data disks. The order is important a data disk's 0-based index in
+ # this list defines which persistent directory the disk is mounted to, for
+ # example the list of { "myproject-1014-104817-4c2-harness-0-disk-0" },
+ # { "myproject-1014-104817-4c2-harness-0-disk-1" }.
+ "A String",
+ ],
+ },
+ ],
+ "forwardingKeyBits": 42, # The size (in bits) of keys that will be assigned to source messages.
"userStageToComputationNameMap": { # Maps user stage names to stable computation names.
"a_key": "A String",
},
- "forwardingKeyBits": 42, # The size (in bits) of keys that will be assigned to source messages.
+ "persistentStateVersion": 42, # Version number for persistent state.
},
"receiveWorkPort": 42, # The TCP port on which the worker should listen for messages from
# other streaming computation workers.
@@ -1090,14 +1071,40 @@
},
],
},
- "configuration": "A String", # Work item-specific configuration as an opaque blob.
+ "packages": [ # Any required packages that need to be fetched in order to execute
+ # this WorkItem.
+ { # The packages that must be installed in order for a worker to run the
+ # steps of the Cloud Dataflow job that will be assigned to its worker
+ # pool.
+ #
+ # This is the mechanism by which the Cloud Dataflow SDK causes code to
+ # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
+ # might use this to install jars containing the user's code and all of the
+ # various dependencies (libraries, data files, etc.) required in order
+ # for that code to run.
+ "location": "A String", # The resource to read the package from. The supported resource type is:
+ #
+ # Google Cloud Storage:
+ #
+ # storage.googleapis.com/{bucket}
+ # bucket.storage.googleapis.com/
+ "name": "A String", # The name of the package.
+ },
+ ],
"shellTask": { # A task which consists of a shell command for the worker to execute. # Additional information for ShellTask WorkItems.
"command": "A String", # The shell command to run.
"exitCode": 42, # Exit code for the task.
},
"streamingComputationTask": { # A task which describes what action should be performed for the specified # Additional information for StreamingComputationTask WorkItems.
# streaming computation ranges.
- "taskType": "A String", # A type of streaming computation task.
+ "dataDisks": [ # Describes the set of data disks this task should apply to.
+ { # Describes mounted data disk.
+ "dataDisk": "A String", # The name of the data disk.
+ # This name is local to the Google Cloud Platform project and uniquely
+ # identifies the disk within that project, for example
+ # "myproject-1014-104817-4c2-harness-0-disk-1".
+ },
+ ],
"computationRanges": [ # Contains ranges of a streaming computation this task should apply to.
{ # Describes full or partial data disk assignment information of the computation
# ranges.
@@ -1117,14 +1124,7 @@
"computationId": "A String", # The ID of the computation.
},
],
- "dataDisks": [ # Describes the set of data disks this task should apply to.
- { # Describes mounted data disk.
- "dataDisk": "A String", # The name of the data disk.
- # This name is local to the Google Cloud Platform project and uniquely
- # identifies the disk within that project, for example
- # "myproject-1014-104817-4c2-harness-0-disk-1".
- },
- ],
+ "taskType": "A String", # A type of streaming computation task.
},
},
],
@@ -1416,8 +1416,8 @@
"concatPosition": { # A position that encapsulates an inner position and an index for the inner # CloudPosition is a concat position.
# position. A ConcatPosition can be used by a reader of a source that
# encapsulates a set of other sources.
- "index": 42, # Index of the inner source.
"position": # Object with schema name: Position # Position within the inner source.
+ "index": 42, # Index of the inner source.
},
"shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED
# sharding).
@@ -1660,8 +1660,9 @@
"dynamicSourceSplit": { # When a task splits using WorkItemStatus.dynamic_source_split, this # See documentation of stop_position.
# message describes the two parts of the split relative to the
# description of the current task's input.
- "residual": { # Specification of one of the bundles produced as a result of splitting # Residual part (returned to the pool of work).
+ "primary": { # Specification of one of the bundles produced as a result of splitting # Primary part (continued to be processed by worker).
# Specified relative to the previously-current source.
+ # Becomes current.
# a Source (e.g. when executing a SourceSplitRequest, or when
# splitting an active task using WorkItemStatus.dynamic_source_split),
# relative to the source being split.
@@ -1720,9 +1721,8 @@
},
},
},
- "primary": { # Specification of one of the bundles produced as a result of splitting # Primary part (continued to be processed by worker).
+ "residual": { # Specification of one of the bundles produced as a result of splitting # Residual part (returned to the pool of work).
# Specified relative to the previously-current source.
- # Becomes current.
# a Source (e.g. when executing a SourceSplitRequest, or when
# splitting an active task using WorkItemStatus.dynamic_source_split),
# relative to the source being split.
@@ -1802,6 +1802,7 @@
"highBits": 42, # The high order bits, including the sign: n >> 32.
},
},
+ "boolean": True or False, # Boolean value for And, Or.
"integerList": { # A metric value representing a list of integers. # List of integers, for Set.
"elements": [ # Elements of the list.
{ # A representation of an int64, n, that is immune to precision loss when
@@ -1815,14 +1816,6 @@
# value accumulated since the worker started working on this WorkItem.
# By default this is false, indicating that this counter is reported
# as a delta.
- "shortId": "A String", # The service-generated short identifier for this counter.
- # The short_id -> (name, metadata) mapping is constant for the lifetime of
- # a job.
- "stringList": { # A metric value representing a list of strings. # List of strings, for Set.
- "elements": [ # Elements of the list.
- "A String",
- ],
- },
"floatingPointMean": { # A representation of a floating point mean metric contribution. # Floating point mean aggregation value for Mean.
"count": { # A representation of an int64, n, that is immune to precision loss when # The number of values being aggregated.
# encoded in JSON.
@@ -1831,7 +1824,10 @@
},
"sum": 3.14, # The sum of all values being aggregated.
},
- "boolean": True or False, # Boolean value for And, Or.
+ "shortId": "A String", # The service-generated short identifier for this counter.
+ # The short_id -> (name, metadata) mapping is constant for the lifetime of
+ # a job.
+ "internal": "", # Value for internally-defined counters used by the Dataflow service.
"structuredNameAndMetadata": { # A single message which encapsulates structured name and metadata for a given # Counter structured name and metadata.
# counter.
"name": { # Identifies a counter within a per-job namespace. Counters whose structured # Structured name of the counter.
@@ -1851,8 +1847,8 @@
"metadata": { # CounterMetadata includes all static non-name non-value counter attributes. # Metadata associated with a counter
"standardUnits": "A String", # System defined Units, see above enum.
"kind": "A String", # Counter aggregation kind.
- "description": "A String", # Human-readable description of the counter semantics.
"otherUnits": "A String", # A string referring to the unit type.
+ "description": "A String", # Human-readable description of the counter semantics.
},
},
"integer": { # A representation of an int64, n, that is immune to precision loss when # Integer value for Sum, Max, Min.
@@ -1888,7 +1884,11 @@
"highBits": 42, # The high order bits, including the sign: n >> 32.
},
},
- "internal": "", # Value for internally-defined counters used by the Dataflow service.
+ "stringList": { # A metric value representing a list of strings. # List of strings, for Set.
+ "elements": [ # Elements of the list.
+ "A String",
+ ],
+ },
},
],
"progress": { # Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest. # DEPRECATED in favor of reported_progress.
@@ -1903,8 +1903,8 @@
"concatPosition": { # A position that encapsulates an inner position and an index for the inner # CloudPosition is a concat position.
# position. A ConcatPosition can be used by a reader of a source that
# encapsulates a set of other sources.
- "index": 42, # Index of the inner source.
"position": # Object with schema name: Position # Position within the inner source.
+ "index": 42, # Index of the inner source.
},
"shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED
# sharding).
@@ -1973,8 +1973,8 @@
"concatPosition": { # A position that encapsulates an inner position and an index for the inner # CloudPosition is a concat position.
# position. A ConcatPosition can be used by a reader of a source that
# encapsulates a set of other sources.
- "index": 42, # Index of the inner source.
"position": # Object with schema name: Position # Position within the inner source.
+ "index": 42, # Index of the inner source.
},
"shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED
# sharding).
@@ -2061,20 +2061,20 @@
"concatPosition": { # A position that encapsulates an inner position and an index for the inner # CloudPosition is a concat position.
# position. A ConcatPosition can be used by a reader of a source that
# encapsulates a set of other sources.
- "index": 42, # Index of the inner source.
"position": # Object with schema name: Position # Position within the inner source.
+ "index": 42, # Index of the inner source.
},
"shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED
# sharding).
},
- "leaseExpireTime": "A String", # Time at which the current lease will expire.
- "nextReportIndex": "A String", # The index value to use for the next report sent by the worker.
- # Note: If the report call fails for whatever reason, the worker should
- # reuse this index for subsequent report attempts.
"harnessData": { # Other data returned by the service, specific to the particular
# worker harness.
"a_key": "", # Properties of the object.
},
+ "nextReportIndex": "A String", # The index value to use for the next report sent by the worker.
+ # Note: If the report call fails for whatever reason, the worker should
+ # reuse this index for subsequent report attempts.
+ "leaseExpireTime": "A String", # Time at which the current lease will expire.
"metricShortId": [ # The short ids that workers should use in subsequent metric updates.
# Workers should strive to use short ids whenever possible, but it is ok
# to request the short_id again if a worker lost track of it
@@ -2103,8 +2103,8 @@
"concatPosition": { # A position that encapsulates an inner position and an index for the inner # CloudPosition is a concat position.
# position. A ConcatPosition can be used by a reader of a source that
# encapsulates a set of other sources.
- "index": 42, # Index of the inner source.
"position": # Object with schema name: Position # Position within the inner source.
+ "index": 42, # Index of the inner source.
},
"shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED
# sharding).
@@ -2122,8 +2122,8 @@
"concatPosition": { # A position that encapsulates an inner position and an index for the inner # CloudPosition is a concat position.
# position. A ConcatPosition can be used by a reader of a source that
# encapsulates a set of other sources.
- "index": 42, # Index of the inner source.
"position": # Object with schema name: Position # Position within the inner source.
+ "index": 42, # Index of the inner source.
},
"shufflePosition": "A String", # CloudPosition is a base64 encoded BatchShufflePosition (with FIXED
# sharding).
diff --git a/docs/dyn/dataflow_v1b3.projects.templates.html b/docs/dyn/dataflow_v1b3.projects.templates.html
index c325c0f..197f0c9 100644
--- a/docs/dyn/dataflow_v1b3.projects.templates.html
+++ b/docs/dyn/dataflow_v1b3.projects.templates.html
@@ -161,13 +161,12 @@
# size.
"a_key": "A String",
},
- "location": "A String", # The location that contains this job.
- "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
- # Cloud Dataflow service.
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the
# corresponding name prefixes of the new job.
"a_key": "A String",
},
+ "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
+ # Cloud Dataflow service.
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
"version": { # A structure describing which components and their versions of the service
# are required in order to run the job.
@@ -221,49 +220,6 @@
# multiple pools, in order to match the various computational
# requirements of the various stages of the job.
"diskSourceImage": "A String", # Fully qualified source image for disks.
- "ipConfiguration": "A String", # Configuration for VM IPs.
- "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
- # are supported.
- "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
- # service will attempt to choose a reasonable default.
- "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
- # the service will use the network "default".
- "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
- # will attempt to choose a reasonable default.
- "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
- "metadata": { # Metadata to set on the Google Compute Engine VMs.
- "a_key": "A String",
- },
- "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
- # Compute Engine API.
- "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
- # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
- # `TEARDOWN_NEVER`.
- # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
- # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
- # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
- # down.
- #
- # If the workers are not torn down by the service, they will
- # continue to run and use Google Compute Engine VM resources in the
- # user's project until they are explicitly terminated by the user.
- # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
- # policy except for small, manually supervised test jobs.
- #
- # If unknown or unspecified, the service will attempt to choose a reasonable
- # default.
- "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
- # service will choose a number of threads (according to the number of cores
- # on the selected machine type for batch, or 1 by convention for streaming).
- "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
- # the form "regions/REGION/subnetworks/SUBNETWORK".
- "poolArgs": { # Extra arguments for this worker pool.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
- # execute the job. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when
# using the standard Dataflow task runner. Users should ignore
# this field.
@@ -276,24 +232,17 @@
# Google Cloud Storage:
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
- "commandlinesFileName": "A String", # The file to store preprocessing commands in.
- "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
- "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
- "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
- "vmId": "A String", # The ID string of the VM.
- "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
- # taskrunner; e.g. "wheel".
"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by
# taskrunner; e.g. "root".
+ "commandlinesFileName": "A String", # The file to store preprocessing commands in.
+ "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
+ "vmId": "A String", # The ID string of the VM.
+ "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
+ "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to
# access the Cloud Dataflow API.
"A String",
],
- "languageHint": "A String", # The suggested backend language.
- "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
- # console.
- "streamingWorkerMainClass": "A String", # The streaming worker main class name.
- "logDir": "A String", # The directory on the VM to store logs.
"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.
"reportingEnabled": True or False, # Whether to send work progress updates to the service.
"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example,
@@ -320,16 +269,14 @@
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
},
+ "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
+ # taskrunner; e.g. "wheel".
+ "languageHint": "A String", # The suggested backend language.
+ "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
+ # console.
+ "streamingWorkerMainClass": "A String", # The streaming worker main class name.
+ "logDir": "A String", # The directory on the VM to store logs.
"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"
- "harnessCommand": "A String", # The command to launch the worker harness.
- "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
- # temporary storage.
- #
- # The supported resource type is:
- #
- # Google Cloud Storage:
- # storage.googleapis.com/{bucket}/{object}
- # bucket.storage.googleapis.com/{object}
"baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs.
#
# When workers access Google Cloud APIs, they logically do so via
@@ -339,33 +286,26 @@
# Locators".
#
# If not specified, the default value is "http://www.googleapis.com/"
- },
- "defaultPackageSet": "A String", # The default package set to install. This allows the service to
- # select a default set of packages which are useful to worker
- # harnesses written in a particular language.
- "packages": [ # Packages to be installed on workers.
- { # The packages that must be installed in order for a worker to run the
- # steps of the Cloud Dataflow job that will be assigned to its worker
- # pool.
+ "harnessCommand": "A String", # The command to launch the worker harness.
+ "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
+ # temporary storage.
#
- # This is the mechanism by which the Cloud Dataflow SDK causes code to
- # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
- # might use this to install jars containing the user's code and all of the
- # various dependencies (libraries, data files, etc.) required in order
- # for that code to run.
- "location": "A String", # The resource to read the package from. The supported resource type is:
- #
- # Google Cloud Storage:
- #
- # storage.googleapis.com/{bucket}
- # bucket.storage.googleapis.com/
- "name": "A String", # The name of the package.
- },
- ],
- "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
- "algorithm": "A String", # The algorithm to use for autoscaling.
- "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ # The supported resource type is:
+ #
+ # Google Cloud Storage:
+ # storage.googleapis.com/{bucket}/{object}
+ # bucket.storage.googleapis.com/{object}
},
+ "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
+ # are supported.
+ "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
+ # service will attempt to choose a reasonable default.
+ "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
+ # the service will use the network "default".
+ "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
+ # will attempt to choose a reasonable default.
+ "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
+ # attempt to choose a reasonable default.
"dataDisks": [ # Data disks that are used by a VM in this workflow.
{ # Describes the data disk used by a workflow job.
"mountPoint": "A String", # Directory in a VM where disk is mounted.
@@ -391,13 +331,78 @@
# compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard
},
],
- "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
+ # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
+ # `TEARDOWN_NEVER`.
+ # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
+ # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
+ # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
+ # down.
+ #
+ # If the workers are not torn down by the service, they will
+ # continue to run and use Google Compute Engine VM resources in the
+ # user's project until they are explicitly terminated by the user.
+ # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
+ # policy except for small, manually supervised test jobs.
+ #
+ # If unknown or unspecified, the service will attempt to choose a reasonable
+ # default.
+ "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
+ # Compute Engine API.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
+ # service will choose a number of threads (according to the number of cores
+ # on the selected machine type for batch, or 1 by convention for streaming).
+ "poolArgs": { # Extra arguments for this worker pool.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
+ # execute the job. If zero or unspecified, the service will
# attempt to choose a reasonable default.
"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker
# harness, residing in Google Container Registry.
+ "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
+ # the form "regions/REGION/subnetworks/SUBNETWORK".
+ "packages": [ # Packages to be installed on workers.
+ { # The packages that must be installed in order for a worker to run the
+ # steps of the Cloud Dataflow job that will be assigned to its worker
+ # pool.
+ #
+ # This is the mechanism by which the Cloud Dataflow SDK causes code to
+ # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
+ # might use this to install jars containing the user's code and all of the
+ # various dependencies (libraries, data files, etc.) required in order
+ # for that code to run.
+ "location": "A String", # The resource to read the package from. The supported resource type is:
+ #
+ # Google Cloud Storage:
+ #
+ # storage.googleapis.com/{bucket}
+ # bucket.storage.googleapis.com/
+ "name": "A String", # The name of the package.
+ },
+ ],
+ "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
+ "algorithm": "A String", # The algorithm to use for autoscaling.
+ "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ },
+ "defaultPackageSet": "A String", # The default package set to install. This allows the service to
+ # select a default set of packages which are useful to worker
+ # harnesses written in a particular language.
+ "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ # attempt to choose a reasonable default.
+ "metadata": { # Metadata to set on the Google Compute Engine VMs.
+ "a_key": "A String",
+ },
},
],
},
+ "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
+ # of the job it replaced.
+ #
+ # When sending a `CreateJobRequest`, you can update a job by specifying it
+ # here. The job named here is stopped, and its intermediate state is
+ # transferred to this job.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed # Preliminary field: The format of this data may change at any time.
# A description of the user pipeline and stages through which it is executed.
# Created by Cloud Dataflow service. Only retrieved with
@@ -413,9 +418,6 @@
],
"displayData": [ # Transform-specific display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -423,6 +425,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -433,7 +436,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -445,9 +450,6 @@
],
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -455,6 +457,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -465,7 +468,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -487,19 +492,19 @@
"outputSource": [ # Output sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"inputSource": [ # Input sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"componentTransform": [ # Transforms that comprise this execution stage.
@@ -541,26 +546,16 @@
# Note that the Cloud Dataflow service may be used to run many different
# types of jobs, not just Map-Reduce.
"kind": "A String", # The kind of step in the Cloud Dataflow job.
+ "name": "A String", # The name that identifies the step. This must be unique for each
+ # step with respect to all other steps in the Cloud Dataflow job.
"properties": { # Named properties associated with the step. Each kind of
# predefined step has its own required set of properties.
# Must be provided on Create. Only retrieved with JOB_VIEW_ALL.
"a_key": "", # Properties of the object.
},
- "name": "A String", # The name that identifies the step. This must be unique for each
- # step with respect to all other steps in the Cloud Dataflow job.
},
],
- "currentState": "A String", # The current state of the job.
- #
- # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
- # specified.
- #
- # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
- # terminal state. After a job has reached a terminal state, no
- # further state updates may be made.
- #
- # This field may be mutated by the Cloud Dataflow service;
- # callers cannot mutate it.
+ "location": "A String", # The location that contains this job.
"tempFiles": [ # A set of files the system should be aware of that are used
# for temporary storage. These temporary files will be
# removed on job completion.
@@ -580,12 +575,17 @@
#
# This field is set by the Cloud Dataflow service when the Job is
# created, and is immutable for the life of the job.
- "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
- # of the job it replaced.
+ "currentState": "A String", # The current state of the job.
#
- # When sending a `CreateJobRequest`, you can update a job by specifying it
- # here. The job named here is stopped, and its intermediate state is
- # transferred to this job.
+ # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
+ # specified.
+ #
+ # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
+ # terminal state. After a job has reached a terminal state, no
+ # further state updates may be made.
+ #
+ # This field may be mutated by the Cloud Dataflow service;
+ # callers cannot mutate it.
"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that # Deprecated.
# isn't contained in the submitted job.
"stages": { # A mapping from each stage to the information about that stage.
@@ -750,70 +750,6 @@
An object of the form:
{ # Response to the request to launch a template.
- "status": { # The `Status` type defines a logical error model that is suitable for different # The status of the launch template request. Any problems with the request
- # will be indicated in the error_details.
- # 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.
- },
- ],
- },
"job": { # Defines a job to be run by the Cloud Dataflow service. # The job that was launched, if the request was not a dry run and
# the job was successfully launched.
"clientRequestId": "A String", # The client's unique identifier of the job, re-used across retried attempts.
@@ -854,13 +790,12 @@
# size.
"a_key": "A String",
},
- "location": "A String", # The location that contains this job.
- "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
- # Cloud Dataflow service.
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the
# corresponding name prefixes of the new job.
"a_key": "A String",
},
+ "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the
+ # Cloud Dataflow service.
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
"version": { # A structure describing which components and their versions of the service
# are required in order to run the job.
@@ -914,49 +849,6 @@
# multiple pools, in order to match the various computational
# requirements of the various stages of the job.
"diskSourceImage": "A String", # Fully qualified source image for disks.
- "ipConfiguration": "A String", # Configuration for VM IPs.
- "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
- # are supported.
- "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
- # service will attempt to choose a reasonable default.
- "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
- # the service will use the network "default".
- "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
- # will attempt to choose a reasonable default.
- "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
- "metadata": { # Metadata to set on the Google Compute Engine VMs.
- "a_key": "A String",
- },
- "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
- # Compute Engine API.
- "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
- # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
- # `TEARDOWN_NEVER`.
- # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
- # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
- # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
- # down.
- #
- # If the workers are not torn down by the service, they will
- # continue to run and use Google Compute Engine VM resources in the
- # user's project until they are explicitly terminated by the user.
- # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
- # policy except for small, manually supervised test jobs.
- #
- # If unknown or unspecified, the service will attempt to choose a reasonable
- # default.
- "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
- # service will choose a number of threads (according to the number of cores
- # on the selected machine type for batch, or 1 by convention for streaming).
- "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
- # the form "regions/REGION/subnetworks/SUBNETWORK".
- "poolArgs": { # Extra arguments for this worker pool.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
- # execute the job. If zero or unspecified, the service will
- # attempt to choose a reasonable default.
"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when
# using the standard Dataflow task runner. Users should ignore
# this field.
@@ -969,24 +861,17 @@
# Google Cloud Storage:
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
- "commandlinesFileName": "A String", # The file to store preprocessing commands in.
- "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
- "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
- "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
- "vmId": "A String", # The ID string of the VM.
- "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
- # taskrunner; e.g. "wheel".
"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by
# taskrunner; e.g. "root".
+ "commandlinesFileName": "A String", # The file to store preprocessing commands in.
+ "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.
+ "vmId": "A String", # The ID string of the VM.
+ "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.
+ "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.
"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to
# access the Cloud Dataflow API.
"A String",
],
- "languageHint": "A String", # The suggested backend language.
- "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
- # console.
- "streamingWorkerMainClass": "A String", # The streaming worker main class name.
- "logDir": "A String", # The directory on the VM to store logs.
"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.
"reportingEnabled": True or False, # Whether to send work progress updates to the service.
"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example,
@@ -1013,16 +898,14 @@
# storage.googleapis.com/{bucket}/{object}
# bucket.storage.googleapis.com/{object}
},
+ "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by
+ # taskrunner; e.g. "wheel".
+ "languageHint": "A String", # The suggested backend language.
+ "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial
+ # console.
+ "streamingWorkerMainClass": "A String", # The streaming worker main class name.
+ "logDir": "A String", # The directory on the VM to store logs.
"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"
- "harnessCommand": "A String", # The command to launch the worker harness.
- "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
- # temporary storage.
- #
- # The supported resource type is:
- #
- # Google Cloud Storage:
- # storage.googleapis.com/{bucket}/{object}
- # bucket.storage.googleapis.com/{object}
"baseUrl": "A String", # The base URL for the taskrunner to use when accessing Google Cloud APIs.
#
# When workers access Google Cloud APIs, they logically do so via
@@ -1032,33 +915,26 @@
# Locators".
#
# If not specified, the default value is "http://www.googleapis.com/"
- },
- "defaultPackageSet": "A String", # The default package set to install. This allows the service to
- # select a default set of packages which are useful to worker
- # harnesses written in a particular language.
- "packages": [ # Packages to be installed on workers.
- { # The packages that must be installed in order for a worker to run the
- # steps of the Cloud Dataflow job that will be assigned to its worker
- # pool.
+ "harnessCommand": "A String", # The command to launch the worker harness.
+ "tempStoragePrefix": "A String", # The prefix of the resources the taskrunner should use for
+ # temporary storage.
#
- # This is the mechanism by which the Cloud Dataflow SDK causes code to
- # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
- # might use this to install jars containing the user's code and all of the
- # various dependencies (libraries, data files, etc.) required in order
- # for that code to run.
- "location": "A String", # The resource to read the package from. The supported resource type is:
- #
- # Google Cloud Storage:
- #
- # storage.googleapis.com/{bucket}
- # bucket.storage.googleapis.com/
- "name": "A String", # The name of the package.
- },
- ],
- "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
- "algorithm": "A String", # The algorithm to use for autoscaling.
- "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ # The supported resource type is:
+ #
+ # Google Cloud Storage:
+ # storage.googleapis.com/{bucket}/{object}
+ # bucket.storage.googleapis.com/{object}
},
+ "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle`
+ # are supported.
+ "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the
+ # service will attempt to choose a reasonable default.
+ "network": "A String", # Network to which VMs will be assigned. If empty or unspecified,
+ # the service will use the network "default".
+ "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service
+ # will attempt to choose a reasonable default.
+ "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will
+ # attempt to choose a reasonable default.
"dataDisks": [ # Data disks that are used by a VM in this workflow.
{ # Describes the data disk used by a workflow job.
"mountPoint": "A String", # Directory in a VM where disk is mounted.
@@ -1084,13 +960,78 @@
# compute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard
},
],
- "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool.
+ # Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and
+ # `TEARDOWN_NEVER`.
+ # `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether
+ # the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down
+ # if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn
+ # down.
+ #
+ # If the workers are not torn down by the service, they will
+ # continue to run and use Google Compute Engine VM resources in the
+ # user's project until they are explicitly terminated by the user.
+ # Because of this, Google recommends using the `TEARDOWN_ALWAYS`
+ # policy except for small, manually supervised test jobs.
+ #
+ # If unknown or unspecified, the service will attempt to choose a reasonable
+ # default.
+ "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google
+ # Compute Engine API.
+ "ipConfiguration": "A String", # Configuration for VM IPs.
+ "numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the
+ # service will choose a number of threads (according to the number of cores
+ # on the selected machine type for batch, or 1 by convention for streaming).
+ "poolArgs": { # Extra arguments for this worker pool.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "numWorkers": 42, # Number of Google Compute Engine workers in this pool needed to
+ # execute the job. If zero or unspecified, the service will
# attempt to choose a reasonable default.
"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker
# harness, residing in Google Container Registry.
+ "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of
+ # the form "regions/REGION/subnetworks/SUBNETWORK".
+ "packages": [ # Packages to be installed on workers.
+ { # The packages that must be installed in order for a worker to run the
+ # steps of the Cloud Dataflow job that will be assigned to its worker
+ # pool.
+ #
+ # This is the mechanism by which the Cloud Dataflow SDK causes code to
+ # be loaded onto the workers. For example, the Cloud Dataflow Java SDK
+ # might use this to install jars containing the user's code and all of the
+ # various dependencies (libraries, data files, etc.) required in order
+ # for that code to run.
+ "location": "A String", # The resource to read the package from. The supported resource type is:
+ #
+ # Google Cloud Storage:
+ #
+ # storage.googleapis.com/{bucket}
+ # bucket.storage.googleapis.com/
+ "name": "A String", # The name of the package.
+ },
+ ],
+ "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.
+ "algorithm": "A String", # The algorithm to use for autoscaling.
+ "maxNumWorkers": 42, # The maximum number of workers to cap scaling at.
+ },
+ "defaultPackageSet": "A String", # The default package set to install. This allows the service to
+ # select a default set of packages which are useful to worker
+ # harnesses written in a particular language.
+ "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will
+ # attempt to choose a reasonable default.
+ "metadata": { # Metadata to set on the Google Compute Engine VMs.
+ "a_key": "A String",
+ },
},
],
},
+ "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
+ # of the job it replaced.
+ #
+ # When sending a `CreateJobRequest`, you can update a job by specifying it
+ # here. The job named here is stopped, and its intermediate state is
+ # transferred to this job.
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed # Preliminary field: The format of this data may change at any time.
# A description of the user pipeline and stages through which it is executed.
# Created by Cloud Dataflow service. Only retrieved with
@@ -1106,9 +1047,6 @@
],
"displayData": [ # Transform-specific display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -1116,6 +1054,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -1126,7 +1065,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -1138,9 +1079,6 @@
],
"displayData": [ # Pipeline level display data.
{ # Data provided with a pipeline or transform to provide descriptive info.
- "key": "A String", # The key identifying the display data.
- # This is intended to be used as a label for the display data
- # when viewed in a dax monitoring system.
"shortStrValue": "A String", # A possible additional shorter value to display.
# For example a java_class_name_value of com.mypackage.MyDoFn
# will be stored with MyDoFn as the short_str_value and
@@ -1148,6 +1086,7 @@
# short_str_value can be displayed and java_class_name_value
# will be displayed as a tooltip.
"timestampValue": "A String", # Contains value if the data is of timestamp type.
+ "durationValue": "A String", # Contains value if the data is of duration type.
"url": "A String", # An optional full URL.
"floatValue": 3.14, # Contains value if the data is of float type.
"namespace": "A String", # The namespace for the key. This is usually a class name or programming
@@ -1158,7 +1097,9 @@
"label": "A String", # An optional label to display in a dax UI for the element.
"boolValue": True or False, # Contains value if the data is of a boolean type.
"strValue": "A String", # Contains value if the data is of string type.
- "durationValue": "A String", # Contains value if the data is of duration type.
+ "key": "A String", # The key identifying the display data.
+ # This is intended to be used as a label for the display data
+ # when viewed in a dax monitoring system.
"int64Value": "A String", # Contains value if the data is of int64 type.
},
],
@@ -1180,19 +1121,19 @@
"outputSource": [ # Output sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"inputSource": [ # Input sources for this stage.
{ # Description of an input or output of an execution stage.
"userName": "A String", # Human-readable name for this source; may be user or system generated.
+ "sizeBytes": "A String", # Size of the source, if measurable.
+ "name": "A String", # Dataflow service generated name for this source.
"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this
# source is most closely associated.
- "name": "A String", # Dataflow service generated name for this source.
- "sizeBytes": "A String", # Size of the source, if measurable.
},
],
"componentTransform": [ # Transforms that comprise this execution stage.
@@ -1234,26 +1175,16 @@
# Note that the Cloud Dataflow service may be used to run many different
# types of jobs, not just Map-Reduce.
"kind": "A String", # The kind of step in the Cloud Dataflow job.
+ "name": "A String", # The name that identifies the step. This must be unique for each
+ # step with respect to all other steps in the Cloud Dataflow job.
"properties": { # Named properties associated with the step. Each kind of
# predefined step has its own required set of properties.
# Must be provided on Create. Only retrieved with JOB_VIEW_ALL.
"a_key": "", # Properties of the object.
},
- "name": "A String", # The name that identifies the step. This must be unique for each
- # step with respect to all other steps in the Cloud Dataflow job.
},
],
- "currentState": "A String", # The current state of the job.
- #
- # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
- # specified.
- #
- # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
- # terminal state. After a job has reached a terminal state, no
- # further state updates may be made.
- #
- # This field may be mutated by the Cloud Dataflow service;
- # callers cannot mutate it.
+ "location": "A String", # The location that contains this job.
"tempFiles": [ # A set of files the system should be aware of that are used
# for temporary storage. These temporary files will be
# removed on job completion.
@@ -1273,12 +1204,17 @@
#
# This field is set by the Cloud Dataflow service when the Job is
# created, and is immutable for the life of the job.
- "replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID
- # of the job it replaced.
+ "currentState": "A String", # The current state of the job.
#
- # When sending a `CreateJobRequest`, you can update a job by specifying it
- # here. The job named here is stopped, and its intermediate state is
- # transferred to this job.
+ # Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise
+ # specified.
+ #
+ # A job in the `JOB_STATE_RUNNING` state may asynchronously enter a
+ # terminal state. After a job has reached a terminal state, no
+ # further state updates may be made.
+ #
+ # This field may be mutated by the Cloud Dataflow service;
+ # callers cannot mutate it.
"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that # Deprecated.
# isn't contained in the submitted job.
"stages": { # A mapping from each stage to the information about that stage.
diff --git a/docs/dyn/dataproc_v1.projects.regions.clusters.html b/docs/dyn/dataproc_v1.projects.regions.clusters.html
index c3b7e95..206a72b 100644
--- a/docs/dyn/dataproc_v1.projects.regions.clusters.html
+++ b/docs/dyn/dataproc_v1.projects.regions.clusters.html
@@ -110,6 +110,7 @@
"status": { # The status of a cluster and its instances. # Output-only Cluster status.
"state": "A String", # Output-only The cluster's state.
"stateStartTime": "A String", # Output-only Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Output-only Optional details of cluster's state.
},
"clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
@@ -130,6 +131,7 @@
{ # The status of a cluster and its instances.
"state": "A String", # Output-only The cluster's state.
"stateStartTime": "A String", # Output-only Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Output-only Optional details of cluster's state.
},
],
@@ -407,6 +409,7 @@
"status": { # The status of a cluster and its instances. # Output-only Cluster status.
"state": "A String", # Output-only The cluster's state.
"stateStartTime": "A String", # Output-only Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Output-only Optional details of cluster's state.
},
"clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
@@ -427,6 +430,7 @@
{ # The status of a cluster and its instances.
"state": "A String", # Output-only The cluster's state.
"stateStartTime": "A String", # Output-only Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Output-only Optional details of cluster's state.
},
],
@@ -580,6 +584,7 @@
"status": { # The status of a cluster and its instances. # Output-only Cluster status.
"state": "A String", # Output-only The cluster's state.
"stateStartTime": "A String", # Output-only Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Output-only Optional details of cluster's state.
},
"clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
@@ -600,6 +605,7 @@
{ # The status of a cluster and its instances.
"state": "A String", # Output-only The cluster's state.
"stateStartTime": "A String", # Output-only Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Output-only Optional details of cluster's state.
},
],
@@ -759,6 +765,7 @@
"status": { # The status of a cluster and its instances. # Output-only Cluster status.
"state": "A String", # Output-only The cluster's state.
"stateStartTime": "A String", # Output-only Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Output-only Optional details of cluster's state.
},
"clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
@@ -779,6 +786,7 @@
{ # The status of a cluster and its instances.
"state": "A String", # Output-only The cluster's state.
"stateStartTime": "A String", # Output-only Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Output-only Optional details of cluster's state.
},
],
diff --git a/docs/dyn/dataproc_v1.projects.regions.jobs.html b/docs/dyn/dataproc_v1.projects.regions.jobs.html
index 2cd6633..0ed4853 100644
--- a/docs/dyn/dataproc_v1.projects.regions.jobs.html
+++ b/docs/dyn/dataproc_v1.projects.regions.jobs.html
@@ -123,6 +123,42 @@
"state": "A String", # Output-only A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
"details": "A String", # Output-only Optional job state details, such as an error description if the state is <code>ERROR</code>.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
+ },
+ "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "fileUris": [ # Optional HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
+ "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "labels": { # Optional The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
+ "a_key": "A String",
+ },
+ "placement": { # Cloud Dataproc job config. # Required Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # Output-only A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
+ "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # Optional The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.
},
"sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.
"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
@@ -187,41 +223,6 @@
"a_key": "A String",
},
},
- "placement": { # Cloud Dataproc job config. # Required Job information, including how, when, and where to run the job.
- "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
- "clusterUuid": "A String", # Output-only A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
- },
- "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
- "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
- "jobId": "A String", # Optional The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.
- },
- "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
- "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
- "A String",
- ],
- "loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
- "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
- "a_key": "A String",
- },
- },
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
- "A String",
- ],
- "fileUris": [ # Optional HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
- "A String",
- ],
- "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
- "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
- "A String",
- ],
- "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
- "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
- "a_key": "A String",
- },
- },
- "labels": { # Optional The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
- "a_key": "A String",
- },
"driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
"pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.
"mainPythonFileUri": "A String", # Required The HCFS URI of the main Python file to use as the driver. Must be a .py file.
@@ -251,7 +252,7 @@
},
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
"loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
@@ -259,7 +260,7 @@
"a_key": "A String",
},
},
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
"fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
@@ -290,6 +291,7 @@
"state": "A String", # Output-only A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
"details": "A String", # Output-only Optional job state details, such as an error description if the state is <code>ERROR</code>.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
},
],
"hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.
@@ -367,6 +369,42 @@
"state": "A String", # Output-only A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
"details": "A String", # Output-only Optional job state details, such as an error description if the state is <code>ERROR</code>.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
+ },
+ "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "fileUris": [ # Optional HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
+ "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "labels": { # Optional The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
+ "a_key": "A String",
+ },
+ "placement": { # Cloud Dataproc job config. # Required Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # Output-only A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
+ "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # Optional The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.
},
"sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.
"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
@@ -431,41 +469,6 @@
"a_key": "A String",
},
},
- "placement": { # Cloud Dataproc job config. # Required Job information, including how, when, and where to run the job.
- "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
- "clusterUuid": "A String", # Output-only A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
- },
- "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
- "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
- "jobId": "A String", # Optional The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.
- },
- "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
- "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
- "A String",
- ],
- "loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
- "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
- "a_key": "A String",
- },
- },
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
- "A String",
- ],
- "fileUris": [ # Optional HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
- "A String",
- ],
- "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
- "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
- "A String",
- ],
- "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
- "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
- "a_key": "A String",
- },
- },
- "labels": { # Optional The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
- "a_key": "A String",
- },
"driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
"pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.
"mainPythonFileUri": "A String", # Required The HCFS URI of the main Python file to use as the driver. Must be a .py file.
@@ -495,7 +498,7 @@
},
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
"loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
@@ -503,7 +506,7 @@
"a_key": "A String",
},
},
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
"fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
@@ -534,6 +537,7 @@
"state": "A String", # Output-only A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
"details": "A String", # Output-only Optional job state details, such as an error description if the state is <code>ERROR</code>.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
},
],
"hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.
@@ -594,6 +598,42 @@
"state": "A String", # Output-only A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
"details": "A String", # Output-only Optional job state details, such as an error description if the state is <code>ERROR</code>.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
+ },
+ "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "fileUris": [ # Optional HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
+ "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "labels": { # Optional The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
+ "a_key": "A String",
+ },
+ "placement": { # Cloud Dataproc job config. # Required Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # Output-only A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
+ "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # Optional The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.
},
"sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.
"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
@@ -658,41 +698,6 @@
"a_key": "A String",
},
},
- "placement": { # Cloud Dataproc job config. # Required Job information, including how, when, and where to run the job.
- "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
- "clusterUuid": "A String", # Output-only A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
- },
- "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
- "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
- "jobId": "A String", # Optional The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.
- },
- "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
- "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
- "A String",
- ],
- "loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
- "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
- "a_key": "A String",
- },
- },
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
- "A String",
- ],
- "fileUris": [ # Optional HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
- "A String",
- ],
- "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
- "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
- "A String",
- ],
- "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
- "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
- "a_key": "A String",
- },
- },
- "labels": { # Optional The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
- "a_key": "A String",
- },
"driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
"pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.
"mainPythonFileUri": "A String", # Required The HCFS URI of the main Python file to use as the driver. Must be a .py file.
@@ -722,7 +727,7 @@
},
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
"loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
@@ -730,7 +735,7 @@
"a_key": "A String",
},
},
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
"fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
@@ -761,6 +766,7 @@
"state": "A String", # Output-only A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
"details": "A String", # Output-only Optional job state details, such as an error description if the state is <code>ERROR</code>.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
},
],
"hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.
@@ -825,6 +831,42 @@
"state": "A String", # Output-only A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
"details": "A String", # Output-only Optional job state details, such as an error description if the state is <code>ERROR</code>.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
+ },
+ "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "fileUris": [ # Optional HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
+ "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "labels": { # Optional The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
+ "a_key": "A String",
+ },
+ "placement": { # Cloud Dataproc job config. # Required Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # Output-only A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
+ "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # Optional The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.
},
"sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.
"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
@@ -889,41 +931,6 @@
"a_key": "A String",
},
},
- "placement": { # Cloud Dataproc job config. # Required Job information, including how, when, and where to run the job.
- "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
- "clusterUuid": "A String", # Output-only A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
- },
- "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
- "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
- "jobId": "A String", # Optional The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.
- },
- "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
- "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
- "A String",
- ],
- "loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
- "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
- "a_key": "A String",
- },
- },
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
- "A String",
- ],
- "fileUris": [ # Optional HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
- "A String",
- ],
- "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
- "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
- "A String",
- ],
- "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
- "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
- "a_key": "A String",
- },
- },
- "labels": { # Optional The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
- "a_key": "A String",
- },
"driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
"pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.
"mainPythonFileUri": "A String", # Required The HCFS URI of the main Python file to use as the driver. Must be a .py file.
@@ -953,7 +960,7 @@
},
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
"loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
@@ -961,7 +968,7 @@
"a_key": "A String",
},
},
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
"fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
@@ -992,6 +999,7 @@
"state": "A String", # Output-only A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
"details": "A String", # Output-only Optional job state details, such as an error description if the state is <code>ERROR</code>.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
},
],
"hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.
@@ -1037,6 +1045,42 @@
"state": "A String", # Output-only A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
"details": "A String", # Output-only Optional job state details, such as an error description if the state is <code>ERROR</code>.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
+ },
+ "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "fileUris": [ # Optional HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
+ "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "labels": { # Optional The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
+ "a_key": "A String",
+ },
+ "placement": { # Cloud Dataproc job config. # Required Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # Output-only A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
+ "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # Optional The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.
},
"sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.
"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
@@ -1101,41 +1145,6 @@
"a_key": "A String",
},
},
- "placement": { # Cloud Dataproc job config. # Required Job information, including how, when, and where to run the job.
- "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
- "clusterUuid": "A String", # Output-only A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
- },
- "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
- "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
- "jobId": "A String", # Optional The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.
- },
- "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
- "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
- "A String",
- ],
- "loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
- "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
- "a_key": "A String",
- },
- },
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
- "A String",
- ],
- "fileUris": [ # Optional HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
- "A String",
- ],
- "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
- "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
- "A String",
- ],
- "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
- "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
- "a_key": "A String",
- },
- },
- "labels": { # Optional The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
- "a_key": "A String",
- },
"driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
"pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.
"mainPythonFileUri": "A String", # Required The HCFS URI of the main Python file to use as the driver. Must be a .py file.
@@ -1165,7 +1174,7 @@
},
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
"loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
@@ -1173,7 +1182,7 @@
"a_key": "A String",
},
},
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
"fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
@@ -1204,6 +1213,7 @@
"state": "A String", # Output-only A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
"details": "A String", # Output-only Optional job state details, such as an error description if the state is <code>ERROR</code>.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
},
],
"hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.
@@ -1252,6 +1262,42 @@
"state": "A String", # Output-only A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
"details": "A String", # Output-only Optional job state details, such as an error description if the state is <code>ERROR</code>.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
+ },
+ "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "fileUris": [ # Optional HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
+ "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "labels": { # Optional The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
+ "a_key": "A String",
+ },
+ "placement": { # Cloud Dataproc job config. # Required Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # Output-only A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
+ "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # Optional The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.
},
"sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.
"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
@@ -1316,41 +1362,6 @@
"a_key": "A String",
},
},
- "placement": { # Cloud Dataproc job config. # Required Job information, including how, when, and where to run the job.
- "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
- "clusterUuid": "A String", # Output-only A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
- },
- "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
- "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
- "jobId": "A String", # Optional The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.
- },
- "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
- "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
- "A String",
- ],
- "loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
- "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
- "a_key": "A String",
- },
- },
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
- "A String",
- ],
- "fileUris": [ # Optional HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
- "A String",
- ],
- "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
- "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
- "A String",
- ],
- "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
- "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
- "a_key": "A String",
- },
- },
- "labels": { # Optional The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
- "a_key": "A String",
- },
"driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
"pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.
"mainPythonFileUri": "A String", # Required The HCFS URI of the main Python file to use as the driver. Must be a .py file.
@@ -1380,7 +1391,7 @@
},
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
"loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
@@ -1388,7 +1399,7 @@
"a_key": "A String",
},
},
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
"fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
@@ -1419,6 +1430,7 @@
"state": "A String", # Output-only A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
"details": "A String", # Output-only Optional job state details, such as an error description if the state is <code>ERROR</code>.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
},
],
"hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.
@@ -1464,6 +1476,42 @@
"state": "A String", # Output-only A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
"details": "A String", # Output-only Optional job state details, such as an error description if the state is <code>ERROR</code>.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
+ },
+ "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
+ "a_key": "A String",
+ },
+ },
+ "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "fileUris": [ # Optional HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
+ "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "labels": { # Optional The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
+ "a_key": "A String",
+ },
+ "placement": { # Cloud Dataproc job config. # Required Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # Output-only A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
+ "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # Optional The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.
},
"sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.
"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
@@ -1528,41 +1576,6 @@
"a_key": "A String",
},
},
- "placement": { # Cloud Dataproc job config. # Required Job information, including how, when, and where to run the job.
- "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
- "clusterUuid": "A String", # Output-only A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
- },
- "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
- "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
- "jobId": "A String", # Optional The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.
- },
- "hadoopJob": { # A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Job is a Hadoop job.
- "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
- "A String",
- ],
- "loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
- "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
- "a_key": "A String",
- },
- },
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
- "A String",
- ],
- "fileUris": [ # Optional HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
- "A String",
- ],
- "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
- "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
- "A String",
- ],
- "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
- "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
- "a_key": "A String",
- },
- },
- "labels": { # Optional The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.
- "a_key": "A String",
- },
"driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
"pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.
"mainPythonFileUri": "A String", # Required The HCFS URI of the main Python file to use as the driver. Must be a .py file.
@@ -1592,7 +1605,7 @@
},
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
"loggingConfig": { # The runtime logging config of the job. # Optional The runtime log config for job execution.
@@ -1600,7 +1613,7 @@
"a_key": "A String",
},
},
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
"fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
@@ -1631,6 +1644,7 @@
"state": "A String", # Output-only A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
"details": "A String", # Output-only Optional job state details, such as an error description if the state is <code>ERROR</code>.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
},
],
"hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.
diff --git a/docs/dyn/dataproc_v1alpha1.operations.html b/docs/dyn/dataproc_v1alpha1.operations.html
index 3c647d6..134a1ab 100644
--- a/docs/dyn/dataproc_v1alpha1.operations.html
+++ b/docs/dyn/dataproc_v1alpha1.operations.html
@@ -158,11 +158,6 @@
"metadata": { # Service-specific metadata associated with the operation.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the result is available. If false, the operation is still in progress.
- "response": { # The operation response. If the called method returns no data on success, the response is google.protobuf.Empty. If the called method is Get,Create or Update, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is TakeSnapshot(), the response type is TakeSnapshotResponse.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # The name of the operation resource, in the format projects/project_id/operations/operation_id
"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: # The error result of the operation in case of failure.
# Simple to use and understand for most users
# Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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:
@@ -179,6 +174,11 @@
},
],
},
+ "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the result is available. If false, the operation is still in progress.
+ "response": { # The operation response. If the called method returns no data on success, the response is google.protobuf.Empty. If the called method is Get,Create or Update, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is TakeSnapshot(), the response type is TakeSnapshotResponse.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The name of the operation resource, in the format projects/project_id/operations/operation_id
}</pre>
</div>
@@ -200,16 +200,12 @@
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 match the specified filter in the request.
{ # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
"metadata": { # Service-specific metadata associated with the operation.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the result is available. If false, the operation is still in progress.
- "response": { # The operation response. If the called method returns no data on success, the response is google.protobuf.Empty. If the called method is Get,Create or Update, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is TakeSnapshot(), the response type is TakeSnapshotResponse.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # The name of the operation resource, in the format projects/project_id/operations/operation_id
"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: # The error result of the operation in case of failure.
# Simple to use and understand for most users
# Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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:
@@ -226,9 +222,13 @@
},
],
},
+ "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the result is available. If false, the operation is still in progress.
+ "response": { # The operation response. If the called method returns no data on success, the response is google.protobuf.Empty. If the called method is Get,Create or Update, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is TakeSnapshot(), the response type is TakeSnapshotResponse.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The name of the operation resource, in the format projects/project_id/operations/operation_id
},
],
- "nextPageToken": "A String", # The standard List next-page token.
}</pre>
</div>
diff --git a/docs/dyn/dataproc_v1alpha1.projects.regions.clusters.html b/docs/dyn/dataproc_v1alpha1.projects.regions.clusters.html
index 3836287..7da774d 100644
--- a/docs/dyn/dataproc_v1alpha1.projects.regions.clusters.html
+++ b/docs/dyn/dataproc_v1alpha1.projects.regions.clusters.html
@@ -107,19 +107,20 @@
"status": { # The status of a cluster and its instances. # Output-only Cluster status.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
"configuration": { # The cluster configuration. # Required The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
+ "workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of worker node disk options.
+ "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
+ },
"softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # Optional The configuration settings for software inside the cluster.
"imageVersion": "A String", # Optional The version of software inside the cluster. It must match the regular expression 0-9+.0-9+. If unspecified it will default to latest version.
"properties": { # Optional The properties to set on daemon configuration files.Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
"a_key": "A String",
},
},
- "workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of worker node disk options.
- "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
- "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
- },
"workers": [ # Deprecated The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
"A String",
],
@@ -147,11 +148,11 @@
"gceConfiguration": { # Deprecated Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Deprecated The Google Compute Engine configuration settings for cluster resources.
"machineTypeUri": "A String", # Deprecated The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"networkUri": "A String", # Deprecated The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/project_id /zones/us-east1-a/default".
- "zoneUri": "A String", # Deprecated The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a".
+ "imageUri": "A String", # Deprecated The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"serviceAccountScopes": [ # Deprecated The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
- "imageUri": "A String", # Deprecated The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "zoneUri": "A String", # Deprecated The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a".
},
"masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of master node disk options.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
@@ -257,6 +258,7 @@
{ # The status of a cluster and its instances.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
],
@@ -275,11 +277,6 @@
"metadata": { # Service-specific metadata associated with the operation.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the result is available. If false, the operation is still in progress.
- "response": { # The operation response. If the called method returns no data on success, the response is google.protobuf.Empty. If the called method is Get,Create or Update, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is TakeSnapshot(), the response type is TakeSnapshotResponse.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # The name of the operation resource, in the format projects/project_id/operations/operation_id
"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: # The error result of the operation in case of failure.
# Simple to use and understand for most users
# Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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:
@@ -296,6 +293,11 @@
},
],
},
+ "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the result is available. If false, the operation is still in progress.
+ "response": { # The operation response. If the called method returns no data on success, the response is google.protobuf.Empty. If the called method is Get,Create or Update, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is TakeSnapshot(), the response type is TakeSnapshotResponse.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The name of the operation resource, in the format projects/project_id/operations/operation_id
}</pre>
</div>
@@ -319,11 +321,6 @@
"metadata": { # Service-specific metadata associated with the operation.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the result is available. If false, the operation is still in progress.
- "response": { # The operation response. If the called method returns no data on success, the response is google.protobuf.Empty. If the called method is Get,Create or Update, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is TakeSnapshot(), the response type is TakeSnapshotResponse.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # The name of the operation resource, in the format projects/project_id/operations/operation_id
"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: # The error result of the operation in case of failure.
# Simple to use and understand for most users
# Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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:
@@ -340,6 +337,11 @@
},
],
},
+ "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the result is available. If false, the operation is still in progress.
+ "response": { # The operation response. If the called method returns no data on success, the response is google.protobuf.Empty. If the called method is Get,Create or Update, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is TakeSnapshot(), the response type is TakeSnapshotResponse.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The name of the operation resource, in the format projects/project_id/operations/operation_id
}</pre>
</div>
@@ -363,19 +365,20 @@
"status": { # The status of a cluster and its instances. # Output-only Cluster status.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
"configuration": { # The cluster configuration. # Required The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
+ "workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of worker node disk options.
+ "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
+ },
"softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # Optional The configuration settings for software inside the cluster.
"imageVersion": "A String", # Optional The version of software inside the cluster. It must match the regular expression 0-9+.0-9+. If unspecified it will default to latest version.
"properties": { # Optional The properties to set on daemon configuration files.Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
"a_key": "A String",
},
},
- "workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of worker node disk options.
- "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
- "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
- },
"workers": [ # Deprecated The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
"A String",
],
@@ -403,11 +406,11 @@
"gceConfiguration": { # Deprecated Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Deprecated The Google Compute Engine configuration settings for cluster resources.
"machineTypeUri": "A String", # Deprecated The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"networkUri": "A String", # Deprecated The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/project_id /zones/us-east1-a/default".
- "zoneUri": "A String", # Deprecated The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a".
+ "imageUri": "A String", # Deprecated The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"serviceAccountScopes": [ # Deprecated The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
- "imageUri": "A String", # Deprecated The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "zoneUri": "A String", # Deprecated The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a".
},
"masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of master node disk options.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
@@ -513,6 +516,7 @@
{ # The status of a cluster and its instances.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
],
@@ -545,19 +549,20 @@
"status": { # The status of a cluster and its instances. # Output-only Cluster status.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
"configuration": { # The cluster configuration. # Required The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
+ "workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of worker node disk options.
+ "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
+ },
"softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # Optional The configuration settings for software inside the cluster.
"imageVersion": "A String", # Optional The version of software inside the cluster. It must match the regular expression 0-9+.0-9+. If unspecified it will default to latest version.
"properties": { # Optional The properties to set on daemon configuration files.Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
"a_key": "A String",
},
},
- "workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of worker node disk options.
- "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
- "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
- },
"workers": [ # Deprecated The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
"A String",
],
@@ -585,11 +590,11 @@
"gceConfiguration": { # Deprecated Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Deprecated The Google Compute Engine configuration settings for cluster resources.
"machineTypeUri": "A String", # Deprecated The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"networkUri": "A String", # Deprecated The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/project_id /zones/us-east1-a/default".
- "zoneUri": "A String", # Deprecated The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a".
+ "imageUri": "A String", # Deprecated The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"serviceAccountScopes": [ # Deprecated The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
- "imageUri": "A String", # Deprecated The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "zoneUri": "A String", # Deprecated The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a".
},
"masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of master node disk options.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
@@ -695,6 +700,7 @@
{ # The status of a cluster and its instances.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
],
@@ -733,19 +739,20 @@
"status": { # The status of a cluster and its instances. # Output-only Cluster status.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
"configuration": { # The cluster configuration. # Required The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
+ "workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of worker node disk options.
+ "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
+ "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
+ },
"softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # Optional The configuration settings for software inside the cluster.
"imageVersion": "A String", # Optional The version of software inside the cluster. It must match the regular expression 0-9+.0-9+. If unspecified it will default to latest version.
"properties": { # Optional The properties to set on daemon configuration files.Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
"a_key": "A String",
},
},
- "workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of worker node disk options.
- "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
- "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
- },
"workers": [ # Deprecated The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
"A String",
],
@@ -773,11 +780,11 @@
"gceConfiguration": { # Deprecated Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Deprecated The Google Compute Engine configuration settings for cluster resources.
"machineTypeUri": "A String", # Deprecated The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2".
"networkUri": "A String", # Deprecated The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/project_id /zones/us-east1-a/default".
- "zoneUri": "A String", # Deprecated The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a".
+ "imageUri": "A String", # Deprecated The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"serviceAccountScopes": [ # Deprecated The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
- "imageUri": "A String", # Deprecated The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
+ "zoneUri": "A String", # Deprecated The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/project_id /zones/us-east1-a".
},
"masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Deprecated The configuration settings of master node disk options.
"numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
@@ -883,6 +890,7 @@
{ # The status of a cluster and its instances.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
],
@@ -910,11 +918,6 @@
"metadata": { # Service-specific metadata associated with the operation.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the result is available. If false, the operation is still in progress.
- "response": { # The operation response. If the called method returns no data on success, the response is google.protobuf.Empty. If the called method is Get,Create or Update, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is TakeSnapshot(), the response type is TakeSnapshotResponse.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "name": "A String", # The name of the operation resource, in the format projects/project_id/operations/operation_id
"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: # The error result of the operation in case of failure.
# Simple to use and understand for most users
# Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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:
@@ -931,6 +934,11 @@
},
],
},
+ "done": True or False, # Indicates if the operation is done. If true, the operation is complete and the result is available. If false, the operation is still in progress.
+ "response": { # The operation response. If the called method returns no data on success, the response is google.protobuf.Empty. If the called method is Get,Create or Update, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is TakeSnapshot(), the response type is TakeSnapshotResponse.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The name of the operation resource, in the format projects/project_id/operations/operation_id
}</pre>
</div>
diff --git a/docs/dyn/dataproc_v1alpha1.projects.regions.jobs.html b/docs/dyn/dataproc_v1alpha1.projects.regions.jobs.html
index 298b4ee..eb57c6c 100644
--- a/docs/dyn/dataproc_v1alpha1.projects.regions.jobs.html
+++ b/docs/dyn/dataproc_v1alpha1.projects.regions.jobs.html
@@ -121,12 +121,48 @@
{ # A Cloud Dataproc job resource.
"status": { # Cloud Dataproc job status. # Output-only The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"startTime": "A String", # The time when the server started the job.
"state": "A String", # Required A state message specifying the overall job state.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
"insertTime": "A String", # The time of the job request.
"endTime": "A String", # The time when the job completed.
},
+ "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
+ "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job.
+ "a_key": "A String",
+ },
+ "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
+ "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 100 characters.
+ },
"sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
"scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
@@ -158,26 +194,21 @@
"a_key": "A String",
},
},
- "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job.
- "a_key": "A String",
- },
"yarnApplications": [ # Output-only The collection of Yarn applications spun up by this job.
{ # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.
"progress": 3.14, # Required The numerical progress of the application, from 1 to 100.
"state": "A String", # Required The application state.
- "trackingUrl": "A String", # Optional The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
"name": "A String", # Required The application name.
+ "trackingUrl": "A String", # Optional The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
},
],
- "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
- "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
- "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 100 characters.
- },
- "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
- "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
- "A String",
- ],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
+ "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+ "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -185,28 +216,6 @@
"a_key": "A String",
},
},
- "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
- "A String",
- ],
- "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
- "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
- "A String",
- ],
- "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
- "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
- "a_key": "A String",
- },
- },
- "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
- "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
- "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
- "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
- "a_key": "A String",
- },
- "continueOnFailure": True or False, # Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
- "A String",
- ],
"queryList": { # A list of queries to run on a cluster. # A list of queries.
"queries": [ # Required The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
# "hiveJob": {
@@ -221,11 +230,7 @@
"A String",
],
},
- "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
- "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
- "a_key": "A String",
- },
- },
+ "continueOnFailure": True or False, # Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
"properties": { # Optional A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
"a_key": "A String",
},
@@ -260,10 +265,10 @@
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
"sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -287,13 +292,10 @@
"scheduling": { # Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release. # Optional Job scheduling configuration.
"maxFailuresPerHour": 42, # Optional Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.
},
- "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
- "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
- "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
- },
"statusHistory": [ # Output-only The previous job status.
{ # Cloud Dataproc job status.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"startTime": "A String", # The time when the server started the job.
"state": "A String", # Required A state message specifying the overall job state.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
@@ -351,12 +353,48 @@
{ # A Cloud Dataproc job resource.
"status": { # Cloud Dataproc job status. # Output-only The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"startTime": "A String", # The time when the server started the job.
"state": "A String", # Required A state message specifying the overall job state.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
"insertTime": "A String", # The time of the job request.
"endTime": "A String", # The time when the job completed.
},
+ "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
+ "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job.
+ "a_key": "A String",
+ },
+ "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
+ "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 100 characters.
+ },
"sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
"scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
@@ -388,26 +426,21 @@
"a_key": "A String",
},
},
- "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job.
- "a_key": "A String",
- },
"yarnApplications": [ # Output-only The collection of Yarn applications spun up by this job.
{ # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.
"progress": 3.14, # Required The numerical progress of the application, from 1 to 100.
"state": "A String", # Required The application state.
- "trackingUrl": "A String", # Optional The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
"name": "A String", # Required The application name.
+ "trackingUrl": "A String", # Optional The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
},
],
- "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
- "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
- "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 100 characters.
- },
- "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
- "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
- "A String",
- ],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
+ "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+ "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -415,28 +448,6 @@
"a_key": "A String",
},
},
- "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
- "A String",
- ],
- "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
- "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
- "A String",
- ],
- "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
- "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
- "a_key": "A String",
- },
- },
- "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
- "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
- "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
- "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
- "a_key": "A String",
- },
- "continueOnFailure": True or False, # Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
- "A String",
- ],
"queryList": { # A list of queries to run on a cluster. # A list of queries.
"queries": [ # Required The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
# "hiveJob": {
@@ -451,11 +462,7 @@
"A String",
],
},
- "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
- "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
- "a_key": "A String",
- },
- },
+ "continueOnFailure": True or False, # Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
"properties": { # Optional A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
"a_key": "A String",
},
@@ -490,10 +497,10 @@
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
"sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -517,13 +524,10 @@
"scheduling": { # Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release. # Optional Job scheduling configuration.
"maxFailuresPerHour": 42, # Optional Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.
},
- "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
- "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
- "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
- },
"statusHistory": [ # Output-only The previous job status.
{ # Cloud Dataproc job status.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"startTime": "A String", # The time when the server started the job.
"state": "A String", # Required A state message specifying the overall job state.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
@@ -581,12 +585,48 @@
{ # A Cloud Dataproc job resource.
"status": { # Cloud Dataproc job status. # Output-only The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"startTime": "A String", # The time when the server started the job.
"state": "A String", # Required A state message specifying the overall job state.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
"insertTime": "A String", # The time of the job request.
"endTime": "A String", # The time when the job completed.
},
+ "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
+ "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job.
+ "a_key": "A String",
+ },
+ "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
+ "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 100 characters.
+ },
"sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
"scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
@@ -618,26 +658,21 @@
"a_key": "A String",
},
},
- "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job.
- "a_key": "A String",
- },
"yarnApplications": [ # Output-only The collection of Yarn applications spun up by this job.
{ # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.
"progress": 3.14, # Required The numerical progress of the application, from 1 to 100.
"state": "A String", # Required The application state.
- "trackingUrl": "A String", # Optional The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
"name": "A String", # Required The application name.
+ "trackingUrl": "A String", # Optional The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
},
],
- "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
- "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
- "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 100 characters.
- },
- "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
- "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
- "A String",
- ],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
+ "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+ "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -645,28 +680,6 @@
"a_key": "A String",
},
},
- "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
- "A String",
- ],
- "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
- "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
- "A String",
- ],
- "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
- "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
- "a_key": "A String",
- },
- },
- "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
- "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
- "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
- "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
- "a_key": "A String",
- },
- "continueOnFailure": True or False, # Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
- "A String",
- ],
"queryList": { # A list of queries to run on a cluster. # A list of queries.
"queries": [ # Required The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
# "hiveJob": {
@@ -681,11 +694,7 @@
"A String",
],
},
- "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
- "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
- "a_key": "A String",
- },
- },
+ "continueOnFailure": True or False, # Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
"properties": { # Optional A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
"a_key": "A String",
},
@@ -720,10 +729,10 @@
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
"sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -747,13 +756,10 @@
"scheduling": { # Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release. # Optional Job scheduling configuration.
"maxFailuresPerHour": 42, # Optional Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.
},
- "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
- "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
- "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
- },
"statusHistory": [ # Output-only The previous job status.
{ # Cloud Dataproc job status.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"startTime": "A String", # The time when the server started the job.
"state": "A String", # Required A state message specifying the overall job state.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
@@ -824,12 +830,48 @@
{ # A Cloud Dataproc job resource.
"status": { # Cloud Dataproc job status. # Output-only The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"startTime": "A String", # The time when the server started the job.
"state": "A String", # Required A state message specifying the overall job state.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
"insertTime": "A String", # The time of the job request.
"endTime": "A String", # The time when the job completed.
},
+ "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
+ "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job.
+ "a_key": "A String",
+ },
+ "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
+ "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 100 characters.
+ },
"sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
"scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
@@ -861,26 +903,21 @@
"a_key": "A String",
},
},
- "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job.
- "a_key": "A String",
- },
"yarnApplications": [ # Output-only The collection of Yarn applications spun up by this job.
{ # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.
"progress": 3.14, # Required The numerical progress of the application, from 1 to 100.
"state": "A String", # Required The application state.
- "trackingUrl": "A String", # Optional The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
"name": "A String", # Required The application name.
+ "trackingUrl": "A String", # Optional The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
},
],
- "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
- "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
- "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 100 characters.
- },
- "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
- "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
- "A String",
- ],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
+ "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+ "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -888,28 +925,6 @@
"a_key": "A String",
},
},
- "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
- "A String",
- ],
- "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
- "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
- "A String",
- ],
- "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
- "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
- "a_key": "A String",
- },
- },
- "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
- "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
- "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
- "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
- "a_key": "A String",
- },
- "continueOnFailure": True or False, # Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
- "A String",
- ],
"queryList": { # A list of queries to run on a cluster. # A list of queries.
"queries": [ # Required The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
# "hiveJob": {
@@ -924,11 +939,7 @@
"A String",
],
},
- "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
- "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
- "a_key": "A String",
- },
- },
+ "continueOnFailure": True or False, # Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
"properties": { # Optional A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
"a_key": "A String",
},
@@ -963,10 +974,10 @@
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
"sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -990,13 +1001,10 @@
"scheduling": { # Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release. # Optional Job scheduling configuration.
"maxFailuresPerHour": 42, # Optional Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.
},
- "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
- "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
- "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
- },
"statusHistory": [ # Output-only The previous job status.
{ # Cloud Dataproc job status.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"startTime": "A String", # The time when the server started the job.
"state": "A String", # Required A state message specifying the overall job state.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
@@ -1065,12 +1073,48 @@
{ # A Cloud Dataproc job resource.
"status": { # Cloud Dataproc job status. # Output-only The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"startTime": "A String", # The time when the server started the job.
"state": "A String", # Required A state message specifying the overall job state.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
"insertTime": "A String", # The time of the job request.
"endTime": "A String", # The time when the job completed.
},
+ "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
+ "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job.
+ "a_key": "A String",
+ },
+ "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
+ "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 100 characters.
+ },
"sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
"scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
@@ -1102,26 +1146,21 @@
"a_key": "A String",
},
},
- "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job.
- "a_key": "A String",
- },
"yarnApplications": [ # Output-only The collection of Yarn applications spun up by this job.
{ # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.
"progress": 3.14, # Required The numerical progress of the application, from 1 to 100.
"state": "A String", # Required The application state.
- "trackingUrl": "A String", # Optional The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
"name": "A String", # Required The application name.
+ "trackingUrl": "A String", # Optional The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
},
],
- "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
- "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
- "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 100 characters.
- },
- "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
- "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
- "A String",
- ],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
+ "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+ "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -1129,28 +1168,6 @@
"a_key": "A String",
},
},
- "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
- "A String",
- ],
- "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
- "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
- "A String",
- ],
- "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
- "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
- "a_key": "A String",
- },
- },
- "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
- "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
- "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
- "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
- "a_key": "A String",
- },
- "continueOnFailure": True or False, # Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
- "A String",
- ],
"queryList": { # A list of queries to run on a cluster. # A list of queries.
"queries": [ # Required The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
# "hiveJob": {
@@ -1165,11 +1182,7 @@
"A String",
],
},
- "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
- "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
- "a_key": "A String",
- },
- },
+ "continueOnFailure": True or False, # Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
"properties": { # Optional A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
"a_key": "A String",
},
@@ -1204,10 +1217,10 @@
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
"sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -1231,13 +1244,10 @@
"scheduling": { # Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release. # Optional Job scheduling configuration.
"maxFailuresPerHour": 42, # Optional Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.
},
- "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
- "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
- "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
- },
"statusHistory": [ # Output-only The previous job status.
{ # Cloud Dataproc job status.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"startTime": "A String", # The time when the server started the job.
"state": "A String", # Required A state message specifying the overall job state.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
@@ -1287,12 +1297,48 @@
{ # A Cloud Dataproc job resource.
"status": { # Cloud Dataproc job status. # Output-only The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"startTime": "A String", # The time when the server started the job.
"state": "A String", # Required A state message specifying the overall job state.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
"insertTime": "A String", # The time of the job request.
"endTime": "A String", # The time when the job completed.
},
+ "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
+ "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job.
+ "a_key": "A String",
+ },
+ "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
+ "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 100 characters.
+ },
"sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
"scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
@@ -1324,26 +1370,21 @@
"a_key": "A String",
},
},
- "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job.
- "a_key": "A String",
- },
"yarnApplications": [ # Output-only The collection of Yarn applications spun up by this job.
{ # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.
"progress": 3.14, # Required The numerical progress of the application, from 1 to 100.
"state": "A String", # Required The application state.
- "trackingUrl": "A String", # Optional The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
"name": "A String", # Required The application name.
+ "trackingUrl": "A String", # Optional The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
},
],
- "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
- "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
- "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 100 characters.
- },
- "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
- "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
- "A String",
- ],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
+ "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+ "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -1351,28 +1392,6 @@
"a_key": "A String",
},
},
- "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
- "A String",
- ],
- "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
- "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
- "A String",
- ],
- "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
- "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
- "a_key": "A String",
- },
- },
- "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
- "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
- "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
- "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
- "a_key": "A String",
- },
- "continueOnFailure": True or False, # Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
- "A String",
- ],
"queryList": { # A list of queries to run on a cluster. # A list of queries.
"queries": [ # Required The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
# "hiveJob": {
@@ -1387,11 +1406,7 @@
"A String",
],
},
- "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
- "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
- "a_key": "A String",
- },
- },
+ "continueOnFailure": True or False, # Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
"properties": { # Optional A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
"a_key": "A String",
},
@@ -1426,10 +1441,10 @@
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
"sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -1453,13 +1468,10 @@
"scheduling": { # Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release. # Optional Job scheduling configuration.
"maxFailuresPerHour": 42, # Optional Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.
},
- "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
- "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
- "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
- },
"statusHistory": [ # Output-only The previous job status.
{ # Cloud Dataproc job status.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"startTime": "A String", # The time when the server started the job.
"state": "A String", # Required A state message specifying the overall job state.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
@@ -1512,12 +1524,48 @@
"job": { # A Cloud Dataproc job resource. # Required The job resource.
"status": { # Cloud Dataproc job status. # Output-only The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"startTime": "A String", # The time when the server started the job.
"state": "A String", # Required A state message specifying the overall job state.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
"insertTime": "A String", # The time of the job request.
"endTime": "A String", # The time when the job completed.
},
+ "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
+ "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job.
+ "a_key": "A String",
+ },
+ "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
+ "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 100 characters.
+ },
"sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
"scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
@@ -1549,26 +1597,21 @@
"a_key": "A String",
},
},
- "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job.
- "a_key": "A String",
- },
"yarnApplications": [ # Output-only The collection of Yarn applications spun up by this job.
{ # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.
"progress": 3.14, # Required The numerical progress of the application, from 1 to 100.
"state": "A String", # Required The application state.
- "trackingUrl": "A String", # Optional The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
"name": "A String", # Required The application name.
+ "trackingUrl": "A String", # Optional The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
},
],
- "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
- "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
- "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 100 characters.
- },
- "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
- "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
- "A String",
- ],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
+ "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+ "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -1576,28 +1619,6 @@
"a_key": "A String",
},
},
- "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
- "A String",
- ],
- "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
- "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
- "A String",
- ],
- "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
- "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
- "a_key": "A String",
- },
- },
- "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
- "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
- "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
- "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
- "a_key": "A String",
- },
- "continueOnFailure": True or False, # Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
- "A String",
- ],
"queryList": { # A list of queries to run on a cluster. # A list of queries.
"queries": [ # Required The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
# "hiveJob": {
@@ -1612,11 +1633,7 @@
"A String",
],
},
- "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
- "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
- "a_key": "A String",
- },
- },
+ "continueOnFailure": True or False, # Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
"properties": { # Optional A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
"a_key": "A String",
},
@@ -1651,10 +1668,10 @@
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
"sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -1678,13 +1695,10 @@
"scheduling": { # Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release. # Optional Job scheduling configuration.
"maxFailuresPerHour": 42, # Optional Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.
},
- "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
- "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
- "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
- },
"statusHistory": [ # Output-only The previous job status.
{ # Cloud Dataproc job status.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"startTime": "A String", # The time when the server started the job.
"state": "A String", # Required A state message specifying the overall job state.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
@@ -1734,12 +1748,48 @@
{ # A Cloud Dataproc job resource.
"status": { # Cloud Dataproc job status. # Output-only The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"startTime": "A String", # The time when the server started the job.
"state": "A String", # Required A state message specifying the overall job state.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
"insertTime": "A String", # The time of the job request.
"endTime": "A String", # The time when the job completed.
},
+ "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "A String",
+ ],
+ "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
+ "A String",
+ ],
+ "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
+ "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
+ "a_key": "A String",
+ },
+ },
+ "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
+ "A String",
+ ],
+ "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
+ "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
+ "A String",
+ ],
+ "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
+ "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
+ "a_key": "A String",
+ },
+ },
+ "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job.
+ "a_key": "A String",
+ },
+ "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
+ "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
+ "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
+ },
+ "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
+ "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
+ "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 100 characters.
+ },
"sparkSqlJob": { # A Cloud Dataproc job for running Spark SQL queries. # Job is a SparkSql job.
"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
"scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
@@ -1771,26 +1821,21 @@
"a_key": "A String",
},
},
- "labels": { # Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given job.
- "a_key": "A String",
- },
"yarnApplications": [ # Output-only The collection of Yarn applications spun up by this job.
{ # A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.
"progress": 3.14, # Required The numerical progress of the application, from 1 to 100.
"state": "A String", # Required The application state.
- "trackingUrl": "A String", # Optional The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
"name": "A String", # Required The application name.
+ "trackingUrl": "A String", # Optional The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
},
],
- "reference": { # Encapsulates the full scoping used to reference a job. # Optional The fully-qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
- "projectId": "A String", # Required The ID of the Google Cloud Platform project that the job belongs to.
- "jobId": "A String", # Required The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 100 characters.
- },
- "hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
- "jarFileUris": [ # Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
- "A String",
- ],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
+ "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
+ "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
+ "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
+ "a_key": "A String",
+ },
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -1798,28 +1843,6 @@
"a_key": "A String",
},
},
- "fileUris": [ # Optional HCFS URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
- "A String",
- ],
- "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
- "archiveUris": [ # Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
- "A String",
- ],
- "mainJarFileUri": "A String", # The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar
- "properties": { # Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
- "a_key": "A String",
- },
- },
- "driverOutputUri": "A String", # Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, <code>gs://sysbucket123/foo-cluster/jobid-123/driver/output</code>.
- "pigJob": { # A Cloud Dataproc job for running Pig queries on YARN. # Job is a Pig job.
- "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
- "scriptVariables": { # Optional Mapping of query variable names to values (equivalent to the Pig command: "name=value").
- "a_key": "A String",
- },
- "continueOnFailure": True or False, # Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
- "A String",
- ],
"queryList": { # A list of queries to run on a cluster. # A list of queries.
"queries": [ # Required The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
# "hiveJob": {
@@ -1834,11 +1857,7 @@
"A String",
],
},
- "loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
- "driverLogLevels": { # The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG
- "a_key": "A String",
- },
- },
+ "continueOnFailure": True or False, # Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
"properties": { # Optional A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
"a_key": "A String",
},
@@ -1873,10 +1892,10 @@
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
"sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -1900,13 +1919,10 @@
"scheduling": { # Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release. # Optional Job scheduling configuration.
"maxFailuresPerHour": 42, # Optional Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.
},
- "placement": { # Cloud Dataproc job configuration. # Required Job information, including how, when, and where to run the job.
- "clusterName": "A String", # Required The name of the cluster where the job will be submitted.
- "clusterUuid": "A String", # Output-only A cluster UUID generated by the Dataproc service when the job is submitted.
- },
"statusHistory": [ # Output-only The previous job status.
{ # Cloud Dataproc job status.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"startTime": "A String", # The time when the server started the job.
"state": "A String", # Required A state message specifying the overall job state.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
diff --git a/docs/dyn/dataproc_v1beta1.operations.html b/docs/dyn/dataproc_v1beta1.operations.html
index 799497c..bf32d6a 100644
--- a/docs/dyn/dataproc_v1beta1.operations.html
+++ b/docs/dyn/dataproc_v1beta1.operations.html
@@ -200,6 +200,7 @@
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.
@@ -228,7 +229,6 @@
"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.
},
],
- "nextPageToken": "A String", # The standard List next-page token.
}</pre>
</div>
diff --git a/docs/dyn/dataproc_v1beta1.projects.clusters.html b/docs/dyn/dataproc_v1beta1.projects.clusters.html
index d03a939..8a4fe9e 100644
--- a/docs/dyn/dataproc_v1beta1.projects.clusters.html
+++ b/docs/dyn/dataproc_v1beta1.projects.clusters.html
@@ -109,8 +109,31 @@
"status": { # The status of a cluster and its instances. # Output-only Cluster status.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
+ "statusHistory": [ # Output-only Previous cluster statuses.
+ { # The status of a cluster and its instances.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ ],
+ "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+ "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+ "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
+ "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
+ "a_key": "A String",
+ },
+ "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
+ "yarnMetrics": { # The YARN metrics.
+ "a_key": "A String",
+ },
+ "hdfsMetrics": { # The HDFS metrics.
+ "a_key": "A String",
+ },
+ },
"configuration": { # The cluster configuration. # Required The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
"softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # Optional The configuration settings for software inside the cluster.
"imageVersion": "A String", # Optional The version of software inside the cluster. It must match the regular expression [0-9]+\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning).
@@ -219,27 +242,6 @@
},
},
},
- "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
- "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
- "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
- "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
- "a_key": "A String",
- },
- "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
- "yarnMetrics": { # The YARN metrics.
- "a_key": "A String",
- },
- "hdfsMetrics": { # The HDFS metrics.
- "a_key": "A String",
- },
- },
- "statusHistory": [ # Output-only Previous cluster statuses.
- { # The status of a cluster and its instances.
- "state": "A String", # The cluster's state.
- "stateStartTime": "A String", # Time when this state was entered.
- "detail": "A String", # Optional details of cluster's state.
- },
- ],
}
x__xgafv: string, V1 error format.
@@ -389,8 +391,31 @@
"status": { # The status of a cluster and its instances. # Output-only Cluster status.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
+ "statusHistory": [ # Output-only Previous cluster statuses.
+ { # The status of a cluster and its instances.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ ],
+ "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+ "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+ "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
+ "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
+ "a_key": "A String",
+ },
+ "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
+ "yarnMetrics": { # The YARN metrics.
+ "a_key": "A String",
+ },
+ "hdfsMetrics": { # The HDFS metrics.
+ "a_key": "A String",
+ },
+ },
"configuration": { # The cluster configuration. # Required The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
"softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # Optional The configuration settings for software inside the cluster.
"imageVersion": "A String", # Optional The version of software inside the cluster. It must match the regular expression [0-9]+\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning).
@@ -499,27 +524,6 @@
},
},
},
- "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
- "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
- "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
- "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
- "a_key": "A String",
- },
- "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
- "yarnMetrics": { # The YARN metrics.
- "a_key": "A String",
- },
- "hdfsMetrics": { # The HDFS metrics.
- "a_key": "A String",
- },
- },
- "statusHistory": [ # Output-only Previous cluster statuses.
- { # The status of a cluster and its instances.
- "state": "A String", # The cluster's state.
- "stateStartTime": "A String", # Time when this state was entered.
- "detail": "A String", # Optional details of cluster's state.
- },
- ],
}</pre>
</div>
@@ -547,8 +551,31 @@
"status": { # The status of a cluster and its instances. # Output-only Cluster status.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
+ "statusHistory": [ # Output-only Previous cluster statuses.
+ { # The status of a cluster and its instances.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ ],
+ "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+ "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+ "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
+ "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
+ "a_key": "A String",
+ },
+ "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
+ "yarnMetrics": { # The YARN metrics.
+ "a_key": "A String",
+ },
+ "hdfsMetrics": { # The HDFS metrics.
+ "a_key": "A String",
+ },
+ },
"configuration": { # The cluster configuration. # Required The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
"softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # Optional The configuration settings for software inside the cluster.
"imageVersion": "A String", # Optional The version of software inside the cluster. It must match the regular expression [0-9]+\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning).
@@ -657,27 +684,6 @@
},
},
},
- "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
- "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
- "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
- "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
- "a_key": "A String",
- },
- "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
- "yarnMetrics": { # The YARN metrics.
- "a_key": "A String",
- },
- "hdfsMetrics": { # The HDFS metrics.
- "a_key": "A String",
- },
- },
- "statusHistory": [ # Output-only Previous cluster statuses.
- { # The status of a cluster and its instances.
- "state": "A String", # The cluster's state.
- "stateStartTime": "A String", # Time when this state was entered.
- "detail": "A String", # Optional details of cluster's state.
- },
- ],
},
],
}</pre>
@@ -711,8 +717,31 @@
"status": { # The status of a cluster and its instances. # Output-only Cluster status.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
"detail": "A String", # Optional details of cluster's state.
},
+ "statusHistory": [ # Output-only Previous cluster statuses.
+ { # The status of a cluster and its instances.
+ "state": "A String", # The cluster's state.
+ "stateStartTime": "A String", # Time when this state was entered.
+ "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
+ "detail": "A String", # Optional details of cluster's state.
+ },
+ ],
+ "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
+ "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
+ "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
+ "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
+ "a_key": "A String",
+ },
+ "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
+ "yarnMetrics": { # The YARN metrics.
+ "a_key": "A String",
+ },
+ "hdfsMetrics": { # The HDFS metrics.
+ "a_key": "A String",
+ },
+ },
"configuration": { # The cluster configuration. # Required The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
"softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # Optional The configuration settings for software inside the cluster.
"imageVersion": "A String", # Optional The version of software inside the cluster. It must match the regular expression [0-9]+\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning).
@@ -821,27 +850,6 @@
},
},
},
- "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
- "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
- "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
- "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
- "a_key": "A String",
- },
- "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
- "yarnMetrics": { # The YARN metrics.
- "a_key": "A String",
- },
- "hdfsMetrics": { # The HDFS metrics.
- "a_key": "A String",
- },
- },
- "statusHistory": [ # Output-only Previous cluster statuses.
- { # The status of a cluster and its instances.
- "state": "A String", # The cluster's state.
- "stateStartTime": "A String", # Time when this state was entered.
- "detail": "A String", # Optional details of cluster's state.
- },
- ],
}
updateMask: string, Required Specifies the path, relative to <code>Cluster</code>, of the field to update. For example, to change the number of workers in a cluster to 5, the <code>update_mask</code> parameter would be specified as <code>configuration.worker_configuration.num_instances</code>, and the PATCH request body would specify the new value, as follows:
diff --git a/docs/dyn/dataproc_v1beta1.projects.jobs.html b/docs/dyn/dataproc_v1beta1.projects.jobs.html
index fc05bfe..c9b5277 100644
--- a/docs/dyn/dataproc_v1beta1.projects.jobs.html
+++ b/docs/dyn/dataproc_v1beta1.projects.jobs.html
@@ -121,6 +121,7 @@
"status": { # Cloud Dataproc job status. # Output-only The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
"state": "A String", # Required A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
},
"hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
@@ -232,10 +233,10 @@
"driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
"pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
"mainPythonFileUri": "A String", # Required The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -259,10 +260,10 @@
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
"sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -290,6 +291,7 @@
{ # Cloud Dataproc job status.
"state": "A String", # Required A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
},
],
@@ -366,6 +368,7 @@
"status": { # Cloud Dataproc job status. # Output-only The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
"state": "A String", # Required A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
},
"hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
@@ -477,10 +480,10 @@
"driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
"pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
"mainPythonFileUri": "A String", # Required The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -504,10 +507,10 @@
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
"sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -535,6 +538,7 @@
{ # Cloud Dataproc job status.
"state": "A String", # Required A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
},
],
@@ -595,6 +599,7 @@
"status": { # Cloud Dataproc job status. # Output-only The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
"state": "A String", # Required A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
},
"hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
@@ -706,10 +711,10 @@
"driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
"pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
"mainPythonFileUri": "A String", # Required The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -733,10 +738,10 @@
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
"sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -764,6 +769,7 @@
{ # Cloud Dataproc job status.
"state": "A String", # Required A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
},
],
@@ -828,6 +834,7 @@
"status": { # Cloud Dataproc job status. # Output-only The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
"state": "A String", # Required A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
},
"hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
@@ -939,10 +946,10 @@
"driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
"pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
"mainPythonFileUri": "A String", # Required The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -966,10 +973,10 @@
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
"sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -997,6 +1004,7 @@
{ # Cloud Dataproc job status.
"state": "A String", # Required A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
},
],
@@ -1043,6 +1051,7 @@
"status": { # Cloud Dataproc job status. # Output-only The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
"state": "A String", # Required A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
},
"hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
@@ -1154,10 +1163,10 @@
"driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
"pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
"mainPythonFileUri": "A String", # Required The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -1181,10 +1190,10 @@
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
"sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -1212,6 +1221,7 @@
{ # Cloud Dataproc job status.
"state": "A String", # Required A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
},
],
@@ -1260,6 +1270,7 @@
"status": { # Cloud Dataproc job status. # Output-only The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
"state": "A String", # Required A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
},
"hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
@@ -1371,10 +1382,10 @@
"driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
"pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
"mainPythonFileUri": "A String", # Required The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -1398,10 +1409,10 @@
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
"sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -1429,6 +1440,7 @@
{ # Cloud Dataproc job status.
"state": "A String", # Required A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
},
],
@@ -1475,6 +1487,7 @@
"status": { # Cloud Dataproc job status. # Output-only The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
"state": "A String", # Required A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
},
"hadoopJob": { # A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN. # Job is a Hadoop job.
@@ -1586,10 +1599,10 @@
"driverOutputResourceUri": "A String", # Output-only A URI pointing to the location of the stdout of the job's driver program.
"pysparkJob": { # A Cloud Dataproc job for running PySpark applications on YARN. # Job is a Pyspark job.
"mainPythonFileUri": "A String", # Required The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -1613,10 +1626,10 @@
"driverControlFilesUri": "A String", # Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.
"driverInputResourceUri": "A String", # Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.
"sparkJob": { # A Cloud Dataproc job for running Spark applications on YARN. # Job is a Spark job.
- "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
+ "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
"A String",
],
- "args": [ # Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
+ "jarFileUris": [ # Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
"A String",
],
"loggingConfiguration": { # The runtime logging configuration of the job. # Optional The runtime log configuration for job execution.
@@ -1644,6 +1657,7 @@
{ # Cloud Dataproc job status.
"state": "A String", # Required A state message specifying the overall job state.
"stateStartTime": "A String", # Output-only The time when this state was entered.
+ "substate": "A String", # Output-only Additional state information, which includes status reported by the agent.
"details": "A String", # Optional Job state details, such as an error description if the state is <code>ERROR</code>.
},
],
diff --git a/docs/dyn/deploymentmanager_alpha.deployments.html b/docs/dyn/deploymentmanager_alpha.deployments.html
index 797201f..dd0e8a1 100644
--- a/docs/dyn/deploymentmanager_alpha.deployments.html
+++ b/docs/dyn/deploymentmanager_alpha.deployments.html
@@ -359,7 +359,7 @@
#
# For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
- { # Specifies the audit configuration for a service. It consists of which permission types are logged, and what identities, if any, are exempted from logging. An AuditConifg must have one or more AuditLogConfigs.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice@googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
"exemptedMembers": [
@@ -377,7 +377,7 @@
"logType": "A String", # The log type that this config enables.
},
],
- "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `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.
@@ -896,7 +896,7 @@
#
# For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
- { # Specifies the audit configuration for a service. It consists of which permission types are logged, and what identities, if any, are exempted from logging. An AuditConifg must have one or more AuditLogConfigs.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice@googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
"exemptedMembers": [
@@ -914,7 +914,7 @@
"logType": "A String", # The log type that this config enables.
},
],
- "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `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.
@@ -997,7 +997,7 @@
#
# For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
- { # Specifies the audit configuration for a service. It consists of which permission types are logged, and what identities, if any, are exempted from logging. An AuditConifg must have one or more AuditLogConfigs.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice@googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
"exemptedMembers": [
@@ -1015,7 +1015,7 @@
"logType": "A String", # The log type that this config enables.
},
],
- "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `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.
diff --git a/docs/dyn/deploymentmanager_alpha.typeProviders.html b/docs/dyn/deploymentmanager_alpha.typeProviders.html
index b9af5c8..456be70 100644
--- a/docs/dyn/deploymentmanager_alpha.typeProviders.html
+++ b/docs/dyn/deploymentmanager_alpha.typeProviders.html
@@ -81,12 +81,21 @@
<code><a href="#get">get(project, typeProvider)</a></code></p>
<p class="firstline">Gets information about a specific type provider.</p>
<p class="toc_element">
+ <code><a href="#getType">getType(project, typeProvider, type)</a></code></p>
+<p class="firstline">Gets a type info for a type provided by a TypeProvider.</p>
+<p class="toc_element">
<code><a href="#insert">insert(project, body)</a></code></p>
<p class="firstline">Creates a type provider.</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">Lists all resource type providers for Deployment Manager.</p>
<p class="toc_element">
+ <code><a href="#listTypes">listTypes(project, typeProvider, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Lists all the type info for a TypeProvider.</p>
+<p class="toc_element">
+ <code><a href="#listTypes_next">listTypes_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">
@@ -268,6 +277,32 @@
</div>
<div class="method">
+ <code class="details" id="getType">getType(project, typeProvider, type)</code>
+ <pre>Gets a type info for a type provided by a TypeProvider.
+
+Args:
+ project: string, The project ID for this request. (required)
+ typeProvider: string, The name of the type provider for this request. (required)
+ type: string, The name of the type provider for this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # Contains detailed information about a composite type, base type, or base type with specific collection.
+ "kind": "deploymentmanager#typeInfo", # [Output Only] Type of the output. Always deploymentManager#TypeInfo for TypeInfo.
+ "description": "A String", # The description of the type.
+ "title": "A String", # The title on the API descriptor URL provided.
+ "name": "A String", # The base type or composite type name.
+ "documentationLink": "A String", # For swagger 2.0 externalDocs field will be used. For swagger 1.2 this field will be empty.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "schema": { # For base types with a collection, we return a schema and documentation link For template types, we return only a schema
+ "input": "A String", # The properties that this composite type or base type collection accept as input, represented as a json blob, format is: JSON Schema Draft V4
+ "output": "A String", # The properties that this composite type or base type collection exposes as output, these properties can be used for references, represented as json blob, format is: JSON Schema Draft V4
+ },
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="insert">insert(project, body)</code>
<pre>Creates a type provider.
@@ -562,6 +597,66 @@
</div>
<div class="method">
+ <code class="details" id="listTypes">listTypes(project, typeProvider, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Lists all the type info for a TypeProvider.
+
+Args:
+ project: string, The project ID for this request. (required)
+ typeProvider: string, The name of the type provider 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. Acceptable values are 0 to 500, inclusive. (Default: 500)
+ 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:
+
+ {
+ "nextPageToken": "A String", # A token used to continue a truncated list request.
+ "types": [ # [Output Only] A list of resource type info.
+ { # Contains detailed information about a composite type, base type, or base type with specific collection.
+ "kind": "deploymentmanager#typeInfo", # [Output Only] Type of the output. Always deploymentManager#TypeInfo for TypeInfo.
+ "description": "A String", # The description of the type.
+ "title": "A String", # The title on the API descriptor URL provided.
+ "name": "A String", # The base type or composite type name.
+ "documentationLink": "A String", # For swagger 2.0 externalDocs field will be used. For swagger 1.2 this field will be empty.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "schema": { # For base types with a collection, we return a schema and documentation link For template types, we return only a schema
+ "input": "A String", # The properties that this composite type or base type collection accept as input, represented as a json blob, format is: JSON Schema Draft V4
+ "output": "A String", # The properties that this composite type or base type collection exposes as output, these properties can be used for references, represented as json blob, format is: JSON Schema Draft V4
+ },
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listTypes_next">listTypes_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="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
diff --git a/docs/dyn/deploymentmanager_v2.deployments.html b/docs/dyn/deploymentmanager_v2.deployments.html
index 64c7076..d21514a 100644
--- a/docs/dyn/deploymentmanager_v2.deployments.html
+++ b/docs/dyn/deploymentmanager_v2.deployments.html
@@ -359,7 +359,7 @@
#
# For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
- { # Specifies the audit configuration for a service. It consists of which permission types are logged, and what identities, if any, are exempted from logging. An AuditConifg must have one or more AuditLogConfigs.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice@googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
"exemptedMembers": [
@@ -377,7 +377,7 @@
"logType": "A String", # The log type that this config enables.
},
],
- "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `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.
@@ -896,7 +896,7 @@
#
# For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
- { # Specifies the audit configuration for a service. It consists of which permission types are logged, and what identities, if any, are exempted from logging. An AuditConifg must have one or more AuditLogConfigs.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice@googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
"exemptedMembers": [
@@ -914,7 +914,7 @@
"logType": "A String", # The log type that this config enables.
},
],
- "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `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.
@@ -997,7 +997,7 @@
#
# For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
- { # Specifies the audit configuration for a service. It consists of which permission types are logged, and what identities, if any, are exempted from logging. An AuditConifg must have one or more AuditLogConfigs.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice@googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
"exemptedMembers": [
@@ -1015,7 +1015,7 @@
"logType": "A String", # The log type that this config enables.
},
],
- "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `resourcemanager`, `storage`, `compute`. `allServices` is a special value that covers all services.
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `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.
diff --git a/docs/dyn/deploymentmanager_v2beta.compositeTypes.html b/docs/dyn/deploymentmanager_v2beta.compositeTypes.html
new file mode 100644
index 0000000..672b91c
--- /dev/null
+++ b/docs/dyn/deploymentmanager_v2beta.compositeTypes.html
@@ -0,0 +1,752 @@
+<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="deploymentmanager_v2beta.html">Google Cloud Deployment Manager API V2Beta Methods</a> . <a href="deploymentmanager_v2beta.compositeTypes.html">compositeTypes</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, compositeType)</a></code></p>
+<p class="firstline">Deletes a composite type.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, compositeType)</a></code></p>
+<p class="firstline">Gets information about a specific composite type.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a composite type.</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">Lists all composite types for Deployment Manager.</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, compositeType, body)</a></code></p>
+<p class="firstline">Updates a composite type. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, compositeType, body)</a></code></p>
+<p class="firstline">Updates a composite type.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, compositeType)</code>
+ <pre>Deletes a composite type.
+
+Args:
+ project: string, The project ID for this request. (required)
+ compositeType: string, The name of the type for this request. (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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a 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, compositeType)</code>
+ <pre>Gets information about a specific composite type.
+
+Args:
+ project: string, The project ID for this request. (required)
+ compositeType: string, The name of the composite type for this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # Holds the composite type.
+ "status": "A String",
+ "name": "A String", # Name of the composite type.
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "templateContents": { # Files that make up the template contents of a template type. # Files for the template type.
+ "imports": [ # Import files referenced by the main template.
+ {
+ "content": "A String", # The contents of the file.
+ "name": "A String", # The name of the file.
+ },
+ ],
+ "schema": "A String", # The contents of the template schema.
+ "template": "A String", # The contents of the main template file.
+ "interpreter": "A String", # Which interpreter (python or jinja) should be used during expansion.
+ },
+ "insertTime": "A String", # [Output Only] Timestamp when the composite type was created, in RFC3339 text format.
+ "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this composite type.
+ "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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Self link for the type provider.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a composite type.
+
+Args:
+ project: string, The project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Holds the composite type.
+ "status": "A String",
+ "name": "A String", # Name of the composite type.
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "templateContents": { # Files that make up the template contents of a template type. # Files for the template type.
+ "imports": [ # Import files referenced by the main template.
+ {
+ "content": "A String", # The contents of the file.
+ "name": "A String", # The name of the file.
+ },
+ ],
+ "schema": "A String", # The contents of the template schema.
+ "template": "A String", # The contents of the main template file.
+ "interpreter": "A String", # Which interpreter (python or jinja) should be used during expansion.
+ },
+ "insertTime": "A String", # [Output Only] Timestamp when the composite type was created, in RFC3339 text format.
+ "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this composite type.
+ "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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Self link for the type provider.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ }
+
+
+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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a 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>Lists all composite types for Deployment Manager.
+
+Args:
+ project: string, The 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. Acceptable values are 0 to 500, inclusive. (Default: 500)
+ 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:
+
+ { # A response that returns all Composite Types supported by Deployment Manager
+ "nextPageToken": "A String", # A token used to continue a truncated list request.
+ "compositeTypes": [ # [Output Only] A list of resource composite types supported by Deployment Manager.
+ { # Holds the composite type.
+ "status": "A String",
+ "name": "A String", # Name of the composite type.
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "templateContents": { # Files that make up the template contents of a template type. # Files for the template type.
+ "imports": [ # Import files referenced by the main template.
+ {
+ "content": "A String", # The contents of the file.
+ "name": "A String", # The name of the file.
+ },
+ ],
+ "schema": "A String", # The contents of the template schema.
+ "template": "A String", # The contents of the main template file.
+ "interpreter": "A String", # Which interpreter (python or jinja) should be used during expansion.
+ },
+ "insertTime": "A String", # [Output Only] Timestamp when the composite type was created, in RFC3339 text format.
+ "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this composite type.
+ "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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Self link for the type provider.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is 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>
+
+<div class="method">
+ <code class="details" id="patch">patch(project, compositeType, body)</code>
+ <pre>Updates a composite type. This method supports patch semantics.
+
+Args:
+ project: string, The project ID for this request. (required)
+ compositeType: string, The name of the composite type for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Holds the composite type.
+ "status": "A String",
+ "name": "A String", # Name of the composite type.
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "templateContents": { # Files that make up the template contents of a template type. # Files for the template type.
+ "imports": [ # Import files referenced by the main template.
+ {
+ "content": "A String", # The contents of the file.
+ "name": "A String", # The name of the file.
+ },
+ ],
+ "schema": "A String", # The contents of the template schema.
+ "template": "A String", # The contents of the main template file.
+ "interpreter": "A String", # Which interpreter (python or jinja) should be used during expansion.
+ },
+ "insertTime": "A String", # [Output Only] Timestamp when the composite type was created, in RFC3339 text format.
+ "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this composite type.
+ "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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Self link for the type provider.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ }
+
+
+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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a 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, compositeType, body)</code>
+ <pre>Updates a composite type.
+
+Args:
+ project: string, The project ID for this request. (required)
+ compositeType: string, The name of the composite type for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Holds the composite type.
+ "status": "A String",
+ "name": "A String", # Name of the composite type.
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "templateContents": { # Files that make up the template contents of a template type. # Files for the template type.
+ "imports": [ # Import files referenced by the main template.
+ {
+ "content": "A String", # The contents of the file.
+ "name": "A String", # The name of the file.
+ },
+ ],
+ "schema": "A String", # The contents of the template schema.
+ "template": "A String", # The contents of the main template file.
+ "interpreter": "A String", # Which interpreter (python or jinja) should be used during expansion.
+ },
+ "insertTime": "A String", # [Output Only] Timestamp when the composite type was created, in RFC3339 text format.
+ "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this composite type.
+ "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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Self link for the type provider.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ }
+
+
+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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a 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/deploymentmanager_v2beta.deployments.html b/docs/dyn/deploymentmanager_v2beta.deployments.html
new file mode 100644
index 0000000..c189f59
--- /dev/null
+++ b/docs/dyn/deploymentmanager_v2beta.deployments.html
@@ -0,0 +1,1334 @@
+<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="deploymentmanager_v2beta.html">Google Cloud Deployment Manager API V2Beta Methods</a> . <a href="deploymentmanager_v2beta.deployments.html">deployments</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#cancelPreview">cancelPreview(project, deployment, body)</a></code></p>
+<p class="firstline">Cancels and removes the preview currently associated with the deployment.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, deployment, deletePolicy=None)</a></code></p>
+<p class="firstline">Deletes a deployment and all of the resources in the deployment.</p>
+<p class="toc_element">
+ <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">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Lists all deployments for a given 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, 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>
+<div class="method">
+ <code class="details" id="cancelPreview">cancelPreview(project, deployment, body)</code>
+ <pre>Cancels and removes the preview currently associated with the deployment.
+
+Args:
+ project: string, The project ID for this request. (required)
+ deployment: string, The name of the deployment for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "fingerprint": "A String", # Specifies a fingerprint for cancelPreview() requests. A fingerprint is a randomly generated value that must be provided in cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests).
+ #
+ # The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment.
+ }
+
+
+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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(project, deployment, deletePolicy=None)</code>
+ <pre>Deletes a deployment and all of the resources in the deployment.
+
+Args:
+ project: string, The project ID for this request. (required)
+ deployment: string, The name of the deployment for this request. (required)
+ deletePolicy: string, Sets the policy to use for deleting resources.
+ Allowed values
+ ABANDON -
+ DELETE -
+
+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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a 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, deployment)</code>
+ <pre>Gets information about a specific deployment.
+
+Args:
+ project: string, The project ID for this request. (required)
+ deployment: string, The name of the deployment for this request. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "description": "A String", # An optional user-provided description of the deployment.
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
+ "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "description": "A String", # [Output Only] An optional user-provided description of the deployment after the current update has been applied.
+ "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
+ },
+ "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
+ "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
+ "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
+ #
+ # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
+ "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
+ "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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
+ "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
+ {
+ "content": "A String", # The contents of the file.
+ "name": "A String", # The name of the file.
+ },
+ ],
+ "config": { # The configuration to use for this deployment.
+ "content": "A String", # The contents of the file.
+ },
+ },
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Self link for the deployment.
+ "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="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 cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConifg must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice@googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
+ "exemptedMembers": [
+ "A String",
+ ],
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example:
+ #
+ # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `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.
+
+Args:
+ project: string, The project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "description": "A String", # An optional user-provided description of the deployment.
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
+ "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "description": "A String", # [Output Only] An optional user-provided description of the deployment after the current update has been applied.
+ "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
+ },
+ "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
+ "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
+ "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
+ #
+ # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
+ "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
+ "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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
+ "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
+ {
+ "content": "A String", # The contents of the file.
+ "name": "A String", # The name of the file.
+ },
+ ],
+ "config": { # The configuration to use for this deployment.
+ "content": "A String", # The contents of the file.
+ },
+ },
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Self link for the deployment.
+ "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.
+ }
+
+ preview: boolean, If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
+
+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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a 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>Lists all deployments for a given project.
+
+Args:
+ project: string, The 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. Acceptable values are 0 to 500, inclusive. (Default: 500)
+ 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:
+
+ { # A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "deployments": [ # [Output Only] The deployments contained in this response.
+ {
+ "description": "A String", # An optional user-provided description of the deployment.
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
+ "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "description": "A String", # [Output Only] An optional user-provided description of the deployment after the current update has been applied.
+ "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
+ },
+ "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
+ "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
+ "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
+ #
+ # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
+ "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
+ "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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
+ "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
+ {
+ "content": "A String", # The contents of the file.
+ "name": "A String", # The name of the file.
+ },
+ ],
+ "config": { # The configuration to use for this deployment.
+ "content": "A String", # The contents of the file.
+ },
+ },
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Self link for the deployment.
+ "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="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, deployment, body, deletePolicy=None, createPolicy=None, preview=None)</code>
+ <pre>Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.
+
+Args:
+ project: string, The project ID for this request. (required)
+ deployment: string, The name of the deployment for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "description": "A String", # An optional user-provided description of the deployment.
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
+ "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "description": "A String", # [Output Only] An optional user-provided description of the deployment after the current update has been applied.
+ "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
+ },
+ "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
+ "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
+ "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
+ #
+ # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
+ "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
+ "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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
+ "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
+ {
+ "content": "A String", # The contents of the file.
+ "name": "A String", # The name of the file.
+ },
+ ],
+ "config": { # The configuration to use for this deployment.
+ "content": "A String", # The contents of the file.
+ },
+ },
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Self link for the deployment.
+ "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.
+ }
+
+ deletePolicy: string, Sets the policy to use for deleting resources.
+ Allowed values
+ ABANDON -
+ DELETE -
+ createPolicy: string, Sets the policy to use for creating new resources.
+ Allowed values
+ ACQUIRE -
+ CREATE_OR_ACQUIRE -
+ preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
+
+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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</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 cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConifg must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice@googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
+ "exemptedMembers": [
+ "A String",
+ ],
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example:
+ #
+ # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `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 cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConifg must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice@googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
+ "exemptedMembers": [
+ "A String",
+ ],
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example:
+ #
+ # { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `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.
+
+Args:
+ project: string, The project ID for this request. (required)
+ deployment: string, The name of the deployment for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "fingerprint": "A String", # Specifies a fingerprint for stop() requests. A fingerprint is a randomly generated value that must be provided in stop() requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision).
+ #
+ # The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a get() request on the deployment.
+ }
+
+
+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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ }</pre>
+</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.
+
+Args:
+ project: string, The project ID for this request. (required)
+ deployment: string, The name of the deployment for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{
+ "description": "A String", # An optional user-provided description of the deployment.
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.
+ "labels": [ # [Output Only] Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "description": "A String", # [Output Only] An optional user-provided description of the deployment after the current update has been applied.
+ "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this deployment.
+ },
+ "manifest": "A String", # [Output Only] URL of the manifest representing the last manifest that was successfully deployed.
+ "insertTime": "A String", # [Output Only] Timestamp when the deployment was created, in RFC3339 text format .
+ "fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as update(), stop(), and cancelPreview() requests. A fingerprint is a randomly generated value that must be provided with update(), stop(), and cancelPreview() requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.
+ #
+ # The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a get() request to a deployment.
+ "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this deployment.
+ "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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ "target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.
+ "imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.
+ {
+ "content": "A String", # The contents of the file.
+ "name": "A String", # The name of the file.
+ },
+ ],
+ "config": { # The configuration to use for this deployment.
+ "content": "A String", # The contents of the file.
+ },
+ },
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Self link for the deployment.
+ "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.
+ }
+
+ deletePolicy: string, Sets the policy to use for deleting resources.
+ Allowed values
+ ABANDON -
+ DELETE -
+ createPolicy: string, Sets the policy to use for creating new resources.
+ Allowed values
+ ACQUIRE -
+ CREATE_OR_ACQUIRE -
+ preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.
+
+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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a 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/deploymentmanager_v2beta.html b/docs/dyn/deploymentmanager_v2beta.html
new file mode 100644
index 0000000..d917eaf
--- /dev/null
+++ b/docs/dyn/deploymentmanager_v2beta.html
@@ -0,0 +1,133 @@
+<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="deploymentmanager_v2beta.html">Google Cloud Deployment Manager API V2Beta Methods</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="deploymentmanager_v2beta.compositeTypes.html">compositeTypes()</a></code>
+</p>
+<p class="firstline">Returns the compositeTypes Resource.</p>
+
+<p class="toc_element">
+ <code><a href="deploymentmanager_v2beta.deployments.html">deployments()</a></code>
+</p>
+<p class="firstline">Returns the deployments Resource.</p>
+
+<p class="toc_element">
+ <code><a href="deploymentmanager_v2beta.manifests.html">manifests()</a></code>
+</p>
+<p class="firstline">Returns the manifests Resource.</p>
+
+<p class="toc_element">
+ <code><a href="deploymentmanager_v2beta.operations.html">operations()</a></code>
+</p>
+<p class="firstline">Returns the operations Resource.</p>
+
+<p class="toc_element">
+ <code><a href="deploymentmanager_v2beta.resources.html">resources()</a></code>
+</p>
+<p class="firstline">Returns the resources Resource.</p>
+
+<p class="toc_element">
+ <code><a href="deploymentmanager_v2beta.typeProviders.html">typeProviders()</a></code>
+</p>
+<p class="firstline">Returns the typeProviders Resource.</p>
+
+<p class="toc_element">
+ <code><a href="deploymentmanager_v2beta.types.html">types()</a></code>
+</p>
+<p class="firstline">Returns the types 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/deploymentmanager_v2beta.manifests.html b/docs/dyn/deploymentmanager_v2beta.manifests.html
new file mode 100644
index 0000000..938fb9f
--- /dev/null
+++ b/docs/dyn/deploymentmanager_v2beta.manifests.html
@@ -0,0 +1,183 @@
+<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="deploymentmanager_v2beta.html">Google Cloud Deployment Manager API V2Beta Methods</a> . <a href="deploymentmanager_v2beta.manifests.html">manifests</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(project, deployment, manifest)</a></code></p>
+<p class="firstline">Gets information about a specific manifest.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, deployment, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Lists all manifests for a given deployment.</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="get">get(project, deployment, manifest)</code>
+ <pre>Gets information about a specific manifest.
+
+Args:
+ project: string, The project ID for this request. (required)
+ deployment: string, The name of the deployment for this request. (required)
+ manifest: string, The name of the manifest for this request. (required)
+
+Returns:
+ An object of the form:
+
+ {
+ "layout": "A String", # [Output Only] The YAML layout for this manifest.
+ "name": "A String", # [Output Only] The name of the manifest.
+ "expandedConfig": "A String", # [Output Only] The fully-expanded configuration file, including any templates and references.
+ "imports": [ # [Output Only] The imported files for this manifest.
+ {
+ "content": "A String", # The contents of the file.
+ "name": "A String", # The name of the file.
+ },
+ ],
+ "insertTime": "A String", # [Output Only] Timestamp when the manifest was created, in RFC3339 text format.
+ "config": { # [Output Only] The YAML configuration for this manifest.
+ "content": "A String", # The contents of the file.
+ },
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Self link for the manifest.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, deployment, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Lists all manifests for a given deployment.
+
+Args:
+ project: string, The project ID for this request. (required)
+ deployment: string, The name of the deployment 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. Acceptable values are 0 to 500, inclusive. (Default: 500)
+ 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:
+
+ { # A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "manifests": [ # [Output Only] Manifests contained in this list response.
+ {
+ "layout": "A String", # [Output Only] The YAML layout for this manifest.
+ "name": "A String", # [Output Only] The name of the manifest.
+ "expandedConfig": "A String", # [Output Only] The fully-expanded configuration file, including any templates and references.
+ "imports": [ # [Output Only] The imported files for this manifest.
+ {
+ "content": "A String", # The contents of the file.
+ "name": "A String", # The name of the file.
+ },
+ ],
+ "insertTime": "A String", # [Output Only] Timestamp when the manifest was created, in RFC3339 text format.
+ "config": { # [Output Only] The YAML configuration for this manifest.
+ "content": "A String", # The contents of the file.
+ },
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Self link for the manifest.
+ },
+ ],
+ }</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/deploymentmanager_v2beta.operations.html b/docs/dyn/deploymentmanager_v2beta.operations.html
new file mode 100644
index 0000000..7735603
--- /dev/null
+++ b/docs/dyn/deploymentmanager_v2beta.operations.html
@@ -0,0 +1,237 @@
+<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="deploymentmanager_v2beta.html">Google Cloud Deployment Manager API V2Beta Methods</a> . <a href="deploymentmanager_v2beta.operations.html">operations</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(project, operation)</a></code></p>
+<p class="firstline">Gets information about a specific operation.</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">Lists all operations 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>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="get">get(project, operation)</code>
+ <pre>Gets information about a specific operation.
+
+Args:
+ project: string, The project ID for this request. (required)
+ operation: string, The name of the operation for this request. (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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a 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>Lists all operations for a project.
+
+Args:
+ project: string, The 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. Acceptable values are 0 to 500, inclusive. (Default: 500)
+ 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:
+
+ { # A response containing a partial list of operations and a page token used to build the next request if the request has been truncated.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "operations": [ # [Output Only] Operations contained in this list response.
+ { # 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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ ],
+ }</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/deploymentmanager_v2beta.resources.html b/docs/dyn/deploymentmanager_v2beta.resources.html
new file mode 100644
index 0000000..e8ac190
--- /dev/null
+++ b/docs/dyn/deploymentmanager_v2beta.resources.html
@@ -0,0 +1,267 @@
+<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="deploymentmanager_v2beta.html">Google Cloud Deployment Manager API V2Beta Methods</a> . <a href="deploymentmanager_v2beta.resources.html">resources</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#get">get(project, deployment, resource)</a></code></p>
+<p class="firstline">Gets information about a single resource.</p>
+<p class="toc_element">
+ <code><a href="#list">list(project, deployment, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Lists all resources in a given deployment.</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="get">get(project, deployment, resource)</code>
+ <pre>Gets information about a single resource.
+
+Args:
+ project: string, The project ID for this request. (required)
+ deployment: string, The name of the deployment for this request. (required)
+ resource: string, The name of the resource for this request. (required)
+
+Returns:
+ 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.
+ "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.
+ {
+ "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).
+ },
+ ],
+ },
+ ],
+ "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.
+ {
+ "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).
+ },
+ ],
+ },
+ ],
+ "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this resource.
+ "state": "A String", # [Output Only] The state of the resource.
+ "intent": "A String", # [Output Only] The intent of the resource: PREVIEW, UPDATE, or CANCEL.
+ "error": { # [Output Only] If errors are generated during update of the resource, 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.
+ },
+ ],
+ },
+ "properties": "A String", # [Output Only] The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
+ },
+ "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.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(project, deployment, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Lists all resources in a given deployment.
+
+Args:
+ project: string, The project ID for this request. (required)
+ deployment: string, The name of the deployment 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. Acceptable values are 0 to 500, inclusive. (Default: 500)
+ 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:
+
+ { # A response containing a partial list of resources and a page token used to build the next request if the request has been truncated.
+ "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.
+ "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.
+ {
+ "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).
+ },
+ ],
+ },
+ ],
+ "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.
+ {
+ "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).
+ },
+ ],
+ },
+ ],
+ "manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this resource.
+ "state": "A String", # [Output Only] The state of the resource.
+ "intent": "A String", # [Output Only] The intent of the resource: PREVIEW, UPDATE, or CANCEL.
+ "error": { # [Output Only] If errors are generated during update of the resource, 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.
+ },
+ ],
+ },
+ "properties": "A String", # [Output Only] The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
+ },
+ "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.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ },
+ ],
+ }</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/deploymentmanager_v2beta.typeProviders.html b/docs/dyn/deploymentmanager_v2beta.typeProviders.html
new file mode 100644
index 0000000..327a1a7
--- /dev/null
+++ b/docs/dyn/deploymentmanager_v2beta.typeProviders.html
@@ -0,0 +1,997 @@
+<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="deploymentmanager_v2beta.html">Google Cloud Deployment Manager API V2Beta Methods</a> . <a href="deploymentmanager_v2beta.typeProviders.html">typeProviders</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#delete">delete(project, typeProvider)</a></code></p>
+<p class="firstline">Deletes a type provider.</p>
+<p class="toc_element">
+ <code><a href="#get">get(project, typeProvider)</a></code></p>
+<p class="firstline">Gets information about a specific type provider.</p>
+<p class="toc_element">
+ <code><a href="#getType">getType(project, typeProvider, type)</a></code></p>
+<p class="firstline">Gets a type info for a type provided by a TypeProvider.</p>
+<p class="toc_element">
+ <code><a href="#insert">insert(project, body)</a></code></p>
+<p class="firstline">Creates a type provider.</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">Lists all resource type providers for Deployment Manager.</p>
+<p class="toc_element">
+ <code><a href="#listTypes">listTypes(project, typeProvider, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Lists all the type info for a TypeProvider.</p>
+<p class="toc_element">
+ <code><a href="#listTypes_next">listTypes_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="#patch">patch(project, typeProvider, body)</a></code></p>
+<p class="firstline">Updates a type provider. This method supports patch semantics.</p>
+<p class="toc_element">
+ <code><a href="#update">update(project, typeProvider, body)</a></code></p>
+<p class="firstline">Updates a type provider.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="delete">delete(project, typeProvider)</code>
+ <pre>Deletes a type provider.
+
+Args:
+ project: string, The project ID for this request. (required)
+ typeProvider: string, The name of the type provider for this request. (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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a 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, typeProvider)</code>
+ <pre>Gets information about a specific type provider.
+
+Args:
+ project: string, The project ID for this request. (required)
+ typeProvider: string, The name of the type provider for this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # A type provider that describes a service-backed Type.
+ "credential": { # Credential used by ConfigurableResourceTypes. # Credential used when interacting with this type.
+ "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credentials for this Type.
+ "password": "A String",
+ "user": "A String",
+ },
+ },
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "options": { # Options allows customized resource handling by Deployment Manager. # Options to apply when handling any resources in this service.
+ "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource.
+ "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request.
+ "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors.
+ },
+ "inputMappings": [ # The mappings that apply for requests.
+ { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
+ "fieldName": "A String", # The name of the field that is going to be injected.
+ "location": "A String", # The location where this mapping applies.
+ "value": "A String", # A jsonPath expression to select an element.
+ "methodMatch": "A String", # Regex to evaluate on method to decide if input applies.
+ },
+ ],
+ "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number
+ },
+ "collectionOverrides": [ # Allows resource handling overrides for specific collections
+ { # CollectionOverride allows resource handling overrides for specific resources within a BaseType
+ "options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override
+ "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource.
+ "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request.
+ "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors.
+ },
+ "inputMappings": [ # The mappings that apply for requests.
+ { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
+ "fieldName": "A String", # The name of the field that is going to be injected.
+ "location": "A String", # The location where this mapping applies.
+ "value": "A String", # A jsonPath expression to select an element.
+ "methodMatch": "A String", # Regex to evaluate on method to decide if input applies.
+ },
+ ],
+ "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number
+ },
+ "collection": "A String", # The collection that identifies this resource within its service.
+ },
+ ],
+ "insertTime": "A String", # [Output Only] Timestamp when the type provider was created, in RFC3339 text format.
+ "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this type provider.
+ "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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ "descriptorUrl": "A String", # Descriptor Url for the this type provider.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Self link for the type provider.
+ "name": "A String", # Name of the type provider.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getType">getType(project, typeProvider, type)</code>
+ <pre>Gets a type info for a type provided by a TypeProvider.
+
+Args:
+ project: string, The project ID for this request. (required)
+ typeProvider: string, The name of the type provider for this request. (required)
+ type: string, The name of the type provider for this request. (required)
+
+Returns:
+ An object of the form:
+
+ { # Contains detailed information about a composite type, base type, or base type with specific collection.
+ "kind": "deploymentmanager#typeInfo", # [Output Only] Type of the output. Always deploymentManager#TypeInfo for TypeInfo.
+ "description": "A String", # The description of the type.
+ "title": "A String", # The title on the API descriptor URL provided.
+ "name": "A String", # The base type or composite type name.
+ "documentationLink": "A String", # For swagger 2.0 externalDocs field will be used. For swagger 1.2 this field will be empty.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "schema": { # For base types with a collection, we return a schema and documentation link For template types, we return only a schema
+ "input": "A String", # The properties that this composite type or base type collection accept as input, represented as a json blob, format is: JSON Schema Draft V4
+ "output": "A String", # The properties that this composite type or base type collection exposes as output, these properties can be used for references, represented as json blob, format is: JSON Schema Draft V4
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="insert">insert(project, body)</code>
+ <pre>Creates a type provider.
+
+Args:
+ project: string, The project ID for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A type provider that describes a service-backed Type.
+ "credential": { # Credential used by ConfigurableResourceTypes. # Credential used when interacting with this type.
+ "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credentials for this Type.
+ "password": "A String",
+ "user": "A String",
+ },
+ },
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "options": { # Options allows customized resource handling by Deployment Manager. # Options to apply when handling any resources in this service.
+ "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource.
+ "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request.
+ "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors.
+ },
+ "inputMappings": [ # The mappings that apply for requests.
+ { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
+ "fieldName": "A String", # The name of the field that is going to be injected.
+ "location": "A String", # The location where this mapping applies.
+ "value": "A String", # A jsonPath expression to select an element.
+ "methodMatch": "A String", # Regex to evaluate on method to decide if input applies.
+ },
+ ],
+ "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number
+ },
+ "collectionOverrides": [ # Allows resource handling overrides for specific collections
+ { # CollectionOverride allows resource handling overrides for specific resources within a BaseType
+ "options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override
+ "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource.
+ "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request.
+ "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors.
+ },
+ "inputMappings": [ # The mappings that apply for requests.
+ { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
+ "fieldName": "A String", # The name of the field that is going to be injected.
+ "location": "A String", # The location where this mapping applies.
+ "value": "A String", # A jsonPath expression to select an element.
+ "methodMatch": "A String", # Regex to evaluate on method to decide if input applies.
+ },
+ ],
+ "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number
+ },
+ "collection": "A String", # The collection that identifies this resource within its service.
+ },
+ ],
+ "insertTime": "A String", # [Output Only] Timestamp when the type provider was created, in RFC3339 text format.
+ "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this type provider.
+ "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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ "descriptorUrl": "A String", # Descriptor Url for the this type provider.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Self link for the type provider.
+ "name": "A String", # Name of the type provider.
+ }
+
+
+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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a 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>Lists all resource type providers for Deployment Manager.
+
+Args:
+ project: string, The 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. Acceptable values are 0 to 500, inclusive. (Default: 500)
+ 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:
+
+ { # A response that returns all Type Providers supported by Deployment Manager
+ "nextPageToken": "A String", # A token used to continue a truncated list request.
+ "typeProviders": [ # [Output Only] A list of resource type providers supported by Deployment Manager.
+ { # A type provider that describes a service-backed Type.
+ "credential": { # Credential used by ConfigurableResourceTypes. # Credential used when interacting with this type.
+ "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credentials for this Type.
+ "password": "A String",
+ "user": "A String",
+ },
+ },
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "options": { # Options allows customized resource handling by Deployment Manager. # Options to apply when handling any resources in this service.
+ "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource.
+ "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request.
+ "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors.
+ },
+ "inputMappings": [ # The mappings that apply for requests.
+ { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
+ "fieldName": "A String", # The name of the field that is going to be injected.
+ "location": "A String", # The location where this mapping applies.
+ "value": "A String", # A jsonPath expression to select an element.
+ "methodMatch": "A String", # Regex to evaluate on method to decide if input applies.
+ },
+ ],
+ "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number
+ },
+ "collectionOverrides": [ # Allows resource handling overrides for specific collections
+ { # CollectionOverride allows resource handling overrides for specific resources within a BaseType
+ "options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override
+ "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource.
+ "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request.
+ "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors.
+ },
+ "inputMappings": [ # The mappings that apply for requests.
+ { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
+ "fieldName": "A String", # The name of the field that is going to be injected.
+ "location": "A String", # The location where this mapping applies.
+ "value": "A String", # A jsonPath expression to select an element.
+ "methodMatch": "A String", # Regex to evaluate on method to decide if input applies.
+ },
+ ],
+ "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number
+ },
+ "collection": "A String", # The collection that identifies this resource within its service.
+ },
+ ],
+ "insertTime": "A String", # [Output Only] Timestamp when the type provider was created, in RFC3339 text format.
+ "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this type provider.
+ "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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ "descriptorUrl": "A String", # Descriptor Url for the this type provider.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Self link for the type provider.
+ "name": "A String", # Name of the type provider.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listTypes">listTypes(project, typeProvider, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Lists all the type info for a TypeProvider.
+
+Args:
+ project: string, The project ID for this request. (required)
+ typeProvider: string, The name of the type provider 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. Acceptable values are 0 to 500, inclusive. (Default: 500)
+ 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:
+
+ {
+ "nextPageToken": "A String", # A token used to continue a truncated list request.
+ "types": [ # [Output Only] A list of resource type info.
+ { # Contains detailed information about a composite type, base type, or base type with specific collection.
+ "kind": "deploymentmanager#typeInfo", # [Output Only] Type of the output. Always deploymentManager#TypeInfo for TypeInfo.
+ "description": "A String", # The description of the type.
+ "title": "A String", # The title on the API descriptor URL provided.
+ "name": "A String", # The base type or composite type name.
+ "documentationLink": "A String", # For swagger 2.0 externalDocs field will be used. For swagger 1.2 this field will be empty.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "schema": { # For base types with a collection, we return a schema and documentation link For template types, we return only a schema
+ "input": "A String", # The properties that this composite type or base type collection accept as input, represented as a json blob, format is: JSON Schema Draft V4
+ "output": "A String", # The properties that this composite type or base type collection exposes as output, these properties can be used for references, represented as json blob, format is: JSON Schema Draft V4
+ },
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="listTypes_next">listTypes_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="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, typeProvider, body)</code>
+ <pre>Updates a type provider. This method supports patch semantics.
+
+Args:
+ project: string, The project ID for this request. (required)
+ typeProvider: string, The name of the type provider for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A type provider that describes a service-backed Type.
+ "credential": { # Credential used by ConfigurableResourceTypes. # Credential used when interacting with this type.
+ "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credentials for this Type.
+ "password": "A String",
+ "user": "A String",
+ },
+ },
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "options": { # Options allows customized resource handling by Deployment Manager. # Options to apply when handling any resources in this service.
+ "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource.
+ "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request.
+ "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors.
+ },
+ "inputMappings": [ # The mappings that apply for requests.
+ { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
+ "fieldName": "A String", # The name of the field that is going to be injected.
+ "location": "A String", # The location where this mapping applies.
+ "value": "A String", # A jsonPath expression to select an element.
+ "methodMatch": "A String", # Regex to evaluate on method to decide if input applies.
+ },
+ ],
+ "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number
+ },
+ "collectionOverrides": [ # Allows resource handling overrides for specific collections
+ { # CollectionOverride allows resource handling overrides for specific resources within a BaseType
+ "options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override
+ "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource.
+ "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request.
+ "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors.
+ },
+ "inputMappings": [ # The mappings that apply for requests.
+ { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
+ "fieldName": "A String", # The name of the field that is going to be injected.
+ "location": "A String", # The location where this mapping applies.
+ "value": "A String", # A jsonPath expression to select an element.
+ "methodMatch": "A String", # Regex to evaluate on method to decide if input applies.
+ },
+ ],
+ "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number
+ },
+ "collection": "A String", # The collection that identifies this resource within its service.
+ },
+ ],
+ "insertTime": "A String", # [Output Only] Timestamp when the type provider was created, in RFC3339 text format.
+ "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this type provider.
+ "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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ "descriptorUrl": "A String", # Descriptor Url for the this type provider.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Self link for the type provider.
+ "name": "A String", # Name of the type provider.
+ }
+
+
+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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a 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, typeProvider, body)</code>
+ <pre>Updates a type provider.
+
+Args:
+ project: string, The project ID for this request. (required)
+ typeProvider: string, The name of the type provider for this request. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A type provider that describes a service-backed Type.
+ "credential": { # Credential used by ConfigurableResourceTypes. # Credential used when interacting with this type.
+ "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credentials for this Type.
+ "password": "A String",
+ "user": "A String",
+ },
+ },
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "options": { # Options allows customized resource handling by Deployment Manager. # Options to apply when handling any resources in this service.
+ "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource.
+ "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request.
+ "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors.
+ },
+ "inputMappings": [ # The mappings that apply for requests.
+ { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
+ "fieldName": "A String", # The name of the field that is going to be injected.
+ "location": "A String", # The location where this mapping applies.
+ "value": "A String", # A jsonPath expression to select an element.
+ "methodMatch": "A String", # Regex to evaluate on method to decide if input applies.
+ },
+ ],
+ "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number
+ },
+ "collectionOverrides": [ # Allows resource handling overrides for specific collections
+ { # CollectionOverride allows resource handling overrides for specific resources within a BaseType
+ "options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override
+ "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource.
+ "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request.
+ "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors.
+ },
+ "inputMappings": [ # The mappings that apply for requests.
+ { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
+ "fieldName": "A String", # The name of the field that is going to be injected.
+ "location": "A String", # The location where this mapping applies.
+ "value": "A String", # A jsonPath expression to select an element.
+ "methodMatch": "A String", # Regex to evaluate on method to decide if input applies.
+ },
+ ],
+ "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number
+ },
+ "collection": "A String", # The collection that identifies this resource within its service.
+ },
+ ],
+ "insertTime": "A String", # [Output Only] Timestamp when the type provider was created, in RFC3339 text format.
+ "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this type provider.
+ "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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ "descriptorUrl": "A String", # Descriptor Url for the this type provider.
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Self link for the type provider.
+ "name": "A String", # Name of the type provider.
+ }
+
+
+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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a 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/deploymentmanager_v2beta.types.html b/docs/dyn/deploymentmanager_v2beta.types.html
new file mode 100644
index 0000000..fc64af6
--- /dev/null
+++ b/docs/dyn/deploymentmanager_v2beta.types.html
@@ -0,0 +1,233 @@
+<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="deploymentmanager_v2beta.html">Google Cloud Deployment Manager API V2Beta Methods</a> . <a href="deploymentmanager_v2beta.types.html">types</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+<p class="firstline">Lists all resource types for Deployment Manager.</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(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <pre>Lists all resource types for Deployment Manager.
+
+Args:
+ project: string, The 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. Acceptable values are 0 to 500, inclusive. (Default: 500)
+ 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:
+
+ { # A response that returns all Types supported by Deployment Manager
+ "nextPageToken": "A String", # A token used to continue a truncated list request.
+ "types": [ # [Output Only] A list of resource types supported by Deployment Manager.
+ { # A resource type supported by Deployment Manager.
+ "name": "A String", # Name of the type.
+ "labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: 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])?)?
+ {
+ "value": "A String",
+ "key": "A String",
+ },
+ ],
+ "base": { # BaseType that describes a service-backed Type. # Base Type (configurable service) that backs this Type.
+ "credential": { # Credential used by ConfigurableResourceTypes. # Credential used when interacting with this type.
+ "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credentials for this Type.
+ "password": "A String",
+ "user": "A String",
+ },
+ },
+ "descriptorUrl": "A String", # Descriptor Url for the this type.
+ "collectionOverrides": [ # Allows resource handling overrides for specific collections
+ { # CollectionOverride allows resource handling overrides for specific resources within a BaseType
+ "options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override
+ "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource.
+ "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request.
+ "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors.
+ },
+ "inputMappings": [ # The mappings that apply for requests.
+ { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
+ "fieldName": "A String", # The name of the field that is going to be injected.
+ "location": "A String", # The location where this mapping applies.
+ "value": "A String", # A jsonPath expression to select an element.
+ "methodMatch": "A String", # Regex to evaluate on method to decide if input applies.
+ },
+ ],
+ "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number
+ },
+ "collection": "A String", # The collection that identifies this resource within its service.
+ },
+ ],
+ "options": { # Options allows customized resource handling by Deployment Manager. # Options to apply when handling any resources in this service.
+ "validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource.
+ "undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request.
+ "schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors.
+ },
+ "inputMappings": [ # The mappings that apply for requests.
+ { # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
+ "fieldName": "A String", # The name of the field that is going to be injected.
+ "location": "A String", # The location where this mapping applies.
+ "value": "A String", # A jsonPath expression to select an element.
+ "methodMatch": "A String", # Regex to evaluate on method to decide if input applies.
+ },
+ ],
+ "virtualProperties": "A String", # Additional properties block described as a jsonSchema, these properties will never be part of the json payload, but they can be consumed by InputMappings, this must be a valid json schema draft-04. The properties specified here will be decouple in a different section. This schema will be merged to the schema validation, and properties here will be extracted From the payload and consumed explicitly by InputMappings. ex: field1: type: string field2: type: number
+ },
+ },
+ "insertTime": "A String", # [Output Only] Timestamp when the type was created, in RFC3339 text format.
+ "operation": { # An Operation resource, used to manage asynchronous API requests. # [Output Only] The Operation that most recently ran, or is currently running, on this type.
+ "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", # [Deprecated] This field is deprecated.
+ "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": "deploymentmanager#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. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ },
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "selfLink": "A String", # [Output Only] Self link for the type.
+ "description": "A String", # An optional textual description of the resource; provided by the client when the resource is 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/dlp_v2beta1.content.html b/docs/dyn/dlp_v2beta1.content.html
new file mode 100644
index 0000000..76cbb56
--- /dev/null
+++ b/docs/dyn/dlp_v2beta1.content.html
@@ -0,0 +1,300 @@
+<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="dlp_v2beta1.html">DLP API</a> . <a href="dlp_v2beta1.content.html">content</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#inspect">inspect(body, x__xgafv=None)</a></code></p>
+<p class="firstline">Find potentially sensitive info in a list of strings.</p>
+<p class="toc_element">
+ <code><a href="#redact">redact(body, x__xgafv=None)</a></code></p>
+<p class="firstline">Redact potentially sensitive info from a list of strings.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="inspect">inspect(body, x__xgafv=None)</code>
+ <pre>Find potentially sensitive info in a list of strings.
+This method has limits on input size, processing time, and output size.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request to search for potentially sensitive info in a list of items.
+ "items": [ # The list of items to inspect. Items in a single request are
+ # considered "related" unless inspect_config.independent_inputs is true.
+ # Up to 100 are allowed per request.
+ { # Container structure for the content to inspect.
+ "type": "A String", # Type of the content, as defined in Content-Type HTTP header.
+ # Supported types are: all "text" types, octet streams, PNG images,
+ # JPEG images.
+ "data": "A String", # Content data to inspect or redact.
+ "value": "A String", # String data to inspect or redact.
+ },
+ ],
+ "inspectConfig": { # Configuration description of the scanning process. # Configuration for the inspector.
+ # When used with redactContent only info_types and min_likelihood are currently
+ # used.
+ "minLikelihood": "A String", # Only return findings equal or above this threshold.
+ "includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding will
+ # be included in the response; see Finding.quote.
+ "excludeTypes": True or False, # When true, exclude type information of the findings.
+ "infoTypes": [ # Restrict what info_types to look for. The values must correspond to
+ # InfoType values returned by ListInfoTypes or found in documentation.
+ # Empty info_types runs all enabled detectors.
+ { # Type of information detected by the API.
+ "name": "A String", # Name of the information type, provided by the API call ListInfoTypes.
+ },
+ ],
+ "maxFindings": 42, # Limit the number of findings per content item.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Results of inspecting a list of items.
+ "results": [ # Each content_item from the request will have a result in this list, in the
+ # same order as the request.
+ { # All the findings for a single scanned item.
+ "findingsTruncated": True or False, # If true, then this item might have more findings than were returned,
+ # and the findings returned are an arbitrary subset of all findings.
+ # The findings list might be truncated because the input items were too
+ # large, or because the server reached the maximum amount of resources
+ # allowed for a single API call. For best results, divide the input into
+ # smaller batches.
+ "findings": [ # List of findings for an item.
+ { # Container structure describing a single finding within a string or image.
+ "quote": "A String", # The specific string that may be potentially sensitive info.
+ "likelihood": "A String", # Estimate of how likely it is that the info_type is correct.
+ "infoType": { # Type of information detected by the API. # The specific type of info the string might be.
+ "name": "A String", # Name of the information type, provided by the API call ListInfoTypes.
+ },
+ "createTime": "A String", # Timestamp when finding was detected.
+ "location": { # Specifies the location of a finding within its source item. # Location of the info found.
+ "fieldId": { # General identifier of a data field in a storage service. # Field id of the field containing the finding.
+ "columnName": "A String", # Column name describing the field.
+ },
+ "imageBoxes": [ # Location within an image's pixels.
+ { # Bounding box encompassing detected text within an image.
+ "width": 42, # Width of the bounding box in pixels.
+ "top": 42, # Top coordinate of the bounding box. (0,0) is upper left.
+ "left": 42, # Left coordinate of the bounding box. (0,0) is upper left.
+ "height": 42, # Height of the bounding box in pixels.
+ },
+ ],
+ "codepointRange": { # Generic half-open interval [start, end) # Character offsets within a content item, included when content type
+ # is a text. Default charset assumed to be UTF-8.
+ "start": "A String", # Index of the first character of the range (inclusive).
+ "end": "A String", # Index of the last character of the range (exclusive).
+ },
+ "recordKey": { # Message for a unique key indicating a record that contains a finding. # Key of the finding.
+ "cloudStorageKey": { # Record key for a finding in a Cloud Storage file.
+ "startOffset": "A String", # Byte offset of the referenced data in the file.
+ "filePath": "A String", # Path to the file.
+ },
+ "datastoreKey": { # Record key for a finding in Cloud Datastore.
+ "entityKey": { # A unique identifier for a Datastore entity. # Datastore entity key.
+ # If a key's partition ID or any of its path kinds or names are
+ # reserved/read-only, the key is reserved/read-only.
+ # A reserved/read-only key is forbidden in certain documented contexts.
+ "path": [ # The entity path.
+ # An entity path consists of one or more elements composed of a kind and a
+ # string or numerical identifier, which identify entities. The first
+ # element identifies a _root entity_, the second element identifies
+ # a _child_ of the root entity, the third element identifies a child of the
+ # second entity, and so forth. The entities identified by all prefixes of
+ # the path are called the element's _ancestors_.
+ #
+ # A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # If either name or ID is set, the element is complete.
+ # If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity.
+ # A kind matching regex `__.*__` is reserved/read-only.
+ # A kind must not contain more than 1500 bytes when UTF-8 encoded.
+ # Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
+ "name": "A String", # The name of the entity.
+ # A name matching regex `__.*__` is reserved/read-only.
+ # A name must not be more than 1500 bytes when UTF-8 encoded.
+ # Cannot be `""`.
+ },
+ ],
+ "partitionId": { # Datastore partition ID. # Entities are partitioned into subsets, currently identified by a project
+ # ID and namespace ID.
+ # Queries are scoped to a single partition.
+ # A partition ID identifies a grouping of entities. The grouping is always
+ # by project and namespace, however the namespace ID may be empty.
+ #
+ # A partition ID contains several dimensions:
+ # project ID and namespace ID.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ "databaseId": "A String", # If not empty, the ID of the database to which the entities
+ # belong.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ },
+ },
+ },
+ },
+ "byteRange": { # Generic half-open interval [start, end) # Zero-based byte offsets within a content item.
+ "start": "A String", # Index of the first character of the range (inclusive).
+ "end": "A String", # Index of the last character of the range (exclusive).
+ },
+ },
+ },
+ ],
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="redact">redact(body, x__xgafv=None)</code>
+ <pre>Redact potentially sensitive info from a list of strings.
+This method has limits on input size, processing time, and output size.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request to search for potentially sensitive info in a list of items
+ # and replace it with a default or provided content.
+ "items": [ # The list of items to inspect. Up to 100 are allowed per request.
+ { # Container structure for the content to inspect.
+ "type": "A String", # Type of the content, as defined in Content-Type HTTP header.
+ # Supported types are: all "text" types, octet streams, PNG images,
+ # JPEG images.
+ "data": "A String", # Content data to inspect or redact.
+ "value": "A String", # String data to inspect or redact.
+ },
+ ],
+ "inspectConfig": { # Configuration description of the scanning process. # Configuration for the inspector.
+ # When used with redactContent only info_types and min_likelihood are currently
+ # used.
+ "minLikelihood": "A String", # Only return findings equal or above this threshold.
+ "includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding will
+ # be included in the response; see Finding.quote.
+ "excludeTypes": True or False, # When true, exclude type information of the findings.
+ "infoTypes": [ # Restrict what info_types to look for. The values must correspond to
+ # InfoType values returned by ListInfoTypes or found in documentation.
+ # Empty info_types runs all enabled detectors.
+ { # Type of information detected by the API.
+ "name": "A String", # Name of the information type, provided by the API call ListInfoTypes.
+ },
+ ],
+ "maxFindings": 42, # Limit the number of findings per content item.
+ },
+ "replaceConfigs": [ # The strings to replace findings with. Must specify at least one.
+ {
+ "replaceWith": "A String", # Content replacing sensitive information of given type. Max 256 chars.
+ "infoType": { # Type of information detected by the API. # Type of information to replace. Only one ReplaceConfig per info_type
+ # should be provided. If ReplaceConfig does not have an info_type, we'll
+ # match it against all info_types that are found but not specified in
+ # another ReplaceConfig.
+ "name": "A String", # Name of the information type, provided by the API call ListInfoTypes.
+ },
+ },
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Results of deidentifying a list of items.
+ "items": [ # The redacted content.
+ { # Container structure for the content to inspect.
+ "type": "A String", # Type of the content, as defined in Content-Type HTTP header.
+ # Supported types are: all "text" types, octet streams, PNG images,
+ # JPEG images.
+ "data": "A String", # Content data to inspect or redact.
+ "value": "A String", # String data to inspect or redact.
+ },
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dlp_v2beta1.html b/docs/dyn/dlp_v2beta1.html
new file mode 100644
index 0000000..bfd5c57
--- /dev/null
+++ b/docs/dyn/dlp_v2beta1.html
@@ -0,0 +1,113 @@
+<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="dlp_v2beta1.html">DLP API</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="dlp_v2beta1.content.html">content()</a></code>
+</p>
+<p class="firstline">Returns the content Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dlp_v2beta1.inspect.html">inspect()</a></code>
+</p>
+<p class="firstline">Returns the inspect Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dlp_v2beta1.rootCategories.html">rootCategories()</a></code>
+</p>
+<p class="firstline">Returns the rootCategories 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/dlp_v2beta1.inspect.html b/docs/dyn/dlp_v2beta1.inspect.html
new file mode 100644
index 0000000..b0a49d4
--- /dev/null
+++ b/docs/dyn/dlp_v2beta1.inspect.html
@@ -0,0 +1,87 @@
+<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="dlp_v2beta1.html">DLP API</a> . <a href="dlp_v2beta1.inspect.html">inspect</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="dlp_v2beta1.inspect.operations.html">operations()</a></code>
+</p>
+<p class="firstline">Returns the operations Resource.</p>
+
+<p class="toc_element">
+ <code><a href="dlp_v2beta1.inspect.results.html">results()</a></code>
+</p>
+<p class="firstline">Returns the results Resource.</p>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dlp_v2beta1.inspect.operations.html b/docs/dyn/dlp_v2beta1.inspect.operations.html
new file mode 100644
index 0000000..0daa74f
--- /dev/null
+++ b/docs/dyn/dlp_v2beta1.inspect.operations.html
@@ -0,0 +1,515 @@
+<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="dlp_v2beta1.html">DLP API</a> . <a href="dlp_v2beta1.inspect.html">inspect</a> . <a href="dlp_v2beta1.inspect.operations.html">operations</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#cancel">cancel(name, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Cancels an operation. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.</p>
+<p class="toc_element">
+ <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
+<p class="firstline">Schedule a job scanning content in a Google Cloud Platform data repository.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
+<p class="firstline">This method is not supported and the server returns `UNIMPLEMENTED`.</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, body, x__xgafv=None)</code>
+ <pre>Cancels an operation. Use the get method 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)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+ }
+
+ 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(body, x__xgafv=None)</code>
+ <pre>Schedule a job scanning content in a Google Cloud Platform data repository.
+
+Args:
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request for scheduling a scan of a data subset from a Google Platform data
+ # repository.
+ "inspectConfig": { # Configuration description of the scanning process. # Configuration for the inspector.
+ # When used with redactContent only info_types and min_likelihood are currently
+ # used.
+ "minLikelihood": "A String", # Only return findings equal or above this threshold.
+ "includeQuote": True or False, # When true, a contextual quote from the data that triggered a finding will
+ # be included in the response; see Finding.quote.
+ "excludeTypes": True or False, # When true, exclude type information of the findings.
+ "infoTypes": [ # Restrict what info_types to look for. The values must correspond to
+ # InfoType values returned by ListInfoTypes or found in documentation.
+ # Empty info_types runs all enabled detectors.
+ { # Type of information detected by the API.
+ "name": "A String", # Name of the information type, provided by the API call ListInfoTypes.
+ },
+ ],
+ "maxFindings": 42, # Limit the number of findings per content item.
+ },
+ "storageConfig": { # Shared message indicating Cloud storage type. # Specification of the data set to process.
+ "datastoreOptions": { # Options defining a data set within Google Cloud Datastore. # Google Cloud Datastore options specification.
+ "kind": { # A representation of a Datastore kind. # The kind to process.
+ "name": "A String", # The name of the kind.
+ },
+ "projection": [ # Properties to scan. If none are specified, all properties will be scanned
+ # by default.
+ { # A representation of a Datastore property in a projection.
+ "property": { # A reference to a property relative to the Datastore kind expressions. # The property to project.
+ "name": "A String", # The name of the property.
+ # If name includes "."s, it may be interpreted as a property name path.
+ },
+ },
+ ],
+ "partitionId": { # Datastore partition ID. # A partition ID identifies a grouping of entities. The grouping is always
+ # by project and namespace, however the namespace ID may be empty.
+ # A partition ID identifies a grouping of entities. The grouping is always
+ # by project and namespace, however the namespace ID may be empty.
+ #
+ # A partition ID contains several dimensions:
+ # project ID and namespace ID.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ "databaseId": "A String", # If not empty, the ID of the database to which the entities
+ # belong.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ },
+ },
+ "cloudStorageOptions": { # Options defining a file or a set of files (path ending with *) within # Google Cloud Storage options specification.
+ # a Google Cloud Storage bucket.
+ "fileSet": { # Set of files to scan.
+ "url": "A String", # The url, in the format gs://<bucket>/<path>. Trailing wildcard in the
+ # path is allowed.
+ },
+ },
+ },
+ }
+
+ 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": { # This field will contain an `InspectOperationMetdata` object.
+ "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 # 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:
+ #
+ # - 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.
+ },
+ ],
+ },
+ "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": { # This field will contain an `InspectOperationResult` object.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, The `name` should have the format of `inspect/operations/<identifier>`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(name, x__xgafv=None)</code>
+ <pre>This method is not supported and the server returns `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": { # This field will contain an `InspectOperationMetdata` object.
+ "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 # 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:
+ #
+ # - 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.
+ },
+ ],
+ },
+ "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": { # This field will contain an `InspectOperationResult` object.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, The `name` should have the format of `inspect/operations/<identifier>`.
+ }</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 list page size. The max allowed value is 256 and default is 100.
+ filter: string, This parameter supports filtering by done, ie done=true or done=false.
+ pageToken: string, The 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.
+ "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": { # This field will contain an `InspectOperationMetdata` object.
+ "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 # 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:
+ #
+ # - 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.
+ },
+ ],
+ },
+ "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": { # This field will contain an `InspectOperationResult` object.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, The `name` should have the format of `inspect/operations/<identifier>`.
+ },
+ ],
+ "nextPageToken": "A String", # The standard List next-page token.
+ }</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/dlp_v2beta1.inspect.results.findings.html b/docs/dyn/dlp_v2beta1.inspect.results.findings.html
new file mode 100644
index 0000000..6c6ea50
--- /dev/null
+++ b/docs/dyn/dlp_v2beta1.inspect.results.findings.html
@@ -0,0 +1,217 @@
+<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="dlp_v2beta1.html">DLP API</a> . <a href="dlp_v2beta1.inspect.html">inspect</a> . <a href="dlp_v2beta1.inspect.results.html">results</a> . <a href="dlp_v2beta1.inspect.results.findings.html">findings</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#list">list(name=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+<p class="firstline">Returns list of results for given inspect operation result set id.</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(name=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <pre>Returns list of results for given inspect operation result set id.
+
+Args:
+ name: string, Identifier of the results set returned as metadata of
+the longrunning operation created by a call to CreateInspectOperation.
+Should be in the format of `inspect/results/{id}. (required)
+ pageToken: string, The value returned by the last `ListInspectFindingsResponse`; indicates
+that this is a continuation of a prior `ListInspectFindings` call, and that
+the system should return the next page of data.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ pageSize: integer, Maximum number of results to return.
+If 0, the implementation will select a reasonable value.
+
+Returns:
+ An object of the form:
+
+ { # Response to the ListInspectFindings request.
+ "nextPageToken": "A String", # If not empty, indicates that there may be more results that match the
+ # request; this value should be passed in a new `ListInspectFindingsRequest`.
+ "result": { # All the findings for a single scanned item. # The results.
+ "findingsTruncated": True or False, # If true, then this item might have more findings than were returned,
+ # and the findings returned are an arbitrary subset of all findings.
+ # The findings list might be truncated because the input items were too
+ # large, or because the server reached the maximum amount of resources
+ # allowed for a single API call. For best results, divide the input into
+ # smaller batches.
+ "findings": [ # List of findings for an item.
+ { # Container structure describing a single finding within a string or image.
+ "quote": "A String", # The specific string that may be potentially sensitive info.
+ "likelihood": "A String", # Estimate of how likely it is that the info_type is correct.
+ "infoType": { # Type of information detected by the API. # The specific type of info the string might be.
+ "name": "A String", # Name of the information type, provided by the API call ListInfoTypes.
+ },
+ "createTime": "A String", # Timestamp when finding was detected.
+ "location": { # Specifies the location of a finding within its source item. # Location of the info found.
+ "fieldId": { # General identifier of a data field in a storage service. # Field id of the field containing the finding.
+ "columnName": "A String", # Column name describing the field.
+ },
+ "imageBoxes": [ # Location within an image's pixels.
+ { # Bounding box encompassing detected text within an image.
+ "width": 42, # Width of the bounding box in pixels.
+ "top": 42, # Top coordinate of the bounding box. (0,0) is upper left.
+ "left": 42, # Left coordinate of the bounding box. (0,0) is upper left.
+ "height": 42, # Height of the bounding box in pixels.
+ },
+ ],
+ "codepointRange": { # Generic half-open interval [start, end) # Character offsets within a content item, included when content type
+ # is a text. Default charset assumed to be UTF-8.
+ "start": "A String", # Index of the first character of the range (inclusive).
+ "end": "A String", # Index of the last character of the range (exclusive).
+ },
+ "recordKey": { # Message for a unique key indicating a record that contains a finding. # Key of the finding.
+ "cloudStorageKey": { # Record key for a finding in a Cloud Storage file.
+ "startOffset": "A String", # Byte offset of the referenced data in the file.
+ "filePath": "A String", # Path to the file.
+ },
+ "datastoreKey": { # Record key for a finding in Cloud Datastore.
+ "entityKey": { # A unique identifier for a Datastore entity. # Datastore entity key.
+ # If a key's partition ID or any of its path kinds or names are
+ # reserved/read-only, the key is reserved/read-only.
+ # A reserved/read-only key is forbidden in certain documented contexts.
+ "path": [ # The entity path.
+ # An entity path consists of one or more elements composed of a kind and a
+ # string or numerical identifier, which identify entities. The first
+ # element identifies a _root entity_, the second element identifies
+ # a _child_ of the root entity, the third element identifies a child of the
+ # second entity, and so forth. The entities identified by all prefixes of
+ # the path are called the element's _ancestors_.
+ #
+ # A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path.
+ #
+ # If either name or ID is set, the element is complete.
+ # If neither is set, the element is incomplete.
+ "kind": "A String", # The kind of the entity.
+ # A kind matching regex `__.*__` is reserved/read-only.
+ # A kind must not contain more than 1500 bytes when UTF-8 encoded.
+ # Cannot be `""`.
+ "id": "A String", # The auto-allocated ID of the entity.
+ # Never equal to zero. Values less than zero are discouraged and may not
+ # be supported in the future.
+ "name": "A String", # The name of the entity.
+ # A name matching regex `__.*__` is reserved/read-only.
+ # A name must not be more than 1500 bytes when UTF-8 encoded.
+ # Cannot be `""`.
+ },
+ ],
+ "partitionId": { # Datastore partition ID. # Entities are partitioned into subsets, currently identified by a project
+ # ID and namespace ID.
+ # Queries are scoped to a single partition.
+ # A partition ID identifies a grouping of entities. The grouping is always
+ # by project and namespace, however the namespace ID may be empty.
+ #
+ # A partition ID contains several dimensions:
+ # project ID and namespace ID.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ "databaseId": "A String", # If not empty, the ID of the database to which the entities
+ # belong.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ },
+ },
+ },
+ },
+ "byteRange": { # Generic half-open interval [start, end) # Zero-based byte offsets within a content item.
+ "start": "A String", # Index of the first character of the range (inclusive).
+ "end": "A String", # Index of the last character of the range (exclusive).
+ },
+ },
+ },
+ ],
+ },
+ }</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/dlp_v2beta1.inspect.results.html b/docs/dyn/dlp_v2beta1.inspect.results.html
new file mode 100644
index 0000000..fd4793e
--- /dev/null
+++ b/docs/dyn/dlp_v2beta1.inspect.results.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="dlp_v2beta1.html">DLP API</a> . <a href="dlp_v2beta1.inspect.html">inspect</a> . <a href="dlp_v2beta1.inspect.results.html">results</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="dlp_v2beta1.inspect.results.findings.html">findings()</a></code>
+</p>
+<p class="firstline">Returns the findings Resource.</p>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dlp_v2beta1.rootCategories.html b/docs/dyn/dlp_v2beta1.rootCategories.html
new file mode 100644
index 0000000..9b2235a
--- /dev/null
+++ b/docs/dyn/dlp_v2beta1.rootCategories.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="dlp_v2beta1.html">DLP API</a> . <a href="dlp_v2beta1.rootCategories.html">rootCategories</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="dlp_v2beta1.rootCategories.infoTypes.html">infoTypes()</a></code>
+</p>
+<p class="firstline">Returns the infoTypes Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#list">list(languageCode=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns the list of root categories of sensitive information.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="list">list(languageCode=None, x__xgafv=None)</code>
+ <pre>Returns the list of root categories of sensitive information.
+
+Args:
+ languageCode: string, Optional language code for localized friendly category names.
+If omitted or if localized strings are not available,
+en-US strings will be returned.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for ListRootCategories request.
+ "categories": [ # List of all into type categories supported by the API.
+ { # Info Type Category description.
+ "displayName": "A String", # Human readable form of the category name.
+ "name": "A String", # Internal name of the category.
+ },
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/dlp_v2beta1.rootCategories.infoTypes.html b/docs/dyn/dlp_v2beta1.rootCategories.infoTypes.html
new file mode 100644
index 0000000..8e3e5d7
--- /dev/null
+++ b/docs/dyn/dlp_v2beta1.rootCategories.infoTypes.html
@@ -0,0 +1,114 @@
+<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="dlp_v2beta1.html">DLP API</a> . <a href="dlp_v2beta1.rootCategories.html">rootCategories</a> . <a href="dlp_v2beta1.rootCategories.infoTypes.html">infoTypes</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="#list">list(category, languageCode=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns sensitive information types for given category.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="list">list(category, languageCode=None, x__xgafv=None)</code>
+ <pre>Returns sensitive information types for given category.
+
+Args:
+ category: string, Category name as returned by ListRootCategories. (required)
+ languageCode: string, Optional BCP-47 language code for localized info type friendly
+names. If omitted, or if localized strings are not available,
+en-US strings will be returned.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response to the ListInfoTypes request.
+ "infoTypes": [ # Set of sensitive info types belonging to a category.
+ { # Info type description.
+ "displayName": "A String", # Human readable form of the info type name.
+ "name": "A String", # Internal name of the info type.
+ "categories": [ # List of categories this info type belongs to.
+ { # Info Type Category description.
+ "displayName": "A String", # Human readable form of the category name.
+ "name": "A String", # Internal name of the category.
+ },
+ ],
+ },
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file
diff --git a/docs/dyn/drive_v2.changes.html b/docs/dyn/drive_v2.changes.html
index 431b105..c5a3692 100644
--- a/docs/dyn/drive_v2.changes.html
+++ b/docs/dyn/drive_v2.changes.html
@@ -349,7 +349,7 @@
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
+ "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
@@ -710,7 +710,7 @@
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
+ "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
diff --git a/docs/dyn/drive_v2.files.html b/docs/dyn/drive_v2.files.html
index 35b29bd..46686d3 100644
--- a/docs/dyn/drive_v2.files.html
+++ b/docs/dyn/drive_v2.files.html
@@ -362,7 +362,7 @@
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
+ "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
@@ -667,7 +667,7 @@
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
+ "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
@@ -1034,7 +1034,7 @@
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
+ "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
@@ -1354,7 +1354,7 @@
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
+ "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
@@ -1662,7 +1662,7 @@
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
+ "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
@@ -1984,7 +1984,7 @@
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
+ "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
@@ -2303,7 +2303,7 @@
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
+ "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
@@ -2618,7 +2618,7 @@
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
+ "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
@@ -2920,7 +2920,7 @@
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
+ "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
@@ -3222,7 +3222,7 @@
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
+ "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
@@ -3524,7 +3524,7 @@
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
+ "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
@@ -3824,7 +3824,7 @@
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
+ "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
@@ -4141,7 +4141,7 @@
"defaultOpenWithLink": "A String", # A link to open this file with the user's default app for this file. Only populated when the drive.apps.readonly scope is used.
"embedLink": "A String", # A link for embedding the file.
"alternateLink": "A String", # A link for opening the file in a relevant Google editor or viewer.
- "title": "A String", # The title of this file.
+ "title": "A String", # The title of this file. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the title is constant.
"modifiedByMeDate": "A String", # Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.
"thumbnail": { # A thumbnail for the file. This will only be used if Drive cannot generate a standard thumbnail.
"mimeType": "A String", # The MIME type of the thumbnail.
diff --git a/docs/dyn/drive_v3.changes.html b/docs/dyn/drive_v3.changes.html
index e34cffe..7ab2f43 100644
--- a/docs/dyn/drive_v3.changes.html
+++ b/docs/dyn/drive_v3.changes.html
@@ -314,7 +314,7 @@
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"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.
+ "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the name is constant.
"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.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files.
"me": True or False, # Whether this user is the requesting user.
diff --git a/docs/dyn/drive_v3.files.html b/docs/dyn/drive_v3.files.html
index e3ea11f..8cd838f 100644
--- a/docs/dyn/drive_v3.files.html
+++ b/docs/dyn/drive_v3.files.html
@@ -292,7 +292,7 @@
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"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.
+ "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the name is constant.
"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.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files.
"me": True or False, # Whether this user is the requesting user.
@@ -493,7 +493,7 @@
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"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.
+ "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the name is constant.
"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.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files.
"me": True or False, # Whether this user is the requesting user.
@@ -695,7 +695,7 @@
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"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.
+ "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the name is constant.
"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.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files.
"me": True or False, # Whether this user is the requesting user.
@@ -899,7 +899,7 @@
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"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.
+ "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the name is constant.
"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.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files.
"me": True or False, # Whether this user is the requesting user.
@@ -1163,7 +1163,7 @@
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"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.
+ "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the name is constant.
"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.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files.
"me": True or False, # Whether this user is the requesting user.
@@ -1396,7 +1396,7 @@
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"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.
+ "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the name is constant.
"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.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files.
"me": True or False, # Whether this user is the requesting user.
@@ -1618,7 +1618,7 @@
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"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.
+ "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the name is constant.
"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.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files.
"me": True or False, # Whether this user is the requesting user.
@@ -1823,7 +1823,7 @@
"cameraModel": "A String", # The model of the camera used to create the photo.
},
"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.
+ "name": "A String", # The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the name is constant.
"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.
"trashingUser": { # Information about a Drive user. # If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive files.
"me": True or False, # Whether this user is the requesting user.
diff --git a/docs/dyn/firebasedynamiclinks_v1.shortLinks.html b/docs/dyn/firebasedynamiclinks_v1.shortLinks.html
index e60a18f..45a6f7f 100644
--- a/docs/dyn/firebasedynamiclinks_v1.shortLinks.html
+++ b/docs/dyn/firebasedynamiclinks_v1.shortLinks.html
@@ -139,8 +139,8 @@
},
"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).
- "androidPackageName": "A String", # Android package name of the app.
"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.
diff --git a/docs/dyn/firebaserules_v1.projects.html b/docs/dyn/firebaserules_v1.projects.html
index afd044c..f860c39 100644
--- a/docs/dyn/firebaserules_v1.projects.html
+++ b/docs/dyn/firebaserules_v1.projects.html
@@ -86,18 +86,17 @@
<p class="toc_element">
<code><a href="#test">test(name=None, body, x__xgafv=None)</a></code></p>
-<p class="firstline">Test `Source` for syntactic and semantic correctness. Issues present in the</p>
+<p class="firstline">Test `Source` for syntactic and semantic correctness. Issues present, if</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="test">test(name=None, body, x__xgafv=None)</code>
- <pre>Test `Source` for syntactic and semantic correctness. Issues present in the
-rules, if any, will be returned to the caller with a description, severity,
-and source location.
+ <pre>Test `Source` for syntactic and semantic correctness. Issues present, if
+any, will be returned to the caller with a description, severity, and
+source location.
-The test method will typically be executed with a developer provided
-`Source`, but if regression testing is desired, this method may be
-executed against a `Ruleset` resource name and the `Source` will be
-retrieved from the persisted `Ruleset`.
+The test method may be executed with `Source` or a `Ruleset` name.
+Passing `Source` is useful for unit testing new rules. Passing a `Ruleset`
+name is useful for regression testing an existing rule.
The following is an example of `Source` that permits users to upload images
to a bucket bearing their user id and matching the correct metadata:
@@ -107,21 +106,28 @@
// Users are allowed to subscribe and unsubscribe to the blog.
service firebase.storage {
match /users/{userId}/images/{imageName} {
- allow write: if userId == request.userId
- && (imageName.endsWith('.png') || imageName.endsWith('.jpg'))
- && resource.mimeType.startsWith('image/')
+ allow write: if userId == request.auth.uid
+ && (imageName.matches('*.png$')
+ || imageName.matches('*.jpg$'))
+ && resource.mimeType.matches('^image/')
}
}
Args:
- name: string, Name of the project.
+ name: string, Tests may either provide `source` or a `Ruleset` resource name.
-Format: `projects/{project_id}` (required)
+For tests against `source`, the resource name must refer to the project:
+Format: `projects/{project_id}`
+
+For tests against a `Ruleset`, this must be the `Ruleset` resource name:
+Format: `projects/{project_id}/rulesets/{ruleset_id}` (required)
body: object, The request body. (required)
The object takes the form of:
{ # The request for FirebaseRulesService.TestRuleset.
- "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # `Source` to be checked for correctness.
+ "source": { # `Source` is one or more `File` messages comprising a logical set of rules. # Optional `Source` to be checked for correctness.
+ #
+ # This field must not be set when the resource name refers to a `Ruleset`.
"files": [ # `File` set constituting the `Source` bundle.
{ # `File` containing source content.
"content": "A String", # Textual Content.
@@ -141,6 +147,49 @@
An object of the form:
{ # The response for FirebaseRulesService.TestRuleset.
+ "testResults": [ # The set of test results given the test cases in the `TestSuite`.
+ # The results will appear in the same order as the test cases appear in the
+ # `TestSuite`.
+ { # Test result message containing the state of the test as well as a
+ # description and source position for test failures.
+ "debugMessages": [ # Debug messages related to test execution issues encountered during
+ # evaluation.
+ #
+ # Debug messages may be related to too many or too few invocations of
+ # function mocks or to runtime errors that occur during evaluation.
+ #
+ # For example: ```Unable to read variable [name: "resource"]```
+ "A String",
+ ],
+ "state": "A String", # State of the test.
+ "errorPosition": { # Position in the `Source` content including its line, column number, and an # Position in the `Source` or `Ruleset` where the principle runtime error
+ # occurs.
+ #
+ # Evaluation of an expression may result in an error. Rules are deny by
+ # default, so a `DENY` expectation when an error is generated is valid.
+ # When there is a `DENY` with an error, the `SourcePosition` is returned.
+ #
+ # E.g. `error_position { line: 19 column: 37 }`
+ # index of the `File` in the `Source` message. Used for debug purposes.
+ "column": 42, # First column on the source line associated with the source fragment.
+ "line": 42, # Line number of the source fragment. 1-based.
+ "fileName": "A String", # Name of the `File`.
+ },
+ "functionCalls": [ # The set of function calls made to service-defined methods.
+ #
+ # Function calls are included in the order in which they are encountered
+ # during evaluation, are provided for both mocked and unmocked functions,
+ # and included on the response regardless of the test `state`.
+ { # Represents a service-defined function call that was invoked during test
+ # execution.
+ "function": "A String", # Name of the function invoked.
+ "args": [ # The arguments that were provided to the function.
+ "",
+ ],
+ },
+ ],
+ },
+ ],
"issues": [ # Syntactic and semantic `Source` issues of varying severity. Issues of
# `ERROR` severity will prevent tests from executing.
{ # Issues include warnings, errors, and deprecation notices.
@@ -150,8 +199,8 @@
"line": 42, # Line number of the source fragment. 1-based.
"fileName": "A String", # Name of the `File`.
},
- "description": "A String", # Short error description.
"severity": "A String", # The severity of the issue.
+ "description": "A String", # Short error description.
},
],
}</pre>
diff --git a/docs/dyn/firebaserules_v1.projects.releases.html b/docs/dyn/firebaserules_v1.projects.releases.html
index a3f791c..0b56eb8 100644
--- a/docs/dyn/firebaserules_v1.projects.releases.html
+++ b/docs/dyn/firebaserules_v1.projects.releases.html
@@ -116,8 +116,7 @@
The table reflects the `Ruleset` rollout in progress. The `prod` and
`prod/beta` releases refer to the same `Ruleset`. However, `prod/v23`
refers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be
-updated using the UpdateRelease method, and the custom `Release` name
-may be referenced by specifying the `X-Firebase-Rules-Release-Name` header.
+updated using the UpdateRelease method.
Args:
name: string, Resource name for the project which owns this `Release`.
@@ -129,11 +128,9 @@
{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
# `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
"updateTime": "A String", # Time the release was updated.
- # @OutputOnly
+ # Output only.
"rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
# exist the `Release` to be created.
- "createTime": "A String", # Time the release was created.
- # @OutputOnly
"name": "A String", # Resource name for the `Release`.
#
# `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
@@ -158,6 +155,8 @@
# relationship between `Release` instances.
#
# Format: `projects/{project_id}/releases/{release_id}`
+ "createTime": "A String", # Time the release was created.
+ # Output only.
}
x__xgafv: string, V1 error format.
@@ -171,11 +170,9 @@
{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
# `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
"updateTime": "A String", # Time the release was updated.
- # @OutputOnly
+ # Output only.
"rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
# exist the `Release` to be created.
- "createTime": "A String", # Time the release was created.
- # @OutputOnly
"name": "A String", # Resource name for the `Release`.
#
# `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
@@ -200,6 +197,8 @@
# relationship between `Release` instances.
#
# Format: `projects/{project_id}/releases/{release_id}`
+ "createTime": "A String", # Time the release was created.
+ # Output only.
}</pre>
</div>
@@ -238,7 +237,6 @@
Args:
name: string, Resource name of the `Release`.
-
Format: `projects/{project_id}/releases/{release_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -251,11 +249,9 @@
{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
# `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
"updateTime": "A String", # Time the release was updated.
- # @OutputOnly
+ # Output only.
"rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
# exist the `Release` to be created.
- "createTime": "A String", # Time the release was created.
- # @OutputOnly
"name": "A String", # Resource name for the `Release`.
#
# `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
@@ -280,26 +276,30 @@
# relationship between `Release` instances.
#
# Format: `projects/{project_id}/releases/{release_id}`
+ "createTime": "A String", # Time the release was created.
+ # Output only.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(name=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
<pre>List the `Release` values for a project. This list may optionally be
-filtered by `Release` name or `Ruleset` id or both.
+filtered by `Release` name, `Ruleset` name, `TestSuite` name, or any
+combination thereof.
Args:
name: string, Resource name for the project.
Format: `projects/{project_id}` (required)
pageSize: integer, Page size to load. Maximum of 100. Defaults to 10.
-Note: `page_size` is just a hint and the service may choose to load less
-than `page_size` due to the size of the output. To traverse all of the
-releases, caller should iterate until the `page_token` is empty.
+Note: `page_size` is just a hint and the service may choose to load fewer
+than `page_size` results due to the size of the output. To traverse all of
+the releases, the caller should iterate until the `page_token` on the
+response is empty.
filter: string, `Release` filter. The list method supports filters with restrictions on the
-`Release` `name` and also on the `Ruleset` `ruleset_name`.
+`Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`.
-Example 1) A filter of 'name=prod*' might return `Release`s with names
+Example 1: A filter of 'name=prod*' might return `Release`s with names
within 'projects/foo' prefixed with 'prod':
Name | Ruleset Name
@@ -308,7 +308,7 @@
projects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234
projects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888
-Example 2) A filter of `name=prod* ruleset_name=uuid1234` would return only
+Example 2: A filter of `name=prod* ruleset_name=uuid1234` would return only
`Release` instances for 'projects/foo' with names prefixed with 'prod'
referring to the same `Ruleset` name of 'uuid1234':
@@ -317,10 +317,9 @@
projects/foo/releases/prod | projects/foo/rulesets/1234
projects/foo/releases/prod/v1 | projects/foo/rulesets/1234
-In the examples, the filter parameters refer to the search filters for
-release and ruleset names are relative to the project releases and rulesets
-collections. Fully qualified prefixed may also be used. e.g.
-`name=projects/foo/releases/prod* ruleset_name=projects/foo/rulesets/uuid1`
+In the examples, the filter parameters refer to the search filters are
+relative to the project. Fully qualified prefixed may also be used. e.g.
+`test_suite_name=projects/foo/testsuites/uuid1`
pageToken: string, Next page token for the next batch of `Release` instances.
x__xgafv: string, V1 error format.
Allowed values
@@ -337,11 +336,9 @@
{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
# `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
"updateTime": "A String", # Time the release was updated.
- # @OutputOnly
+ # Output only.
"rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
# exist the `Release` to be created.
- "createTime": "A String", # Time the release was created.
- # @OutputOnly
"name": "A String", # Resource name for the `Release`.
#
# `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
@@ -366,6 +363,8 @@
# relationship between `Release` instances.
#
# Format: `projects/{project_id}/releases/{release_id}`
+ "createTime": "A String", # Time the release was created.
+ # Output only.
},
],
}</pre>
@@ -389,9 +388,9 @@
<code class="details" id="update">update(name=None, body, x__xgafv=None)</code>
<pre>Update a `Release`.
-Only updates to the `ruleset_name` field will be honored. `Release` rename
-is not supported. To create a `Release` use the CreateRelease method
-instead.
+Only updates to the `ruleset_name` and `test_suite_name` fields will be
+honored. `Release` rename is not supported. To create a `Release` use the
+CreateRelease method.
Args:
name: string, Resource name for the `Release`.
@@ -424,11 +423,9 @@
{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
# `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
"updateTime": "A String", # Time the release was updated.
- # @OutputOnly
+ # Output only.
"rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
# exist the `Release` to be created.
- "createTime": "A String", # Time the release was created.
- # @OutputOnly
"name": "A String", # Resource name for the `Release`.
#
# `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
@@ -453,6 +450,8 @@
# relationship between `Release` instances.
#
# Format: `projects/{project_id}/releases/{release_id}`
+ "createTime": "A String", # Time the release was created.
+ # Output only.
}
x__xgafv: string, V1 error format.
@@ -466,11 +465,9 @@
{ # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a
# `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
"updateTime": "A String", # Time the release was updated.
- # @OutputOnly
+ # Output only.
"rulesetName": "A String", # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must
# exist the `Release` to be created.
- "createTime": "A String", # Time the release was created.
- # @OutputOnly
"name": "A String", # Resource name for the `Release`.
#
# `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`
@@ -495,6 +492,8 @@
# relationship between `Release` instances.
#
# Format: `projects/{project_id}/releases/{release_id}`
+ "createTime": "A String", # Time the release was created.
+ # Output only.
}</pre>
</div>
diff --git a/docs/dyn/firebaserules_v1.projects.rulesets.html b/docs/dyn/firebaserules_v1.projects.rulesets.html
index 6130a25..dc882f0 100644
--- a/docs/dyn/firebaserules_v1.projects.rulesets.html
+++ b/docs/dyn/firebaserules_v1.projects.rulesets.html
@@ -84,8 +84,8 @@
<code><a href="#get">get(name=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get a `Ruleset` by name including the full `Source` contents.</p>
<p class="toc_element">
- <code><a href="#list">list(name=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
-<p class="firstline">List `Ruleset` metadata only and optionally filter the results by Ruleset</p>
+ <code><a href="#list">list(name=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">List `Ruleset` metadata only and optionally filter the results by `Ruleset`</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>
@@ -118,10 +118,10 @@
],
},
"createTime": "A String", # Time the `Ruleset` was created.
- # @OutputOnly
+ # Output only.
"name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
# Format: `projects/{project_id}/rulesets/{ruleset_id}`
- # @OutputOnly
+ # Output only.
}
x__xgafv: string, V1 error format.
@@ -144,10 +144,10 @@
],
},
"createTime": "A String", # Time the `Ruleset` was created.
- # @OutputOnly
+ # Output only.
"name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
# Format: `projects/{project_id}/rulesets/{ruleset_id}`
- # @OutputOnly
+ # Output only.
}</pre>
</div>
@@ -209,16 +209,16 @@
],
},
"createTime": "A String", # Time the `Ruleset` was created.
- # @OutputOnly
+ # Output only.
"name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
# Format: `projects/{project_id}/rulesets/{ruleset_id}`
- # @OutputOnly
+ # Output only.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(name=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
- <pre>List `Ruleset` metadata only and optionally filter the results by Ruleset
+ <code class="details" id="list">list(name=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
+ <pre>List `Ruleset` metadata only and optionally filter the results by `Ruleset`
name.
The full `Source` contents of a `Ruleset` may be retrieved with
@@ -228,20 +228,27 @@
name: string, Resource name for the project.
Format: `projects/{project_id}` (required)
+ pageSize: integer, Page size to load. Maximum of 100. Defaults to 10.
+Note: `page_size` is just a hint and the service may choose to load less
+than `page_size` due to the size of the output. To traverse all of the
+releases, caller should iterate until the `page_token` is empty.
+ filter: string, `Ruleset` filter. The list method supports filters with restrictions on
+`Ruleset.name`.
+
+Filters on `Ruleset.create_time` should use the `date` function which
+parses strings that conform to the RFC 3339 date/time specifications.
+
+Example: `create_time > date("2017-01-01") AND name=UUID-*`
pageToken: string, Next page token for loading the next batch of `Ruleset` instances.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- pageSize: integer, Page size to load. Maximum of 100. Defaults to 10.
-Note: `page_size` is just a hint and the service may choose to load less
-than `page_size` due to the size of the output. To traverse all of the
-releases, caller should iterate until the `page_token` is empty.
Returns:
An object of the form:
- { # The response for FirebaseRulesService.ListRulesets
+ { # The response for FirebaseRulesService.ListRulesets.
"nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is
# empty, no further results remain.
"rulesets": [ # List of `Ruleset` instances.
@@ -257,10 +264,10 @@
],
},
"createTime": "A String", # Time the `Ruleset` was created.
- # @OutputOnly
+ # Output only.
"name": "A String", # Name of the `Ruleset`. The ruleset_id is auto generated by the service.
# Format: `projects/{project_id}/rulesets/{ruleset_id}`
- # @OutputOnly
+ # Output only.
},
],
}</pre>
diff --git a/docs/dyn/genomics_v1.annotations.html b/docs/dyn/genomics_v1.annotations.html
index 959c505..f67494e 100644
--- a/docs/dyn/genomics_v1.annotations.html
+++ b/docs/dyn/genomics_v1.annotations.html
@@ -118,6 +118,13 @@
The object takes the form of:
{
+ "requestId": "A String", # A unique request ID which enables the server to detect duplicated requests.
+ # If provided, duplicated requests will result in the same response; if not
+ # provided, duplicated requests may result in duplicated data. For a given
+ # annotation set, callers should not reuse `request_id`s when writing
+ # different batches of annotations - behavior in this case is undefined.
+ # A common approach is to use a UUID. For batch jobs where worker crashes are
+ # a possibility, consider using some unique variant of a worker or run ID.
"annotations": [ # The annotations to be created. At most 4096 can be specified in a single
# request.
{ # An annotation describes a region of reference genome. The value of an
@@ -150,10 +157,10 @@
"id": "A String", # The id used by the source of this data.
},
],
- "omimId": "A String", # The OMIM id for this condition.
- # Search for these IDs at http://omim.org/
"conceptId": "A String", # The MedGen concept id associated with this gene.
# Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
+ "omimId": "A String", # The OMIM id for this condition.
+ # Search for these IDs at http://omim.org/
"names": [ # A set of names for the condition.
"A String",
],
@@ -207,7 +214,6 @@
# 0-based exclusive. Note that this position is relative to the reference
# start, and *not* the containing annotation start.
},
- "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
"exons": [ # The <a href="http://en.wikipedia.org/wiki/Exon">exons</a> that compose
# this transcript. This field should be unset for genomes where transcript
# splicing does not occur, for example prokaryotes.
@@ -244,17 +250,11 @@
# *not* the containing annotation start.
},
],
+ "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
},
"id": "A String", # The server-generated annotation ID, unique across all annotations.
},
],
- "requestId": "A String", # A unique request ID which enables the server to detect duplicated requests.
- # If provided, duplicated requests will result in the same response; if not
- # provided, duplicated requests may result in duplicated data. For a given
- # annotation set, callers should not reuse `request_id`s when writing
- # different batches of annotations - behavior in this case is undefined.
- # A common approach is to use a UUID. For batch jobs where worker crashes are
- # a possibility, consider using some unique variant of a worker or run ID.
}
x__xgafv: string, V1 error format.
@@ -362,10 +362,10 @@
"id": "A String", # The id used by the source of this data.
},
],
- "omimId": "A String", # The OMIM id for this condition.
- # Search for these IDs at http://omim.org/
"conceptId": "A String", # The MedGen concept id associated with this gene.
# Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
+ "omimId": "A String", # The OMIM id for this condition.
+ # Search for these IDs at http://omim.org/
"names": [ # A set of names for the condition.
"A String",
],
@@ -419,7 +419,6 @@
# 0-based exclusive. Note that this position is relative to the reference
# start, and *not* the containing annotation start.
},
- "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
"exons": [ # The <a href="http://en.wikipedia.org/wiki/Exon">exons</a> that compose
# this transcript. This field should be unset for genomes where transcript
# splicing does not occur, for example prokaryotes.
@@ -456,6 +455,7 @@
# *not* the containing annotation start.
},
],
+ "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
},
"id": "A String", # The server-generated annotation ID, unique across all annotations.
},
@@ -523,10 +523,10 @@
"id": "A String", # The id used by the source of this data.
},
],
- "omimId": "A String", # The OMIM id for this condition.
- # Search for these IDs at http://omim.org/
"conceptId": "A String", # The MedGen concept id associated with this gene.
# Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
+ "omimId": "A String", # The OMIM id for this condition.
+ # Search for these IDs at http://omim.org/
"names": [ # A set of names for the condition.
"A String",
],
@@ -580,7 +580,6 @@
# 0-based exclusive. Note that this position is relative to the reference
# start, and *not* the containing annotation start.
},
- "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
"exons": [ # The <a href="http://en.wikipedia.org/wiki/Exon">exons</a> that compose
# this transcript. This field should be unset for genomes where transcript
# splicing does not occur, for example prokaryotes.
@@ -617,6 +616,7 @@
# *not* the containing annotation start.
},
],
+ "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
},
"id": "A String", # The server-generated annotation ID, unique across all annotations.
}
@@ -659,10 +659,10 @@
"id": "A String", # The id used by the source of this data.
},
],
- "omimId": "A String", # The OMIM id for this condition.
- # Search for these IDs at http://omim.org/
"conceptId": "A String", # The MedGen concept id associated with this gene.
# Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
+ "omimId": "A String", # The OMIM id for this condition.
+ # Search for these IDs at http://omim.org/
"names": [ # A set of names for the condition.
"A String",
],
@@ -716,7 +716,6 @@
# 0-based exclusive. Note that this position is relative to the reference
# start, and *not* the containing annotation start.
},
- "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
"exons": [ # The <a href="http://en.wikipedia.org/wiki/Exon">exons</a> that compose
# this transcript. This field should be unset for genomes where transcript
# splicing does not occur, for example prokaryotes.
@@ -753,6 +752,7 @@
# *not* the containing annotation start.
},
],
+ "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
},
"id": "A String", # The server-generated annotation ID, unique across all annotations.
}</pre>
@@ -830,10 +830,10 @@
"id": "A String", # The id used by the source of this data.
},
],
- "omimId": "A String", # The OMIM id for this condition.
- # Search for these IDs at http://omim.org/
"conceptId": "A String", # The MedGen concept id associated with this gene.
# Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
+ "omimId": "A String", # The OMIM id for this condition.
+ # Search for these IDs at http://omim.org/
"names": [ # A set of names for the condition.
"A String",
],
@@ -887,7 +887,6 @@
# 0-based exclusive. Note that this position is relative to the reference
# start, and *not* the containing annotation start.
},
- "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
"exons": [ # The <a href="http://en.wikipedia.org/wiki/Exon">exons</a> that compose
# this transcript. This field should be unset for genomes where transcript
# splicing does not occur, for example prokaryotes.
@@ -924,6 +923,7 @@
# *not* the containing annotation start.
},
],
+ "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
},
"id": "A String", # The server-generated annotation ID, unique across all annotations.
}</pre>
@@ -951,19 +951,19 @@
# must be specified, Defaults to the length of the reference.
"pageSize": 42, # The maximum number of results to return in a single page. If unspecified,
# defaults to 256. The maximum value is 2048.
- "start": "A String", # The start position of the range on the reference, 0-based inclusive. If
- # specified,
- # referenceId or
- # referenceName
- # must be specified. Defaults to 0.
+ "pageToken": "A 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.
"annotationSetIds": [ # Required. The annotation sets to search within. The caller must have
# `READ` access to these annotation sets.
# All queried annotation sets must have the same type.
"A String",
],
- "pageToken": "A 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.
+ "start": "A String", # The start position of the range on the reference, 0-based inclusive. If
+ # specified,
+ # referenceId or
+ # referenceName
+ # must be specified. Defaults to 0.
"referenceName": "A String", # The name of the reference to query, within the reference set associated
# with this query.
}
@@ -1011,10 +1011,10 @@
"id": "A String", # The id used by the source of this data.
},
],
- "omimId": "A String", # The OMIM id for this condition.
- # Search for these IDs at http://omim.org/
"conceptId": "A String", # The MedGen concept id associated with this gene.
# Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
+ "omimId": "A String", # The OMIM id for this condition.
+ # Search for these IDs at http://omim.org/
"names": [ # A set of names for the condition.
"A String",
],
@@ -1068,7 +1068,6 @@
# 0-based exclusive. Note that this position is relative to the reference
# start, and *not* the containing annotation start.
},
- "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
"exons": [ # The <a href="http://en.wikipedia.org/wiki/Exon">exons</a> that compose
# this transcript. This field should be unset for genomes where transcript
# splicing does not occur, for example prokaryotes.
@@ -1105,6 +1104,7 @@
# *not* the containing annotation start.
},
],
+ "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
},
"id": "A String", # The server-generated annotation ID, unique across all annotations.
},
@@ -1166,10 +1166,10 @@
"id": "A String", # The id used by the source of this data.
},
],
- "omimId": "A String", # The OMIM id for this condition.
- # Search for these IDs at http://omim.org/
"conceptId": "A String", # The MedGen concept id associated with this gene.
# Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
+ "omimId": "A String", # The OMIM id for this condition.
+ # Search for these IDs at http://omim.org/
"names": [ # A set of names for the condition.
"A String",
],
@@ -1223,7 +1223,6 @@
# 0-based exclusive. Note that this position is relative to the reference
# start, and *not* the containing annotation start.
},
- "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
"exons": [ # The <a href="http://en.wikipedia.org/wiki/Exon">exons</a> that compose
# this transcript. This field should be unset for genomes where transcript
# splicing does not occur, for example prokaryotes.
@@ -1260,6 +1259,7 @@
# *not* the containing annotation start.
},
],
+ "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
},
"id": "A String", # The server-generated annotation ID, unique across all annotations.
}
@@ -1308,10 +1308,10 @@
"id": "A String", # The id used by the source of this data.
},
],
- "omimId": "A String", # The OMIM id for this condition.
- # Search for these IDs at http://omim.org/
"conceptId": "A String", # The MedGen concept id associated with this gene.
# Search for these IDs at http://www.ncbi.nlm.nih.gov/medgen/
+ "omimId": "A String", # The OMIM id for this condition.
+ # Search for these IDs at http://omim.org/
"names": [ # A set of names for the condition.
"A String",
],
@@ -1365,7 +1365,6 @@
# 0-based exclusive. Note that this position is relative to the reference
# start, and *not* the containing annotation start.
},
- "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
"exons": [ # The <a href="http://en.wikipedia.org/wiki/Exon">exons</a> that compose
# this transcript. This field should be unset for genomes where transcript
# splicing does not occur, for example prokaryotes.
@@ -1402,6 +1401,7 @@
# *not* the containing annotation start.
},
],
+ "geneId": "A String", # The annotation ID of the gene from which this transcript is transcribed.
},
"id": "A String", # The server-generated annotation ID, unique across all annotations.
}</pre>
diff --git a/docs/dyn/genomics_v1.annotationsets.html b/docs/dyn/genomics_v1.annotationsets.html
index c282cfa..780e01d 100644
--- a/docs/dyn/genomics_v1.annotationsets.html
+++ b/docs/dyn/genomics_v1.annotationsets.html
@@ -90,7 +90,7 @@
<code><a href="#search_next">search_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(annotationSetId, body, updateMask=None, x__xgafv=None)</a></code></p>
+ <code><a href="#update">update(annotationSetId, body, x__xgafv=None, updateMask=None)</a></code></p>
<p class="firstline">Updates an annotation set. The update must respect all mutability</p>
<h3>Method Details</h3>
<div class="method">
@@ -111,6 +111,33 @@
The object takes the form of:
{ # An annotation set is a logical grouping of annotations that share consistent
+ # type information and provenance. Examples of annotation sets include 'all
+ # genes from refseq', and 'all variant annotations from ClinVar'.
+ "info": { # A map of additional read alignment information. This must be of the form
+ # map<string, string[]> (string key mapping to a list of string values).
+ "a_key": [
+ "",
+ ],
+ },
+ "name": "A String", # The display name for this annotation set.
+ "sourceUri": "A String", # The source URI describing the file from which this annotation set was
+ # generated, if any.
+ "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this
+ # set's annotations.
+ "type": "A String", # The type of annotations contained within this set.
+ "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
+ "datasetId": "A String", # The dataset to which this annotation set belongs.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An annotation set is a logical grouping of annotations that share consistent
# type information and provenance. Examples of annotation sets include 'all
# genes from refseq', and 'all variant annotations from ClinVar'.
"info": { # A map of additional read alignment information. This must be of the form
@@ -122,39 +149,12 @@
"name": "A String", # The display name for this annotation set.
"sourceUri": "A String", # The source URI describing the file from which this annotation set was
# generated, if any.
- "type": "A String", # The type of annotations contained within this set.
"referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this
# set's annotations.
+ "type": "A String", # The type of annotations contained within this set.
"id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
"datasetId": "A String", # The dataset to which this annotation set belongs.
- }
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # An annotation set is a logical grouping of annotations that share consistent
- # type information and provenance. Examples of annotation sets include 'all
- # genes from refseq', and 'all variant annotations from ClinVar'.
- "info": { # A map of additional read alignment information. This must be of the form
- # map<string, string[]> (string key mapping to a list of string values).
- "a_key": [
- "",
- ],
- },
- "name": "A String", # The display name for this annotation set.
- "sourceUri": "A String", # The source URI describing the file from which this annotation set was
- # generated, if any.
- "type": "A String", # The type of annotations contained within this set.
- "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this
- # set's annotations.
- "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
- "datasetId": "A String", # The dataset to which this annotation set belongs.
- }</pre>
+ }</pre>
</div>
<div class="method">
@@ -200,23 +200,23 @@
An object of the form:
{ # An annotation set is a logical grouping of annotations that share consistent
- # type information and provenance. Examples of annotation sets include 'all
- # genes from refseq', and 'all variant annotations from ClinVar'.
- "info": { # A map of additional read alignment information. This must be of the form
- # map<string, string[]> (string key mapping to a list of string values).
- "a_key": [
- "",
- ],
- },
- "name": "A String", # The display name for this annotation set.
- "sourceUri": "A String", # The source URI describing the file from which this annotation set was
- # generated, if any.
- "type": "A String", # The type of annotations contained within this set.
- "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this
- # set's annotations.
- "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
- "datasetId": "A String", # The dataset to which this annotation set belongs.
- }</pre>
+ # type information and provenance. Examples of annotation sets include 'all
+ # genes from refseq', and 'all variant annotations from ClinVar'.
+ "info": { # A map of additional read alignment information. This must be of the form
+ # map<string, string[]> (string key mapping to a list of string values).
+ "a_key": [
+ "",
+ ],
+ },
+ "name": "A String", # The display name for this annotation set.
+ "sourceUri": "A String", # The source URI describing the file from which this annotation set was
+ # generated, if any.
+ "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this
+ # set's annotations.
+ "type": "A String", # The type of annotations contained within this set.
+ "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
+ "datasetId": "A String", # The dataset to which this annotation set belongs.
+ }</pre>
</div>
<div class="method">
@@ -265,23 +265,23 @@
# results. This field will be empty if there aren't any additional results.
"annotationSets": [ # The matching annotation sets.
{ # An annotation set is a logical grouping of annotations that share consistent
- # type information and provenance. Examples of annotation sets include 'all
- # genes from refseq', and 'all variant annotations from ClinVar'.
- "info": { # A map of additional read alignment information. This must be of the form
- # map<string, string[]> (string key mapping to a list of string values).
- "a_key": [
- "",
- ],
- },
- "name": "A String", # The display name for this annotation set.
- "sourceUri": "A String", # The source URI describing the file from which this annotation set was
- # generated, if any.
- "type": "A String", # The type of annotations contained within this set.
- "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this
- # set's annotations.
- "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
- "datasetId": "A String", # The dataset to which this annotation set belongs.
+ # type information and provenance. Examples of annotation sets include 'all
+ # genes from refseq', and 'all variant annotations from ClinVar'.
+ "info": { # A map of additional read alignment information. This must be of the form
+ # map<string, string[]> (string key mapping to a list of string values).
+ "a_key": [
+ "",
+ ],
},
+ "name": "A String", # The display name for this annotation set.
+ "sourceUri": "A String", # The source URI describing the file from which this annotation set was
+ # generated, if any.
+ "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this
+ # set's annotations.
+ "type": "A String", # The type of annotations contained within this set.
+ "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
+ "datasetId": "A String", # The dataset to which this annotation set belongs.
+ },
],
}</pre>
</div>
@@ -301,7 +301,7 @@
</div>
<div class="method">
- <code class="details" id="update">update(annotationSetId, body, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="update">update(annotationSetId, body, x__xgafv=None, updateMask=None)</code>
<pre>Updates an annotation set. The update must respect all mutability
restrictions and other invariants described on the annotation set resource.
Caller must have WRITE permission for the associated dataset.
@@ -312,6 +312,38 @@
The object takes the form of:
{ # An annotation set is a logical grouping of annotations that share consistent
+ # type information and provenance. Examples of annotation sets include 'all
+ # genes from refseq', and 'all variant annotations from ClinVar'.
+ "info": { # A map of additional read alignment information. This must be of the form
+ # map<string, string[]> (string key mapping to a list of string values).
+ "a_key": [
+ "",
+ ],
+ },
+ "name": "A String", # The display name for this annotation set.
+ "sourceUri": "A String", # The source URI describing the file from which this annotation set was
+ # generated, if any.
+ "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this
+ # set's annotations.
+ "type": "A String", # The type of annotations contained within this set.
+ "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
+ "datasetId": "A String", # The dataset to which this annotation set belongs.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ updateMask: string, An optional mask specifying which fields to update. Mutable fields are
+name,
+source_uri, and
+info. If unspecified, all
+mutable fields will be updated.
+
+Returns:
+ An object of the form:
+
+ { # An annotation set is a logical grouping of annotations that share consistent
# type information and provenance. Examples of annotation sets include 'all
# genes from refseq', and 'all variant annotations from ClinVar'.
"info": { # A map of additional read alignment information. This must be of the form
@@ -323,44 +355,12 @@
"name": "A String", # The display name for this annotation set.
"sourceUri": "A String", # The source URI describing the file from which this annotation set was
# generated, if any.
- "type": "A String", # The type of annotations contained within this set.
"referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this
# set's annotations.
+ "type": "A String", # The type of annotations contained within this set.
"id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
"datasetId": "A String", # The dataset to which this annotation set belongs.
- }
-
- updateMask: string, An optional mask specifying which fields to update. Mutable fields are
-name,
-source_uri, and
-info. If unspecified, all
-mutable fields will be updated.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # An annotation set is a logical grouping of annotations that share consistent
- # type information and provenance. Examples of annotation sets include 'all
- # genes from refseq', and 'all variant annotations from ClinVar'.
- "info": { # A map of additional read alignment information. This must be of the form
- # map<string, string[]> (string key mapping to a list of string values).
- "a_key": [
- "",
- ],
- },
- "name": "A String", # The display name for this annotation set.
- "sourceUri": "A String", # The source URI describing the file from which this annotation set was
- # generated, if any.
- "type": "A String", # The type of annotations contained within this set.
- "referenceSetId": "A String", # The ID of the reference set that defines the coordinate space for this
- # set's annotations.
- "id": "A String", # The server-generated annotation set ID, unique across all annotation sets.
- "datasetId": "A String", # The dataset to which this annotation set belongs.
- }</pre>
+ }</pre>
</div>
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/genomics_v1.datasets.html b/docs/dyn/genomics_v1.datasets.html
index d620977..dc12b87 100644
--- a/docs/dyn/genomics_v1.datasets.html
+++ b/docs/dyn/genomics_v1.datasets.html
@@ -122,9 +122,9 @@
# For more genomics resource definitions, see [Fundamentals of Google
# Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
"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.
"name": "A String", # The dataset name.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
- "id": "A String", # The server-generated dataset ID, unique across all datasets.
}
x__xgafv: string, V1 error format.
@@ -140,9 +140,9 @@
# For more genomics resource definitions, see [Fundamentals of Google
# Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
"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.
"name": "A String", # The dataset name.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
- "id": "A String", # The server-generated dataset ID, unique across all datasets.
}</pre>
</div>
@@ -204,9 +204,9 @@
# For more genomics resource definitions, see [Fundamentals of Google
# Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
"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.
"name": "A String", # The dataset name.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
- "id": "A String", # The server-generated dataset ID, unique across all datasets.
}</pre>
</div>
@@ -303,7 +303,6 @@
],
},
],
- "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
@@ -314,6 +313,7 @@
#
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
# policy is overwritten blindly.
+ "version": 42, # Version of the `Policy`. The default version is 0.
}</pre>
</div>
@@ -350,9 +350,9 @@
# For more genomics resource definitions, see [Fundamentals of Google
# Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
"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.
"name": "A String", # The dataset name.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
- "id": "A String", # The server-generated dataset ID, unique across all datasets.
},
],
}</pre>
@@ -392,9 +392,9 @@
# For more genomics resource definitions, see [Fundamentals of Google
# Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
"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.
"name": "A String", # The dataset name.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
- "id": "A String", # The server-generated dataset ID, unique across all datasets.
}
updateMask: string, An optional mask specifying which fields to update. At this time, the only
@@ -414,9 +414,9 @@
# For more genomics resource definitions, see [Fundamentals of Google
# Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
"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.
"name": "A String", # The dataset name.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
- "id": "A String", # The server-generated dataset ID, unique across all datasets.
}</pre>
</div>
@@ -506,7 +506,6 @@
],
},
],
- "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
@@ -517,6 +516,7 @@
#
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
# policy is overwritten blindly.
+ "version": 42, # Version of the `Policy`. The default version is 0.
},
}
@@ -592,7 +592,6 @@
],
},
],
- "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
@@ -603,6 +602,7 @@
#
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
# policy is overwritten blindly.
+ "version": 42, # Version of the `Policy`. The default version is 0.
}</pre>
</div>
@@ -685,9 +685,9 @@
# For more genomics resource definitions, see [Fundamentals of Google
# Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
"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.
"name": "A String", # The dataset name.
"createTime": "A String", # The time this dataset was created, in seconds from the epoch.
- "id": "A String", # The server-generated dataset ID, unique across all datasets.
}</pre>
</div>
diff --git a/docs/dyn/genomics_v1.operations.html b/docs/dyn/genomics_v1.operations.html
index 6658f33..c0c602e 100644
--- a/docs/dyn/genomics_v1.operations.html
+++ b/docs/dyn/genomics_v1.operations.html
@@ -137,16 +137,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an empty response is returned.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"metadata": { # An OperationMetadata object. This will always be returned with the Operation.
"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. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
"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:
@@ -210,6 +203,13 @@
},
],
},
+ "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": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an empty response is returned.
+ "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. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
}</pre>
</div>
@@ -253,16 +253,9 @@
"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.
- "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an empty response is returned.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"metadata": { # An OperationMetadata object. This will always be returned with the Operation.
"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. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
"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:
@@ -326,6 +319,13 @@
},
],
},
+ "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": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an empty response is returned.
+ "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. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
},
],
}</pre>
diff --git a/docs/dyn/genomics_v1.readgroupsets.html b/docs/dyn/genomics_v1.readgroupsets.html
index 54ca9c1..281e8d3 100644
--- a/docs/dyn/genomics_v1.readgroupsets.html
+++ b/docs/dyn/genomics_v1.readgroupsets.html
@@ -174,16 +174,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an empty response is returned.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"metadata": { # An OperationMetadata object. This will always be returned with the Operation.
"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. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
"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:
@@ -247,6 +240,13 @@
},
],
},
+ "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": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an empty response is returned.
+ "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. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
}</pre>
</div>
@@ -303,13 +303,13 @@
# only the first read group in a returned set will have this field
# populated.
{
- "prevProgramId": "A String", # The ID of the program run before this one.
- "commandLine": "A String", # The command line used to run this program.
- "version": "A String", # The version of the program run.
"id": "A String", # The user specified locally unique ID of the program. Used along with
# `prevProgramId` to define an ordering between programs.
+ "commandLine": "A String", # The command line used to run this program.
+ "version": "A String", # The version of the program run.
"name": "A String", # The display name of the program. This is typically the colloquial name of
# the tool used, for example 'bwa' or 'picard'.
+ "prevProgramId": "A String", # The ID of the program run before this one.
},
],
"sampleId": "A String", # A client-supplied sample identifier for the reads in this read group.
@@ -398,16 +398,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an empty response is returned.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"metadata": { # An OperationMetadata object. This will always be returned with the Operation.
"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. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
"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:
@@ -471,6 +464,13 @@
},
],
},
+ "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": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an empty response is returned.
+ "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. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
}</pre>
</div>
@@ -525,13 +525,13 @@
# only the first read group in a returned set will have this field
# populated.
{
- "prevProgramId": "A String", # The ID of the program run before this one.
- "commandLine": "A String", # The command line used to run this program.
- "version": "A String", # The version of the program run.
"id": "A String", # The user specified locally unique ID of the program. Used along with
# `prevProgramId` to define an ordering between programs.
+ "commandLine": "A String", # The command line used to run this program.
+ "version": "A String", # The version of the program run.
"name": "A String", # The display name of the program. This is typically the colloquial name of
# the tool used, for example 'bwa' or 'picard'.
+ "prevProgramId": "A String", # The ID of the program run before this one.
},
],
"sampleId": "A String", # A client-supplied sample identifier for the reads in this read group.
@@ -611,13 +611,13 @@
# only the first read group in a returned set will have this field
# populated.
{
- "prevProgramId": "A String", # The ID of the program run before this one.
- "commandLine": "A String", # The command line used to run this program.
- "version": "A String", # The version of the program run.
"id": "A String", # The user specified locally unique ID of the program. Used along with
# `prevProgramId` to define an ordering between programs.
+ "commandLine": "A String", # The command line used to run this program.
+ "version": "A String", # The version of the program run.
"name": "A String", # The display name of the program. This is typically the colloquial name of
# the tool used, for example 'bwa' or 'picard'.
+ "prevProgramId": "A String", # The ID of the program run before this one.
},
],
"sampleId": "A String", # A client-supplied sample identifier for the reads in this read group.
@@ -725,13 +725,13 @@
# only the first read group in a returned set will have this field
# populated.
{
- "prevProgramId": "A String", # The ID of the program run before this one.
- "commandLine": "A String", # The command line used to run this program.
- "version": "A String", # The version of the program run.
"id": "A String", # The user specified locally unique ID of the program. Used along with
# `prevProgramId` to define an ordering between programs.
+ "commandLine": "A String", # The command line used to run this program.
+ "version": "A String", # The version of the program run.
"name": "A String", # The display name of the program. This is typically the colloquial name of
# the tool used, for example 'bwa' or 'picard'.
+ "prevProgramId": "A String", # The ID of the program run before this one.
},
],
"sampleId": "A String", # A client-supplied sample identifier for the reads in this read group.
diff --git a/docs/dyn/genomics_v1.reads.html b/docs/dyn/genomics_v1.reads.html
index 8a9e671..764e2fe 100644
--- a/docs/dyn/genomics_v1.reads.html
+++ b/docs/dyn/genomics_v1.reads.html
@@ -113,12 +113,8 @@
The object takes the form of:
{ # The read search request.
- "readGroupSetIds": [ # The IDs of the read groups sets within which to search for reads. All
- # specified read group sets must be aligned against a common set of reference
- # sequences; this defines the genomic coordinates for the query. Must specify
- # one of `readGroupSetIds` or `readGroupIds`.
- "A String",
- ],
+ "end": "A String", # The end position of the range on the reference, 0-based exclusive. If
+ # specified, `referenceName` must also be specified.
"readGroupIds": [ # The IDs of the read groups within which to search for reads. All specified
# read groups must belong to the same read group sets. Must specify one of
# `readGroupSetIds` or `readGroupIds`.
@@ -126,16 +122,20 @@
],
"pageSize": 42, # The maximum number of results to return in a single page. If unspecified,
# defaults to 256. The maximum value is 2048.
- "start": "A String", # The start position of the range on the reference, 0-based inclusive. If
- # specified, `referenceName` must also be specified.
"pageToken": "A 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.
+ "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. If unspecified, all reads (mapped
# and unmapped) are returned.
- "end": "A String", # The end position of the range on the reference, 0-based exclusive. If
- # specified, `referenceName` must also be specified.
+ "readGroupSetIds": [ # The IDs of the read groups sets within which to search for reads. All
+ # specified read group sets must be aligned against a common set of reference
+ # sequences; this defines the genomic coordinates for the query. Must specify
+ # one of `readGroupSetIds` or `readGroupIds`.
+ "A String",
+ ],
}
x__xgafv: string, V1 error format.
diff --git a/docs/dyn/genomics_v1.references.html b/docs/dyn/genomics_v1.references.html
index 0644b04..1f99b02 100644
--- a/docs/dyn/genomics_v1.references.html
+++ b/docs/dyn/genomics_v1.references.html
@@ -125,11 +125,11 @@
"A String",
],
"length": "A String", # The length of this reference's sequence.
+ "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human.
+ "id": "A String", # The server-generated reference ID, unique across all references.
"md5checksum": "A String", # MD5 of the upper-case sequence excluding all whitespace characters (this
# is equivalent to SQ:M5 in SAM). This value is represented in lower case
# hexadecimal format.
- "id": "A String", # The server-generated reference ID, unique across all references.
- "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human.
}</pre>
</div>
@@ -195,11 +195,11 @@
"A String",
],
"length": "A String", # The length of this reference's sequence.
+ "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human.
+ "id": "A String", # The server-generated reference ID, unique across all references.
"md5checksum": "A String", # MD5 of the upper-case sequence excluding all whitespace characters (this
# is equivalent to SQ:M5 in SAM). This value is represented in lower case
# hexadecimal format.
- "id": "A String", # The server-generated reference ID, unique across all references.
- "ncbiTaxonId": 42, # ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human.
},
],
}</pre>
diff --git a/docs/dyn/genomics_v1.variants.html b/docs/dyn/genomics_v1.variants.html
index fe7b4a6..443ec74 100644
--- a/docs/dyn/genomics_v1.variants.html
+++ b/docs/dyn/genomics_v1.variants.html
@@ -178,8 +178,7 @@
},
],
"created": "A String", # The date this variant was created, in milliseconds from the epoch.
- "referenceBases": "A String", # The reference bases for this variant. They start at the given
- # position.
+ "id": "A String", # The server-generated variant ID, unique across all variants.
"filter": [ # A list of filters (normally quality filters) this variant has failed.
# `PASS` indicates this variant has passed all filters.
"A String",
@@ -196,7 +195,8 @@
# (such as `chr20` or `X`)
"quality": 3.14, # A measure of how likely this variant is to be real.
# A higher value is better.
- "id": "A String", # The server-generated variant ID, unique across all variants.
+ "referenceBases": "A String", # The reference bases for this variant. They start at the given
+ # position.
}
x__xgafv: string, V1 error format.
@@ -274,8 +274,7 @@
},
],
"created": "A String", # The date this variant was created, in milliseconds from the epoch.
- "referenceBases": "A String", # The reference bases for this variant. They start at the given
- # position.
+ "id": "A String", # The server-generated variant ID, unique across all variants.
"filter": [ # A list of filters (normally quality filters) this variant has failed.
# `PASS` indicates this variant has passed all filters.
"A String",
@@ -292,7 +291,8 @@
# (such as `chr20` or `X`)
"quality": 3.14, # A measure of how likely this variant is to be real.
# A higher value is better.
- "id": "A String", # The server-generated variant ID, unique across all variants.
+ "referenceBases": "A String", # The reference bases for this variant. They start at the given
+ # position.
}</pre>
</div>
@@ -411,8 +411,7 @@
},
],
"created": "A String", # The date this variant was created, in milliseconds from the epoch.
- "referenceBases": "A String", # The reference bases for this variant. They start at the given
- # position.
+ "id": "A String", # The server-generated variant ID, unique across all variants.
"filter": [ # A list of filters (normally quality filters) this variant has failed.
# `PASS` indicates this variant has passed all filters.
"A String",
@@ -429,7 +428,8 @@
# (such as `chr20` or `X`)
"quality": 3.14, # A measure of how likely this variant is to be real.
# A higher value is better.
- "id": "A String", # The server-generated variant ID, unique across all variants.
+ "referenceBases": "A String", # The reference bases for this variant. They start at the given
+ # position.
}</pre>
</div>
@@ -460,14 +460,8 @@
{ # The variant data import request.
"variantSetId": "A String", # Required. The variant set to which variant data should be imported.
- "normalizeReferenceNames": True or False, # Convert reference names to the canonical representation.
- # hg19 haploytypes (those reference names containing "_hap")
- # are not modified in any way.
- # All other reference names are modified according to the following rules:
- # The reference name is capitalized.
- # The "chr" prefix is dropped for all autosomes and sex chromsomes.
- # For example "chr17" becomes "17" and "chrX" becomes "X".
- # All mitochondrial chromosomes ("chrM", "chrMT", etc) become "MT".
+ "format": "A String", # The format of the variant data being imported. If unspecified, defaults to
+ # to `VCF`.
"sourceUris": [ # A list of URIs referencing variant files in Google Cloud Storage. URIs can
# include wildcards [as described
# here](https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames).
@@ -479,8 +473,14 @@
# generated by the resulting import job.
"a_key": "A String",
},
- "format": "A String", # The format of the variant data being imported. If unspecified, defaults to
- # to `VCF`.
+ "normalizeReferenceNames": True or False, # Convert reference names to the canonical representation.
+ # hg19 haploytypes (those reference names containing "_hap")
+ # are not modified in any way.
+ # All other reference names are modified according to the following rules:
+ # The reference name is capitalized.
+ # The "chr" prefix is dropped for all autosomes and sex chromsomes.
+ # For example "chr17" becomes "17" and "chrX" becomes "X".
+ # All mitochondrial chromosomes ("chrM", "chrMT", etc) become "MT".
}
x__xgafv: string, V1 error format.
@@ -493,16 +493,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an empty response is returned.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"metadata": { # An OperationMetadata object. This will always be returned with the Operation.
"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. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
"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:
@@ -566,6 +559,13 @@
},
],
},
+ "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": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an empty response is returned.
+ "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. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
}</pre>
</div>
@@ -737,8 +737,7 @@
},
],
"created": "A String", # The date this variant was created, in milliseconds from the epoch.
- "referenceBases": "A String", # The reference bases for this variant. They start at the given
- # position.
+ "id": "A String", # The server-generated variant ID, unique across all variants.
"filter": [ # A list of filters (normally quality filters) this variant has failed.
# `PASS` indicates this variant has passed all filters.
"A String",
@@ -755,7 +754,8 @@
# (such as `chr20` or `X`)
"quality": 3.14, # A measure of how likely this variant is to be real.
# A higher value is better.
- "id": "A String", # The server-generated variant ID, unique across all variants.
+ "referenceBases": "A String", # The reference bases for this variant. They start at the given
+ # position.
},
],
"infoMergeConfig": { # A mapping between info field keys and the InfoMergeOperations to
@@ -867,8 +867,7 @@
},
],
"created": "A String", # The date this variant was created, in milliseconds from the epoch.
- "referenceBases": "A String", # The reference bases for this variant. They start at the given
- # position.
+ "id": "A String", # The server-generated variant ID, unique across all variants.
"filter": [ # A list of filters (normally quality filters) this variant has failed.
# `PASS` indicates this variant has passed all filters.
"A String",
@@ -885,7 +884,8 @@
# (such as `chr20` or `X`)
"quality": 3.14, # A measure of how likely this variant is to be real.
# A higher value is better.
- "id": "A String", # The server-generated variant ID, unique across all variants.
+ "referenceBases": "A String", # The reference bases for this variant. They start at the given
+ # position.
}
x__xgafv: string, V1 error format.
@@ -967,8 +967,7 @@
},
],
"created": "A String", # The date this variant was created, in milliseconds from the epoch.
- "referenceBases": "A String", # The reference bases for this variant. They start at the given
- # position.
+ "id": "A String", # The server-generated variant ID, unique across all variants.
"filter": [ # A list of filters (normally quality filters) this variant has failed.
# `PASS` indicates this variant has passed all filters.
"A String",
@@ -985,7 +984,8 @@
# (such as `chr20` or `X`)
"quality": 3.14, # A measure of how likely this variant is to be real.
# A higher value is better.
- "id": "A String", # The server-generated variant ID, unique across all variants.
+ "referenceBases": "A String", # The reference bases for this variant. They start at the given
+ # position.
}</pre>
</div>
@@ -1009,25 +1009,25 @@
# the length of the reference.
"pageSize": 42, # The maximum number of variants to return in a single page. If unspecified,
# defaults to 5000. The maximum value is 10000.
- "pageToken": "A 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.
+ "start": "A String", # The beginning of the window (0-based, inclusive) for which
+ # overlapping variants should be returned. If unspecified, defaults to 0.
"maxCalls": 42, # The maximum number of calls to return in a single page. Note that this
# limit may be exceeded in the event that a matching variant contains more
# calls than the requested maximum. If unspecified, defaults to 5000. The
# maximum value is 10000.
- "start": "A String", # The beginning of the window (0-based, inclusive) for which
- # overlapping variants should be returned. If unspecified, defaults to 0.
- "callSetIds": [ # Only return variant calls which belong to call sets with these ids.
- # Leaving this blank returns all variant calls. If a variant has no
- # calls belonging to any of these call sets, it won't be returned at all.
+ "pageToken": "A 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.
+ "variantSetIds": [ # At most one variant set ID must be provided. Only variants from this
+ # variant set will be returned. If omitted, a call set id must be included in
+ # the request.
"A String",
],
"variantName": "A String", # Only return variants which have exactly this name.
"referenceName": "A String", # Required. Only return variants in this reference sequence.
- "variantSetIds": [ # At most one variant set ID must be provided. Only variants from this
- # variant set will be returned. If omitted, a call set id must be included in
- # the request.
+ "callSetIds": [ # Only return variant calls which belong to call sets with these ids.
+ # Leaving this blank returns all variant calls. If a variant has no
+ # calls belonging to any of these call sets, it won't be returned at all.
"A String",
],
}
@@ -1112,8 +1112,7 @@
},
],
"created": "A String", # The date this variant was created, in milliseconds from the epoch.
- "referenceBases": "A String", # The reference bases for this variant. They start at the given
- # position.
+ "id": "A String", # The server-generated variant ID, unique across all variants.
"filter": [ # A list of filters (normally quality filters) this variant has failed.
# `PASS` indicates this variant has passed all filters.
"A String",
@@ -1130,7 +1129,8 @@
# (such as `chr20` or `X`)
"quality": 3.14, # A measure of how likely this variant is to be real.
# A higher value is better.
- "id": "A String", # The server-generated variant ID, unique across all variants.
+ "referenceBases": "A String", # The reference bases for this variant. They start at the given
+ # position.
},
],
}</pre>
diff --git a/docs/dyn/genomics_v1.variantsets.html b/docs/dyn/genomics_v1.variantsets.html
index 6adc2f8..e0b4146 100644
--- a/docs/dyn/genomics_v1.variantsets.html
+++ b/docs/dyn/genomics_v1.variantsets.html
@@ -118,7 +118,6 @@
# For more genomics resource definitions, see [Fundamentals of Google
# Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
"name": "A String", # User-specified, mutable name.
- "description": "A String", # A textual description of this variant set.
"metadata": [ # The metadata associated with this variant set.
{ # Metadata describes a single piece of variant call metadata.
# These data include a top level key and either a single value string (value)
@@ -142,6 +141,15 @@
# id and key fields are considered equivalent.
},
],
+ "referenceBounds": [ # A list of all references used by the variants in a variant set
+ # with associated coordinate upper bounds for each one.
+ { # ReferenceBound records an upper bound for the starting coordinate of
+ # variants in a particular reference.
+ "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any
+ # variant in the reference sequence.
+ "referenceName": "A String", # The name of the reference associated with this reference bound.
+ },
+ ],
"referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set
# describes the alignment provenance of the variant set, while the
# `referenceBounds` describe the shape of the actual variant data. The
@@ -154,15 +162,7 @@
# enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
"id": "A String", # The server-generated variant set ID, unique across all variant sets.
"datasetId": "A String", # The dataset to which this variant set belongs.
- "referenceBounds": [ # A list of all references used by the variants in a variant set
- # with associated coordinate upper bounds for each one.
- { # ReferenceBound records an upper bound for the starting coordinate of
- # variants in a particular reference.
- "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any
- # variant in the reference sequence.
- "referenceName": "A String", # The name of the reference associated with this reference bound.
- },
- ],
+ "description": "A String", # A textual description of this variant set.
}
x__xgafv: string, V1 error format.
@@ -179,7 +179,6 @@
# For more genomics resource definitions, see [Fundamentals of Google
# Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
"name": "A String", # User-specified, mutable name.
- "description": "A String", # A textual description of this variant set.
"metadata": [ # The metadata associated with this variant set.
{ # Metadata describes a single piece of variant call metadata.
# These data include a top level key and either a single value string (value)
@@ -203,6 +202,15 @@
# id and key fields are considered equivalent.
},
],
+ "referenceBounds": [ # A list of all references used by the variants in a variant set
+ # with associated coordinate upper bounds for each one.
+ { # ReferenceBound records an upper bound for the starting coordinate of
+ # variants in a particular reference.
+ "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any
+ # variant in the reference sequence.
+ "referenceName": "A String", # The name of the reference associated with this reference bound.
+ },
+ ],
"referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set
# describes the alignment provenance of the variant set, while the
# `referenceBounds` describe the shape of the actual variant data. The
@@ -215,15 +223,7 @@
# enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
"id": "A String", # The server-generated variant set ID, unique across all variant sets.
"datasetId": "A String", # The dataset to which this variant set belongs.
- "referenceBounds": [ # A list of all references used by the variants in a variant set
- # with associated coordinate upper bounds for each one.
- { # ReferenceBound records an upper bound for the starting coordinate of
- # variants in a particular reference.
- "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any
- # variant in the reference sequence.
- "referenceName": "A String", # The name of the reference associated with this reference bound.
- },
- ],
+ "description": "A String", # A textual description of this variant set.
}</pre>
</div>
@@ -298,16 +298,9 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an empty response is returned.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"metadata": { # An OperationMetadata object. This will always be returned with the Operation.
"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. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
"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:
@@ -371,6 +364,13 @@
},
],
},
+ "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": { # If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an empty response is returned.
+ "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. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
}</pre>
</div>
@@ -398,7 +398,6 @@
# For more genomics resource definitions, see [Fundamentals of Google
# Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
"name": "A String", # User-specified, mutable name.
- "description": "A String", # A textual description of this variant set.
"metadata": [ # The metadata associated with this variant set.
{ # Metadata describes a single piece of variant call metadata.
# These data include a top level key and either a single value string (value)
@@ -422,6 +421,15 @@
# id and key fields are considered equivalent.
},
],
+ "referenceBounds": [ # A list of all references used by the variants in a variant set
+ # with associated coordinate upper bounds for each one.
+ { # ReferenceBound records an upper bound for the starting coordinate of
+ # variants in a particular reference.
+ "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any
+ # variant in the reference sequence.
+ "referenceName": "A String", # The name of the reference associated with this reference bound.
+ },
+ ],
"referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set
# describes the alignment provenance of the variant set, while the
# `referenceBounds` describe the shape of the actual variant data. The
@@ -434,15 +442,7 @@
# enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
"id": "A String", # The server-generated variant set ID, unique across all variant sets.
"datasetId": "A String", # The dataset to which this variant set belongs.
- "referenceBounds": [ # A list of all references used by the variants in a variant set
- # with associated coordinate upper bounds for each one.
- { # ReferenceBound records an upper bound for the starting coordinate of
- # variants in a particular reference.
- "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any
- # variant in the reference sequence.
- "referenceName": "A String", # The name of the reference associated with this reference bound.
- },
- ],
+ "description": "A String", # A textual description of this variant set.
}</pre>
</div>
@@ -465,7 +465,6 @@
# For more genomics resource definitions, see [Fundamentals of Google
# Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
"name": "A String", # User-specified, mutable name.
- "description": "A String", # A textual description of this variant set.
"metadata": [ # The metadata associated with this variant set.
{ # Metadata describes a single piece of variant call metadata.
# These data include a top level key and either a single value string (value)
@@ -489,6 +488,15 @@
# id and key fields are considered equivalent.
},
],
+ "referenceBounds": [ # A list of all references used by the variants in a variant set
+ # with associated coordinate upper bounds for each one.
+ { # ReferenceBound records an upper bound for the starting coordinate of
+ # variants in a particular reference.
+ "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any
+ # variant in the reference sequence.
+ "referenceName": "A String", # The name of the reference associated with this reference bound.
+ },
+ ],
"referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set
# describes the alignment provenance of the variant set, while the
# `referenceBounds` describe the shape of the actual variant data. The
@@ -501,15 +509,7 @@
# enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
"id": "A String", # The server-generated variant set ID, unique across all variant sets.
"datasetId": "A String", # The dataset to which this variant set belongs.
- "referenceBounds": [ # A list of all references used by the variants in a variant set
- # with associated coordinate upper bounds for each one.
- { # ReferenceBound records an upper bound for the starting coordinate of
- # variants in a particular reference.
- "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any
- # variant in the reference sequence.
- "referenceName": "A String", # The name of the reference associated with this reference bound.
- },
- ],
+ "description": "A String", # A textual description of this variant set.
}
updateMask: string, An optional mask specifying which fields to update. Supported fields:
@@ -534,7 +534,6 @@
# For more genomics resource definitions, see [Fundamentals of Google
# Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
"name": "A String", # User-specified, mutable name.
- "description": "A String", # A textual description of this variant set.
"metadata": [ # The metadata associated with this variant set.
{ # Metadata describes a single piece of variant call metadata.
# These data include a top level key and either a single value string (value)
@@ -558,6 +557,15 @@
# id and key fields are considered equivalent.
},
],
+ "referenceBounds": [ # A list of all references used by the variants in a variant set
+ # with associated coordinate upper bounds for each one.
+ { # ReferenceBound records an upper bound for the starting coordinate of
+ # variants in a particular reference.
+ "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any
+ # variant in the reference sequence.
+ "referenceName": "A String", # The name of the reference associated with this reference bound.
+ },
+ ],
"referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set
# describes the alignment provenance of the variant set, while the
# `referenceBounds` describe the shape of the actual variant data. The
@@ -570,15 +578,7 @@
# enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
"id": "A String", # The server-generated variant set ID, unique across all variant sets.
"datasetId": "A String", # The dataset to which this variant set belongs.
- "referenceBounds": [ # A list of all references used by the variants in a variant set
- # with associated coordinate upper bounds for each one.
- { # ReferenceBound records an upper bound for the starting coordinate of
- # variants in a particular reference.
- "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any
- # variant in the reference sequence.
- "referenceName": "A String", # The name of the reference associated with this reference bound.
- },
- ],
+ "description": "A String", # A textual description of this variant set.
}</pre>
</div>
@@ -628,7 +628,6 @@
# For more genomics resource definitions, see [Fundamentals of Google
# Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
"name": "A String", # User-specified, mutable name.
- "description": "A String", # A textual description of this variant set.
"metadata": [ # The metadata associated with this variant set.
{ # Metadata describes a single piece of variant call metadata.
# These data include a top level key and either a single value string (value)
@@ -652,6 +651,15 @@
# id and key fields are considered equivalent.
},
],
+ "referenceBounds": [ # A list of all references used by the variants in a variant set
+ # with associated coordinate upper bounds for each one.
+ { # ReferenceBound records an upper bound for the starting coordinate of
+ # variants in a particular reference.
+ "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any
+ # variant in the reference sequence.
+ "referenceName": "A String", # The name of the reference associated with this reference bound.
+ },
+ ],
"referenceSetId": "A String", # The reference set to which the variant set is mapped. The reference set
# describes the alignment provenance of the variant set, while the
# `referenceBounds` describe the shape of the actual variant data. The
@@ -664,15 +672,7 @@
# enumerates all possible references: '1', '2', 'X', 'Y', 'MT', etc.
"id": "A String", # The server-generated variant set ID, unique across all variant sets.
"datasetId": "A String", # The dataset to which this variant set belongs.
- "referenceBounds": [ # A list of all references used by the variants in a variant set
- # with associated coordinate upper bounds for each one.
- { # ReferenceBound records an upper bound for the starting coordinate of
- # variants in a particular reference.
- "upperBound": "A String", # An upper bound (inclusive) on the starting coordinate of any
- # variant in the reference sequence.
- "referenceName": "A String", # The name of the reference associated with this reference bound.
- },
- ],
+ "description": "A String", # A textual description of this variant set.
},
],
}</pre>
diff --git a/docs/dyn/genomics_v1alpha2.pipelines.html b/docs/dyn/genomics_v1alpha2.pipelines.html
index 837f468..183bb9a 100644
--- a/docs/dyn/genomics_v1alpha2.pipelines.html
+++ b/docs/dyn/genomics_v1alpha2.pipelines.html
@@ -1108,7 +1108,9 @@
{ # Stores the information that the controller will fetch from the
# server in order to run. Should only be used by VMs created by the
# Pipelines Service and not by end users.
- "cmd": "A String",
+ "disks": {
+ "a_key": "A String",
+ },
"machineType": "A String",
"vars": {
"a_key": "A String",
@@ -1122,9 +1124,7 @@
},
},
"image": "A String",
- "disks": {
- "a_key": "A String",
- },
+ "cmd": "A String",
"gcsSources": {
"a_key": {
"values": [
@@ -2029,7 +2029,6 @@
{ # Request to set operation status. Should only be used by VMs
# created by the Pipelines Service and not by end users.
"errorCode": "A String",
- "errorMessage": "A String",
"timestampEvents": [
{ # Stores the list of events and times they occured for major events in job
# execution.
@@ -2037,6 +2036,7 @@
"description": "A String", # String indicating the type of event
},
],
+ "errorMessage": "A String",
"validationToken": "A String",
"operationId": "A String",
}
diff --git a/docs/dyn/iam_v1.projects.serviceAccounts.html b/docs/dyn/iam_v1.projects.serviceAccounts.html
index d450dc3..95ac18e 100644
--- a/docs/dyn/iam_v1.projects.serviceAccounts.html
+++ b/docs/dyn/iam_v1.projects.serviceAccounts.html
@@ -308,8 +308,7 @@
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)
+See the operation documentation for the appropriate value for this field. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -483,8 +482,7 @@
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)
+See the operation documentation for the appropriate value for this field. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -729,8 +727,7 @@
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)
+See the operation documentation for the appropriate value for this field. (required)
body: object, The request body. (required)
The object takes the form of:
diff --git a/docs/dyn/iam_v1.projects.serviceAccounts.keys.html b/docs/dyn/iam_v1.projects.serviceAccounts.keys.html
index 92151ac..3e7f3e5 100644
--- a/docs/dyn/iam_v1.projects.serviceAccounts.keys.html
+++ b/docs/dyn/iam_v1.projects.serviceAccounts.keys.html
@@ -133,20 +133,20 @@
#
# Public keys for all service accounts are also published at the OAuth2
# Service Account API.
- "name": "A String", # The resource name of the service account key in the following format
- # `projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.
- "validBeforeTime": "A String", # The key can be used before this timestamp.
- "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
"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.
"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.
+ "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
"publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
- "validAfterTime": "A String", # The key can be used after this timestamp.
+ "name": "A String", # The resource name of the service account key in the following format
+ # `projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.
}</pre>
</div>
@@ -218,20 +218,20 @@
#
# Public keys for all service accounts are also published at the OAuth2
# Service Account API.
- "name": "A String", # The resource name of the service account key in the following format
- # `projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.
- "validBeforeTime": "A String", # The key can be used before this timestamp.
- "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
"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.
"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.
+ "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
"publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
- "validAfterTime": "A String", # The key can be used after this timestamp.
+ "name": "A String", # The resource name of the service account key in the following format
+ # `projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.
}</pre>
</div>
@@ -275,20 +275,20 @@
#
# Public keys for all service accounts are also published at the OAuth2
# Service Account API.
- "name": "A String", # The resource name of the service account key in the following format
- # `projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.
- "validBeforeTime": "A String", # The key can be used before this timestamp.
- "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
"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.
"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.
+ "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
"publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
- "validAfterTime": "A String", # The key can be used after this timestamp.
+ "name": "A String", # The resource name of the service account key in the following format
+ # `projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.
},
],
}</pre>
diff --git a/docs/dyn/iam_v1.roles.html b/docs/dyn/iam_v1.roles.html
index 887b98f..f2278e6 100644
--- a/docs/dyn/iam_v1.roles.html
+++ b/docs/dyn/iam_v1.roles.html
@@ -107,8 +107,7 @@
{ # The grantable role query response.
"roles": [ # The list of matching roles.
{ # A role in the Identity and Access Management API.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
+ "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.
@@ -116,7 +115,8 @@
# 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.
- "description": "A String", # Optional. A human-readable description for the role.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
+ # is limited to 100 UTF-8 bytes.
},
],
}</pre>
diff --git a/docs/dyn/identitytoolkit_v3.relyingparty.html b/docs/dyn/identitytoolkit_v3.relyingparty.html
index bd43282..4524ab2 100644
--- a/docs/dyn/identitytoolkit_v3.relyingparty.html
+++ b/docs/dyn/identitytoolkit_v3.relyingparty.html
@@ -335,13 +335,20 @@
The object takes the form of:
{ # Request of getting a code for user confirmation (reset password, change email etc.)
+ "canHandleCodeInApp": True or False, # whether or not the app can handle the oob code without first going to web
"kind": "identitytoolkit#relyingparty", # The fixed string "identitytoolkit#relyingparty".
- "requestType": "A String", # The request type.
+ "iOSBundleId": "A String", # the iOS bundle id of iOS app to handle the action code
+ "androidMinimumVersion": "A String", # minimum version of the app. if the version on the device is lower than this version then the user is taken to the play store to upgrade the app
+ "newEmail": "A String", # The new email if the code is for email change.
+ "androidPackageName": "A String", # android package name of the android app to handle the action code
"idToken": "A String", # The user's Gitkit login token for email change.
"challenge": "A String", # The recaptcha challenge presented to the user.
- "newEmail": "A String", # The new email if the code is for email change.
- "userIp": "A String", # The IP address of the user.
+ "iOSAppStoreId": "A String", # iOS app store id to download the app if it's not already installed
"email": "A String", # The email of the user.
+ "requestType": "A String", # The request type.
+ "androidInstallApp": True or False, # whether or not to install the android app on the device where the link is opened
+ "userIp": "A String", # The IP address of the user.
+ "continueUrl": "A String", # The url to continue to the Gitkit app
"captchaResp": "A String", # The recaptcha response from the user.
}
@@ -760,6 +767,7 @@
"sessionId": "A String", # Session ID, which should match the one in previous createAuthUri request.
"requestUri": "A String", # The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP.
"returnSecureToken": True or False, # Whether return sts id token and refresh token instead of gitkit token.
+ "autoCreate": True or False, # When it's true, automatically creates a new account if the user doesn't exist. When it's false, allows existing user to sign in normally and throws exception if the user doesn't exist.
"returnRefreshToken": True or False, # Whether to return refresh tokens.
"returnIdpCredential": True or False, # Whether return 200 and IDP credential rather than throw exception when federated id is already linked.
}
diff --git a/docs/dyn/language_v1.documents.html b/docs/dyn/language_v1.documents.html
index 6f89cbd..9a1abf1 100644
--- a/docs/dyn/language_v1.documents.html
+++ b/docs/dyn/language_v1.documents.html
@@ -76,7 +76,7 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#analyzeEntities">analyzeEntities(body, x__xgafv=None)</a></code></p>
-<p class="firstline">Finds named entities (currently finds proper names) in the text,</p>
+<p class="firstline">Finds named entities (currently proper names and common nouns) in the text</p>
<p class="toc_element">
<code><a href="#analyzeSentiment">analyzeSentiment(body, x__xgafv=None)</a></code></p>
<p class="firstline">Analyzes the sentiment of the provided text.</p>
@@ -89,8 +89,9 @@
<h3>Method Details</h3>
<div class="method">
<code class="details" id="analyzeEntities">analyzeEntities(body, x__xgafv=None)</code>
- <pre>Finds named entities (currently finds proper names) in the text,
-entity types, salience, mentions for each entity, and other properties.
+ <pre>Finds named entities (currently proper names and common nouns) in the text
+along with entity types, salience, mentions for each entity, and
+other properties.
Args:
body: object, The request body. (required)
@@ -133,6 +134,12 @@
{ # Represents a phrase in the text that is a known entity, such as
# a person, an organization, or location. The API associates information, such
# as salience and mentions, with entities.
+ "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range.
+ #
+ # The salience score for an entity provides information about the
+ # importance or centrality of that entity to the entire document text.
+ # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
+ # salient.
"mentions": [ # The mentions of this entity in the input document. The API currently
# supports proper noun mentions.
{ # Represents a mention for an entity in the text. Currently, proper noun
@@ -145,12 +152,6 @@
"type": "A String", # The type of the entity mention.
},
],
- "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range.
- #
- # The salience score for an entity provides information about the
- # importance or centrality of that entity to the entire document text.
- # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
- # salient.
"type": "A String", # The entity type.
"name": "A String", # The representative name for the entity.
"metadata": { # Metadata associated with the entity.
@@ -176,6 +177,7 @@
The object takes the form of:
{ # The sentiment analysis request message.
+ "encodingType": "A String", # The encoding type used by the API to calculate sentence offsets.
"document": { # ################################################################ # # Input document. Currently, `analyzeSentiment` only supports English text
# (Document.language="EN").
#
@@ -197,7 +199,6 @@
# details, see https://cloud.google.com/storage/docs/reference-uris.
# NOTE: Cloud Storage object versioning is not supported.
},
- "encodingType": "A String", # The encoding type used by the API to calculate sentence offsets.
}
x__xgafv: string, V1 error format.
@@ -292,16 +293,6 @@
"beginOffset": 42, # The API calculates the beginning offset of the content in the original
# document according to the EncodingType specified in the API request.
},
- "dependencyEdge": { # Represents dependency parse tree information for a token. (For more # Dependency tree parse for this token.
- # information on dependency labels, see
- # http://www.aclweb.org/anthology/P13-2017
- "headTokenIndex": 42, # Represents the head of this token in the dependency tree.
- # This is the index of the token which has an arc going to this token.
- # The index is the position of the token in the array of tokens returned
- # by the API method. If this token is a root token, then the
- # `head_token_index` is its own index.
- "label": "A String", # The parse label for the token.
- },
"partOfSpeech": { # Represents part of speech information for a token. Parts of speech # Parts of speech tag for this token.
# are as defined in
# http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf
@@ -318,6 +309,16 @@
"voice": "A String", # The grammatical voice.
"mood": "A String", # The grammatical mood.
},
+ "dependencyEdge": { # Represents dependency parse tree information for a token. (For more # Dependency tree parse for this token.
+ # information on dependency labels, see
+ # http://www.aclweb.org/anthology/P13-2017
+ "headTokenIndex": 42, # Represents the head of this token in the dependency tree.
+ # This is the index of the token which has an arc going to this token.
+ # The index is the position of the token in the array of tokens returned
+ # by the API method. If this token is a root token, then the
+ # `head_token_index` is its own index.
+ "label": "A String", # The parse label for the token.
+ },
"lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
},
],
@@ -358,6 +359,12 @@
{ # The request message for the text annotation API, which can perform multiple
# analysis types (sentiment, entities, and syntax) in one call.
"encodingType": "A String", # The encoding type used by the API to calculate offsets.
+ "features": { # All available features for sentiment, syntax, and semantic analysis. # The enabled features.
+ # Setting each one to true will enable that specific analysis for the input.
+ "extractDocumentSentiment": True or False, # Extract document-level sentiment.
+ "extractEntities": True or False, # Extract entities.
+ "extractSyntax": True or False, # Extract syntax information.
+ },
"document": { # ################################################################ # # Input document.
#
# Represents the input to API methods.
@@ -378,12 +385,6 @@
# details, see https://cloud.google.com/storage/docs/reference-uris.
# NOTE: Cloud Storage object versioning is not supported.
},
- "features": { # All available features for sentiment, syntax, and semantic analysis. # The enabled features.
- # Setting each one to true will enable that specific analysis for the input.
- "extractDocumentSentiment": True or False, # Extract document-level sentiment.
- "extractEntities": True or False, # Extract entities.
- "extractSyntax": True or False, # Extract syntax information.
- },
}
x__xgafv: string, V1 error format.
@@ -404,16 +405,6 @@
"beginOffset": 42, # The API calculates the beginning offset of the content in the original
# document according to the EncodingType specified in the API request.
},
- "dependencyEdge": { # Represents dependency parse tree information for a token. (For more # Dependency tree parse for this token.
- # information on dependency labels, see
- # http://www.aclweb.org/anthology/P13-2017
- "headTokenIndex": 42, # Represents the head of this token in the dependency tree.
- # This is the index of the token which has an arc going to this token.
- # The index is the position of the token in the array of tokens returned
- # by the API method. If this token is a root token, then the
- # `head_token_index` is its own index.
- "label": "A String", # The parse label for the token.
- },
"partOfSpeech": { # Represents part of speech information for a token. Parts of speech # Parts of speech tag for this token.
# are as defined in
# http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf
@@ -430,6 +421,16 @@
"voice": "A String", # The grammatical voice.
"mood": "A String", # The grammatical mood.
},
+ "dependencyEdge": { # Represents dependency parse tree information for a token. (For more # Dependency tree parse for this token.
+ # information on dependency labels, see
+ # http://www.aclweb.org/anthology/P13-2017
+ "headTokenIndex": 42, # Represents the head of this token in the dependency tree.
+ # This is the index of the token which has an arc going to this token.
+ # The index is the position of the token in the array of tokens returned
+ # by the API method. If this token is a root token, then the
+ # `head_token_index` is its own index.
+ "label": "A String", # The parse label for the token.
+ },
"lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
},
],
@@ -439,6 +440,12 @@
{ # Represents a phrase in the text that is a known entity, such as
# a person, an organization, or location. The API associates information, such
# as salience and mentions, with entities.
+ "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range.
+ #
+ # The salience score for an entity provides information about the
+ # importance or centrality of that entity to the entire document text.
+ # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
+ # salient.
"mentions": [ # The mentions of this entity in the input document. The API currently
# supports proper noun mentions.
{ # Represents a mention for an entity in the text. Currently, proper noun
@@ -451,12 +458,6 @@
"type": "A String", # The type of the entity mention.
},
],
- "salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range.
- #
- # The salience score for an entity provides information about the
- # importance or centrality of that entity to the entire document text.
- # Scores closer to 0 are less salient, while scores closer to 1.0 are highly
- # salient.
"type": "A String", # The entity type.
"name": "A String", # The representative name for the entity.
"metadata": { # Metadata associated with the entity.
diff --git a/docs/dyn/language_v1beta1.documents.html b/docs/dyn/language_v1beta1.documents.html
index d7190fc..b7f5625 100644
--- a/docs/dyn/language_v1beta1.documents.html
+++ b/docs/dyn/language_v1beta1.documents.html
@@ -76,7 +76,7 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#analyzeEntities">analyzeEntities(body, x__xgafv=None)</a></code></p>
-<p class="firstline">Finds named entities (currently finds proper names) in the text,</p>
+<p class="firstline">Finds named entities (currently proper names and common nouns) in the text</p>
<p class="toc_element">
<code><a href="#analyzeSentiment">analyzeSentiment(body, x__xgafv=None)</a></code></p>
<p class="firstline">Analyzes the sentiment of the provided text.</p>
@@ -89,15 +89,15 @@
<h3>Method Details</h3>
<div class="method">
<code class="details" id="analyzeEntities">analyzeEntities(body, x__xgafv=None)</code>
- <pre>Finds named entities (currently finds proper names) in the text,
-entity types, salience, mentions for each entity, and other properties.
+ <pre>Finds named entities (currently proper names and common nouns) in the text
+along with entity types, salience, mentions for each entity, and
+other properties.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # The entity analysis request message.
- "encodingType": "A String", # The encoding type used by the API to calculate offsets.
"document": { # ################################################################ # # Input document.
#
# Represents the input to API methods.
@@ -118,6 +118,7 @@
# details, see https://cloud.google.com/storage/docs/reference-uris.
# NOTE: Cloud Storage object versioning is not supported.
},
+ "encodingType": "A String", # The encoding type used by the API to calculate offsets.
}
x__xgafv: string, V1 error format.
@@ -259,7 +260,6 @@
The object takes the form of:
{ # The syntax analysis request message.
- "encodingType": "A String", # The encoding type used by the API to calculate offsets.
"document": { # ################################################################ # # Input document.
#
# Represents the input to API methods.
@@ -280,6 +280,7 @@
# details, see https://cloud.google.com/storage/docs/reference-uris.
# NOTE: Cloud Storage object versioning is not supported.
},
+ "encodingType": "A String", # The encoding type used by the API to calculate offsets.
}
x__xgafv: string, V1 error format.
@@ -298,20 +299,6 @@
"beginOffset": 42, # The API calculates the beginning offset of the content in the original
# document according to the EncodingType specified in the API request.
},
- "partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.
- "case": "A String", # The grammatical case.
- "mood": "A String", # The grammatical mood.
- "form": "A String", # The grammatical form.
- "gender": "A String", # The grammatical gender.
- "aspect": "A String", # The grammatical aspect.
- "number": "A String", # The grammatical number.
- "person": "A String", # The grammatical person.
- "tag": "A String", # The part of speech tag.
- "tense": "A String", # The grammatical tense.
- "reciprocity": "A String", # The grammatical reciprocity.
- "proper": "A String", # The grammatical properness.
- "voice": "A String", # The grammatical voice.
- },
"dependencyEdge": { # Represents dependency parse tree information for a token. # Dependency tree parse for this token.
"headTokenIndex": 42, # Represents the head of this token in the dependency tree.
# This is the index of the token which has an arc going to this token.
@@ -320,6 +307,20 @@
# `head_token_index` is its own index.
"label": "A String", # The parse label for the token.
},
+ "partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.
+ "case": "A String", # The grammatical case.
+ "aspect": "A String", # The grammatical aspect.
+ "form": "A String", # The grammatical form.
+ "gender": "A String", # The grammatical gender.
+ "number": "A String", # The grammatical number.
+ "person": "A String", # The grammatical person.
+ "tag": "A String", # The part of speech tag.
+ "tense": "A String", # The grammatical tense.
+ "reciprocity": "A String", # The grammatical reciprocity.
+ "proper": "A String", # The grammatical properness.
+ "voice": "A String", # The grammatical voice.
+ "mood": "A String", # The grammatical mood.
+ },
"lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
},
],
@@ -409,20 +410,6 @@
"beginOffset": 42, # The API calculates the beginning offset of the content in the original
# document according to the EncodingType specified in the API request.
},
- "partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.
- "case": "A String", # The grammatical case.
- "mood": "A String", # The grammatical mood.
- "form": "A String", # The grammatical form.
- "gender": "A String", # The grammatical gender.
- "aspect": "A String", # The grammatical aspect.
- "number": "A String", # The grammatical number.
- "person": "A String", # The grammatical person.
- "tag": "A String", # The part of speech tag.
- "tense": "A String", # The grammatical tense.
- "reciprocity": "A String", # The grammatical reciprocity.
- "proper": "A String", # The grammatical properness.
- "voice": "A String", # The grammatical voice.
- },
"dependencyEdge": { # Represents dependency parse tree information for a token. # Dependency tree parse for this token.
"headTokenIndex": 42, # Represents the head of this token in the dependency tree.
# This is the index of the token which has an arc going to this token.
@@ -431,6 +418,20 @@
# `head_token_index` is its own index.
"label": "A String", # The parse label for the token.
},
+ "partOfSpeech": { # Represents part of speech information for a token. # Parts of speech tag for this token.
+ "case": "A String", # The grammatical case.
+ "aspect": "A String", # The grammatical aspect.
+ "form": "A String", # The grammatical form.
+ "gender": "A String", # The grammatical gender.
+ "number": "A String", # The grammatical number.
+ "person": "A String", # The grammatical person.
+ "tag": "A String", # The part of speech tag.
+ "tense": "A String", # The grammatical tense.
+ "reciprocity": "A String", # The grammatical reciprocity.
+ "proper": "A String", # The grammatical properness.
+ "voice": "A String", # The grammatical voice.
+ "mood": "A String", # The grammatical mood.
+ },
"lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.
},
],
diff --git a/docs/dyn/licensing_v1.licenseAssignments.html b/docs/dyn/licensing_v1.licenseAssignments.html
index c0df2a5..c939d4a 100644
--- a/docs/dyn/licensing_v1.licenseAssignments.html
+++ b/docs/dyn/licensing_v1.licenseAssignments.html
@@ -126,12 +126,14 @@
An object of the form:
{ # Template for LiscenseAssignment Resource
- "skuId": "A String", # Name of the sku of the product.
+ "skuId": "A String", # Id of the sku of the product.
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
"userId": "A String", # Email id of the user.
+ "productName": "A String", # Display Name of the product.
+ "skuName": "A String", # Display Name of the sku of the product.
"etags": "A String", # ETag of the resource.
"selfLink": "A String", # Link to this page.
- "productId": "A String", # Name of the product.
+ "productId": "A String", # Id of the product.
}</pre>
</div>
@@ -154,12 +156,14 @@
An object of the form:
{ # Template for LiscenseAssignment Resource
- "skuId": "A String", # Name of the sku of the product.
+ "skuId": "A String", # Id of the sku of the product.
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
"userId": "A String", # Email id of the user.
+ "productName": "A String", # Display Name of the product.
+ "skuName": "A String", # Display Name of the sku of the product.
"etags": "A String", # ETag of the resource.
"selfLink": "A String", # Link to this page.
- "productId": "A String", # Name of the product.
+ "productId": "A String", # Id of the product.
}</pre>
</div>
@@ -180,12 +184,14 @@
"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 LicenseAssignments in this page of results.
{ # Template for LiscenseAssignment Resource
- "skuId": "A String", # Name of the sku of the product.
+ "skuId": "A String", # Id of the sku of the product.
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
"userId": "A String", # Email id of the user.
+ "productName": "A String", # Display Name of the product.
+ "skuName": "A String", # Display Name of the sku of the product.
"etags": "A String", # ETag of the resource.
"selfLink": "A String", # Link to this page.
- "productId": "A String", # Name of the product.
+ "productId": "A String", # Id of the product.
},
],
"kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
@@ -211,12 +217,14 @@
"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 LicenseAssignments in this page of results.
{ # Template for LiscenseAssignment Resource
- "skuId": "A String", # Name of the sku of the product.
+ "skuId": "A String", # Id of the sku of the product.
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
"userId": "A String", # Email id of the user.
+ "productName": "A String", # Display Name of the product.
+ "skuName": "A String", # Display Name of the sku of the product.
"etags": "A String", # ETag of the resource.
"selfLink": "A String", # Link to this page.
- "productId": "A String", # Name of the product.
+ "productId": "A String", # Id of the product.
},
],
"kind": "licensing#licenseAssignmentList", # Identifies the resource as a collection of LicenseAssignments.
@@ -264,12 +272,14 @@
The object takes the form of:
{ # Template for LiscenseAssignment Resource
- "skuId": "A String", # Name of the sku of the product.
+ "skuId": "A String", # Id of the sku of the product.
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
"userId": "A String", # Email id of the user.
+ "productName": "A String", # Display Name of the product.
+ "skuName": "A String", # Display Name of the sku of the product.
"etags": "A String", # ETag of the resource.
"selfLink": "A String", # Link to this page.
- "productId": "A String", # Name of the product.
+ "productId": "A String", # Id of the product.
}
@@ -277,12 +287,14 @@
An object of the form:
{ # Template for LiscenseAssignment Resource
- "skuId": "A String", # Name of the sku of the product.
+ "skuId": "A String", # Id of the sku of the product.
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
"userId": "A String", # Email id of the user.
+ "productName": "A String", # Display Name of the product.
+ "skuName": "A String", # Display Name of the sku of the product.
"etags": "A String", # ETag of the resource.
"selfLink": "A String", # Link to this page.
- "productId": "A String", # Name of the product.
+ "productId": "A String", # Id of the product.
}</pre>
</div>
@@ -298,12 +310,14 @@
The object takes the form of:
{ # Template for LiscenseAssignment Resource
- "skuId": "A String", # Name of the sku of the product.
+ "skuId": "A String", # Id of the sku of the product.
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
"userId": "A String", # Email id of the user.
+ "productName": "A String", # Display Name of the product.
+ "skuName": "A String", # Display Name of the sku of the product.
"etags": "A String", # ETag of the resource.
"selfLink": "A String", # Link to this page.
- "productId": "A String", # Name of the product.
+ "productId": "A String", # Id of the product.
}
@@ -311,12 +325,14 @@
An object of the form:
{ # Template for LiscenseAssignment Resource
- "skuId": "A String", # Name of the sku of the product.
+ "skuId": "A String", # Id of the sku of the product.
"kind": "licensing#licenseAssignment", # Identifies the resource as a LicenseAssignment.
"userId": "A String", # Email id of the user.
+ "productName": "A String", # Display Name of the product.
+ "skuName": "A String", # Display Name of the sku of the product.
"etags": "A String", # ETag of the resource.
"selfLink": "A String", # Link to this page.
- "productId": "A String", # Name of the product.
+ "productId": "A String", # Id of the product.
}</pre>
</div>
diff --git a/docs/dyn/logging_v2.billingAccounts.logs.html b/docs/dyn/logging_v2.billingAccounts.logs.html
index 3ad11dd..83729a1 100644
--- a/docs/dyn/logging_v2.billingAccounts.logs.html
+++ b/docs/dyn/logging_v2.billingAccounts.logs.html
@@ -78,7 +78,7 @@
<code><a href="#delete">delete(logName=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.</p>
<p class="toc_element">
- <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -112,7 +112,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.
Args:
@@ -122,12 +122,12 @@
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
(required)
+ 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
- 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:
diff --git a/docs/dyn/logging_v2.billingAccounts.sinks.html b/docs/dyn/logging_v2.billingAccounts.sinks.html
index d2e93be..97eff5f 100644
--- a/docs/dyn/logging_v2.billingAccounts.sinks.html
+++ b/docs/dyn/logging_v2.billingAccounts.sinks.html
@@ -108,7 +108,7 @@
The object takes the form of:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -118,7 +118,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}
@@ -132,7 +132,7 @@
An object of the form:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -142,7 +142,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}</pre>
</div>
@@ -194,7 +194,7 @@
An object of the form:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -204,7 +204,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}</pre>
</div>
@@ -234,7 +234,7 @@
"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 to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -244,7 +244,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
},
],
@@ -280,7 +280,7 @@
The object takes the form of:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -290,7 +290,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}
@@ -307,7 +307,7 @@
An object of the form:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -317,7 +317,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}</pre>
</div>
diff --git a/docs/dyn/logging_v2.entries.html b/docs/dyn/logging_v2.entries.html
index 469249e..5735415 100644
--- a/docs/dyn/logging_v2.entries.html
+++ b/docs/dyn/logging_v2.entries.html
@@ -147,16 +147,13 @@
},
"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.
- "trace": "A String", # Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824
"textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8).
+ "trace": "A String", # Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824
"timestamp": "A String", # Optional. The time the event described by the log entry occurred. If omitted in a new log entry, Stackdriver Logging will insert the time the log entry is received. Stackdriver Logging might reject log entries whose time stamps are more than a couple of hours in the future. Log entries with time stamps in the past are accepted.
"labels": { # Optional. A set of user-defined (key, value) data that provides additional information about the log entry.
"a_key": "A String",
},
- "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.
- },
+ "insertId": "A String", # Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging will insert its own unique identifier. The insert_id is used to order log entries that have the same timestamp value.
"jsonPayload": { # The log entry payload, represented as a structure that is expressed as a JSON object.
"a_key": "", # Properties of the object.
},
@@ -166,7 +163,9 @@
# "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
# "folders/[FOLDER_ID]/logs/[LOG_ID]"
# [LOG_ID] must be URL-encoded within log_name. Example: "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.
- "insertId": "A String", # Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging will insert its own unique identifier. The insert_id is used to order log entries that have the same timestamp value.
+ "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.
"last": True or False, # Optional. Set this to True if this is the last log entry in the operation.
"id": "A String", # Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.
@@ -178,6 +177,7 @@
"line": "A String", # Optional. Line within the source file. 1-based; 0 indicates no line number available.
"file": "A String", # Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.
},
+ "severity": "A String", # Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.
},
],
}</pre>
@@ -206,6 +206,16 @@
The object takes the form of:
{ # The parameters to WriteLogEntries.
+ "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:
+ # "projects/[PROJECT_ID]/logs/[LOG_ID]"
+ # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
+ # "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
+ # "folders/[FOLDER_ID]/logs/[LOG_ID]"
+ # [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" or "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, see LogEntry.
+ "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, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries' zero-based index in the entries.write method.
+ "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",
+ },
"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": # 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": {
@@ -219,16 +229,6 @@
},
"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, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries' zero-based index in the entries.write method.
- "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 that is assigned to all log entries in entries that do not specify a value for log_name:
- # "projects/[PROJECT_ID]/logs/[LOG_ID]"
- # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
- # "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
- # "folders/[FOLDER_ID]/logs/[LOG_ID]"
- # [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" or "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, 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 inserted into those log entries in this list that do not provide their own values.Stackdriver Logging also creates and inserts values for timestamp and insert_id if the entries do not provide them. The created insert_id for the N'th entry in this list will be greater than earlier entries and less than later entries. Otherwise, the order of log entries in this list does not matter.To improve throughput and to avoid exceeding the quota limit 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. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message. # Optional. Information about the HTTP request associated with this log entry, if applicable.
@@ -256,16 +256,13 @@
},
"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.
- "trace": "A String", # Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824
"textPayload": "A String", # The log entry payload, represented as a Unicode string (UTF-8).
+ "trace": "A String", # Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824
"timestamp": "A String", # Optional. The time the event described by the log entry occurred. If omitted in a new log entry, Stackdriver Logging will insert the time the log entry is received. Stackdriver Logging might reject log entries whose time stamps are more than a couple of hours in the future. Log entries with time stamps in the past are accepted.
"labels": { # Optional. A set of user-defined (key, value) data that provides additional information about the log entry.
"a_key": "A String",
},
- "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.
- },
+ "insertId": "A String", # Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging will insert its own unique identifier. The insert_id is used to order log entries that have the same timestamp value.
"jsonPayload": { # The log entry payload, represented as a structure that is expressed as a JSON object.
"a_key": "", # Properties of the object.
},
@@ -275,7 +272,9 @@
# "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
# "folders/[FOLDER_ID]/logs/[LOG_ID]"
# [LOG_ID] must be URL-encoded within log_name. Example: "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.
- "insertId": "A String", # Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging will insert its own unique identifier. The insert_id is used to order log entries that have the same timestamp value.
+ "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.
"last": True or False, # Optional. Set this to True if this is the last log entry in the operation.
"id": "A String", # Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.
@@ -287,6 +286,7 @@
"line": "A String", # Optional. Line within the source file. 1-based; 0 indicates no line number available.
"file": "A String", # Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.
},
+ "severity": "A String", # Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.
},
],
}
diff --git a/docs/dyn/logging_v2.folders.sinks.html b/docs/dyn/logging_v2.folders.sinks.html
index 476f770..11ea918 100644
--- a/docs/dyn/logging_v2.folders.sinks.html
+++ b/docs/dyn/logging_v2.folders.sinks.html
@@ -84,7 +84,7 @@
<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(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=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>
@@ -108,7 +108,7 @@
The object takes the form of:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -118,7 +118,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}
@@ -132,7 +132,7 @@
An object of the form:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -142,7 +142,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}</pre>
</div>
@@ -194,7 +194,7 @@
An object of the form:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -204,13 +204,13 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists sinks.
Args:
@@ -220,12 +220,12 @@
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
(required)
+ 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
- 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:
@@ -234,7 +234,7 @@
"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 to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -244,7 +244,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
},
],
@@ -280,7 +280,7 @@
The object takes the form of:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -290,7 +290,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}
@@ -307,7 +307,7 @@
An object of the form:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -317,7 +317,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}</pre>
</div>
diff --git a/docs/dyn/logging_v2.monitoredResourceDescriptors.html b/docs/dyn/logging_v2.monitoredResourceDescriptors.html
index 3b54b9b..1b5eed4 100644
--- a/docs/dyn/logging_v2.monitoredResourceDescriptors.html
+++ b/docs/dyn/logging_v2.monitoredResourceDescriptors.html
@@ -109,8 +109,8 @@
},
],
"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}".
+ "description": "A String", # Optional. A detailed description of the monitored resource type that might be used in documentation.
},
],
}</pre>
diff --git a/docs/dyn/logging_v2.organizations.logs.html b/docs/dyn/logging_v2.organizations.logs.html
index 5974754..c0026b8 100644
--- a/docs/dyn/logging_v2.organizations.logs.html
+++ b/docs/dyn/logging_v2.organizations.logs.html
@@ -78,7 +78,7 @@
<code><a href="#delete">delete(logName=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.</p>
<p class="toc_element">
- <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -112,7 +112,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.
Args:
@@ -122,12 +122,12 @@
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
(required)
+ 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
- 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:
diff --git a/docs/dyn/logging_v2.organizations.sinks.html b/docs/dyn/logging_v2.organizations.sinks.html
index 9b375b8..e75710e 100644
--- a/docs/dyn/logging_v2.organizations.sinks.html
+++ b/docs/dyn/logging_v2.organizations.sinks.html
@@ -84,7 +84,7 @@
<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(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=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>
@@ -108,7 +108,7 @@
The object takes the form of:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -118,7 +118,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}
@@ -132,7 +132,7 @@
An object of the form:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -142,7 +142,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}</pre>
</div>
@@ -194,7 +194,7 @@
An object of the form:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -204,13 +204,13 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists sinks.
Args:
@@ -220,12 +220,12 @@
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
(required)
+ 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
- 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:
@@ -234,7 +234,7 @@
"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 to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -244,7 +244,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
},
],
@@ -280,7 +280,7 @@
The object takes the form of:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -290,7 +290,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}
@@ -307,7 +307,7 @@
An object of the form:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -317,7 +317,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}</pre>
</div>
diff --git a/docs/dyn/logging_v2.projects.sinks.html b/docs/dyn/logging_v2.projects.sinks.html
index 280a046..808ea26 100644
--- a/docs/dyn/logging_v2.projects.sinks.html
+++ b/docs/dyn/logging_v2.projects.sinks.html
@@ -84,7 +84,7 @@
<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(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=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>
@@ -108,7 +108,7 @@
The object takes the form of:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -118,7 +118,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}
@@ -132,7 +132,7 @@
An object of the form:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -142,7 +142,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}</pre>
</div>
@@ -194,7 +194,7 @@
An object of the form:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -204,13 +204,13 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists sinks.
Args:
@@ -220,12 +220,12 @@
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
(required)
+ 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
- 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:
@@ -234,7 +234,7 @@
"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 to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -244,7 +244,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
},
],
@@ -280,7 +280,7 @@
The object takes the form of:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -290,7 +290,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}
@@ -307,7 +307,7 @@
An object of the form:
{ # Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
+ "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
"name": "A String", # Required. The client-assigned sink identifier, unique within the project. Example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"destination": "A String", # Required. The export destination:
# "storage.googleapis.com/[GCS_BUCKET]"
@@ -317,7 +317,7 @@
"filter": "A String", # Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:
# logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR
"startTime": "A String", # Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.
- "outputVersionFormat": "A String", # Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.
+ "endTime": "A String", # Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.
"writerIdentity": "A String", # Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.
}</pre>
</div>
diff --git a/docs/dyn/logging_v2beta1.billingAccounts.logs.html b/docs/dyn/logging_v2beta1.billingAccounts.logs.html
index c467d7d..9801413 100644
--- a/docs/dyn/logging_v2beta1.billingAccounts.logs.html
+++ b/docs/dyn/logging_v2beta1.billingAccounts.logs.html
@@ -78,7 +78,7 @@
<code><a href="#delete">delete(logName=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.</p>
<p class="toc_element">
- <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -112,7 +112,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.
Args:
@@ -122,12 +122,12 @@
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
(required)
+ 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
- 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:
diff --git a/docs/dyn/logging_v2beta1.entries.html b/docs/dyn/logging_v2beta1.entries.html
index 885a189..64f1792 100644
--- a/docs/dyn/logging_v2beta1.entries.html
+++ b/docs/dyn/logging_v2beta1.entries.html
@@ -124,14 +124,14 @@
{ # An individual entry in a log.
"httpRequest": { # A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message. # 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.
- "requestMethod": "A String", # The request method. Examples: "GET", "HEAD", "PUT", "POST".
"latency": "A String", # The request processing latency on the server, from the time the request was received until the response was sent.
+ "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".
"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).
+ "requestMethod": "A String", # The request method. Examples: "GET", "HEAD", "PUT", "POST".
+ "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.
"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)".
@@ -154,7 +154,9 @@
"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 identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging will insert its own unique identifier. The insert_id is used to order log entries that have the same timestamp value.
+ "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.
+ },
"jsonPayload": { # The log entry payload, represented as a structure that is expressed as a JSON object.
"a_key": "", # Properties of the object.
},
@@ -164,9 +166,7 @@
# "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
# "folders/[FOLDER_ID]/logs/[LOG_ID]"
# [LOG_ID] must be URL-encoded within log_name. Example: "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.
- "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.
- },
+ "insertId": "A String", # Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging will insert its own unique identifier. The insert_id is used to order log entries that have the same timestamp value.
"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.
"last": True or False, # Optional. Set this to True if this is the last log entry in the operation.
"id": "A String", # Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.
@@ -206,16 +206,6 @@
The object takes the form of:
{ # The parameters to WriteLogEntries.
- "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:
- # "projects/[PROJECT_ID]/logs/[LOG_ID]"
- # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
- # "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
- # "folders/[FOLDER_ID]/logs/[LOG_ID]"
- # [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" or "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, see LogEntry.
- "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, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries' zero-based index in the entries.write method.
- "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",
- },
"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": # 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": {
@@ -229,18 +219,28 @@
},
"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, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries' zero-based index in the entries.write method.
+ "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 that is assigned to all log entries in entries that do not specify a value for log_name:
+ # "projects/[PROJECT_ID]/logs/[LOG_ID]"
+ # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
+ # "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
+ # "folders/[FOLDER_ID]/logs/[LOG_ID]"
+ # [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" or "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". For more information about log names, 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 inserted into those log entries in this list that do not provide their own values.Stackdriver Logging also creates and inserts values for timestamp and insert_id if the entries do not provide them. The created insert_id for the N'th entry in this list will be greater than earlier entries and less than later entries. Otherwise, the order of log entries in this list does not matter.To improve throughput and to avoid exceeding the quota limit 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. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message. # 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.
- "requestMethod": "A String", # The request method. Examples: "GET", "HEAD", "PUT", "POST".
"latency": "A String", # The request processing latency on the server, from the time the request was received until the response was sent.
+ "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".
"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).
+ "requestMethod": "A String", # The request method. Examples: "GET", "HEAD", "PUT", "POST".
+ "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.
"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)".
@@ -263,7 +263,9 @@
"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 identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging will insert its own unique identifier. The insert_id is used to order log entries that have the same timestamp value.
+ "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.
+ },
"jsonPayload": { # The log entry payload, represented as a structure that is expressed as a JSON object.
"a_key": "", # Properties of the object.
},
@@ -273,9 +275,7 @@
# "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
# "folders/[FOLDER_ID]/logs/[LOG_ID]"
# [LOG_ID] must be URL-encoded within log_name. Example: "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.
- "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.
- },
+ "insertId": "A String", # Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging will insert its own unique identifier. The insert_id is used to order log entries that have the same timestamp value.
"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.
"last": True or False, # Optional. Set this to True if this is the last log entry in the operation.
"id": "A String", # Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.
diff --git a/docs/dyn/logging_v2beta1.projects.metrics.html b/docs/dyn/logging_v2beta1.projects.metrics.html
index 802a1b7..ab01ef8 100644
--- a/docs/dyn/logging_v2beta1.projects.metrics.html
+++ b/docs/dyn/logging_v2beta1.projects.metrics.html
@@ -200,7 +200,6 @@
An object of the form:
{ # Result returned from ListLogMetrics.
- "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.
"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 in a given time interval.
"filter": "A String", # Required. An advanced logs filter which is used to match log entries. Example:
@@ -211,6 +210,7 @@
"description": "A String", # Optional. A description of this metric, which is used in documentation.
},
],
+ "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>
diff --git a/docs/dyn/logging_v2beta1.projects.sinks.html b/docs/dyn/logging_v2beta1.projects.sinks.html
index 8ea4016..d4099fe 100644
--- a/docs/dyn/logging_v2beta1.projects.sinks.html
+++ b/docs/dyn/logging_v2beta1.projects.sinks.html
@@ -84,7 +84,7 @@
<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(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=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>
@@ -210,7 +210,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists sinks.
Args:
@@ -220,12 +220,12 @@
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
(required)
+ 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
- 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:
diff --git a/docs/dyn/manufacturers_v1.accounts.products.html b/docs/dyn/manufacturers_v1.accounts.products.html
index 08ea302..3bbc180 100644
--- a/docs/dyn/manufacturers_v1.accounts.products.html
+++ b/docs/dyn/manufacturers_v1.accounts.products.html
@@ -120,13 +120,6 @@
# @OutputOnly
"A String",
],
- "parent": "A String", # Parent ID in the format `accounts/{account_id}`.
- #
- # `account_id` - The ID of the Manufacturer Center account.
- # @OutputOnly
- "contentLanguage": "A String", # The content language of the product as a two-letter ISO 639-1 language code
- # (for example, en).
- # @OutputOnly
"name": "A String", # Name in the format `{target_country}:{content_language}:{product_id}`.
#
# `target_country` - The target country of the product as a CLDR territory
@@ -138,31 +131,135 @@
# `product_id` - The ID of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#id.
# @OutputOnly
+ "parent": "A String", # Parent ID in the format `accounts/{account_id}`.
+ #
+ # `account_id` - The ID of the Manufacturer Center account.
+ # @OutputOnly
"manuallyProvidedAttributes": { # Attributes of the product. For more information, see # Attributes of the product provided manually via the Manufacturer Center UI.
# @OutputOnly
# https://support.google.com/manufacturers/answer/6124116.
"productLine": "A String", # The name of the group of products related to the product. For more
# information, see
# https://support.google.com/manufacturers/answer/6124116#productline.
+ "suggestedRetailPrice": { # A price. # The suggested retail price (MSRP) of the product. For more information,
+ # see https://support.google.com/manufacturers/answer/6124116#price.
+ "currency": "A String", # The currency in which the price is denoted.
+ "amount": "A String", # The numeric value of the price.
+ },
+ "color": "A String", # The color of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#color.
+ "releaseDate": "A String", # The release date of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#release.
+ "itemGroupId": "A String", # The item group id of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#itemgroupid.
+ "videoLink": [ # The videos of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#video.
+ "A String",
+ ],
+ "flavor": "A String", # The flavor of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#flavor.
+ "scent": "A String", # The scent of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#scent.
+ "size": "A String", # The size of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#size.
+ "capacity": { # The capacity of a product. For more information, see # The capacity of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#capacity.
+ # https://support.google.com/manufacturers/answer/6124116#capacity.
+ "unit": "A String", # The unit of the capacity, i.e., MB, GB, or TB.
+ "value": "A String", # The numeric value of the capacity.
+ },
"title": "A String", # The title of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#title.
+ "pattern": "A String", # The pattern of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#pattern.
+ "disclosureDate": "A String", # The disclosure date of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#disclosure.
+ "theme": "A String", # The theme of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#theme.
+ "productDetail": [ # The details of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#productdetail.
+ { # A product detail of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#productdetail.
+ "attributeName": "A String", # The name of the attribute.
+ "attributeValue": "A String", # The value of the attribute.
+ "sectionName": "A String", # A short section name that can be reused between multiple product details.
+ },
+ ],
+ "description": "A String", # The description of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#description.
+ "format": "A String", # The format of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#format.
"mpn": "A String", # The Manufacturer Part Number (MPN) of the product. For more information,
# see https://support.google.com/manufacturers/answer/6124116#mpn.
"brand": "A String", # The brand name of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#brand.
+ "material": "A String", # The material of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#material.
"productName": "A String", # The canonical name of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#productname.
- "productPageUrl": "A String", # The URL of the manufacturer's detail page of the product. For more
- # information, see
+ "featureDescription": [ # The rich format description of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#featuredesc.
+ { # A feature description of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#featuredesc.
+ "headline": "A String", # A short description of the feature.
+ "text": "A String", # A detailed description of the feature.
+ "image": { # An image. # An optional image describing the feature.
+ "status": "A String", # The status of the image.
+ # @OutputOnly
+ "imageUrl": "A String", # The URL of the image. For crawled images, this is the provided URL. For
+ # uploaded images, this is a serving URL from Google if the image has been
+ # processed successfully.
+ "type": "A String", # The type of the image, i.e., crawled or uploaded.
+ # @OutputOnly
+ },
+ },
+ ],
+ "sizeSystem": "A String", # The size system of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#sizesystem.
+ "sizeType": "A String", # The size type of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#sizetype.
+ "additionalImageLink": [ # The additional images of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#addlimage.
+ { # An image.
+ "status": "A String", # The status of the image.
+ # @OutputOnly
+ "imageUrl": "A String", # The URL of the image. For crawled images, this is the provided URL. For
+ # uploaded images, this is a serving URL from Google if the image has been
+ # processed successfully.
+ "type": "A String", # The type of the image, i.e., crawled or uploaded.
+ # @OutputOnly
+ },
+ ],
+ "count": { # The number of products in a single package. For more information, see # The count of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#count.
+ # https://support.google.com/manufacturers/answer/6124116#count.
+ "unit": "A String", # The unit in which these products are counted.
+ "value": "A String", # The numeric value of the number of products in a package.
+ },
+ "gender": "A String", # The target gender of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#gender.
+ "productPageUrl": "A String", # The URL of the detail page of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#productpage.
+ "imageLink": { # An image. # The image of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#image.
+ "status": "A String", # The status of the image.
+ # @OutputOnly
+ "imageUrl": "A String", # The URL of the image. For crawled images, this is the provided URL. For
+ # uploaded images, this is a serving URL from Google if the image has been
+ # processed successfully.
+ "type": "A String", # The type of the image, i.e., crawled or uploaded.
+ # @OutputOnly
+ },
+ "productType": [ # The category of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#producttype.
+ "A String",
+ ],
"gtin": [ # The Global Trade Item Number (GTIN) of the product. For more information,
# see https://support.google.com/manufacturers/answer/6124116#gtin.
"A String",
],
- "productType": [ # The manufacturer's category of the product. For more information, see
- # https://support.google.com/manufacturers/answer/6124116#producttype.
- "A String",
- ],
+ "ageGroup": "A String", # The target age group of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#agegroup.
},
"finalAttributes": { # Attributes of the product. For more information, see # Final attributes of the product. The final attributes are obtained by
# overriding the uploaded attributes with the manually provided and deleted
@@ -173,25 +270,125 @@
"productLine": "A String", # The name of the group of products related to the product. For more
# information, see
# https://support.google.com/manufacturers/answer/6124116#productline.
+ "suggestedRetailPrice": { # A price. # The suggested retail price (MSRP) of the product. For more information,
+ # see https://support.google.com/manufacturers/answer/6124116#price.
+ "currency": "A String", # The currency in which the price is denoted.
+ "amount": "A String", # The numeric value of the price.
+ },
+ "color": "A String", # The color of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#color.
+ "releaseDate": "A String", # The release date of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#release.
+ "itemGroupId": "A String", # The item group id of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#itemgroupid.
+ "videoLink": [ # The videos of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#video.
+ "A String",
+ ],
+ "flavor": "A String", # The flavor of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#flavor.
+ "scent": "A String", # The scent of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#scent.
+ "size": "A String", # The size of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#size.
+ "capacity": { # The capacity of a product. For more information, see # The capacity of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#capacity.
+ # https://support.google.com/manufacturers/answer/6124116#capacity.
+ "unit": "A String", # The unit of the capacity, i.e., MB, GB, or TB.
+ "value": "A String", # The numeric value of the capacity.
+ },
"title": "A String", # The title of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#title.
+ "pattern": "A String", # The pattern of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#pattern.
+ "disclosureDate": "A String", # The disclosure date of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#disclosure.
+ "theme": "A String", # The theme of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#theme.
+ "productDetail": [ # The details of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#productdetail.
+ { # A product detail of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#productdetail.
+ "attributeName": "A String", # The name of the attribute.
+ "attributeValue": "A String", # The value of the attribute.
+ "sectionName": "A String", # A short section name that can be reused between multiple product details.
+ },
+ ],
+ "description": "A String", # The description of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#description.
+ "format": "A String", # The format of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#format.
"mpn": "A String", # The Manufacturer Part Number (MPN) of the product. For more information,
# see https://support.google.com/manufacturers/answer/6124116#mpn.
"brand": "A String", # The brand name of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#brand.
+ "material": "A String", # The material of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#material.
"productName": "A String", # The canonical name of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#productname.
- "productPageUrl": "A String", # The URL of the manufacturer's detail page of the product. For more
- # information, see
+ "featureDescription": [ # The rich format description of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#featuredesc.
+ { # A feature description of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#featuredesc.
+ "headline": "A String", # A short description of the feature.
+ "text": "A String", # A detailed description of the feature.
+ "image": { # An image. # An optional image describing the feature.
+ "status": "A String", # The status of the image.
+ # @OutputOnly
+ "imageUrl": "A String", # The URL of the image. For crawled images, this is the provided URL. For
+ # uploaded images, this is a serving URL from Google if the image has been
+ # processed successfully.
+ "type": "A String", # The type of the image, i.e., crawled or uploaded.
+ # @OutputOnly
+ },
+ },
+ ],
+ "sizeSystem": "A String", # The size system of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#sizesystem.
+ "sizeType": "A String", # The size type of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#sizetype.
+ "additionalImageLink": [ # The additional images of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#addlimage.
+ { # An image.
+ "status": "A String", # The status of the image.
+ # @OutputOnly
+ "imageUrl": "A String", # The URL of the image. For crawled images, this is the provided URL. For
+ # uploaded images, this is a serving URL from Google if the image has been
+ # processed successfully.
+ "type": "A String", # The type of the image, i.e., crawled or uploaded.
+ # @OutputOnly
+ },
+ ],
+ "count": { # The number of products in a single package. For more information, see # The count of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#count.
+ # https://support.google.com/manufacturers/answer/6124116#count.
+ "unit": "A String", # The unit in which these products are counted.
+ "value": "A String", # The numeric value of the number of products in a package.
+ },
+ "gender": "A String", # The target gender of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#gender.
+ "productPageUrl": "A String", # The URL of the detail page of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#productpage.
+ "imageLink": { # An image. # The image of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#image.
+ "status": "A String", # The status of the image.
+ # @OutputOnly
+ "imageUrl": "A String", # The URL of the image. For crawled images, this is the provided URL. For
+ # uploaded images, this is a serving URL from Google if the image has been
+ # processed successfully.
+ "type": "A String", # The type of the image, i.e., crawled or uploaded.
+ # @OutputOnly
+ },
+ "productType": [ # The category of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#producttype.
+ "A String",
+ ],
"gtin": [ # The Global Trade Item Number (GTIN) of the product. For more information,
# see https://support.google.com/manufacturers/answer/6124116#gtin.
"A String",
],
- "productType": [ # The manufacturer's category of the product. For more information, see
- # https://support.google.com/manufacturers/answer/6124116#producttype.
- "A String",
- ],
+ "ageGroup": "A String", # The target age group of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#agegroup.
},
"uploadedAttributes": { # Attributes of the product. For more information, see # Attributes of the product uploaded via the Manufacturer Center API or via
# feeds.
@@ -199,26 +396,129 @@
"productLine": "A String", # The name of the group of products related to the product. For more
# information, see
# https://support.google.com/manufacturers/answer/6124116#productline.
+ "suggestedRetailPrice": { # A price. # The suggested retail price (MSRP) of the product. For more information,
+ # see https://support.google.com/manufacturers/answer/6124116#price.
+ "currency": "A String", # The currency in which the price is denoted.
+ "amount": "A String", # The numeric value of the price.
+ },
+ "color": "A String", # The color of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#color.
+ "releaseDate": "A String", # The release date of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#release.
+ "itemGroupId": "A String", # The item group id of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#itemgroupid.
+ "videoLink": [ # The videos of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#video.
+ "A String",
+ ],
+ "flavor": "A String", # The flavor of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#flavor.
+ "scent": "A String", # The scent of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#scent.
+ "size": "A String", # The size of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#size.
+ "capacity": { # The capacity of a product. For more information, see # The capacity of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#capacity.
+ # https://support.google.com/manufacturers/answer/6124116#capacity.
+ "unit": "A String", # The unit of the capacity, i.e., MB, GB, or TB.
+ "value": "A String", # The numeric value of the capacity.
+ },
"title": "A String", # The title of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#title.
+ "pattern": "A String", # The pattern of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#pattern.
+ "disclosureDate": "A String", # The disclosure date of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#disclosure.
+ "theme": "A String", # The theme of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#theme.
+ "productDetail": [ # The details of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#productdetail.
+ { # A product detail of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#productdetail.
+ "attributeName": "A String", # The name of the attribute.
+ "attributeValue": "A String", # The value of the attribute.
+ "sectionName": "A String", # A short section name that can be reused between multiple product details.
+ },
+ ],
+ "description": "A String", # The description of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#description.
+ "format": "A String", # The format of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#format.
"mpn": "A String", # The Manufacturer Part Number (MPN) of the product. For more information,
# see https://support.google.com/manufacturers/answer/6124116#mpn.
"brand": "A String", # The brand name of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#brand.
+ "material": "A String", # The material of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#material.
"productName": "A String", # The canonical name of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#productname.
- "productPageUrl": "A String", # The URL of the manufacturer's detail page of the product. For more
- # information, see
+ "featureDescription": [ # The rich format description of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#featuredesc.
+ { # A feature description of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#featuredesc.
+ "headline": "A String", # A short description of the feature.
+ "text": "A String", # A detailed description of the feature.
+ "image": { # An image. # An optional image describing the feature.
+ "status": "A String", # The status of the image.
+ # @OutputOnly
+ "imageUrl": "A String", # The URL of the image. For crawled images, this is the provided URL. For
+ # uploaded images, this is a serving URL from Google if the image has been
+ # processed successfully.
+ "type": "A String", # The type of the image, i.e., crawled or uploaded.
+ # @OutputOnly
+ },
+ },
+ ],
+ "sizeSystem": "A String", # The size system of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#sizesystem.
+ "sizeType": "A String", # The size type of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#sizetype.
+ "additionalImageLink": [ # The additional images of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#addlimage.
+ { # An image.
+ "status": "A String", # The status of the image.
+ # @OutputOnly
+ "imageUrl": "A String", # The URL of the image. For crawled images, this is the provided URL. For
+ # uploaded images, this is a serving URL from Google if the image has been
+ # processed successfully.
+ "type": "A String", # The type of the image, i.e., crawled or uploaded.
+ # @OutputOnly
+ },
+ ],
+ "count": { # The number of products in a single package. For more information, see # The count of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#count.
+ # https://support.google.com/manufacturers/answer/6124116#count.
+ "unit": "A String", # The unit in which these products are counted.
+ "value": "A String", # The numeric value of the number of products in a package.
+ },
+ "gender": "A String", # The target gender of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#gender.
+ "productPageUrl": "A String", # The URL of the detail page of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#productpage.
+ "imageLink": { # An image. # The image of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#image.
+ "status": "A String", # The status of the image.
+ # @OutputOnly
+ "imageUrl": "A String", # The URL of the image. For crawled images, this is the provided URL. For
+ # uploaded images, this is a serving URL from Google if the image has been
+ # processed successfully.
+ "type": "A String", # The type of the image, i.e., crawled or uploaded.
+ # @OutputOnly
+ },
+ "productType": [ # The category of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#producttype.
+ "A String",
+ ],
"gtin": [ # The Global Trade Item Number (GTIN) of the product. For more information,
# see https://support.google.com/manufacturers/answer/6124116#gtin.
"A String",
],
- "productType": [ # The manufacturer's category of the product. For more information, see
- # https://support.google.com/manufacturers/answer/6124116#producttype.
- "A String",
- ],
+ "ageGroup": "A String", # The target age group of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#agegroup.
},
+ "contentLanguage": "A String", # The content language of the product as a two-letter ISO 639-1 language code
+ # (for example, en).
+ # @OutputOnly
"issues": [ # A server-generated list of issues associated with the product.
# @OutputOnly
{ # Product issue.
@@ -227,8 +527,9 @@
# https://support.google.com/manufacturers/answer/6124116.
"type": "A String", # The server-generated type of the issue, for example,
# “INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc.
- "description": "A String", # Description of the issue.
"severity": "A String", # The severity of the issue.
+ "timestamp": "A String", # The timestamp when this issue appeared.
+ "description": "A String", # Description of the issue.
},
],
"productId": "A String", # The ID of the product. For more information, see
@@ -268,13 +569,6 @@
# @OutputOnly
"A String",
],
- "parent": "A String", # Parent ID in the format `accounts/{account_id}`.
- #
- # `account_id` - The ID of the Manufacturer Center account.
- # @OutputOnly
- "contentLanguage": "A String", # The content language of the product as a two-letter ISO 639-1 language code
- # (for example, en).
- # @OutputOnly
"name": "A String", # Name in the format `{target_country}:{content_language}:{product_id}`.
#
# `target_country` - The target country of the product as a CLDR territory
@@ -286,31 +580,135 @@
# `product_id` - The ID of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#id.
# @OutputOnly
+ "parent": "A String", # Parent ID in the format `accounts/{account_id}`.
+ #
+ # `account_id` - The ID of the Manufacturer Center account.
+ # @OutputOnly
"manuallyProvidedAttributes": { # Attributes of the product. For more information, see # Attributes of the product provided manually via the Manufacturer Center UI.
# @OutputOnly
# https://support.google.com/manufacturers/answer/6124116.
"productLine": "A String", # The name of the group of products related to the product. For more
# information, see
# https://support.google.com/manufacturers/answer/6124116#productline.
+ "suggestedRetailPrice": { # A price. # The suggested retail price (MSRP) of the product. For more information,
+ # see https://support.google.com/manufacturers/answer/6124116#price.
+ "currency": "A String", # The currency in which the price is denoted.
+ "amount": "A String", # The numeric value of the price.
+ },
+ "color": "A String", # The color of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#color.
+ "releaseDate": "A String", # The release date of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#release.
+ "itemGroupId": "A String", # The item group id of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#itemgroupid.
+ "videoLink": [ # The videos of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#video.
+ "A String",
+ ],
+ "flavor": "A String", # The flavor of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#flavor.
+ "scent": "A String", # The scent of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#scent.
+ "size": "A String", # The size of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#size.
+ "capacity": { # The capacity of a product. For more information, see # The capacity of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#capacity.
+ # https://support.google.com/manufacturers/answer/6124116#capacity.
+ "unit": "A String", # The unit of the capacity, i.e., MB, GB, or TB.
+ "value": "A String", # The numeric value of the capacity.
+ },
"title": "A String", # The title of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#title.
+ "pattern": "A String", # The pattern of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#pattern.
+ "disclosureDate": "A String", # The disclosure date of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#disclosure.
+ "theme": "A String", # The theme of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#theme.
+ "productDetail": [ # The details of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#productdetail.
+ { # A product detail of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#productdetail.
+ "attributeName": "A String", # The name of the attribute.
+ "attributeValue": "A String", # The value of the attribute.
+ "sectionName": "A String", # A short section name that can be reused between multiple product details.
+ },
+ ],
+ "description": "A String", # The description of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#description.
+ "format": "A String", # The format of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#format.
"mpn": "A String", # The Manufacturer Part Number (MPN) of the product. For more information,
# see https://support.google.com/manufacturers/answer/6124116#mpn.
"brand": "A String", # The brand name of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#brand.
+ "material": "A String", # The material of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#material.
"productName": "A String", # The canonical name of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#productname.
- "productPageUrl": "A String", # The URL of the manufacturer's detail page of the product. For more
- # information, see
+ "featureDescription": [ # The rich format description of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#featuredesc.
+ { # A feature description of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#featuredesc.
+ "headline": "A String", # A short description of the feature.
+ "text": "A String", # A detailed description of the feature.
+ "image": { # An image. # An optional image describing the feature.
+ "status": "A String", # The status of the image.
+ # @OutputOnly
+ "imageUrl": "A String", # The URL of the image. For crawled images, this is the provided URL. For
+ # uploaded images, this is a serving URL from Google if the image has been
+ # processed successfully.
+ "type": "A String", # The type of the image, i.e., crawled or uploaded.
+ # @OutputOnly
+ },
+ },
+ ],
+ "sizeSystem": "A String", # The size system of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#sizesystem.
+ "sizeType": "A String", # The size type of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#sizetype.
+ "additionalImageLink": [ # The additional images of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#addlimage.
+ { # An image.
+ "status": "A String", # The status of the image.
+ # @OutputOnly
+ "imageUrl": "A String", # The URL of the image. For crawled images, this is the provided URL. For
+ # uploaded images, this is a serving URL from Google if the image has been
+ # processed successfully.
+ "type": "A String", # The type of the image, i.e., crawled or uploaded.
+ # @OutputOnly
+ },
+ ],
+ "count": { # The number of products in a single package. For more information, see # The count of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#count.
+ # https://support.google.com/manufacturers/answer/6124116#count.
+ "unit": "A String", # The unit in which these products are counted.
+ "value": "A String", # The numeric value of the number of products in a package.
+ },
+ "gender": "A String", # The target gender of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#gender.
+ "productPageUrl": "A String", # The URL of the detail page of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#productpage.
+ "imageLink": { # An image. # The image of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#image.
+ "status": "A String", # The status of the image.
+ # @OutputOnly
+ "imageUrl": "A String", # The URL of the image. For crawled images, this is the provided URL. For
+ # uploaded images, this is a serving URL from Google if the image has been
+ # processed successfully.
+ "type": "A String", # The type of the image, i.e., crawled or uploaded.
+ # @OutputOnly
+ },
+ "productType": [ # The category of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#producttype.
+ "A String",
+ ],
"gtin": [ # The Global Trade Item Number (GTIN) of the product. For more information,
# see https://support.google.com/manufacturers/answer/6124116#gtin.
"A String",
],
- "productType": [ # The manufacturer's category of the product. For more information, see
- # https://support.google.com/manufacturers/answer/6124116#producttype.
- "A String",
- ],
+ "ageGroup": "A String", # The target age group of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#agegroup.
},
"finalAttributes": { # Attributes of the product. For more information, see # Final attributes of the product. The final attributes are obtained by
# overriding the uploaded attributes with the manually provided and deleted
@@ -321,25 +719,125 @@
"productLine": "A String", # The name of the group of products related to the product. For more
# information, see
# https://support.google.com/manufacturers/answer/6124116#productline.
+ "suggestedRetailPrice": { # A price. # The suggested retail price (MSRP) of the product. For more information,
+ # see https://support.google.com/manufacturers/answer/6124116#price.
+ "currency": "A String", # The currency in which the price is denoted.
+ "amount": "A String", # The numeric value of the price.
+ },
+ "color": "A String", # The color of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#color.
+ "releaseDate": "A String", # The release date of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#release.
+ "itemGroupId": "A String", # The item group id of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#itemgroupid.
+ "videoLink": [ # The videos of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#video.
+ "A String",
+ ],
+ "flavor": "A String", # The flavor of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#flavor.
+ "scent": "A String", # The scent of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#scent.
+ "size": "A String", # The size of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#size.
+ "capacity": { # The capacity of a product. For more information, see # The capacity of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#capacity.
+ # https://support.google.com/manufacturers/answer/6124116#capacity.
+ "unit": "A String", # The unit of the capacity, i.e., MB, GB, or TB.
+ "value": "A String", # The numeric value of the capacity.
+ },
"title": "A String", # The title of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#title.
+ "pattern": "A String", # The pattern of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#pattern.
+ "disclosureDate": "A String", # The disclosure date of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#disclosure.
+ "theme": "A String", # The theme of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#theme.
+ "productDetail": [ # The details of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#productdetail.
+ { # A product detail of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#productdetail.
+ "attributeName": "A String", # The name of the attribute.
+ "attributeValue": "A String", # The value of the attribute.
+ "sectionName": "A String", # A short section name that can be reused between multiple product details.
+ },
+ ],
+ "description": "A String", # The description of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#description.
+ "format": "A String", # The format of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#format.
"mpn": "A String", # The Manufacturer Part Number (MPN) of the product. For more information,
# see https://support.google.com/manufacturers/answer/6124116#mpn.
"brand": "A String", # The brand name of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#brand.
+ "material": "A String", # The material of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#material.
"productName": "A String", # The canonical name of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#productname.
- "productPageUrl": "A String", # The URL of the manufacturer's detail page of the product. For more
- # information, see
+ "featureDescription": [ # The rich format description of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#featuredesc.
+ { # A feature description of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#featuredesc.
+ "headline": "A String", # A short description of the feature.
+ "text": "A String", # A detailed description of the feature.
+ "image": { # An image. # An optional image describing the feature.
+ "status": "A String", # The status of the image.
+ # @OutputOnly
+ "imageUrl": "A String", # The URL of the image. For crawled images, this is the provided URL. For
+ # uploaded images, this is a serving URL from Google if the image has been
+ # processed successfully.
+ "type": "A String", # The type of the image, i.e., crawled or uploaded.
+ # @OutputOnly
+ },
+ },
+ ],
+ "sizeSystem": "A String", # The size system of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#sizesystem.
+ "sizeType": "A String", # The size type of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#sizetype.
+ "additionalImageLink": [ # The additional images of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#addlimage.
+ { # An image.
+ "status": "A String", # The status of the image.
+ # @OutputOnly
+ "imageUrl": "A String", # The URL of the image. For crawled images, this is the provided URL. For
+ # uploaded images, this is a serving URL from Google if the image has been
+ # processed successfully.
+ "type": "A String", # The type of the image, i.e., crawled or uploaded.
+ # @OutputOnly
+ },
+ ],
+ "count": { # The number of products in a single package. For more information, see # The count of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#count.
+ # https://support.google.com/manufacturers/answer/6124116#count.
+ "unit": "A String", # The unit in which these products are counted.
+ "value": "A String", # The numeric value of the number of products in a package.
+ },
+ "gender": "A String", # The target gender of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#gender.
+ "productPageUrl": "A String", # The URL of the detail page of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#productpage.
+ "imageLink": { # An image. # The image of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#image.
+ "status": "A String", # The status of the image.
+ # @OutputOnly
+ "imageUrl": "A String", # The URL of the image. For crawled images, this is the provided URL. For
+ # uploaded images, this is a serving URL from Google if the image has been
+ # processed successfully.
+ "type": "A String", # The type of the image, i.e., crawled or uploaded.
+ # @OutputOnly
+ },
+ "productType": [ # The category of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#producttype.
+ "A String",
+ ],
"gtin": [ # The Global Trade Item Number (GTIN) of the product. For more information,
# see https://support.google.com/manufacturers/answer/6124116#gtin.
"A String",
],
- "productType": [ # The manufacturer's category of the product. For more information, see
- # https://support.google.com/manufacturers/answer/6124116#producttype.
- "A String",
- ],
+ "ageGroup": "A String", # The target age group of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#agegroup.
},
"uploadedAttributes": { # Attributes of the product. For more information, see # Attributes of the product uploaded via the Manufacturer Center API or via
# feeds.
@@ -347,26 +845,129 @@
"productLine": "A String", # The name of the group of products related to the product. For more
# information, see
# https://support.google.com/manufacturers/answer/6124116#productline.
+ "suggestedRetailPrice": { # A price. # The suggested retail price (MSRP) of the product. For more information,
+ # see https://support.google.com/manufacturers/answer/6124116#price.
+ "currency": "A String", # The currency in which the price is denoted.
+ "amount": "A String", # The numeric value of the price.
+ },
+ "color": "A String", # The color of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#color.
+ "releaseDate": "A String", # The release date of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#release.
+ "itemGroupId": "A String", # The item group id of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#itemgroupid.
+ "videoLink": [ # The videos of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#video.
+ "A String",
+ ],
+ "flavor": "A String", # The flavor of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#flavor.
+ "scent": "A String", # The scent of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#scent.
+ "size": "A String", # The size of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#size.
+ "capacity": { # The capacity of a product. For more information, see # The capacity of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#capacity.
+ # https://support.google.com/manufacturers/answer/6124116#capacity.
+ "unit": "A String", # The unit of the capacity, i.e., MB, GB, or TB.
+ "value": "A String", # The numeric value of the capacity.
+ },
"title": "A String", # The title of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#title.
+ "pattern": "A String", # The pattern of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#pattern.
+ "disclosureDate": "A String", # The disclosure date of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#disclosure.
+ "theme": "A String", # The theme of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#theme.
+ "productDetail": [ # The details of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#productdetail.
+ { # A product detail of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#productdetail.
+ "attributeName": "A String", # The name of the attribute.
+ "attributeValue": "A String", # The value of the attribute.
+ "sectionName": "A String", # A short section name that can be reused between multiple product details.
+ },
+ ],
+ "description": "A String", # The description of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#description.
+ "format": "A String", # The format of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#format.
"mpn": "A String", # The Manufacturer Part Number (MPN) of the product. For more information,
# see https://support.google.com/manufacturers/answer/6124116#mpn.
"brand": "A String", # The brand name of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#brand.
+ "material": "A String", # The material of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#material.
"productName": "A String", # The canonical name of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#productname.
- "productPageUrl": "A String", # The URL of the manufacturer's detail page of the product. For more
- # information, see
+ "featureDescription": [ # The rich format description of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#featuredesc.
+ { # A feature description of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#featuredesc.
+ "headline": "A String", # A short description of the feature.
+ "text": "A String", # A detailed description of the feature.
+ "image": { # An image. # An optional image describing the feature.
+ "status": "A String", # The status of the image.
+ # @OutputOnly
+ "imageUrl": "A String", # The URL of the image. For crawled images, this is the provided URL. For
+ # uploaded images, this is a serving URL from Google if the image has been
+ # processed successfully.
+ "type": "A String", # The type of the image, i.e., crawled or uploaded.
+ # @OutputOnly
+ },
+ },
+ ],
+ "sizeSystem": "A String", # The size system of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#sizesystem.
+ "sizeType": "A String", # The size type of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#sizetype.
+ "additionalImageLink": [ # The additional images of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#addlimage.
+ { # An image.
+ "status": "A String", # The status of the image.
+ # @OutputOnly
+ "imageUrl": "A String", # The URL of the image. For crawled images, this is the provided URL. For
+ # uploaded images, this is a serving URL from Google if the image has been
+ # processed successfully.
+ "type": "A String", # The type of the image, i.e., crawled or uploaded.
+ # @OutputOnly
+ },
+ ],
+ "count": { # The number of products in a single package. For more information, see # The count of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#count.
+ # https://support.google.com/manufacturers/answer/6124116#count.
+ "unit": "A String", # The unit in which these products are counted.
+ "value": "A String", # The numeric value of the number of products in a package.
+ },
+ "gender": "A String", # The target gender of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#gender.
+ "productPageUrl": "A String", # The URL of the detail page of the product. For more information, see
# https://support.google.com/manufacturers/answer/6124116#productpage.
+ "imageLink": { # An image. # The image of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#image.
+ "status": "A String", # The status of the image.
+ # @OutputOnly
+ "imageUrl": "A String", # The URL of the image. For crawled images, this is the provided URL. For
+ # uploaded images, this is a serving URL from Google if the image has been
+ # processed successfully.
+ "type": "A String", # The type of the image, i.e., crawled or uploaded.
+ # @OutputOnly
+ },
+ "productType": [ # The category of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#producttype.
+ "A String",
+ ],
"gtin": [ # The Global Trade Item Number (GTIN) of the product. For more information,
# see https://support.google.com/manufacturers/answer/6124116#gtin.
"A String",
],
- "productType": [ # The manufacturer's category of the product. For more information, see
- # https://support.google.com/manufacturers/answer/6124116#producttype.
- "A String",
- ],
+ "ageGroup": "A String", # The target age group of the product. For more information, see
+ # https://support.google.com/manufacturers/answer/6124116#agegroup.
},
+ "contentLanguage": "A String", # The content language of the product as a two-letter ISO 639-1 language code
+ # (for example, en).
+ # @OutputOnly
"issues": [ # A server-generated list of issues associated with the product.
# @OutputOnly
{ # Product issue.
@@ -375,8 +976,9 @@
# https://support.google.com/manufacturers/answer/6124116.
"type": "A String", # The server-generated type of the issue, for example,
# “INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc.
- "description": "A String", # Description of the issue.
"severity": "A String", # The severity of the issue.
+ "timestamp": "A String", # The timestamp when this issue appeared.
+ "description": "A String", # Description of the issue.
},
],
"productId": "A String", # The ID of the product. For more information, see
diff --git a/docs/dyn/ml_v1.projects.jobs.html b/docs/dyn/ml_v1.projects.jobs.html
index a1f577b..89ffc72 100644
--- a/docs/dyn/ml_v1.projects.jobs.html
+++ b/docs/dyn/ml_v1.projects.jobs.html
@@ -216,7 +216,7 @@
# <dd>
# A machine equivalent to <code suppresswarning="true">standard</code> that
# also includes a
- # <a href="ml/docs/how-tos/using-gpus">
+ # <a href="/ml-engine/docs/how-tos/using-gpus">
# GPU that you can use in your trainer</a>.
# </dd>
# <dt>complex_model_m_gpu</dt>
@@ -243,9 +243,9 @@
"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.
+ "categoricalValues": [ # Required if type is `CATEGORICAL`. The list of possible categories.
+ "A String",
+ ],
"discreteValues": [ # Required if type is `DISCRETE`.
# A list of feasible points.
# The list should be in strictly increasing order. For instance, this
@@ -255,9 +255,9 @@
],
"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",
- ],
+ "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.
"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.
@@ -441,7 +441,7 @@
# <dd>
# A machine equivalent to <code suppresswarning="true">standard</code> that
# also includes a
- # <a href="ml/docs/how-tos/using-gpus">
+ # <a href="/ml-engine/docs/how-tos/using-gpus">
# GPU that you can use in your trainer</a>.
# </dd>
# <dt>complex_model_m_gpu</dt>
@@ -468,9 +468,9 @@
"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.
+ "categoricalValues": [ # Required if type is `CATEGORICAL`. The list of possible categories.
+ "A String",
+ ],
"discreteValues": [ # Required if type is `DISCRETE`.
# A list of feasible points.
# The list should be in strictly increasing order. For instance, this
@@ -480,9 +480,9 @@
],
"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",
- ],
+ "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.
"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.
@@ -675,7 +675,7 @@
# <dd>
# A machine equivalent to <code suppresswarning="true">standard</code> that
# also includes a
- # <a href="ml/docs/how-tos/using-gpus">
+ # <a href="/ml-engine/docs/how-tos/using-gpus">
# GPU that you can use in your trainer</a>.
# </dd>
# <dt>complex_model_m_gpu</dt>
@@ -702,9 +702,9 @@
"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.
+ "categoricalValues": [ # Required if type is `CATEGORICAL`. The list of possible categories.
+ "A String",
+ ],
"discreteValues": [ # Required if type is `DISCRETE`.
# A list of feasible points.
# The list should be in strictly increasing order. For instance, this
@@ -714,9 +714,9 @@
],
"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",
- ],
+ "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.
"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.
@@ -923,7 +923,7 @@
# <dd>
# A machine equivalent to <code suppresswarning="true">standard</code> that
# also includes a
- # <a href="ml/docs/how-tos/using-gpus">
+ # <a href="/ml-engine/docs/how-tos/using-gpus">
# GPU that you can use in your trainer</a>.
# </dd>
# <dt>complex_model_m_gpu</dt>
@@ -950,9 +950,9 @@
"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.
+ "categoricalValues": [ # Required if type is `CATEGORICAL`. The list of possible categories.
+ "A String",
+ ],
"discreteValues": [ # Required if type is `DISCRETE`.
# A list of feasible points.
# The list should be in strictly increasing order. For instance, this
@@ -962,9 +962,9 @@
],
"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",
- ],
+ "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.
"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.
diff --git a/docs/dyn/ml_v1.projects.models.html b/docs/dyn/ml_v1.projects.models.html
index 3db945b..1ddb867 100644
--- a/docs/dyn/ml_v1.projects.models.html
+++ b/docs/dyn/ml_v1.projects.models.html
@@ -101,7 +101,7 @@
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/v1/projects.models.versions/create).
+[projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create).
Args:
parent: string, Required. The project name.
@@ -118,19 +118,27 @@
"regions": [ # Optional. The list of regions where the model is going to be deployed.
# Currently only one region per model is supported.
# Defaults to 'us-central1' if nothing is set.
+ # Note:
+ # * No matter where a model is deployed, it can always be accessed by
+ # users from anywhere, both for online and batch prediction.
+ # * The region for a batch prediction job is set by the region field when
+ # submitting the batch prediction job and does not take its value from
+ # this field.
"A String",
],
"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/v1/projects.models.versions/setDefault).
+ # [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/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/v1/projects.models.versions/list).
- "description": "A String", # Optional. The description specified for the version when it was created.
+ # [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).
+ "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.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
"manualScaling": { # Options for manually scaling a model. # Optional. Manually select the number of nodes to use for serving the
@@ -147,11 +155,11 @@
"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
+ # [overview of model deployment](/ml-engine/docs/concepts/deployment-overview) for
# more informaiton.
#
# When passing Version to
- # [projects.models.versions.create](/ml/reference/rest/v1/projects.models.versions/create)
+ # [projects.models.versions.create](/ml-engine/reference/rest/v1/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.
@@ -160,17 +168,15 @@
# requests that do not specify a version.
#
# You can change the default version by calling
- # [projects.methods.versions.setDefault](/ml/reference/rest/v1/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.
+ # [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).
+ "description": "A String", # Optional. The description specified for the version when it was created.
},
+ "description": "A String", # Optional. The description specified for the model when it was created.
+ "onlinePredictionLogging": True or False, # Optional. If true, enables StackDriver Logging for online prediction.
+ # Default is false.
"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.
- "onlinePredictionLogging": True or False, # Optional. If true, enables StackDriver Logging for online prediction.
- # Default is false.
- "description": "A String", # Optional. The description specified for the model when it was created.
}
x__xgafv: string, V1 error format.
@@ -189,19 +195,27 @@
"regions": [ # Optional. The list of regions where the model is going to be deployed.
# Currently only one region per model is supported.
# Defaults to 'us-central1' if nothing is set.
+ # Note:
+ # * No matter where a model is deployed, it can always be accessed by
+ # users from anywhere, both for online and batch prediction.
+ # * The region for a batch prediction job is set by the region field when
+ # submitting the batch prediction job and does not take its value from
+ # this field.
"A String",
],
"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/v1/projects.models.versions/setDefault).
+ # [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/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/v1/projects.models.versions/list).
- "description": "A String", # Optional. The description specified for the version when it was created.
+ # [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).
+ "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.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
"manualScaling": { # Options for manually scaling a model. # Optional. Manually select the number of nodes to use for serving the
@@ -218,11 +232,11 @@
"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
+ # [overview of model deployment](/ml-engine/docs/concepts/deployment-overview) for
# more informaiton.
#
# When passing Version to
- # [projects.models.versions.create](/ml/reference/rest/v1/projects.models.versions/create)
+ # [projects.models.versions.create](/ml-engine/reference/rest/v1/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.
@@ -231,17 +245,15 @@
# requests that do not specify a version.
#
# You can change the default version by calling
- # [projects.methods.versions.setDefault](/ml/reference/rest/v1/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.
+ # [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).
+ "description": "A String", # Optional. The description specified for the version when it was created.
},
+ "description": "A String", # Optional. The description specified for the model when it was created.
+ "onlinePredictionLogging": True or False, # Optional. If true, enables StackDriver Logging for online prediction.
+ # Default is false.
"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.
- "onlinePredictionLogging": True or False, # Optional. If true, enables StackDriver Logging for online prediction.
- # Default is false.
- "description": "A String", # Optional. The description specified for the model when it was created.
}</pre>
</div>
@@ -251,7 +263,7 @@
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/v1/projects.models.versions/delete).
+[projects.models.versions.delete](/ml-engine/reference/rest/v1/projects.models.versions/delete).
Args:
name: string, Required. The name of the model.
@@ -273,6 +285,22 @@
# 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 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:
@@ -336,22 +364,6 @@
},
],
},
- "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`.
}</pre>
</div>
@@ -381,19 +393,27 @@
"regions": [ # Optional. The list of regions where the model is going to be deployed.
# Currently only one region per model is supported.
# Defaults to 'us-central1' if nothing is set.
+ # Note:
+ # * No matter where a model is deployed, it can always be accessed by
+ # users from anywhere, both for online and batch prediction.
+ # * The region for a batch prediction job is set by the region field when
+ # submitting the batch prediction job and does not take its value from
+ # this field.
"A String",
],
"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/v1/projects.models.versions/setDefault).
+ # [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/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/v1/projects.models.versions/list).
- "description": "A String", # Optional. The description specified for the version when it was created.
+ # [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).
+ "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.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
"manualScaling": { # Options for manually scaling a model. # Optional. Manually select the number of nodes to use for serving the
@@ -410,11 +430,11 @@
"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
+ # [overview of model deployment](/ml-engine/docs/concepts/deployment-overview) for
# more informaiton.
#
# When passing Version to
- # [projects.models.versions.create](/ml/reference/rest/v1/projects.models.versions/create)
+ # [projects.models.versions.create](/ml-engine/reference/rest/v1/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.
@@ -423,17 +443,15 @@
# requests that do not specify a version.
#
# You can change the default version by calling
- # [projects.methods.versions.setDefault](/ml/reference/rest/v1/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.
+ # [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).
+ "description": "A String", # Optional. The description specified for the version when it was created.
},
+ "description": "A String", # Optional. The description specified for the model when it was created.
+ "onlinePredictionLogging": True or False, # Optional. If true, enables StackDriver Logging for online prediction.
+ # Default is false.
"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.
- "onlinePredictionLogging": True or False, # Optional. If true, enables StackDriver Logging for online prediction.
- # Default is false.
- "description": "A String", # Optional. The description specified for the model when it was created.
}</pre>
</div>
@@ -466,8 +484,6 @@
An object of the form:
{ # Response message for the ListModels method.
- "nextPageToken": "A String", # Optional. Pass this token as the `page_token` field of the request for a
- # subsequent call.
"models": [ # The list of models.
{ # Represents a machine learning solution.
#
@@ -477,19 +493,27 @@
"regions": [ # Optional. The list of regions where the model is going to be deployed.
# Currently only one region per model is supported.
# Defaults to 'us-central1' if nothing is set.
+ # Note:
+ # * No matter where a model is deployed, it can always be accessed by
+ # users from anywhere, both for online and batch prediction.
+ # * The region for a batch prediction job is set by the region field when
+ # submitting the batch prediction job and does not take its value from
+ # this field.
"A String",
],
"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/v1/projects.models.versions/setDefault).
+ # [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/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/v1/projects.models.versions/list).
- "description": "A String", # Optional. The description specified for the version when it was created.
+ # [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).
+ "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.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
"manualScaling": { # Options for manually scaling a model. # Optional. Manually select the number of nodes to use for serving the
@@ -506,11 +530,11 @@
"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
+ # [overview of model deployment](/ml-engine/docs/concepts/deployment-overview) for
# more informaiton.
#
# When passing Version to
- # [projects.models.versions.create](/ml/reference/rest/v1/projects.models.versions/create)
+ # [projects.models.versions.create](/ml-engine/reference/rest/v1/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.
@@ -519,19 +543,19 @@
# requests that do not specify a version.
#
# You can change the default version by calling
- # [projects.methods.versions.setDefault](/ml/reference/rest/v1/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.
+ # [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).
+ "description": "A String", # Optional. The description specified for the version when it was created.
},
+ "description": "A String", # Optional. The description specified for the model when it was created.
+ "onlinePredictionLogging": True or False, # Optional. If true, enables StackDriver Logging for online prediction.
+ # Default is false.
"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.
- "onlinePredictionLogging": True or False, # Optional. If true, enables StackDriver Logging for online prediction.
- # Default is false.
- "description": "A String", # Optional. The description specified for the model when it was created.
},
],
+ "nextPageToken": "A String", # Optional. Pass this token as the `page_token` field of the request for a
+ # subsequent call.
}</pre>
</div>
diff --git a/docs/dyn/ml_v1.projects.models.versions.html b/docs/dyn/ml_v1.projects.models.versions.html
index 116096f..99553f7 100644
--- a/docs/dyn/ml_v1.projects.models.versions.html
+++ b/docs/dyn/ml_v1.projects.models.versions.html
@@ -102,7 +102,7 @@
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/v1/projects.models.versions/setDefault).
+[projects.models.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).
Args:
parent: string, Required. The name of the model.
@@ -116,8 +116,10 @@
# 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/v1/projects.models.versions/list).
- "description": "A String", # Optional. The description specified for the version when it was created.
+ # [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).
+ "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.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
"manualScaling": { # Options for manually scaling a model. # Optional. Manually select the number of nodes to use for serving the
@@ -134,11 +136,11 @@
"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
+ # [overview of model deployment](/ml-engine/docs/concepts/deployment-overview) for
# more informaiton.
#
# When passing Version to
- # [projects.models.versions.create](/ml/reference/rest/v1/projects.models.versions/create)
+ # [projects.models.versions.create](/ml-engine/reference/rest/v1/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.
@@ -147,10 +149,8 @@
# requests that do not specify a version.
#
# You can change the default version by calling
- # [projects.methods.versions.setDefault](/ml/reference/rest/v1/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.
+ # [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).
+ "description": "A String", # Optional. The description specified for the version when it was created.
}
x__xgafv: string, V1 error format.
@@ -169,6 +169,22 @@
# 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 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:
@@ -232,22 +248,6 @@
},
],
},
- "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`.
}</pre>
</div>
@@ -264,7 +264,7 @@
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/v1/projects.models.versions/list).
+[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).
Authorization: requires `Editor` role on the parent project. (required)
x__xgafv: string, V1 error format.
@@ -283,6 +283,22 @@
# 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 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:
@@ -346,22 +362,6 @@
},
],
},
- "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`.
}</pre>
</div>
@@ -370,7 +370,7 @@
<pre>Gets information about a model version.
Models can have multiple versions. You can call
-[projects.models.versions.list](/ml/reference/rest/v1/projects.models.versions/list)
+[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list)
to get the same information that this method returns for all of the
versions of a model.
@@ -391,8 +391,10 @@
# 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/v1/projects.models.versions/list).
- "description": "A String", # Optional. The description specified for the version when it was created.
+ # [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).
+ "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.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
"manualScaling": { # Options for manually scaling a model. # Optional. Manually select the number of nodes to use for serving the
@@ -409,11 +411,11 @@
"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
+ # [overview of model deployment](/ml-engine/docs/concepts/deployment-overview) for
# more informaiton.
#
# When passing Version to
- # [projects.models.versions.create](/ml/reference/rest/v1/projects.models.versions/create)
+ # [projects.models.versions.create](/ml-engine/reference/rest/v1/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.
@@ -422,10 +424,8 @@
# requests that do not specify a version.
#
# You can change the default version by calling
- # [projects.methods.versions.setDefault](/ml/reference/rest/v1/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.
+ # [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).
+ "description": "A String", # Optional. The description specified for the version when it was created.
}</pre>
</div>
@@ -467,8 +467,10 @@
# 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/v1/projects.models.versions/list).
- "description": "A String", # Optional. The description specified for the version when it was created.
+ # [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).
+ "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.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
"manualScaling": { # Options for manually scaling a model. # Optional. Manually select the number of nodes to use for serving the
@@ -485,11 +487,11 @@
"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
+ # [overview of model deployment](/ml-engine/docs/concepts/deployment-overview) for
# more informaiton.
#
# When passing Version to
- # [projects.models.versions.create](/ml/reference/rest/v1/projects.models.versions/create)
+ # [projects.models.versions.create](/ml-engine/reference/rest/v1/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.
@@ -498,10 +500,8 @@
# requests that do not specify a version.
#
# You can change the default version by calling
- # [projects.methods.versions.setDefault](/ml/reference/rest/v1/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.
+ # [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).
+ "description": "A String", # Optional. The description specified for the version when it was created.
},
],
}</pre>
@@ -535,7 +535,7 @@
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/v1/projects.models.versions/list).
+[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).
Authorization: requires `Editor` role on the parent project. (required)
body: object, The request body. (required)
@@ -557,8 +557,10 @@
# 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/v1/projects.models.versions/list).
- "description": "A String", # Optional. The description specified for the version when it was created.
+ # [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).
+ "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.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
"manualScaling": { # Options for manually scaling a model. # Optional. Manually select the number of nodes to use for serving the
@@ -575,11 +577,11 @@
"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
+ # [overview of model deployment](/ml-engine/docs/concepts/deployment-overview) for
# more informaiton.
#
# When passing Version to
- # [projects.models.versions.create](/ml/reference/rest/v1/projects.models.versions/create)
+ # [projects.models.versions.create](/ml-engine/reference/rest/v1/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.
@@ -588,10 +590,8 @@
# requests that do not specify a version.
#
# You can change the default version by calling
- # [projects.methods.versions.setDefault](/ml/reference/rest/v1/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.
+ # [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).
+ "description": "A String", # Optional. The description specified for the version when it was created.
}</pre>
</div>
diff --git a/docs/dyn/ml_v1.projects.operations.html b/docs/dyn/ml_v1.projects.operations.html
index 14d735f..3d1bd3c 100644
--- a/docs/dyn/ml_v1.projects.operations.html
+++ b/docs/dyn/ml_v1.projects.operations.html
@@ -178,6 +178,22 @@
# 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 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:
@@ -241,22 +257,6 @@
},
],
},
- "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`.
}</pre>
</div>
@@ -282,7 +282,6 @@
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.
@@ -292,6 +291,22 @@
# 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 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:
@@ -355,24 +370,9 @@
},
],
},
- "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`.
},
],
+ "nextPageToken": "A String", # The standard List next-page token.
}</pre>
</div>
diff --git a/docs/dyn/ml_v1beta1.projects.jobs.html b/docs/dyn/ml_v1beta1.projects.jobs.html
index 57245ca..0399c35 100644
--- a/docs/dyn/ml_v1beta1.projects.jobs.html
+++ b/docs/dyn/ml_v1beta1.projects.jobs.html
@@ -137,9 +137,6 @@
{ # Represents a training or prediction job.
"trainingOutput": { # Represents results of a training job. Output only. # The current training job result.
- "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
- # Only set for hyperparameter tuning jobs.
- "isHyperparameterTuningJob": True or False, # Whether this job is a hyperparameter tuning job.
"trials": [ # Results for individual Hyperparameter trials.
# Only set for hyperparameter tuning jobs.
{ # Represents the result of a single hyperparameter tuning trial from a
@@ -162,39 +159,11 @@
},
},
],
+ "isHyperparameterTuningJob": True or False, # Whether this job is a hyperparameter tuning job.
"consumedMLUnits": 3.14, # The amount of ML units consumed by the job.
+ "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
+ # Only set for hyperparameter tuning jobs.
},
- "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:
- #
- # `"projects/<var>[YOUR_PROJECT]</var>/models/<var>[YOUR_MODEL]</var>"`
- "runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this batch
- # prediction. If not set, Google Cloud ML will pick the runtime version used
- # during the CreateVersion request for this model version, or choose the
- # latest stable version when model version information is not available
- # such as when the model is specified by uri.
- "inputPaths": [ # Required. The Google Cloud Storage location of the input data files.
- # May contain wildcards.
- "A String",
- ],
- "maxWorkerCount": "A String", # Optional. The maximum number of workers to be used for parallel processing.
- # Defaults to 10 if not specified.
- "uri": "A String", # Use this field if you want to specify a Google Cloud Storage path for
- # the model to use.
- "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:
- #
- # `"projects/<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.
- },
- "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.
- "startTime": "A String", # Output only. When the job processing was started.
"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.
@@ -245,7 +214,7 @@
# <dd>
# A machine equivalent to <code suppresswarning="true">standard</code> that
# also includes a
- # <a href="ml/docs/how-tos/using-gpus">
+ # <a href="/ml-engine/docs/how-tos/using-gpus">
# GPU that you can use in your trainer</a>.
# </dd>
# <dt>complex_model_m_gpu</dt>
@@ -272,9 +241,9 @@
"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`.
- "categoricalValues": [ # Required if type is `CATEGORICAL`. The list of possible categories.
- "A String",
- ],
+ "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
@@ -284,9 +253,9 @@
],
"parameterName": "A String", # Required. The parameter name must be unique amongst all ParameterConfigs in
# a HyperparameterSpec message. E.g., "learning_rate".
- "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.
+ "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.
@@ -294,10 +263,6 @@
# parameters (e.g., `UNIT_LINEAR_SCALE`).
},
],
- "goal": "A String", # Required. The type of goal to use for tuning. Available types are
- # `MAXIMIZE` and `MINIMIZE`.
- #
- # Defaults to `MAXIMIZE`.
"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
@@ -308,6 +273,10 @@
# 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.
@@ -342,6 +311,37 @@
# 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`.
},
+ "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:
+ #
+ # `"projects/<var>[YOUR_PROJECT]</var>/models/<var>[YOUR_MODEL]</var>"`
+ "runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this batch
+ # prediction. If not set, Google Cloud ML will pick the runtime version used
+ # during the CreateVersion request for this model version, or choose the
+ # latest stable version when model version information is not available
+ # such as when the model is specified by uri.
+ "inputPaths": [ # Required. The Google Cloud Storage location of the input data files.
+ # May contain wildcards.
+ "A String",
+ ],
+ "maxWorkerCount": "A String", # Optional. The maximum number of workers to be used for parallel processing.
+ # Defaults to 10 if not specified.
+ "uri": "A String", # Use this field if you want to specify a Google Cloud Storage path for
+ # the model to use.
+ "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:
+ #
+ # `"projects/<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.
+ },
+ "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.
+ "startTime": "A String", # Output only. When the job processing was started.
"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.
@@ -362,9 +362,6 @@
{ # Represents a training or prediction job.
"trainingOutput": { # Represents results of a training job. Output only. # The current training job result.
- "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
- # Only set for hyperparameter tuning jobs.
- "isHyperparameterTuningJob": True or False, # Whether this job is a hyperparameter tuning job.
"trials": [ # Results for individual Hyperparameter trials.
# Only set for hyperparameter tuning jobs.
{ # Represents the result of a single hyperparameter tuning trial from a
@@ -387,39 +384,11 @@
},
},
],
+ "isHyperparameterTuningJob": True or False, # Whether this job is a hyperparameter tuning job.
"consumedMLUnits": 3.14, # The amount of ML units consumed by the job.
+ "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
+ # Only set for hyperparameter tuning jobs.
},
- "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:
- #
- # `"projects/<var>[YOUR_PROJECT]</var>/models/<var>[YOUR_MODEL]</var>"`
- "runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this batch
- # prediction. If not set, Google Cloud ML will pick the runtime version used
- # during the CreateVersion request for this model version, or choose the
- # latest stable version when model version information is not available
- # such as when the model is specified by uri.
- "inputPaths": [ # Required. The Google Cloud Storage location of the input data files.
- # May contain wildcards.
- "A String",
- ],
- "maxWorkerCount": "A String", # Optional. The maximum number of workers to be used for parallel processing.
- # Defaults to 10 if not specified.
- "uri": "A String", # Use this field if you want to specify a Google Cloud Storage path for
- # the model to use.
- "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:
- #
- # `"projects/<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.
- },
- "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.
- "startTime": "A String", # Output only. When the job processing was started.
"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.
@@ -470,7 +439,7 @@
# <dd>
# A machine equivalent to <code suppresswarning="true">standard</code> that
# also includes a
- # <a href="ml/docs/how-tos/using-gpus">
+ # <a href="/ml-engine/docs/how-tos/using-gpus">
# GPU that you can use in your trainer</a>.
# </dd>
# <dt>complex_model_m_gpu</dt>
@@ -497,9 +466,9 @@
"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`.
- "categoricalValues": [ # Required if type is `CATEGORICAL`. The list of possible categories.
- "A String",
- ],
+ "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
@@ -509,9 +478,9 @@
],
"parameterName": "A String", # Required. The parameter name must be unique amongst all ParameterConfigs in
# a HyperparameterSpec message. E.g., "learning_rate".
- "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.
+ "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.
@@ -519,10 +488,6 @@
# parameters (e.g., `UNIT_LINEAR_SCALE`).
},
],
- "goal": "A String", # Required. The type of goal to use for tuning. Available types are
- # `MAXIMIZE` and `MINIMIZE`.
- #
- # Defaults to `MAXIMIZE`.
"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
@@ -533,6 +498,10 @@
# 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.
@@ -567,6 +536,37 @@
# 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`.
},
+ "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:
+ #
+ # `"projects/<var>[YOUR_PROJECT]</var>/models/<var>[YOUR_MODEL]</var>"`
+ "runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this batch
+ # prediction. If not set, Google Cloud ML will pick the runtime version used
+ # during the CreateVersion request for this model version, or choose the
+ # latest stable version when model version information is not available
+ # such as when the model is specified by uri.
+ "inputPaths": [ # Required. The Google Cloud Storage location of the input data files.
+ # May contain wildcards.
+ "A String",
+ ],
+ "maxWorkerCount": "A String", # Optional. The maximum number of workers to be used for parallel processing.
+ # Defaults to 10 if not specified.
+ "uri": "A String", # Use this field if you want to specify a Google Cloud Storage path for
+ # the model to use.
+ "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:
+ #
+ # `"projects/<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.
+ },
+ "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.
+ "startTime": "A String", # Output only. When the job processing was started.
"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.
@@ -596,9 +596,6 @@
{ # Represents a training or prediction job.
"trainingOutput": { # Represents results of a training job. Output only. # The current training job result.
- "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
- # Only set for hyperparameter tuning jobs.
- "isHyperparameterTuningJob": True or False, # Whether this job is a hyperparameter tuning job.
"trials": [ # Results for individual Hyperparameter trials.
# Only set for hyperparameter tuning jobs.
{ # Represents the result of a single hyperparameter tuning trial from a
@@ -621,39 +618,11 @@
},
},
],
+ "isHyperparameterTuningJob": True or False, # Whether this job is a hyperparameter tuning job.
"consumedMLUnits": 3.14, # The amount of ML units consumed by the job.
+ "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
+ # Only set for hyperparameter tuning jobs.
},
- "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:
- #
- # `"projects/<var>[YOUR_PROJECT]</var>/models/<var>[YOUR_MODEL]</var>"`
- "runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this batch
- # prediction. If not set, Google Cloud ML will pick the runtime version used
- # during the CreateVersion request for this model version, or choose the
- # latest stable version when model version information is not available
- # such as when the model is specified by uri.
- "inputPaths": [ # Required. The Google Cloud Storage location of the input data files.
- # May contain wildcards.
- "A String",
- ],
- "maxWorkerCount": "A String", # Optional. The maximum number of workers to be used for parallel processing.
- # Defaults to 10 if not specified.
- "uri": "A String", # Use this field if you want to specify a Google Cloud Storage path for
- # the model to use.
- "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:
- #
- # `"projects/<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.
- },
- "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.
- "startTime": "A String", # Output only. When the job processing was started.
"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.
@@ -704,7 +673,7 @@
# <dd>
# A machine equivalent to <code suppresswarning="true">standard</code> that
# also includes a
- # <a href="ml/docs/how-tos/using-gpus">
+ # <a href="/ml-engine/docs/how-tos/using-gpus">
# GPU that you can use in your trainer</a>.
# </dd>
# <dt>complex_model_m_gpu</dt>
@@ -731,9 +700,9 @@
"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`.
- "categoricalValues": [ # Required if type is `CATEGORICAL`. The list of possible categories.
- "A String",
- ],
+ "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
@@ -743,9 +712,9 @@
],
"parameterName": "A String", # Required. The parameter name must be unique amongst all ParameterConfigs in
# a HyperparameterSpec message. E.g., "learning_rate".
- "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.
+ "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.
@@ -753,10 +722,6 @@
# parameters (e.g., `UNIT_LINEAR_SCALE`).
},
],
- "goal": "A String", # Required. The type of goal to use for tuning. Available types are
- # `MAXIMIZE` and `MINIMIZE`.
- #
- # Defaults to `MAXIMIZE`.
"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
@@ -767,6 +732,10 @@
# 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.
@@ -801,6 +770,37 @@
# 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`.
},
+ "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:
+ #
+ # `"projects/<var>[YOUR_PROJECT]</var>/models/<var>[YOUR_MODEL]</var>"`
+ "runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this batch
+ # prediction. If not set, Google Cloud ML will pick the runtime version used
+ # during the CreateVersion request for this model version, or choose the
+ # latest stable version when model version information is not available
+ # such as when the model is specified by uri.
+ "inputPaths": [ # Required. The Google Cloud Storage location of the input data files.
+ # May contain wildcards.
+ "A String",
+ ],
+ "maxWorkerCount": "A String", # Optional. The maximum number of workers to be used for parallel processing.
+ # Defaults to 10 if not specified.
+ "uri": "A String", # Use this field if you want to specify a Google Cloud Storage path for
+ # the model to use.
+ "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:
+ #
+ # `"projects/<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.
+ },
+ "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.
+ "startTime": "A String", # Output only. When the job processing was started.
"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.
@@ -844,9 +844,6 @@
"jobs": [ # The list of jobs.
{ # Represents a training or prediction job.
"trainingOutput": { # Represents results of a training job. Output only. # The current training job result.
- "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
- # Only set for hyperparameter tuning jobs.
- "isHyperparameterTuningJob": True or False, # Whether this job is a hyperparameter tuning job.
"trials": [ # Results for individual Hyperparameter trials.
# Only set for hyperparameter tuning jobs.
{ # Represents the result of a single hyperparameter tuning trial from a
@@ -869,39 +866,11 @@
},
},
],
+ "isHyperparameterTuningJob": True or False, # Whether this job is a hyperparameter tuning job.
"consumedMLUnits": 3.14, # The amount of ML units consumed by the job.
+ "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
+ # Only set for hyperparameter tuning jobs.
},
- "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:
- #
- # `"projects/<var>[YOUR_PROJECT]</var>/models/<var>[YOUR_MODEL]</var>"`
- "runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this batch
- # prediction. If not set, Google Cloud ML will pick the runtime version used
- # during the CreateVersion request for this model version, or choose the
- # latest stable version when model version information is not available
- # such as when the model is specified by uri.
- "inputPaths": [ # Required. The Google Cloud Storage location of the input data files.
- # May contain wildcards.
- "A String",
- ],
- "maxWorkerCount": "A String", # Optional. The maximum number of workers to be used for parallel processing.
- # Defaults to 10 if not specified.
- "uri": "A String", # Use this field if you want to specify a Google Cloud Storage path for
- # the model to use.
- "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:
- #
- # `"projects/<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.
- },
- "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.
- "startTime": "A String", # Output only. When the job processing was started.
"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.
@@ -952,7 +921,7 @@
# <dd>
# A machine equivalent to <code suppresswarning="true">standard</code> that
# also includes a
- # <a href="ml/docs/how-tos/using-gpus">
+ # <a href="/ml-engine/docs/how-tos/using-gpus">
# GPU that you can use in your trainer</a>.
# </dd>
# <dt>complex_model_m_gpu</dt>
@@ -979,9 +948,9 @@
"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`.
- "categoricalValues": [ # Required if type is `CATEGORICAL`. The list of possible categories.
- "A String",
- ],
+ "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
@@ -991,9 +960,9 @@
],
"parameterName": "A String", # Required. The parameter name must be unique amongst all ParameterConfigs in
# a HyperparameterSpec message. E.g., "learning_rate".
- "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.
+ "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.
@@ -1001,10 +970,6 @@
# parameters (e.g., `UNIT_LINEAR_SCALE`).
},
],
- "goal": "A String", # Required. The type of goal to use for tuning. Available types are
- # `MAXIMIZE` and `MINIMIZE`.
- #
- # Defaults to `MAXIMIZE`.
"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
@@ -1015,6 +980,10 @@
# 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.
@@ -1049,6 +1018,37 @@
# 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`.
},
+ "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:
+ #
+ # `"projects/<var>[YOUR_PROJECT]</var>/models/<var>[YOUR_MODEL]</var>"`
+ "runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this batch
+ # prediction. If not set, Google Cloud ML will pick the runtime version used
+ # during the CreateVersion request for this model version, or choose the
+ # latest stable version when model version information is not available
+ # such as when the model is specified by uri.
+ "inputPaths": [ # Required. The Google Cloud Storage location of the input data files.
+ # May contain wildcards.
+ "A String",
+ ],
+ "maxWorkerCount": "A String", # Optional. The maximum number of workers to be used for parallel processing.
+ # Defaults to 10 if not specified.
+ "uri": "A String", # Use this field if you want to specify a Google Cloud Storage path for
+ # the model to use.
+ "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:
+ #
+ # `"projects/<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.
+ },
+ "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.
+ "startTime": "A String", # Output only. When the job processing was started.
"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.
diff --git a/docs/dyn/ml_v1beta1.projects.models.html b/docs/dyn/ml_v1beta1.projects.models.html
index 1ead461..9483d3e 100644
--- a/docs/dyn/ml_v1beta1.projects.models.html
+++ b/docs/dyn/ml_v1beta1.projects.models.html
@@ -89,7 +89,7 @@
<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>
+ <code><a href="#list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=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>
@@ -101,7 +101,7 @@
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).
+[projects.models.versions.create](/ml-engine/reference/rest/v1beta1/projects.models.versions/create).
Args:
parent: string, Required. The project name.
@@ -118,18 +118,24 @@
"regions": [ # Optional. The list of regions where the model is going to be deployed.
# Currently only one region per model is supported.
# Defaults to 'us-central1' if nothing is set.
+ # Note:
+ # * No matter where a model is deployed, it can always be accessed by
+ # users from anywhere, both for online and batch prediction.
+ # * The region for a batch prediction job is set by the region field when
+ # submitting the batch prediction job and does not take its value from
+ # this field.
"A String",
],
"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).
+ # [projects.methods.versions.setDefault](/ml-engine/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).
+ # [projects.models.versions.list](/ml-engine/reference/rest/v1beta1/projects.models.versions/list).
"description": "A String", # Optional. The description specified for the version when it was created.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
@@ -147,11 +153,11 @@
"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
+ # [overview of model deployment](/ml-engine/docs/concepts/deployment-overview) for
# more informaiton.
#
# When passing Version to
- # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
+ # [projects.models.versions.create](/ml-engine/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.
@@ -160,7 +166,7 @@
# 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).
+ # [projects.methods.versions.setDefault](/ml-engine/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.
@@ -189,18 +195,24 @@
"regions": [ # Optional. The list of regions where the model is going to be deployed.
# Currently only one region per model is supported.
# Defaults to 'us-central1' if nothing is set.
+ # Note:
+ # * No matter where a model is deployed, it can always be accessed by
+ # users from anywhere, both for online and batch prediction.
+ # * The region for a batch prediction job is set by the region field when
+ # submitting the batch prediction job and does not take its value from
+ # this field.
"A String",
],
"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).
+ # [projects.methods.versions.setDefault](/ml-engine/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).
+ # [projects.models.versions.list](/ml-engine/reference/rest/v1beta1/projects.models.versions/list).
"description": "A String", # Optional. The description specified for the version when it was created.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
@@ -218,11 +230,11 @@
"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
+ # [overview of model deployment](/ml-engine/docs/concepts/deployment-overview) for
# more informaiton.
#
# When passing Version to
- # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
+ # [projects.models.versions.create](/ml-engine/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.
@@ -231,7 +243,7 @@
# 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).
+ # [projects.methods.versions.setDefault](/ml-engine/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.
@@ -251,7 +263,7 @@
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).
+[projects.models.versions.delete](/ml-engine/reference/rest/v1beta1/projects.models.versions/delete).
Args:
name: string, Required. The name of the model.
@@ -267,12 +279,6 @@
{ # 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.
- },
"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:
@@ -352,6 +358,12 @@
"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>
@@ -381,18 +393,24 @@
"regions": [ # Optional. The list of regions where the model is going to be deployed.
# Currently only one region per model is supported.
# Defaults to 'us-central1' if nothing is set.
+ # Note:
+ # * No matter where a model is deployed, it can always be accessed by
+ # users from anywhere, both for online and batch prediction.
+ # * The region for a batch prediction job is set by the region field when
+ # submitting the batch prediction job and does not take its value from
+ # this field.
"A String",
],
"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).
+ # [projects.methods.versions.setDefault](/ml-engine/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).
+ # [projects.models.versions.list](/ml-engine/reference/rest/v1beta1/projects.models.versions/list).
"description": "A String", # Optional. The description specified for the version when it was created.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
@@ -410,11 +428,11 @@
"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
+ # [overview of model deployment](/ml-engine/docs/concepts/deployment-overview) for
# more informaiton.
#
# When passing Version to
- # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
+ # [projects.models.versions.create](/ml-engine/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.
@@ -423,7 +441,7 @@
# 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).
+ # [projects.methods.versions.setDefault](/ml-engine/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.
@@ -438,7 +456,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the models in a project.
Each project can contain multiple models, and each model can have multiple
@@ -448,6 +466,11 @@
parent: string, Required. The name of the project whose models are to be listed.
Authorization: requires `Viewer` role on the specified project. (required)
+ 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.
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
@@ -456,18 +479,11 @@
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.
- "nextPageToken": "A String", # Optional. Pass this token as the `page_token` field of the request for a
- # subsequent call.
"models": [ # The list of models.
{ # Represents a machine learning solution.
#
@@ -477,18 +493,24 @@
"regions": [ # Optional. The list of regions where the model is going to be deployed.
# Currently only one region per model is supported.
# Defaults to 'us-central1' if nothing is set.
+ # Note:
+ # * No matter where a model is deployed, it can always be accessed by
+ # users from anywhere, both for online and batch prediction.
+ # * The region for a batch prediction job is set by the region field when
+ # submitting the batch prediction job and does not take its value from
+ # this field.
"A String",
],
"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).
+ # [projects.methods.versions.setDefault](/ml-engine/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).
+ # [projects.models.versions.list](/ml-engine/reference/rest/v1beta1/projects.models.versions/list).
"description": "A String", # Optional. The description specified for the version when it was created.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
@@ -506,11 +528,11 @@
"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
+ # [overview of model deployment](/ml-engine/docs/concepts/deployment-overview) for
# more informaiton.
#
# When passing Version to
- # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
+ # [projects.models.versions.create](/ml-engine/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.
@@ -519,7 +541,7 @@
# 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).
+ # [projects.methods.versions.setDefault](/ml-engine/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.
@@ -532,6 +554,8 @@
"description": "A String", # Optional. The description specified for the model when it was created.
},
],
+ "nextPageToken": "A String", # Optional. Pass this token as the `page_token` field of the request for a
+ # subsequent call.
}</pre>
</div>
diff --git a/docs/dyn/ml_v1beta1.projects.models.versions.html b/docs/dyn/ml_v1beta1.projects.models.versions.html
index e201ee0..340d4e9 100644
--- a/docs/dyn/ml_v1beta1.projects.models.versions.html
+++ b/docs/dyn/ml_v1beta1.projects.models.versions.html
@@ -102,7 +102,7 @@
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).
+[projects.models.versions.setDefault](/ml-engine/reference/rest/v1beta1/projects.models.versions/setDefault).
Args:
parent: string, Required. The name of the model.
@@ -116,7 +116,7 @@
# 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).
+ # [projects.models.versions.list](/ml-engine/reference/rest/v1beta1/projects.models.versions/list).
"description": "A String", # Optional. The description specified for the version when it was created.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
@@ -134,11 +134,11 @@
"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
+ # [overview of model deployment](/ml-engine/docs/concepts/deployment-overview) for
# more informaiton.
#
# When passing Version to
- # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
+ # [projects.models.versions.create](/ml-engine/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.
@@ -147,7 +147,7 @@
# 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).
+ # [projects.methods.versions.setDefault](/ml-engine/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.
@@ -163,12 +163,6 @@
{ # 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.
- },
"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:
@@ -248,6 +242,12 @@
"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>
@@ -264,7 +264,7 @@
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).
+[projects.models.versions.list](/ml-engine/reference/rest/v1beta1/projects.models.versions/list).
Authorization: requires `Editor` role on the parent project. (required)
x__xgafv: string, V1 error format.
@@ -277,12 +277,6 @@
{ # 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.
- },
"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:
@@ -362,6 +356,12 @@
"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>
@@ -370,7 +370,7 @@
<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)
+[projects.models.versions.list](/ml-engine/reference/rest/v1beta1/projects.models.versions/list)
to get the same information that this method returns for all of the
versions of a model.
@@ -391,7 +391,7 @@
# 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).
+ # [projects.models.versions.list](/ml-engine/reference/rest/v1beta1/projects.models.versions/list).
"description": "A String", # Optional. The description specified for the version when it was created.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
@@ -409,11 +409,11 @@
"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
+ # [overview of model deployment](/ml-engine/docs/concepts/deployment-overview) for
# more informaiton.
#
# When passing Version to
- # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
+ # [projects.models.versions.create](/ml-engine/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.
@@ -422,7 +422,7 @@
# 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).
+ # [projects.methods.versions.setDefault](/ml-engine/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.
@@ -467,7 +467,7 @@
# 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).
+ # [projects.models.versions.list](/ml-engine/reference/rest/v1beta1/projects.models.versions/list).
"description": "A String", # Optional. The description specified for the version when it was created.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
@@ -485,11 +485,11 @@
"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
+ # [overview of model deployment](/ml-engine/docs/concepts/deployment-overview) for
# more informaiton.
#
# When passing Version to
- # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
+ # [projects.models.versions.create](/ml-engine/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.
@@ -498,7 +498,7 @@
# 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).
+ # [projects.methods.versions.setDefault](/ml-engine/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.
@@ -535,7 +535,7 @@
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).
+[projects.models.versions.list](/ml-engine/reference/rest/v1beta1/projects.models.versions/list).
Authorization: requires `Editor` role on the parent project. (required)
body: object, The request body. (required)
@@ -557,7 +557,7 @@
# 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).
+ # [projects.models.versions.list](/ml-engine/reference/rest/v1beta1/projects.models.versions/list).
"description": "A String", # Optional. The description specified for the version when it was created.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
@@ -575,11 +575,11 @@
"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
+ # [overview of model deployment](/ml-engine/docs/concepts/deployment-overview) for
# more informaiton.
#
# When passing Version to
- # [projects.models.versions.create](/ml/reference/rest/v1beta1/projects.models.versions/create)
+ # [projects.models.versions.create](/ml-engine/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.
@@ -588,7 +588,7 @@
# 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).
+ # [projects.methods.versions.setDefault](/ml-engine/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.
diff --git a/docs/dyn/ml_v1beta1.projects.operations.html b/docs/dyn/ml_v1beta1.projects.operations.html
index 0639f0d..3d80014 100644
--- a/docs/dyn/ml_v1beta1.projects.operations.html
+++ b/docs/dyn/ml_v1beta1.projects.operations.html
@@ -172,12 +172,6 @@
{ # 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.
- },
"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:
@@ -257,6 +251,12 @@
"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>
@@ -282,16 +282,9 @@
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.
- },
"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:
@@ -371,8 +364,15 @@
"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.
+ },
},
],
+ "nextPageToken": "A String", # The standard List next-page token.
}</pre>
</div>
diff --git a/docs/dyn/monitoring_v3.projects.collectdTimeSeries.html b/docs/dyn/monitoring_v3.projects.collectdTimeSeries.html
index 91d1335..809836f 100644
--- a/docs/dyn/monitoring_v3.projects.collectdTimeSeries.html
+++ b/docs/dyn/monitoring_v3.projects.collectdTimeSeries.html
@@ -97,23 +97,23 @@
"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".
"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.
- "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.
+ "distributionValue": { # Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of 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 formulas for buckets of fixed or exponentially increasing widths.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. This value must equal the sum of the values in bucket_counts if a histogram is provided.
+ "bucketCounts": [ # Required in the Stackdriver Monitoring API v3. The values for each bucket specified in bucket_options. The sum of the values in bucketCounts must equal the value in the count field of the Distribution object. The order of the bucket counts follows the numbering schemes described for the three bucket types. The underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; and the overflow bucket has number N-1. The size of bucket_counts must not be greater than N. If the size is less than N, then the remaining buckets are assigned values of zero.
"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_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.
+ "bucketOptions": { # BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be 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. # Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries.
+ "exponentialBuckets": { # Specifies an exponential 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.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries: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": { # Specifies a linear 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.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries: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): 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.
+ "explicitBuckets": { # Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then 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,
],
@@ -141,23 +141,23 @@
"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.
- "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.
+ "distributionValue": { # Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of 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 formulas for buckets of fixed or exponentially increasing widths.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. This value must equal the sum of the values in bucket_counts if a histogram is provided.
+ "bucketCounts": [ # Required in the Stackdriver Monitoring API v3. The values for each bucket specified in bucket_options. The sum of the values in bucketCounts must equal the value in the count field of the Distribution object. The order of the bucket counts follows the numbering schemes described for the three bucket types. The underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; and the overflow bucket has number N-1. The size of bucket_counts must not be greater than N. If the size is less than N, then the remaining buckets are assigned values of zero.
"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_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.
+ "bucketOptions": { # BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be 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. # Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries.
+ "exponentialBuckets": { # Specifies an exponential 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.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries: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": { # Specifies a linear 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.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries: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): 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.
+ "explicitBuckets": { # Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then 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,
],
diff --git a/docs/dyn/monitoring_v3.projects.metricDescriptors.html b/docs/dyn/monitoring_v3.projects.metricDescriptors.html
index 5575b54..e65f317 100644
--- a/docs/dyn/monitoring_v3.projects.metricDescriptors.html
+++ b/docs/dyn/monitoring_v3.projects.metricDescriptors.html
@@ -101,7 +101,8 @@
{ # Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
"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".
- "description": "A String", # A detailed description of the metric, which can be used in documentation.
+ "name": "A String", # The resource name of the metric descriptor. Depending on the implementation, the name typically includes: (1) the parent resource name that defines the scope of the metric type or of its data; and (2) the metric's URL-encoded type, which also appears in the type field of this descriptor. For example, following is the resource name of a custom metric within the GCP project my-project-id:
+ # "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount"
"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 appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
@@ -154,8 +155,7 @@
# 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", # The resource name of the metric descriptor. Depending on the implementation, the name typically includes: (1) the parent resource name that defines the scope of the metric type or of its data; and (2) the metric's URL-encoded type, which also appears in the type field of this descriptor. For example, following is the resource name of a custom metric within the GCP project my-project-id:
- # "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount"
+ "description": "A String", # A detailed description of the metric, which can be used in documentation.
}
x__xgafv: string, V1 error format.
@@ -168,7 +168,8 @@
{ # Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
"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".
- "description": "A String", # A detailed description of the metric, which can be used in documentation.
+ "name": "A String", # The resource name of the metric descriptor. Depending on the implementation, the name typically includes: (1) the parent resource name that defines the scope of the metric type or of its data; and (2) the metric's URL-encoded type, which also appears in the type field of this descriptor. For example, following is the resource name of a custom metric within the GCP project my-project-id:
+ # "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount"
"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 appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
@@ -221,8 +222,7 @@
# 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", # The resource name of the metric descriptor. Depending on the implementation, the name typically includes: (1) the parent resource name that defines the scope of the metric type or of its data; and (2) the metric's URL-encoded type, which also appears in the type field of this descriptor. For example, following is the resource name of a custom metric within the GCP project my-project-id:
- # "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount"
+ "description": "A String", # A detailed description of the metric, which can be used in documentation.
}</pre>
</div>
@@ -264,7 +264,8 @@
{ # Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
"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".
- "description": "A String", # A detailed description of the metric, which can be used in documentation.
+ "name": "A String", # The resource name of the metric descriptor. Depending on the implementation, the name typically includes: (1) the parent resource name that defines the scope of the metric type or of its data; and (2) the metric's URL-encoded type, which also appears in the type field of this descriptor. For example, following is the resource name of a custom metric within the GCP project my-project-id:
+ # "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount"
"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 appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
@@ -317,8 +318,7 @@
# 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", # The resource name of the metric descriptor. Depending on the implementation, the name typically includes: (1) the parent resource name that defines the scope of the metric type or of its data; and (2) the metric's URL-encoded type, which also appears in the type field of this descriptor. For example, following is the resource name of a custom metric within the GCP project my-project-id:
- # "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount"
+ "description": "A String", # A detailed description of the metric, which can be used in documentation.
}</pre>
</div>
@@ -346,7 +346,8 @@
"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. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
"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".
- "description": "A String", # A detailed description of the metric, which can be used in documentation.
+ "name": "A String", # The resource name of the metric descriptor. Depending on the implementation, the name typically includes: (1) the parent resource name that defines the scope of the metric type or of its data; and (2) the metric's URL-encoded type, which also appears in the type field of this descriptor. For example, following is the resource name of a custom metric within the GCP project my-project-id:
+ # "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount"
"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 appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
@@ -399,8 +400,7 @@
# 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", # The resource name of the metric descriptor. Depending on the implementation, the name typically includes: (1) the parent resource name that defines the scope of the metric type or of its data; and (2) the metric's URL-encoded type, which also appears in the type field of this descriptor. For example, following is the resource name of a custom metric within the GCP project my-project-id:
- # "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount"
+ "description": "A String", # A detailed description of the metric, which can be used in documentation.
},
],
}</pre>
diff --git a/docs/dyn/monitoring_v3.projects.timeSeries.html b/docs/dyn/monitoring_v3.projects.timeSeries.html
index 8712d02..6d702c1 100644
--- a/docs/dyn/monitoring_v3.projects.timeSeries.html
+++ b/docs/dyn/monitoring_v3.projects.timeSeries.html
@@ -110,23 +110,23 @@
"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.
- "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.
+ "distributionValue": { # Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of 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 formulas for buckets of fixed or exponentially increasing widths.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. This value must equal the sum of the values in bucket_counts if a histogram is provided.
+ "bucketCounts": [ # Required in the Stackdriver Monitoring API v3. The values for each bucket specified in bucket_options. The sum of the values in bucketCounts must equal the value in the count field of the Distribution object. The order of the bucket counts follows the numbering schemes described for the three bucket types. The underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; and the overflow bucket has number N-1. The size of bucket_counts must not be greater than N. If the size is less than N, then the remaining buckets are assigned values of zero.
"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_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.
+ "bucketOptions": { # BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be 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. # Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries.
+ "exponentialBuckets": { # Specifies an exponential 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.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries: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": { # Specifies a linear 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.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries: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): 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.
+ "explicitBuckets": { # Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then 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,
],
@@ -224,23 +224,23 @@
"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.
- "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.
+ "distributionValue": { # Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of 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 formulas for buckets of fixed or exponentially increasing widths.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. This value must equal the sum of the values in bucket_counts if a histogram is provided.
+ "bucketCounts": [ # Required in the Stackdriver Monitoring API v3. The values for each bucket specified in bucket_options. The sum of the values in bucketCounts must equal the value in the count field of the Distribution object. The order of the bucket counts follows the numbering schemes described for the three bucket types. The underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; and the overflow bucket has number N-1. The size of bucket_counts must not be greater than N. If the size is less than N, then the remaining buckets are assigned values of zero.
"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_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.
+ "bucketOptions": { # BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be 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. # Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries.
+ "exponentialBuckets": { # Specifies an exponential 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.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries: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": { # Specifies a linear 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.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries: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): 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.
+ "explicitBuckets": { # Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then 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,
],
diff --git a/docs/dyn/partners_v2.analytics.html b/docs/dyn/partners_v2.analytics.html
index 7dd3814..6f0ede4 100644
--- a/docs/dyn/partners_v2.analytics.html
+++ b/docs/dyn/partners_v2.analytics.html
@@ -257,11 +257,11 @@
# expiration date. The year may be 0 to represent a month and day independent
# of year, e.g. anniversary date. Related types are google.type.TimeOfDay
# and `google.protobuf.Timestamp`.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
+ "month": 42, # Month of year. Must be from 1 to 12.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year/month where the day is not significant.
- "month": 42, # Month of year. Must be from 1 to 12.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
},
"contacts": { # Details of the analytics events for a `Company` within a single day. # Instances of users contacting the `Company`
# on the specified date.
diff --git a/docs/dyn/partners_v2.clientMessages.html b/docs/dyn/partners_v2.clientMessages.html
index f849bcd..aced843 100644
--- a/docs/dyn/partners_v2.clientMessages.html
+++ b/docs/dyn/partners_v2.clientMessages.html
@@ -91,8 +91,17 @@
{ # Request message for
# LogClientMessage.
"requestMetadata": { # Common data that is in each API request. # Current request metadata.
- "locale": "A String", # Locale to use for the current request.
+ "experimentIds": [ # Experiment IDs the current request belongs to.
+ "A String",
+ ],
"partnersSessionId": "A String", # Google Partners session ID.
+ "locale": "A String", # Locale to use for the current request.
+ "userOverrides": { # Values to use instead of the user's respective defaults. These are only # Values to use instead of the user's respective defaults for the current
+ # request. These are only honored by whitelisted products.
+ # honored by whitelisted products.
+ "userId": "A String", # Logged-in user ID to impersonate instead of the user's ID.
+ "ipAddress": "A String", # IP address to use instead of the user's geo-located IP address.
+ },
"trafficSource": { # Source of traffic for the current request. # Source of traffic for the current request.
"trafficSubId": "A String", # Second level identifier to indicate where the traffic comes from.
# An identifier has multiple letters created by a team which redirected the
@@ -101,15 +110,6 @@
# An identifier has multiple letters created by a team which redirected the
# traffic to us.
},
- "userOverrides": { # Values to use instead of the user's respective defaults. These are only # Values to use instead of the user's respective defaults for the current
- # request. These are only honored by whitelisted products.
- # honored by whitelisted products.
- "userId": "A String", # Logged-in user ID to impersonate instead of the user's ID.
- "ipAddress": "A String", # IP address to use instead of the user's geo-located IP address.
- },
- "experimentIds": [ # Experiment IDs the current request belongs to.
- "A String",
- ],
},
"clientInfo": { # Map of client info, such as URL, browser navigator, browser platform, etc.
"a_key": "A String",
diff --git a/docs/dyn/partners_v2.companies.html b/docs/dyn/partners_v2.companies.html
index f6649e7..ddfda31 100644
--- a/docs/dyn/partners_v2.companies.html
+++ b/docs/dyn/partners_v2.companies.html
@@ -133,20 +133,23 @@
],
"originalMinMonthlyBudget": { # Represents an amount of money with its currency type. # The unconverted minimum monthly budget that the company accepts for partner
# business.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "autoApprovalEmailDomains": [ # Email domains that allow users with a matching email address to get
- # auto-approved for associating with this company.
- "A String",
- ],
+ "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile.
+ "url": "A String", # The URL of the public profile.
+ "profileImage": "A String", # The URL to the main profile image of the public profile.
+ "displayImageUrl": "A String", # The URL to the main display image of the public profile. Being deprecated.
+ "displayName": "A String", # The display name of the public profile.
+ "id": "A String", # The ID which can be used to retrieve more details about the public profile.
+ },
"name": "A String", # The name of the company.
"badgeTier": "A String", # Partner badge tier
"localizedInfos": [ # The list of localized info for the company.
@@ -154,13 +157,17 @@
"countryCodes": [ # List of country codes for the localized company info.
"A String",
],
- "overview": "A String", # Localized brief description that the company uses to advertise themselves.
- "displayName": "A String", # Localized display name.
"languageCode": "A String", # Language code of the localized company info, as defined by
# <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
# (IETF BCP 47, "Tags for Identifying Languages").
+ "displayName": "A String", # Localized display name.
+ "overview": "A String", # Localized brief description that the company uses to advertise themselves.
},
],
+ "autoApprovalEmailDomains": [ # Email domains that allow users with a matching email address to get
+ # auto-approved for associating with this company.
+ "A String",
+ ],
"locations": [ # The list of all company locations.
# If set, must include the
# primary_location
@@ -229,6 +236,23 @@
},
],
"websiteUrl": "A String", # URL of the company's website.
+ "services": [ # Services the company can help with.
+ "A String",
+ ],
+ "additionalWebsites": [ # URL of the company's additional websites used to verify the dynamic badges.
+ # These are stored as full URLs as entered by the user, but only the TLD will
+ # be used for the actual verification.
+ "A String",
+ ],
+ "profileStatus": "A String", # The public viewability status of the company's profile.
+ "ranks": [ # Information related to the ranking of the company within the list of
+ # companies.
+ { # Information related to ranking of results.
+ "type": "A String", # The type of rank.
+ "value": 3.14, # The numerical value of the rank.
+ },
+ ],
+ "primaryAdwordsManagerAccountId": "A String", # The Primary AdWords Manager Account id.
"primaryLocation": { # A location with address and geographic coordinates. May optionally contain a # The primary location of the company.
# detailed (multi-field) version of the address.
"languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
@@ -291,56 +315,32 @@
"address": "A String", # The single string version of the address.
"postalCode": "A String", # Values are frequently alphanumeric.
},
- "additionalWebsites": [ # URL of the company's additional websites used to verify the dynamic badges.
- # These are stored as full URLs as entered by the user, but only the TLD will
- # be used for the actual verification.
- "A String",
- ],
- "profileStatus": "A String", # The public viewability status of the company's profile.
- "ranks": [ # Information related to the ranking of the company within the list of
- # companies.
- { # Information related to ranking of results.
- "type": "A String", # The type of rank.
- "value": 3.14, # The numerical value of the rank.
- },
- ],
- "primaryAdwordsManagerAccountId": "A String", # The Primary AdWords Manager Account id.
- "services": [ # Services the company can help with.
- "A String",
- ],
"certificationStatuses": [ # The list of Google Partners certification statuses for the company.
{ # Google Partners certification status.
"type": "A String", # The type of the certification.
+ "userCount": 42, # Number of people who are certified,
+ "isCertified": True or False, # Whether certification is passing.
"examStatuses": [ # List of certification exam statuses.
{ # Status for a Google Partners certification exam.
"numberUsersPass": 42, # The number of people who have passed the certification exam.
"type": "A String", # The type of certification exam.
},
],
- "isCertified": True or False, # Whether certification is passing.
- "userCount": 42, # Number of people who are certified,
},
],
"companyTypes": [ # Company type labels listed on the company's profile.
"A String",
],
- "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile.
- "url": "A String", # The URL of the public profile.
- "profileImage": "A String", # The URL to the main profile image of the public profile.
- "displayImageUrl": "A String", # The URL to the main display image of the public profile. Being deprecated.
- "displayName": "A String", # The display name of the public profile.
- "id": "A String", # The ID which can be used to retrieve more details about the public profile.
- },
"convertedMinMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget that the company accepts for partner business,
# converted to the requested currency code.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"id": "A String", # The ID of the company.
@@ -450,20 +450,23 @@
],
"originalMinMonthlyBudget": { # Represents an amount of money with its currency type. # The unconverted minimum monthly budget that the company accepts for partner
# business.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "autoApprovalEmailDomains": [ # Email domains that allow users with a matching email address to get
- # auto-approved for associating with this company.
- "A String",
- ],
+ "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile.
+ "url": "A String", # The URL of the public profile.
+ "profileImage": "A String", # The URL to the main profile image of the public profile.
+ "displayImageUrl": "A String", # The URL to the main display image of the public profile. Being deprecated.
+ "displayName": "A String", # The display name of the public profile.
+ "id": "A String", # The ID which can be used to retrieve more details about the public profile.
+ },
"name": "A String", # The name of the company.
"badgeTier": "A String", # Partner badge tier
"localizedInfos": [ # The list of localized info for the company.
@@ -471,13 +474,17 @@
"countryCodes": [ # List of country codes for the localized company info.
"A String",
],
- "overview": "A String", # Localized brief description that the company uses to advertise themselves.
- "displayName": "A String", # Localized display name.
"languageCode": "A String", # Language code of the localized company info, as defined by
# <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
# (IETF BCP 47, "Tags for Identifying Languages").
+ "displayName": "A String", # Localized display name.
+ "overview": "A String", # Localized brief description that the company uses to advertise themselves.
},
],
+ "autoApprovalEmailDomains": [ # Email domains that allow users with a matching email address to get
+ # auto-approved for associating with this company.
+ "A String",
+ ],
"locations": [ # The list of all company locations.
# If set, must include the
# primary_location
@@ -546,6 +553,23 @@
},
],
"websiteUrl": "A String", # URL of the company's website.
+ "services": [ # Services the company can help with.
+ "A String",
+ ],
+ "additionalWebsites": [ # URL of the company's additional websites used to verify the dynamic badges.
+ # These are stored as full URLs as entered by the user, but only the TLD will
+ # be used for the actual verification.
+ "A String",
+ ],
+ "profileStatus": "A String", # The public viewability status of the company's profile.
+ "ranks": [ # Information related to the ranking of the company within the list of
+ # companies.
+ { # Information related to ranking of results.
+ "type": "A String", # The type of rank.
+ "value": 3.14, # The numerical value of the rank.
+ },
+ ],
+ "primaryAdwordsManagerAccountId": "A String", # The Primary AdWords Manager Account id.
"primaryLocation": { # A location with address and geographic coordinates. May optionally contain a # The primary location of the company.
# detailed (multi-field) version of the address.
"languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
@@ -608,56 +632,32 @@
"address": "A String", # The single string version of the address.
"postalCode": "A String", # Values are frequently alphanumeric.
},
- "additionalWebsites": [ # URL of the company's additional websites used to verify the dynamic badges.
- # These are stored as full URLs as entered by the user, but only the TLD will
- # be used for the actual verification.
- "A String",
- ],
- "profileStatus": "A String", # The public viewability status of the company's profile.
- "ranks": [ # Information related to the ranking of the company within the list of
- # companies.
- { # Information related to ranking of results.
- "type": "A String", # The type of rank.
- "value": 3.14, # The numerical value of the rank.
- },
- ],
- "primaryAdwordsManagerAccountId": "A String", # The Primary AdWords Manager Account id.
- "services": [ # Services the company can help with.
- "A String",
- ],
"certificationStatuses": [ # The list of Google Partners certification statuses for the company.
{ # Google Partners certification status.
"type": "A String", # The type of the certification.
+ "userCount": 42, # Number of people who are certified,
+ "isCertified": True or False, # Whether certification is passing.
"examStatuses": [ # List of certification exam statuses.
{ # Status for a Google Partners certification exam.
"numberUsersPass": 42, # The number of people who have passed the certification exam.
"type": "A String", # The type of certification exam.
},
],
- "isCertified": True or False, # Whether certification is passing.
- "userCount": 42, # Number of people who are certified,
},
],
"companyTypes": [ # Company type labels listed on the company's profile.
"A String",
],
- "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile.
- "url": "A String", # The URL of the public profile.
- "profileImage": "A String", # The URL to the main profile image of the public profile.
- "displayImageUrl": "A String", # The URL to the main display image of the public profile. Being deprecated.
- "displayName": "A String", # The display name of the public profile.
- "id": "A String", # The ID which can be used to retrieve more details about the public profile.
- },
"convertedMinMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget that the company accepts for partner business,
# converted to the requested currency code.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"id": "A String", # The ID of the company.
diff --git a/docs/dyn/partners_v2.companies.leads.html b/docs/dyn/partners_v2.companies.leads.html
index d2d0816..7e6cd46 100644
--- a/docs/dyn/partners_v2.companies.leads.html
+++ b/docs/dyn/partners_v2.companies.leads.html
@@ -89,8 +89,17 @@
{ # Request message for CreateLead.
"requestMetadata": { # Common data that is in each API request. # Current request metadata.
- "locale": "A String", # Locale to use for the current request.
+ "experimentIds": [ # Experiment IDs the current request belongs to.
+ "A String",
+ ],
"partnersSessionId": "A String", # Google Partners session ID.
+ "locale": "A String", # Locale to use for the current request.
+ "userOverrides": { # Values to use instead of the user's respective defaults. These are only # Values to use instead of the user's respective defaults for the current
+ # request. These are only honored by whitelisted products.
+ # honored by whitelisted products.
+ "userId": "A String", # Logged-in user ID to impersonate instead of the user's ID.
+ "ipAddress": "A String", # IP address to use instead of the user's geo-located IP address.
+ },
"trafficSource": { # Source of traffic for the current request. # Source of traffic for the current request.
"trafficSubId": "A String", # Second level identifier to indicate where the traffic comes from.
# An identifier has multiple letters created by a team which redirected the
@@ -99,15 +108,6 @@
# An identifier has multiple letters created by a team which redirected the
# traffic to us.
},
- "userOverrides": { # Values to use instead of the user's respective defaults. These are only # Values to use instead of the user's respective defaults for the current
- # request. These are only honored by whitelisted products.
- # honored by whitelisted products.
- "userId": "A String", # Logged-in user ID to impersonate instead of the user's ID.
- "ipAddress": "A String", # IP address to use instead of the user's geo-located IP address.
- },
- "experimentIds": [ # Experiment IDs the current request belongs to.
- "A String",
- ],
},
"recaptchaChallenge": { # <a href="https://www.google.com/recaptcha/">reCaptcha</a> challenge info. # <a href="https://www.google.com/recaptcha/">reCaptcha</a> challenge info.
"id": "A String", # The ID of the reCaptcha challenge.
@@ -120,17 +120,19 @@
"languageCode": "A String", # Language code of the lead's language preference, as defined by
# <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
# (IETF BCP 47, "Tags for Identifying Languages").
- "type": "A String", # Type of lead.
+ "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
+ "A String",
+ ],
"familyName": "A String", # Last name of lead source.
"minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"comments": "A String", # Comments lead source gave.
@@ -138,12 +140,10 @@
"websiteUrl": "A String", # Website URL of lead source.
"state": "A String", # The lead's state in relation to the company.
"phoneNumber": "A String", # Phone number of lead source.
- "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
- "A String",
- ],
+ "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
"id": "A String", # ID of the lead.
"givenName": "A String", # First name of lead source.
- "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
+ "type": "A String", # Type of lead.
"createTime": "A String", # Timestamp of when this lead was created.
},
}
@@ -166,17 +166,19 @@
"languageCode": "A String", # Language code of the lead's language preference, as defined by
# <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
# (IETF BCP 47, "Tags for Identifying Languages").
- "type": "A String", # Type of lead.
+ "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
+ "A String",
+ ],
"familyName": "A String", # Last name of lead source.
"minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"comments": "A String", # Comments lead source gave.
@@ -184,12 +186,10 @@
"websiteUrl": "A String", # Website URL of lead source.
"state": "A String", # The lead's state in relation to the company.
"phoneNumber": "A String", # Phone number of lead source.
- "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
- "A String",
- ],
+ "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
"id": "A String", # ID of the lead.
"givenName": "A String", # First name of lead source.
- "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
+ "type": "A String", # Type of lead.
"createTime": "A String", # Timestamp of when this lead was created.
},
"responseMetadata": { # Common data that is in each API response. # Current response metadata.
diff --git a/docs/dyn/partners_v2.leads.html b/docs/dyn/partners_v2.leads.html
index 40b0311..c79ed1a 100644
--- a/docs/dyn/partners_v2.leads.html
+++ b/docs/dyn/partners_v2.leads.html
@@ -128,17 +128,19 @@
"languageCode": "A String", # Language code of the lead's language preference, as defined by
# <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
# (IETF BCP 47, "Tags for Identifying Languages").
- "type": "A String", # Type of lead.
+ "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
+ "A String",
+ ],
"familyName": "A String", # Last name of lead source.
"minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"comments": "A String", # Comments lead source gave.
@@ -146,12 +148,10 @@
"websiteUrl": "A String", # Website URL of lead source.
"state": "A String", # The lead's state in relation to the company.
"phoneNumber": "A String", # Phone number of lead source.
- "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
- "A String",
- ],
+ "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
"id": "A String", # ID of the lead.
"givenName": "A String", # First name of lead source.
- "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
+ "type": "A String", # Type of lead.
"createTime": "A String", # Timestamp of when this lead was created.
},
],
diff --git a/docs/dyn/partners_v2.offers.history.html b/docs/dyn/partners_v2.offers.history.html
index 1d18f6e..f10bb49 100644
--- a/docs/dyn/partners_v2.offers.history.html
+++ b/docs/dyn/partners_v2.offers.history.html
@@ -123,23 +123,23 @@
},
},
"canShowEntireCompany": True or False, # True if the user has the option to show entire company history.
- "showingEntireCompany": True or False, # True if this response is showing entire company history.
"offers": [ # Historical offers meeting request.
{ # Historical information about a Google Partners Offer.
"offerCode": "A String", # Offer code.
"status": "A String", # Status of the offer.
- "adwordsUrl": "A String", # Client's AdWords page URL.
"offerCountryCode": "A String", # Country Code for the offer country.
+ "adwordsUrl": "A String", # Client's AdWords page URL.
"creationTime": "A String", # Time offer was first created.
"clientId": "A String", # ID of client.
"clientEmail": "A String", # Email address for client.
- "expirationTime": "A String", # Time this offer expires.
+ "lastModifiedTime": "A String", # Time last action was taken.
"offerType": "A String", # Type of offer.
"senderName": "A String", # Name (First + Last) of the partners user to whom the incentive is allocated.
- "lastModifiedTime": "A String", # Time last action was taken.
+ "expirationTime": "A String", # Time this offer expires.
"clientName": "A String", # Name of the client.
},
],
+ "showingEntireCompany": True or False, # True if this response is showing entire company history.
"totalResults": 42, # Number of results across all pages.
}</pre>
</div>
diff --git a/docs/dyn/partners_v2.userEvents.html b/docs/dyn/partners_v2.userEvents.html
index f8670b5..aa8d8e6 100644
--- a/docs/dyn/partners_v2.userEvents.html
+++ b/docs/dyn/partners_v2.userEvents.html
@@ -94,17 +94,19 @@
"languageCode": "A String", # Language code of the lead's language preference, as defined by
# <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
# (IETF BCP 47, "Tags for Identifying Languages").
- "type": "A String", # Type of lead.
+ "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
+ "A String",
+ ],
"familyName": "A String", # Last name of lead source.
"minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"comments": "A String", # Comments lead source gave.
@@ -112,12 +114,10 @@
"websiteUrl": "A String", # Website URL of lead source.
"state": "A String", # The lead's state in relation to the company.
"phoneNumber": "A String", # Phone number of lead source.
- "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
- "A String",
- ],
+ "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
"id": "A String", # ID of the lead.
"givenName": "A String", # First name of lead source.
- "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
+ "type": "A String", # Type of lead.
"createTime": "A String", # Timestamp of when this lead was created.
},
"url": "A String", # The URL where the event occurred.
@@ -132,8 +132,17 @@
"eventCategory": "A String", # The category the action belongs to.
"eventAction": "A String", # The action that occurred.
"requestMetadata": { # Common data that is in each API request. # Current request metadata.
- "locale": "A String", # Locale to use for the current request.
+ "experimentIds": [ # Experiment IDs the current request belongs to.
+ "A String",
+ ],
"partnersSessionId": "A String", # Google Partners session ID.
+ "locale": "A String", # Locale to use for the current request.
+ "userOverrides": { # Values to use instead of the user's respective defaults. These are only # Values to use instead of the user's respective defaults for the current
+ # request. These are only honored by whitelisted products.
+ # honored by whitelisted products.
+ "userId": "A String", # Logged-in user ID to impersonate instead of the user's ID.
+ "ipAddress": "A String", # IP address to use instead of the user's geo-located IP address.
+ },
"trafficSource": { # Source of traffic for the current request. # Source of traffic for the current request.
"trafficSubId": "A String", # Second level identifier to indicate where the traffic comes from.
# An identifier has multiple letters created by a team which redirected the
@@ -142,15 +151,6 @@
# An identifier has multiple letters created by a team which redirected the
# traffic to us.
},
- "userOverrides": { # Values to use instead of the user's respective defaults. These are only # Values to use instead of the user's respective defaults for the current
- # request. These are only honored by whitelisted products.
- # honored by whitelisted products.
- "userId": "A String", # Logged-in user ID to impersonate instead of the user's ID.
- "ipAddress": "A String", # IP address to use instead of the user's geo-located IP address.
- },
- "experimentIds": [ # Experiment IDs the current request belongs to.
- "A String",
- ],
},
"eventScope": "A String", # The scope of the event.
}
diff --git a/docs/dyn/partners_v2.users.html b/docs/dyn/partners_v2.users.html
index fca659d..18c1228 100644
--- a/docs/dyn/partners_v2.users.html
+++ b/docs/dyn/partners_v2.users.html
@@ -241,21 +241,19 @@
An object of the form:
{ # A resource representing a user of the Partners platform.
- "companyVerificationEmail": "A String", # The email address used by the user used for company verification.
- # @OutputOnly
"profile": { # The profile information of a Partners user. # The profile information of a Partners user, contains all the directly
# editable user information.
"industries": [ # A list of ids representing which industries the user selected.
"A String",
],
- "primaryCountryCode": "A String", # The user's primary country, an ISO 2-character code.
- "adwordsManagerAccount": "A String", # If the user has edit access to multiple accounts, the user can choose the
- # preferred account and it is used when a personal account is needed. Can
- # be empty.
"languages": [ # The list of languages this user understands.
"A String",
],
- "jobFunctions": [ # A list of ids represnting which job categories the user selected.
+ "adwordsManagerAccount": "A String", # If the user has edit access to multiple accounts, the user can choose the
+ # preferred account and it is used when a personal account is needed. Can
+ # be empty.
+ "primaryCountryCode": "A String", # The user's primary country, an ISO 2-character code.
+ "markets": [ # A list of ids representing which markets the user was interested in.
"A String",
],
"emailOptIns": { # A set of opt-ins for a user. # The list of opt-ins for the user, related to communication preferences.
@@ -271,7 +269,7 @@
"channels": [ # A list of ids representing which channels the user selected they were in.
"A String",
],
- "emailAddress": "A String", # The email address the user has selected on the Partners site as primary.
+ "phoneNumber": "A String", # The user's phone number.
"address": { # A location with address and geographic coordinates. May optionally contain a # The user's mailing address, contains multiple fields.
# detailed (multi-field) version of the address.
"languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
@@ -334,21 +332,23 @@
"address": "A String", # The single string version of the address.
"postalCode": "A String", # Values are frequently alphanumeric.
},
- "phoneNumber": "A String", # The user's phone number.
+ "emailAddress": "A String", # The email address the user has selected on the Partners site as primary.
"givenName": "A String", # The user's given name.
- "markets": [ # A list of ids representing which markets the user was interested in.
+ "jobFunctions": [ # A list of ids represnting which job categories the user selected.
"A String",
],
"profilePublic": True or False, # Whether the user's public profile is visible to anyone with the URL.
},
+ "companyVerificationEmail": "A String", # The email address used by the user used for company verification.
+ # @OutputOnly
"certificationStatus": [ # The list of achieved certifications. These are calculated based on exam
# results and other requirements.
# @OutputOnly
{ # A user's information on a specific certification.
- "warning": True or False, # Whether this certification is in the state of warning.
- "certificationType": "A String", # The type of certification, the area of expertise.
"lastAchieved": "A String", # The date the user last achieved certification.
+ "warning": True or False, # Whether this certification is in the state of warning.
"expiration": "A String", # Date this certification is due to expire.
+ "certificationType": "A String", # The type of certification, the area of expertise.
"achieved": True or False, # Whether this certification has been achieved.
},
],
@@ -359,8 +359,8 @@
# @OutputOnly
{ # Information about a particular AdWords Manager Account.
# Read more at https://support.google.com/adwords/answer/6139186
- "customerName": "A String", # Name of the customer this account represents.
"id": "A String", # The AdWords Manager Account id.
+ "customerName": "A String", # Name of the customer this account represents.
},
],
"company": { # A CompanyRelation resource representing information about a user's # The company that the user is associated with.
@@ -433,14 +433,14 @@
"industries": [ # A list of ids representing which industries the user selected.
"A String",
],
- "primaryCountryCode": "A String", # The user's primary country, an ISO 2-character code.
- "adwordsManagerAccount": "A String", # If the user has edit access to multiple accounts, the user can choose the
- # preferred account and it is used when a personal account is needed. Can
- # be empty.
"languages": [ # The list of languages this user understands.
"A String",
],
- "jobFunctions": [ # A list of ids represnting which job categories the user selected.
+ "adwordsManagerAccount": "A String", # If the user has edit access to multiple accounts, the user can choose the
+ # preferred account and it is used when a personal account is needed. Can
+ # be empty.
+ "primaryCountryCode": "A String", # The user's primary country, an ISO 2-character code.
+ "markets": [ # A list of ids representing which markets the user was interested in.
"A String",
],
"emailOptIns": { # A set of opt-ins for a user. # The list of opt-ins for the user, related to communication preferences.
@@ -456,7 +456,7 @@
"channels": [ # A list of ids representing which channels the user selected they were in.
"A String",
],
- "emailAddress": "A String", # The email address the user has selected on the Partners site as primary.
+ "phoneNumber": "A String", # The user's phone number.
"address": { # A location with address and geographic coordinates. May optionally contain a # The user's mailing address, contains multiple fields.
# detailed (multi-field) version of the address.
"languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
@@ -519,9 +519,9 @@
"address": "A String", # The single string version of the address.
"postalCode": "A String", # Values are frequently alphanumeric.
},
- "phoneNumber": "A String", # The user's phone number.
+ "emailAddress": "A String", # The email address the user has selected on the Partners site as primary.
"givenName": "A String", # The user's given name.
- "markets": [ # A list of ids representing which markets the user was interested in.
+ "jobFunctions": [ # A list of ids represnting which job categories the user selected.
"A String",
],
"profilePublic": True or False, # Whether the user's public profile is visible to anyone with the URL.
@@ -550,14 +550,14 @@
"industries": [ # A list of ids representing which industries the user selected.
"A String",
],
- "primaryCountryCode": "A String", # The user's primary country, an ISO 2-character code.
- "adwordsManagerAccount": "A String", # If the user has edit access to multiple accounts, the user can choose the
- # preferred account and it is used when a personal account is needed. Can
- # be empty.
"languages": [ # The list of languages this user understands.
"A String",
],
- "jobFunctions": [ # A list of ids represnting which job categories the user selected.
+ "adwordsManagerAccount": "A String", # If the user has edit access to multiple accounts, the user can choose the
+ # preferred account and it is used when a personal account is needed. Can
+ # be empty.
+ "primaryCountryCode": "A String", # The user's primary country, an ISO 2-character code.
+ "markets": [ # A list of ids representing which markets the user was interested in.
"A String",
],
"emailOptIns": { # A set of opt-ins for a user. # The list of opt-ins for the user, related to communication preferences.
@@ -573,7 +573,7 @@
"channels": [ # A list of ids representing which channels the user selected they were in.
"A String",
],
- "emailAddress": "A String", # The email address the user has selected on the Partners site as primary.
+ "phoneNumber": "A String", # The user's phone number.
"address": { # A location with address and geographic coordinates. May optionally contain a # The user's mailing address, contains multiple fields.
# detailed (multi-field) version of the address.
"languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
@@ -636,9 +636,9 @@
"address": "A String", # The single string version of the address.
"postalCode": "A String", # Values are frequently alphanumeric.
},
- "phoneNumber": "A String", # The user's phone number.
+ "emailAddress": "A String", # The email address the user has selected on the Partners site as primary.
"givenName": "A String", # The user's given name.
- "markets": [ # A list of ids representing which markets the user was interested in.
+ "jobFunctions": [ # A list of ids represnting which job categories the user selected.
"A String",
],
"profilePublic": True or False, # Whether the user's public profile is visible to anyone with the URL.
diff --git a/docs/dyn/partners_v2.v2.html b/docs/dyn/partners_v2.v2.html
index 36130c6..22270a4 100644
--- a/docs/dyn/partners_v2.v2.html
+++ b/docs/dyn/partners_v2.v2.html
@@ -137,20 +137,23 @@
],
"originalMinMonthlyBudget": { # Represents an amount of money with its currency type. # The unconverted minimum monthly budget that the company accepts for partner
# business.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "autoApprovalEmailDomains": [ # Email domains that allow users with a matching email address to get
- # auto-approved for associating with this company.
- "A String",
- ],
+ "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile.
+ "url": "A String", # The URL of the public profile.
+ "profileImage": "A String", # The URL to the main profile image of the public profile.
+ "displayImageUrl": "A String", # The URL to the main display image of the public profile. Being deprecated.
+ "displayName": "A String", # The display name of the public profile.
+ "id": "A String", # The ID which can be used to retrieve more details about the public profile.
+ },
"name": "A String", # The name of the company.
"badgeTier": "A String", # Partner badge tier
"localizedInfos": [ # The list of localized info for the company.
@@ -158,13 +161,17 @@
"countryCodes": [ # List of country codes for the localized company info.
"A String",
],
- "overview": "A String", # Localized brief description that the company uses to advertise themselves.
- "displayName": "A String", # Localized display name.
"languageCode": "A String", # Language code of the localized company info, as defined by
# <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
# (IETF BCP 47, "Tags for Identifying Languages").
+ "displayName": "A String", # Localized display name.
+ "overview": "A String", # Localized brief description that the company uses to advertise themselves.
},
],
+ "autoApprovalEmailDomains": [ # Email domains that allow users with a matching email address to get
+ # auto-approved for associating with this company.
+ "A String",
+ ],
"locations": [ # The list of all company locations.
# If set, must include the
# primary_location
@@ -233,6 +240,23 @@
},
],
"websiteUrl": "A String", # URL of the company's website.
+ "services": [ # Services the company can help with.
+ "A String",
+ ],
+ "additionalWebsites": [ # URL of the company's additional websites used to verify the dynamic badges.
+ # These are stored as full URLs as entered by the user, but only the TLD will
+ # be used for the actual verification.
+ "A String",
+ ],
+ "profileStatus": "A String", # The public viewability status of the company's profile.
+ "ranks": [ # Information related to the ranking of the company within the list of
+ # companies.
+ { # Information related to ranking of results.
+ "type": "A String", # The type of rank.
+ "value": 3.14, # The numerical value of the rank.
+ },
+ ],
+ "primaryAdwordsManagerAccountId": "A String", # The Primary AdWords Manager Account id.
"primaryLocation": { # A location with address and geographic coordinates. May optionally contain a # The primary location of the company.
# detailed (multi-field) version of the address.
"languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
@@ -295,56 +319,32 @@
"address": "A String", # The single string version of the address.
"postalCode": "A String", # Values are frequently alphanumeric.
},
- "additionalWebsites": [ # URL of the company's additional websites used to verify the dynamic badges.
- # These are stored as full URLs as entered by the user, but only the TLD will
- # be used for the actual verification.
- "A String",
- ],
- "profileStatus": "A String", # The public viewability status of the company's profile.
- "ranks": [ # Information related to the ranking of the company within the list of
- # companies.
- { # Information related to ranking of results.
- "type": "A String", # The type of rank.
- "value": 3.14, # The numerical value of the rank.
- },
- ],
- "primaryAdwordsManagerAccountId": "A String", # The Primary AdWords Manager Account id.
- "services": [ # Services the company can help with.
- "A String",
- ],
"certificationStatuses": [ # The list of Google Partners certification statuses for the company.
{ # Google Partners certification status.
"type": "A String", # The type of the certification.
+ "userCount": 42, # Number of people who are certified,
+ "isCertified": True or False, # Whether certification is passing.
"examStatuses": [ # List of certification exam statuses.
{ # Status for a Google Partners certification exam.
"numberUsersPass": 42, # The number of people who have passed the certification exam.
"type": "A String", # The type of certification exam.
},
],
- "isCertified": True or False, # Whether certification is passing.
- "userCount": 42, # Number of people who are certified,
},
],
"companyTypes": [ # Company type labels listed on the company's profile.
"A String",
],
- "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile.
- "url": "A String", # The URL of the public profile.
- "profileImage": "A String", # The URL to the main profile image of the public profile.
- "displayImageUrl": "A String", # The URL to the main display image of the public profile. Being deprecated.
- "displayName": "A String", # The display name of the public profile.
- "id": "A String", # The ID which can be used to retrieve more details about the public profile.
- },
"convertedMinMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget that the company accepts for partner business,
# converted to the requested currency code.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"id": "A String", # The ID of the company.
@@ -387,20 +387,23 @@
],
"originalMinMonthlyBudget": { # Represents an amount of money with its currency type. # The unconverted minimum monthly budget that the company accepts for partner
# business.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
- "autoApprovalEmailDomains": [ # Email domains that allow users with a matching email address to get
- # auto-approved for associating with this company.
- "A String",
- ],
+ "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile.
+ "url": "A String", # The URL of the public profile.
+ "profileImage": "A String", # The URL to the main profile image of the public profile.
+ "displayImageUrl": "A String", # The URL to the main display image of the public profile. Being deprecated.
+ "displayName": "A String", # The display name of the public profile.
+ "id": "A String", # The ID which can be used to retrieve more details about the public profile.
+ },
"name": "A String", # The name of the company.
"badgeTier": "A String", # Partner badge tier
"localizedInfos": [ # The list of localized info for the company.
@@ -408,13 +411,17 @@
"countryCodes": [ # List of country codes for the localized company info.
"A String",
],
- "overview": "A String", # Localized brief description that the company uses to advertise themselves.
- "displayName": "A String", # Localized display name.
"languageCode": "A String", # Language code of the localized company info, as defined by
# <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
# (IETF BCP 47, "Tags for Identifying Languages").
+ "displayName": "A String", # Localized display name.
+ "overview": "A String", # Localized brief description that the company uses to advertise themselves.
},
],
+ "autoApprovalEmailDomains": [ # Email domains that allow users with a matching email address to get
+ # auto-approved for associating with this company.
+ "A String",
+ ],
"locations": [ # The list of all company locations.
# If set, must include the
# primary_location
@@ -483,6 +490,23 @@
},
],
"websiteUrl": "A String", # URL of the company's website.
+ "services": [ # Services the company can help with.
+ "A String",
+ ],
+ "additionalWebsites": [ # URL of the company's additional websites used to verify the dynamic badges.
+ # These are stored as full URLs as entered by the user, but only the TLD will
+ # be used for the actual verification.
+ "A String",
+ ],
+ "profileStatus": "A String", # The public viewability status of the company's profile.
+ "ranks": [ # Information related to the ranking of the company within the list of
+ # companies.
+ { # Information related to ranking of results.
+ "type": "A String", # The type of rank.
+ "value": 3.14, # The numerical value of the rank.
+ },
+ ],
+ "primaryAdwordsManagerAccountId": "A String", # The Primary AdWords Manager Account id.
"primaryLocation": { # A location with address and geographic coordinates. May optionally contain a # The primary location of the company.
# detailed (multi-field) version of the address.
"languageCode": "A String", # Language code of the address. Should be in BCP 47 format.
@@ -545,56 +569,32 @@
"address": "A String", # The single string version of the address.
"postalCode": "A String", # Values are frequently alphanumeric.
},
- "additionalWebsites": [ # URL of the company's additional websites used to verify the dynamic badges.
- # These are stored as full URLs as entered by the user, but only the TLD will
- # be used for the actual verification.
- "A String",
- ],
- "profileStatus": "A String", # The public viewability status of the company's profile.
- "ranks": [ # Information related to the ranking of the company within the list of
- # companies.
- { # Information related to ranking of results.
- "type": "A String", # The type of rank.
- "value": 3.14, # The numerical value of the rank.
- },
- ],
- "primaryAdwordsManagerAccountId": "A String", # The Primary AdWords Manager Account id.
- "services": [ # Services the company can help with.
- "A String",
- ],
"certificationStatuses": [ # The list of Google Partners certification statuses for the company.
{ # Google Partners certification status.
"type": "A String", # The type of the certification.
+ "userCount": 42, # Number of people who are certified,
+ "isCertified": True or False, # Whether certification is passing.
"examStatuses": [ # List of certification exam statuses.
{ # Status for a Google Partners certification exam.
"numberUsersPass": 42, # The number of people who have passed the certification exam.
"type": "A String", # The type of certification exam.
},
],
- "isCertified": True or False, # Whether certification is passing.
- "userCount": 42, # Number of people who are certified,
},
],
"companyTypes": [ # Company type labels listed on the company's profile.
"A String",
],
- "publicProfile": { # Basic information from a public profile. # Basic information from the company's public profile.
- "url": "A String", # The URL of the public profile.
- "profileImage": "A String", # The URL to the main profile image of the public profile.
- "displayImageUrl": "A String", # The URL to the main display image of the public profile. Being deprecated.
- "displayName": "A String", # The display name of the public profile.
- "id": "A String", # The ID which can be used to retrieve more details about the public profile.
- },
"convertedMinMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget that the company accepts for partner business,
# converted to the requested currency code.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"id": "A String", # The ID of the company.
@@ -624,17 +624,19 @@
"languageCode": "A String", # Language code of the lead's language preference, as defined by
# <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
# (IETF BCP 47, "Tags for Identifying Languages").
- "type": "A String", # Type of lead.
+ "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
+ "A String",
+ ],
"familyName": "A String", # Last name of lead source.
"minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"comments": "A String", # Comments lead source gave.
@@ -642,12 +644,10 @@
"websiteUrl": "A String", # Website URL of lead source.
"state": "A String", # The lead's state in relation to the company.
"phoneNumber": "A String", # Phone number of lead source.
- "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
- "A String",
- ],
+ "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
"id": "A String", # ID of the lead.
"givenName": "A String", # First name of lead source.
- "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
+ "type": "A String", # Type of lead.
"createTime": "A String", # Timestamp of when this lead was created.
}
@@ -679,17 +679,19 @@
"languageCode": "A String", # Language code of the lead's language preference, as defined by
# <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
# (IETF BCP 47, "Tags for Identifying Languages").
- "type": "A String", # Type of lead.
+ "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
+ "A String",
+ ],
"familyName": "A String", # Last name of lead source.
"minMonthlyBudget": { # Represents an amount of money with its currency type. # The minimum monthly budget lead source is willing to spend.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"comments": "A String", # Comments lead source gave.
@@ -697,12 +699,10 @@
"websiteUrl": "A String", # Website URL of lead source.
"state": "A String", # The lead's state in relation to the company.
"phoneNumber": "A String", # Phone number of lead source.
- "gpsMotivations": [ # List of reasons for using Google Partner Search and creating a lead.
- "A String",
- ],
+ "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
"id": "A String", # ID of the lead.
"givenName": "A String", # First name of lead source.
- "adwordsCustomerId": "A String", # The AdWords Customer ID of the lead.
+ "type": "A String", # Type of lead.
"createTime": "A String", # Timestamp of when this lead was created.
}</pre>
</div>
diff --git a/docs/dyn/people_v1.people.connections.html b/docs/dyn/people_v1.people.connections.html
index 8801b0b..1a9c233 100644
--- a/docs/dyn/people_v1.people.connections.html
+++ b/docs/dyn/people_v1.people.connections.html
@@ -112,6 +112,7 @@
An object of the form:
{
+ "totalPeople": 42, # The total number of people in the list without pagination.
"nextPageToken": "A String", # The token that can be used to retrieve the next page of results.
"connections": [ # The list of people that the requestor is connected to.
{ # Information about a person merged from various data sources such as the
@@ -234,6 +235,24 @@
{ # A person's phone number.
"formattedType": "A String", # The read-only type of the phone number translated and formatted in the
# viewer's account locale or the the `Accept-Language` HTTP header locale.
+ "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
+ # form of the phone number.
+ "type": "A String", # The type of the phone number. The type can be custom or predefined.
+ # Possible values include, but are not limited to, the following:
+ #
+ # * `home`
+ # * `work`
+ # * `mobile`
+ # * `homeFax`
+ # * `workFax`
+ # * `otherFax`
+ # * `pager`
+ # * `workMobile`
+ # * `workPager`
+ # * `main`
+ # * `googleVoice`
+ # * `other`
+ "value": "A String", # The phone number.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"source": { # The source of a field. # The source of the field.
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
@@ -251,24 +270,6 @@
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
# field.
},
- "type": "A String", # The type of the phone number. The type can be custom or predefined.
- # Possible values include, but are not limited to, the following:
- #
- # * `home`
- # * `work`
- # * `mobile`
- # * `homeFax`
- # * `workFax`
- # * `otherFax`
- # * `pager`
- # * `workMobile`
- # * `workPager`
- # * `main`
- # * `googleVoice`
- # * `other`
- "value": "A String", # The phone number.
- "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
- # form of the phone number.
},
],
"names": [ # The person's names.
@@ -343,11 +344,11 @@
# The day may be 0 to represent a year and month where the day is not
# significant. The year may be 0 to represent a month and day independent
# of year; for example, anniversary date.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
+ "month": 42, # Month of year. Must be from 1 to 12.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year/month where the day is not significant.
- "month": 42, # Month of year. Must be from 1 to 12.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
},
"text": "A String", # A free-form string representing the user's birthday.
"metadata": { # Metadata about a field. # Metadata about the birthday.
@@ -372,23 +373,8 @@
"relations": [ # The person's relations.
{ # A person's relation to another person.
"person": "A String", # The name of the other person this relation refers to.
- "metadata": { # Metadata about a field. # Metadata about the relation.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation. Only populated in
- # person.metadata.sources.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
+ "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
+ # locale or the locale specified in the Accept-Language HTTP header.
"type": "A String", # The person's relation to the other person. The type can be custom or predefined.
# Possible values include, but are not limited to, the following values:
#
@@ -406,8 +392,23 @@
# * `assistant`
# * `referredBy`
# * `partner`
- "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
- # locale or the locale specified in the Accept-Language HTTP header.
+ "metadata": { # Metadata about a field. # Metadata about the relation.
+ "source": { # The source of a field. # The source of the field.
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation. Only populated in
+ # person.metadata.sources.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
+ "objectType": "A String", # The profile object type.
+ },
+ },
+ "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
@@ -522,11 +523,11 @@
# The day may be 0 to represent a year and month where the day is not
# significant. The year may be 0 to represent a month and day independent
# of year; for example, anniversary date.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
+ "month": 42, # Month of year. Must be from 1 to 12.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year/month where the day is not significant.
- "month": 42, # Month of year. Must be from 1 to 12.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
},
"formattedType": "A String", # The read-only type of the event translated and formatted in the
# viewer's account locale or the `Accept-Language` HTTP header locale.
@@ -555,15 +556,9 @@
},
],
"metadata": { # The read-only metadata about a person. # Metadata about the person.
- "previousResourceNames": [ # Any former resource names this person has had. Populated only for
+ "deleted": True or False, # True if the person resource has been deleted. Populated only for
# [`connections.list`](/people/api/rest/v1/people.connections/list) requests
# that include a sync token.
- #
- # The resource name may change when adding or removing fields that link a
- # contact and profile such as a verified email, verified phone number, or
- # profile URL.
- "A String",
- ],
"sources": [ # The sources of data for the person.
{ # The source of a field.
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
@@ -579,9 +574,15 @@
"linkedPeopleResourceNames": [ # Resource names of people linked to this resource.
"A String",
],
- "deleted": True or False, # True if the person resource has been deleted. Populated only for
+ "previousResourceNames": [ # Any former resource names this person has had. Populated only for
# [`connections.list`](/people/api/rest/v1/people.connections/list) requests
# that include a sync token.
+ #
+ # The resource name may change when adding or removing fields that link a
+ # contact and profile such as a verified email, verified phone number, or
+ # profile URL.
+ "A String",
+ ],
"objectType": "A String", # DEPRECATED(Please read person.metadata.sources.profile_metadata instead).
# The type of the person object.
},
@@ -737,8 +738,19 @@
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are
# permitted.
- "formattedType": "A String", # The read-only type of the organization translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
+ # of day and time zone are either specified elsewhere or are not
+ # significant. The date is relative to the
+ # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
+ # The day may be 0 to represent a year and month where the day is not
+ # significant. The year may be 0 to represent a month and day independent
+ # of year; for example, anniversary date.
+ "month": 42, # Month of year. Must be from 1 to 12.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year/month where the day is not significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
"domain": "A String", # The domain name associated with the organization; for example, `google.com`.
"endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
# of day and time zone are either specified elsewhere or are not
@@ -747,19 +759,14 @@
# The day may be 0 to represent a year and month where the day is not
# significant. The year may be 0 to represent a month and day independent
# of year; for example, anniversary date.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
+ "month": 42, # Month of year. Must be from 1 to 12.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year/month where the day is not significant.
- "month": 42, # Month of year. Must be from 1 to 12.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
},
"name": "A String", # The name of the organization.
"title": "A String", # The person's job title at the organization.
- "type": "A String", # The type of the organization. The type can be custom or predefined.
- # Possible values include, but are not limited to, the following:
- #
- # * `work`
- # * `school`
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
# symbol, abbreviation, or acronym.
"current": True or False, # True if the organization is the person's current organization;
@@ -767,19 +774,13 @@
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"department": "A String", # The person's department at the organization.
- "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year/month where the day is not significant.
- "month": 42, # Month of year. Must be from 1 to 12.
- },
+ "formattedType": "A String", # The read-only type of the organization translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the organization. The type can be custom or predefined.
+ # Possible values include, but are not limited to, the following:
+ #
+ # * `work`
+ # * `school`
"phoneticName": "A String", # The phonetic name of the organization.
"metadata": { # Metadata about a field. # Metadata about the organization.
"source": { # The source of a field. # The source of the field.
@@ -948,14 +949,14 @@
],
"emailAddresses": [ # The person's email addresses.
{ # A person's email address.
+ "formattedType": "A String", # The read-only type of the email address translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the email address. The type can be custom or predefined.
# Possible values include, but are not limited to, the following:
#
# * `home`
# * `work`
# * `other`
- "formattedType": "A String", # The read-only type of the email address translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
"displayName": "A String", # The display name of the email.
"value": "A String", # The email address.
"metadata": { # Metadata about a field. # Metadata about the email address.
diff --git a/docs/dyn/people_v1.people.html b/docs/dyn/people_v1.people.html
index 4eaa5e0..b8331d2 100644
--- a/docs/dyn/people_v1.people.html
+++ b/docs/dyn/people_v1.people.html
@@ -232,6 +232,24 @@
{ # A person's phone number.
"formattedType": "A String", # The read-only type of the phone number translated and formatted in the
# viewer's account locale or the the `Accept-Language` HTTP header locale.
+ "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
+ # form of the phone number.
+ "type": "A String", # The type of the phone number. The type can be custom or predefined.
+ # Possible values include, but are not limited to, the following:
+ #
+ # * `home`
+ # * `work`
+ # * `mobile`
+ # * `homeFax`
+ # * `workFax`
+ # * `otherFax`
+ # * `pager`
+ # * `workMobile`
+ # * `workPager`
+ # * `main`
+ # * `googleVoice`
+ # * `other`
+ "value": "A String", # The phone number.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"source": { # The source of a field. # The source of the field.
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
@@ -249,24 +267,6 @@
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
# field.
},
- "type": "A String", # The type of the phone number. The type can be custom or predefined.
- # Possible values include, but are not limited to, the following:
- #
- # * `home`
- # * `work`
- # * `mobile`
- # * `homeFax`
- # * `workFax`
- # * `otherFax`
- # * `pager`
- # * `workMobile`
- # * `workPager`
- # * `main`
- # * `googleVoice`
- # * `other`
- "value": "A String", # The phone number.
- "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
- # form of the phone number.
},
],
"names": [ # The person's names.
@@ -341,11 +341,11 @@
# The day may be 0 to represent a year and month where the day is not
# significant. The year may be 0 to represent a month and day independent
# of year; for example, anniversary date.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
+ "month": 42, # Month of year. Must be from 1 to 12.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year/month where the day is not significant.
- "month": 42, # Month of year. Must be from 1 to 12.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
},
"text": "A String", # A free-form string representing the user's birthday.
"metadata": { # Metadata about a field. # Metadata about the birthday.
@@ -370,23 +370,8 @@
"relations": [ # The person's relations.
{ # A person's relation to another person.
"person": "A String", # The name of the other person this relation refers to.
- "metadata": { # Metadata about a field. # Metadata about the relation.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation. Only populated in
- # person.metadata.sources.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
+ "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
+ # locale or the locale specified in the Accept-Language HTTP header.
"type": "A String", # The person's relation to the other person. The type can be custom or predefined.
# Possible values include, but are not limited to, the following values:
#
@@ -404,8 +389,23 @@
# * `assistant`
# * `referredBy`
# * `partner`
- "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
- # locale or the locale specified in the Accept-Language HTTP header.
+ "metadata": { # Metadata about a field. # Metadata about the relation.
+ "source": { # The source of a field. # The source of the field.
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation. Only populated in
+ # person.metadata.sources.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
+ "objectType": "A String", # The profile object type.
+ },
+ },
+ "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
@@ -520,11 +520,11 @@
# The day may be 0 to represent a year and month where the day is not
# significant. The year may be 0 to represent a month and day independent
# of year; for example, anniversary date.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
+ "month": 42, # Month of year. Must be from 1 to 12.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year/month where the day is not significant.
- "month": 42, # Month of year. Must be from 1 to 12.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
},
"formattedType": "A String", # The read-only type of the event translated and formatted in the
# viewer's account locale or the `Accept-Language` HTTP header locale.
@@ -553,15 +553,9 @@
},
],
"metadata": { # The read-only metadata about a person. # Metadata about the person.
- "previousResourceNames": [ # Any former resource names this person has had. Populated only for
+ "deleted": True or False, # True if the person resource has been deleted. Populated only for
# [`connections.list`](/people/api/rest/v1/people.connections/list) requests
# that include a sync token.
- #
- # The resource name may change when adding or removing fields that link a
- # contact and profile such as a verified email, verified phone number, or
- # profile URL.
- "A String",
- ],
"sources": [ # The sources of data for the person.
{ # The source of a field.
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
@@ -577,9 +571,15 @@
"linkedPeopleResourceNames": [ # Resource names of people linked to this resource.
"A String",
],
- "deleted": True or False, # True if the person resource has been deleted. Populated only for
+ "previousResourceNames": [ # Any former resource names this person has had. Populated only for
# [`connections.list`](/people/api/rest/v1/people.connections/list) requests
# that include a sync token.
+ #
+ # The resource name may change when adding or removing fields that link a
+ # contact and profile such as a verified email, verified phone number, or
+ # profile URL.
+ "A String",
+ ],
"objectType": "A String", # DEPRECATED(Please read person.metadata.sources.profile_metadata instead).
# The type of the person object.
},
@@ -735,8 +735,19 @@
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are
# permitted.
- "formattedType": "A String", # The read-only type of the organization translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
+ # of day and time zone are either specified elsewhere or are not
+ # significant. The date is relative to the
+ # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
+ # The day may be 0 to represent a year and month where the day is not
+ # significant. The year may be 0 to represent a month and day independent
+ # of year; for example, anniversary date.
+ "month": 42, # Month of year. Must be from 1 to 12.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year/month where the day is not significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
"domain": "A String", # The domain name associated with the organization; for example, `google.com`.
"endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
# of day and time zone are either specified elsewhere or are not
@@ -745,19 +756,14 @@
# The day may be 0 to represent a year and month where the day is not
# significant. The year may be 0 to represent a month and day independent
# of year; for example, anniversary date.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
+ "month": 42, # Month of year. Must be from 1 to 12.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year/month where the day is not significant.
- "month": 42, # Month of year. Must be from 1 to 12.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
},
"name": "A String", # The name of the organization.
"title": "A String", # The person's job title at the organization.
- "type": "A String", # The type of the organization. The type can be custom or predefined.
- # Possible values include, but are not limited to, the following:
- #
- # * `work`
- # * `school`
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
# symbol, abbreviation, or acronym.
"current": True or False, # True if the organization is the person's current organization;
@@ -765,19 +771,13 @@
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"department": "A String", # The person's department at the organization.
- "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year/month where the day is not significant.
- "month": 42, # Month of year. Must be from 1 to 12.
- },
+ "formattedType": "A String", # The read-only type of the organization translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the organization. The type can be custom or predefined.
+ # Possible values include, but are not limited to, the following:
+ #
+ # * `work`
+ # * `school`
"phoneticName": "A String", # The phonetic name of the organization.
"metadata": { # Metadata about a field. # Metadata about the organization.
"source": { # The source of a field. # The source of the field.
@@ -946,14 +946,14 @@
],
"emailAddresses": [ # The person's email addresses.
{ # A person's email address.
+ "formattedType": "A String", # The read-only type of the email address translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the email address. The type can be custom or predefined.
# Possible values include, but are not limited to, the following:
#
# * `home`
# * `work`
# * `other`
- "formattedType": "A String", # The read-only type of the email address translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
"displayName": "A String", # The display name of the email.
"value": "A String", # The email address.
"metadata": { # Metadata about a field. # Metadata about the email address.
@@ -1132,6 +1132,24 @@
{ # A person's phone number.
"formattedType": "A String", # The read-only type of the phone number translated and formatted in the
# viewer's account locale or the the `Accept-Language` HTTP header locale.
+ "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
+ # form of the phone number.
+ "type": "A String", # The type of the phone number. The type can be custom or predefined.
+ # Possible values include, but are not limited to, the following:
+ #
+ # * `home`
+ # * `work`
+ # * `mobile`
+ # * `homeFax`
+ # * `workFax`
+ # * `otherFax`
+ # * `pager`
+ # * `workMobile`
+ # * `workPager`
+ # * `main`
+ # * `googleVoice`
+ # * `other`
+ "value": "A String", # The phone number.
"metadata": { # Metadata about a field. # Metadata about the phone number.
"source": { # The source of a field. # The source of the field.
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
@@ -1149,24 +1167,6 @@
"primary": True or False, # True if the field is the primary field; false if the field is a secondary
# field.
},
- "type": "A String", # The type of the phone number. The type can be custom or predefined.
- # Possible values include, but are not limited to, the following:
- #
- # * `home`
- # * `work`
- # * `mobile`
- # * `homeFax`
- # * `workFax`
- # * `otherFax`
- # * `pager`
- # * `workMobile`
- # * `workPager`
- # * `main`
- # * `googleVoice`
- # * `other`
- "value": "A String", # The phone number.
- "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
- # form of the phone number.
},
],
"names": [ # The person's names.
@@ -1241,11 +1241,11 @@
# The day may be 0 to represent a year and month where the day is not
# significant. The year may be 0 to represent a month and day independent
# of year; for example, anniversary date.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
+ "month": 42, # Month of year. Must be from 1 to 12.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year/month where the day is not significant.
- "month": 42, # Month of year. Must be from 1 to 12.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
},
"text": "A String", # A free-form string representing the user's birthday.
"metadata": { # Metadata about a field. # Metadata about the birthday.
@@ -1270,23 +1270,8 @@
"relations": [ # The person's relations.
{ # A person's relation to another person.
"person": "A String", # The name of the other person this relation refers to.
- "metadata": { # Metadata about a field. # Metadata about the relation.
- "source": { # The source of a field. # The source of the field.
- "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
- # source. Used for web cache validation. Only populated in
- # person.metadata.sources.
- "type": "A String", # The source type.
- "id": "A String", # The unique identifier within the source type generated by the server.
- "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
- "objectType": "A String", # The profile object type.
- },
- },
- "verified": True or False, # True if the field is verified; false if the field is unverified. A
- # verified field is typically a name, email address, phone number, or
- # website that has been confirmed to be owned by the person.
- "primary": True or False, # True if the field is the primary field; false if the field is a secondary
- # field.
- },
+ "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
+ # locale or the locale specified in the Accept-Language HTTP header.
"type": "A String", # The person's relation to the other person. The type can be custom or predefined.
# Possible values include, but are not limited to, the following values:
#
@@ -1304,8 +1289,23 @@
# * `assistant`
# * `referredBy`
# * `partner`
- "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
- # locale or the locale specified in the Accept-Language HTTP header.
+ "metadata": { # Metadata about a field. # Metadata about the relation.
+ "source": { # The source of a field. # The source of the field.
+ "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
+ # source. Used for web cache validation. Only populated in
+ # person.metadata.sources.
+ "type": "A String", # The source type.
+ "id": "A String", # The unique identifier within the source type generated by the server.
+ "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
+ "objectType": "A String", # The profile object type.
+ },
+ },
+ "verified": True or False, # True if the field is verified; false if the field is unverified. A
+ # verified field is typically a name, email address, phone number, or
+ # website that has been confirmed to be owned by the person.
+ "primary": True or False, # True if the field is the primary field; false if the field is a secondary
+ # field.
+ },
},
],
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
@@ -1420,11 +1420,11 @@
# The day may be 0 to represent a year and month where the day is not
# significant. The year may be 0 to represent a month and day independent
# of year; for example, anniversary date.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
+ "month": 42, # Month of year. Must be from 1 to 12.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year/month where the day is not significant.
- "month": 42, # Month of year. Must be from 1 to 12.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
},
"formattedType": "A String", # The read-only type of the event translated and formatted in the
# viewer's account locale or the `Accept-Language` HTTP header locale.
@@ -1453,15 +1453,9 @@
},
],
"metadata": { # The read-only metadata about a person. # Metadata about the person.
- "previousResourceNames": [ # Any former resource names this person has had. Populated only for
+ "deleted": True or False, # True if the person resource has been deleted. Populated only for
# [`connections.list`](/people/api/rest/v1/people.connections/list) requests
# that include a sync token.
- #
- # The resource name may change when adding or removing fields that link a
- # contact and profile such as a verified email, verified phone number, or
- # profile URL.
- "A String",
- ],
"sources": [ # The sources of data for the person.
{ # The source of a field.
"etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
@@ -1477,9 +1471,15 @@
"linkedPeopleResourceNames": [ # Resource names of people linked to this resource.
"A String",
],
- "deleted": True or False, # True if the person resource has been deleted. Populated only for
+ "previousResourceNames": [ # Any former resource names this person has had. Populated only for
# [`connections.list`](/people/api/rest/v1/people.connections/list) requests
# that include a sync token.
+ #
+ # The resource name may change when adding or removing fields that link a
+ # contact and profile such as a verified email, verified phone number, or
+ # profile URL.
+ "A String",
+ ],
"objectType": "A String", # DEPRECATED(Please read person.metadata.sources.profile_metadata instead).
# The type of the person object.
},
@@ -1635,8 +1635,19 @@
"organizations": [ # The person's past or current organizations.
{ # A person's past or current organization. Overlapping date ranges are
# permitted.
- "formattedType": "A String", # The read-only type of the organization translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
+ # of day and time zone are either specified elsewhere or are not
+ # significant. The date is relative to the
+ # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
+ # The day may be 0 to represent a year and month where the day is not
+ # significant. The year may be 0 to represent a month and day independent
+ # of year; for example, anniversary date.
+ "month": 42, # Month of year. Must be from 1 to 12.
+ "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
+ # if specifying a year/month where the day is not significant.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
+ },
"domain": "A String", # The domain name associated with the organization; for example, `google.com`.
"endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
# of day and time zone are either specified elsewhere or are not
@@ -1645,19 +1656,14 @@
# The day may be 0 to represent a year and month where the day is not
# significant. The year may be 0 to represent a month and day independent
# of year; for example, anniversary date.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
+ "month": 42, # Month of year. Must be from 1 to 12.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year/month where the day is not significant.
- "month": 42, # Month of year. Must be from 1 to 12.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
},
"name": "A String", # The name of the organization.
"title": "A String", # The person's job title at the organization.
- "type": "A String", # The type of the organization. The type can be custom or predefined.
- # Possible values include, but are not limited to, the following:
- #
- # * `work`
- # * `school`
"symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
# symbol, abbreviation, or acronym.
"current": True or False, # True if the organization is the person's current organization;
@@ -1665,19 +1671,13 @@
"jobDescription": "A String", # The person's job description at the organization.
"location": "A String", # The location of the organization office the person works at.
"department": "A String", # The person's department at the organization.
- "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
- # of day and time zone are either specified elsewhere or are not
- # significant. The date is relative to the
- # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
- # The day may be 0 to represent a year and month where the day is not
- # significant. The year may be 0 to represent a month and day independent
- # of year; for example, anniversary date.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
- "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
- # if specifying a year/month where the day is not significant.
- "month": 42, # Month of year. Must be from 1 to 12.
- },
+ "formattedType": "A String", # The read-only type of the organization translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
+ "type": "A String", # The type of the organization. The type can be custom or predefined.
+ # Possible values include, but are not limited to, the following:
+ #
+ # * `work`
+ # * `school`
"phoneticName": "A String", # The phonetic name of the organization.
"metadata": { # Metadata about a field. # Metadata about the organization.
"source": { # The source of a field. # The source of the field.
@@ -1846,14 +1846,14 @@
],
"emailAddresses": [ # The person's email addresses.
{ # A person's email address.
+ "formattedType": "A String", # The read-only type of the email address translated and formatted in the
+ # viewer's account locale or the `Accept-Language` HTTP header locale.
"type": "A String", # The type of the email address. The type can be custom or predefined.
# Possible values include, but are not limited to, the following:
#
# * `home`
# * `work`
# * `other`
- "formattedType": "A String", # The read-only type of the email address translated and formatted in the
- # viewer's account locale or the `Accept-Language` HTTP header locale.
"displayName": "A String", # The display name of the email.
"value": "A String", # The email address.
"metadata": { # Metadata about a field. # Metadata about the email address.
diff --git a/docs/dyn/playmoviespartner_v1.accounts.orders.html b/docs/dyn/playmoviespartner_v1.accounts.orders.html
index 9b01004..116ec2d 100644
--- a/docs/dyn/playmoviespartner_v1.accounts.orders.html
+++ b/docs/dyn/playmoviespartner_v1.accounts.orders.html
@@ -110,7 +110,8 @@
#
# Externally, Orders can also be identified by partners using its `custom_id`
# (when provided).
- "status": "A String", # High-level status of the order.
+ "orderId": "A String", # ID internally generated by Google to uniquely identify an Order.
+ # Example: 'abcde12_x'
"channelId": "A String", # YouTube Channel ID that should be used to fulfill the Order.
# Example: "UCRG64darCZhb".
"studioName": "A String", # Name of the studio that owns the Edit ordered.
@@ -130,8 +131,7 @@
"channelName": "A String", # YouTube Channel Name that should be used to fulfill the Order.
# Example: "Google_channel".
"type": "A String", # Type of the Edit linked to the Order.
- "orderId": "A String", # ID internally generated by Google to uniquely identify an Order.
- # Example: 'abcde12_x'
+ "status": "A String", # High-level status of the order.
"statusDetail": "A String", # Detailed status of the order
"videoId": "A String", # Google-generated ID identifying the video linked to this Order, once
# delivered.
@@ -200,7 +200,8 @@
#
# Externally, Orders can also be identified by partners using its `custom_id`
# (when provided).
- "status": "A String", # High-level status of the order.
+ "orderId": "A String", # ID internally generated by Google to uniquely identify an Order.
+ # Example: 'abcde12_x'
"channelId": "A String", # YouTube Channel ID that should be used to fulfill the Order.
# Example: "UCRG64darCZhb".
"studioName": "A String", # Name of the studio that owns the Edit ordered.
@@ -220,8 +221,7 @@
"channelName": "A String", # YouTube Channel Name that should be used to fulfill the Order.
# Example: "Google_channel".
"type": "A String", # Type of the Edit linked to the Order.
- "orderId": "A String", # ID internally generated by Google to uniquely identify an Order.
- # Example: 'abcde12_x'
+ "status": "A String", # High-level status of the order.
"statusDetail": "A String", # Detailed status of the order
"videoId": "A String", # Google-generated ID identifying the video linked to this Order, once
# delivered.
diff --git a/docs/dyn/playmoviespartner_v1.accounts.storeInfos.country.html b/docs/dyn/playmoviespartner_v1.accounts.storeInfos.country.html
index 0708953..35b0b48 100644
--- a/docs/dyn/playmoviespartner_v1.accounts.storeInfos.country.html
+++ b/docs/dyn/playmoviespartner_v1.accounts.storeInfos.country.html
@@ -125,7 +125,9 @@
"hasAudio51": True or False, # Whether the Edit has a 5.1 channel audio track.
"hasInfoCards": True or False, # Whether the Edit has info cards.
"type": "A String", # Edit type, like Movie, Episode or Season.
- "hasVodOffer": True or False, # Whether the Edit has a VOD offer.
+ "seasonId": "A String", # Google-generated ID identifying the season linked to the Edit.
+ # Only available for TV Edits.
+ # Example: 'ster23ex'
"titleLevelEidr": "A String", # Title-level EIDR ID.
# Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".
"hasSdOffer": True or False, # Whether the Edit has a SD offer.
@@ -149,9 +151,6 @@
"country": "A String", # Country where Edit is available in ISO 3166-1 alpha-2 country
# code.
# Example: "US".
- "seasonId": "A String", # Google-generated ID identifying the season linked to the Edit.
- # Only available for TV Edits.
- # Example: 'ster23ex'
"seasonName": "A String", # Default Season name, usually in the language of the country of
# origin.
# Only available for TV Edits
@@ -159,6 +158,7 @@
"audioTracks": [ # Audio tracks available for this Edit.
"A String",
],
+ "hasVodOffer": True or False, # Whether the Edit has a VOD offer.
"showName": "A String", # Default Show name, usually in the language of the country of
# origin.
# Only available for TV Edits
diff --git a/docs/dyn/playmoviespartner_v1.accounts.storeInfos.html b/docs/dyn/playmoviespartner_v1.accounts.storeInfos.html
index dc0c19f..e2d7bf6 100644
--- a/docs/dyn/playmoviespartner_v1.accounts.storeInfos.html
+++ b/docs/dyn/playmoviespartner_v1.accounts.storeInfos.html
@@ -118,7 +118,6 @@
An object of the form:
{ # Response to the 'ListStoreInfos' method.
- "nextPageToken": "A String", # See 'List methods rules' for info about this field.
"storeInfos": [ # List of StoreInfos that match the request criteria.
{ # Information about a playable sequence (video) associated with an Edit
# and available at the Google Play Store.
@@ -148,7 +147,9 @@
"hasAudio51": True or False, # Whether the Edit has a 5.1 channel audio track.
"hasInfoCards": True or False, # Whether the Edit has info cards.
"type": "A String", # Edit type, like Movie, Episode or Season.
- "hasVodOffer": True or False, # Whether the Edit has a VOD offer.
+ "seasonId": "A String", # Google-generated ID identifying the season linked to the Edit.
+ # Only available for TV Edits.
+ # Example: 'ster23ex'
"titleLevelEidr": "A String", # Title-level EIDR ID.
# Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".
"hasSdOffer": True or False, # Whether the Edit has a SD offer.
@@ -172,9 +173,6 @@
"country": "A String", # Country where Edit is available in ISO 3166-1 alpha-2 country
# code.
# Example: "US".
- "seasonId": "A String", # Google-generated ID identifying the season linked to the Edit.
- # Only available for TV Edits.
- # Example: 'ster23ex'
"seasonName": "A String", # Default Season name, usually in the language of the country of
# origin.
# Only available for TV Edits
@@ -182,6 +180,7 @@
"audioTracks": [ # Audio tracks available for this Edit.
"A String",
],
+ "hasVodOffer": True or False, # Whether the Edit has a VOD offer.
"showName": "A String", # Default Show name, usually in the language of the country of
# origin.
# Only available for TV Edits
@@ -189,6 +188,7 @@
},
],
"totalSize": 42, # See _List methods rules_ for more information about this field.
+ "nextPageToken": "A String", # See 'List methods rules' for info about this field.
}</pre>
</div>
diff --git a/docs/dyn/proximitybeacon_v1beta1.beacons.attachments.html b/docs/dyn/proximitybeacon_v1beta1.beacons.attachments.html
index 19b3a55..fdd25f6 100644
--- a/docs/dyn/proximitybeacon_v1beta1.beacons.attachments.html
+++ b/docs/dyn/proximitybeacon_v1beta1.beacons.attachments.html
@@ -163,15 +163,15 @@
The object takes the form of:
{ # Project-specific data associated with a beacon.
- "attachmentName": "A String", # Resource name of this attachment. Attachment names have the format:
- # <code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>.
- # Leave this empty on creation.
- "creationTimeMs": "A String", # The UTC time when this attachment was created, in milliseconds since the
- # UNIX epoch.
"data": "A String", # An opaque data container for client-provided data. Must be
# [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP
# requests, and will be so encoded (with padding) in responses.
# Required.
+ "creationTimeMs": "A String", # The UTC time when this attachment was created, in milliseconds since the
+ # UNIX epoch.
+ "attachmentName": "A String", # Resource name of this attachment. Attachment names have the format:
+ # <code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>.
+ # Leave this empty on creation.
"namespacedType": "A String", # Specifies what kind of attachment this is. Tells a client how to
# interpret the `data` field. Format is <var>namespace/type</var>. Namespace
# provides type separation between clients. Type describes the type of
@@ -192,15 +192,15 @@
An object of the form:
{ # Project-specific data associated with a beacon.
- "attachmentName": "A String", # Resource name of this attachment. Attachment names have the format:
- # <code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>.
- # Leave this empty on creation.
- "creationTimeMs": "A String", # The UTC time when this attachment was created, in milliseconds since the
- # UNIX epoch.
"data": "A String", # An opaque data container for client-provided data. Must be
# [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP
# requests, and will be so encoded (with padding) in responses.
# Required.
+ "creationTimeMs": "A String", # The UTC time when this attachment was created, in milliseconds since the
+ # UNIX epoch.
+ "attachmentName": "A String", # Resource name of this attachment. Attachment names have the format:
+ # <code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>.
+ # Leave this empty on creation.
"namespacedType": "A String", # Specifies what kind of attachment this is. Tells a client how to
# interpret the `data` field. Format is <var>namespace/type</var>. Namespace
# provides type separation between clients. Type describes the type of
@@ -293,15 +293,15 @@
{ # Response to `ListBeaconAttachments` that contains the requested attachments.
"attachments": [ # The attachments that corresponded to the request params.
{ # Project-specific data associated with a beacon.
- "attachmentName": "A String", # Resource name of this attachment. Attachment names have the format:
- # <code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>.
- # Leave this empty on creation.
- "creationTimeMs": "A String", # The UTC time when this attachment was created, in milliseconds since the
- # UNIX epoch.
"data": "A String", # An opaque data container for client-provided data. Must be
# [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP
# requests, and will be so encoded (with padding) in responses.
# Required.
+ "creationTimeMs": "A String", # The UTC time when this attachment was created, in milliseconds since the
+ # UNIX epoch.
+ "attachmentName": "A String", # Resource name of this attachment. Attachment names have the format:
+ # <code>beacons/<var>beacon_id</var>/attachments/<var>attachment_id</var></code>.
+ # Leave this empty on creation.
"namespacedType": "A String", # Specifies what kind of attachment this is. Tells a client how to
# interpret the `data` field. Format is <var>namespace/type</var>. Namespace
# provides type separation between clients. Type describes the type of
diff --git a/docs/dyn/proximitybeacon_v1beta1.beacons.diagnostics.html b/docs/dyn/proximitybeacon_v1beta1.beacons.diagnostics.html
index 474ebda..a2b2280 100644
--- a/docs/dyn/proximitybeacon_v1beta1.beacons.diagnostics.html
+++ b/docs/dyn/proximitybeacon_v1beta1.beacons.diagnostics.html
@@ -124,11 +124,11 @@
# expiration date. The year may be 0 to represent a month and day independent
# of year, e.g. anniversary date. Related types are google.type.TimeOfDay
# and `google.protobuf.Timestamp`.
- "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
- # a year.
+ "month": 42, # Month of year. Must be from 1 to 12.
"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
# if specifying a year/month where the day is not significant.
- "month": 42, # Month of year. Must be from 1 to 12.
+ "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
+ # a year.
},
"alerts": [ # An unordered list of Alerts that the beacon has.
"A String",
diff --git a/docs/dyn/proximitybeacon_v1beta1.beacons.html b/docs/dyn/proximitybeacon_v1beta1.beacons.html
index 65e5980..107002a 100644
--- a/docs/dyn/proximitybeacon_v1beta1.beacons.html
+++ b/docs/dyn/proximitybeacon_v1beta1.beacons.html
@@ -567,6 +567,8 @@
An object of the form:
{ # Response that contains list beacon results and pagination help.
+ "nextPageToken": "A String", # An opaque pagination token that the client may provide in their next
+ # request to retrieve the next page of results.
"beacons": [ # The beacons that matched the search criteria.
{ # Details of a beacon device.
"status": "A String", # Current status of the beacon.
@@ -725,8 +727,6 @@
# that this key grants nothing on the service, only on the beacon itself.
},
],
- "nextPageToken": "A String", # An opaque pagination token that the client may provide in their next
- # request to retrieve the next page of results.
"totalCount": "A String", # Estimate of the total number of beacons matched by the query. Higher
# values may be less accurate.
}</pre>
diff --git a/docs/dyn/proximitybeacon_v1beta1.namespaces.html b/docs/dyn/proximitybeacon_v1beta1.namespaces.html
index 33dce03..def3fb8 100644
--- a/docs/dyn/proximitybeacon_v1beta1.namespaces.html
+++ b/docs/dyn/proximitybeacon_v1beta1.namespaces.html
@@ -107,10 +107,10 @@
{ # An attachment namespace defines read and write access for all the attachments
# created under it. Each namespace is globally unique, and owned by one
# project which is the only project that can create attachments under it.
- "namespaceName": "A String", # Resource name of this namespace. Namespaces names have the format:
- # <code>namespaces/<var>namespace</var></code>.
"servingVisibility": "A String", # Specifies what clients may receive attachments under this namespace
# via `beaconinfo.getforobserved`.
+ "namespaceName": "A String", # Resource name of this namespace. Namespaces names have the format:
+ # <code>namespaces/<var>namespace</var></code>.
},
],
}</pre>
@@ -130,10 +130,10 @@
{ # An attachment namespace defines read and write access for all the attachments
# created under it. Each namespace is globally unique, and owned by one
# project which is the only project that can create attachments under it.
- "namespaceName": "A String", # Resource name of this namespace. Namespaces names have the format:
- # <code>namespaces/<var>namespace</var></code>.
"servingVisibility": "A String", # Specifies what clients may receive attachments under this namespace
# via `beaconinfo.getforobserved`.
+ "namespaceName": "A String", # Resource name of this namespace. Namespaces names have the format:
+ # <code>namespaces/<var>namespace</var></code>.
}
projectId: string, The project id of the namespace to update. If the project id is not
@@ -151,10 +151,10 @@
{ # An attachment namespace defines read and write access for all the attachments
# created under it. Each namespace is globally unique, and owned by one
# project which is the only project that can create attachments under it.
- "namespaceName": "A String", # Resource name of this namespace. Namespaces names have the format:
- # <code>namespaces/<var>namespace</var></code>.
"servingVisibility": "A String", # Specifies what clients may receive attachments under this namespace
# via `beaconinfo.getforobserved`.
+ "namespaceName": "A String", # Resource name of this namespace. Namespaces names have the format:
+ # <code>namespaces/<var>namespace</var></code>.
}</pre>
</div>
diff --git a/docs/dyn/pubsub_v1.projects.snapshots.html b/docs/dyn/pubsub_v1.projects.snapshots.html
index d777b78..5a15e7f 100644
--- a/docs/dyn/pubsub_v1.projects.snapshots.html
+++ b/docs/dyn/pubsub_v1.projects.snapshots.html
@@ -92,8 +92,7 @@
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)
+See the operation documentation for the appropriate value for this field. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -187,8 +186,7 @@
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)
+See the operation documentation for the appropriate value for this field. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -372,8 +370,7 @@
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)
+See the operation documentation for the appropriate value for this field. (required)
body: object, The request body. (required)
The object takes the form of:
diff --git a/docs/dyn/pubsub_v1.projects.subscriptions.html b/docs/dyn/pubsub_v1.projects.subscriptions.html
index 583a0e4..5f513e2 100644
--- a/docs/dyn/pubsub_v1.projects.subscriptions.html
+++ b/docs/dyn/pubsub_v1.projects.subscriptions.html
@@ -178,82 +178,16 @@
The object takes the form of:
{ # A subscription resource.
- "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 minimum custom deadline you can specify is 10 seconds.
- # The maximum custom deadline you can specify is 600 seconds (10 minutes).
- # If this parameter is 0, a default value of 10 seconds is used.
- #
- # 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.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
- # Format is `projects/{project}/topics/{topic}`.
- # The value of this field will be `_deleted-topic_` if the topic has been
- # deleted.
- "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",
- },
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use "https://example.com/push".
- },
- "name": "A 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"`.
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # A subscription resource.
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ # Format is `projects/{project}/topics/{topic}`.
+ # 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
@@ -261,16 +195,12 @@
# The minimum custom deadline you can specify is 10 seconds.
# The maximum custom deadline you can specify is 600 seconds (10 minutes).
# If this parameter is 0, a default value of 10 seconds is used.
- #
+ #
# 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.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
- # Format is `projects/{project}/topics/{topic}`.
- # The value of this field will be `_deleted-topic_` if the topic has been
- # deleted.
"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.
@@ -280,11 +210,10 @@
# 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
+ # use to change the format of the pushed 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.
+ # controls the shape of the pushed message (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
@@ -307,7 +236,76 @@
# (`[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"`.
- }</pre>
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A subscription resource.
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ # Format is `projects/{project}/topics/{topic}`.
+ # 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.
+ # The minimum custom deadline you can specify is 10 seconds.
+ # The maximum custom deadline you can specify is 600 seconds (10 minutes).
+ # If this parameter is 0, a default value of 10 seconds is used.
+ #
+ # 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.
+ "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 pushed message. This attribute
+ # indicates the version of the data expected by the endpoint. This
+ # controls the shape of the pushed message (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",
+ },
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use "https://example.com/push".
+ },
+ "name": "A 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"`.
+ }</pre>
</div>
<div class="method">
@@ -357,66 +355,65 @@
An object of the form:
{ # A subscription resource.
- "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 minimum custom deadline you can specify is 10 seconds.
- # The maximum custom deadline you can specify is 600 seconds (10 minutes).
- # If this parameter is 0, a default value of 10 seconds is used.
- #
- # 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.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
- # Format is `projects/{project}/topics/{topic}`.
- # The value of this field will be `_deleted-topic_` if the topic has been
- # deleted.
- "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.
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ # Format is `projects/{project}/topics/{topic}`.
+ # 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).
#
- # Every endpoint has a set of API supported attributes that can be used to
- # control different aspects of the message delivery.
+ # 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 minimum custom deadline you can specify is 10 seconds.
+ # The maximum custom deadline you can specify is 600 seconds (10 minutes).
+ # If this parameter is 0, a default value of 10 seconds is used.
#
- # 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.
+ # For push delivery, this value is also used to set the request timeout for
+ # the call to the push endpoint.
#
- # 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",
+ # If the subscriber never acknowledges the message, the Pub/Sub
+ # system will eventually redeliver the message.
+ "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 pushed message. This attribute
+ # indicates the version of the data expected by the endpoint. This
+ # controls the shape of the pushed message (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",
+ },
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use "https://example.com/push".
},
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use "https://example.com/push".
- },
- "name": "A 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"`.
- }</pre>
+ "name": "A 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"`.
+ }</pre>
</div>
<div class="method">
@@ -427,8 +424,7 @@
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)
+See the operation documentation for the appropriate value for this field. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -540,66 +536,65 @@
# `ListSubscriptionsRequest` to get more subscriptions.
"subscriptions": [ # The subscriptions that match the request.
{ # A subscription resource.
- "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 minimum custom deadline you can specify is 10 seconds.
- # The maximum custom deadline you can specify is 600 seconds (10 minutes).
- # If this parameter is 0, a default value of 10 seconds is used.
- #
- # 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.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
- # Format is `projects/{project}/topics/{topic}`.
- # The value of this field will be `_deleted-topic_` if the topic has been
- # deleted.
- "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.
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ # Format is `projects/{project}/topics/{topic}`.
+ # 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).
#
- # Every endpoint has a set of API supported attributes that can be used to
- # control different aspects of the message delivery.
+ # 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 minimum custom deadline you can specify is 10 seconds.
+ # The maximum custom deadline you can specify is 600 seconds (10 minutes).
+ # If this parameter is 0, a default value of 10 seconds is used.
#
- # 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.
+ # For push delivery, this value is also used to set the request timeout for
+ # the call to the push endpoint.
#
- # 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",
+ # If the subscriber never acknowledges the message, the Pub/Sub
+ # system will eventually redeliver the message.
+ "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 pushed message. This attribute
+ # indicates the version of the data expected by the endpoint. This
+ # controls the shape of the pushed message (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",
+ },
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use "https://example.com/push".
},
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use "https://example.com/push".
+ "name": "A 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"`.
},
- "name": "A 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"`.
- },
],
}</pre>
</div>
@@ -693,11 +688,10 @@
# 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
+ # use to change the format of the pushed 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.
+ # controls the shape of the pushed message (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
@@ -801,8 +795,7 @@
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)
+See the operation documentation for the appropriate value for this field. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -986,8 +979,7 @@
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)
+See the operation documentation for the appropriate value for this field. (required)
body: object, The request body. (required)
The object takes the form of:
diff --git a/docs/dyn/pubsub_v1.projects.topics.html b/docs/dyn/pubsub_v1.projects.topics.html
index c006cb7..3110294 100644
--- a/docs/dyn/pubsub_v1.projects.topics.html
+++ b/docs/dyn/pubsub_v1.projects.topics.html
@@ -212,8 +212,7 @@
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)
+See the operation documentation for the appropriate value for this field. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -404,8 +403,7 @@
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)
+See the operation documentation for the appropriate value for this field. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -589,8 +587,7 @@
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)
+See the operation documentation for the appropriate value for this field. (required)
body: object, The request body. (required)
The object takes the form of:
diff --git a/docs/dyn/pubsub_v1beta1a.subscriptions.html b/docs/dyn/pubsub_v1beta1a.subscriptions.html
index 03f1af9..4b460c7 100644
--- a/docs/dyn/pubsub_v1beta1a.subscriptions.html
+++ b/docs/dyn/pubsub_v1beta1a.subscriptions.html
@@ -164,6 +164,43 @@
The object takes the form of:
{ # A subscription resource.
+ "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
+ # subscriber receives a message before the subscriber should acknowledge or
+ # Nack the message. If the Ack deadline for a message passes without an
+ # Ack or a Nack, the Pub/Sub system will eventually redeliver the message.
+ # If a subscriber acknowledges after the deadline, the Pub/Sub system may
+ # accept the Ack, but it is possible that the message has been already
+ # delivered again. Multiple Acks to the message are allowed and will
+ # succeed.
+ #
+ # For push delivery, this value is used to set the request timeout for
+ # the call to the push endpoint.
+ #
+ # For pull delivery, this value is used as the initial value for the Ack
+ # deadline. It may be overridden for each message using its corresponding
+ # ack_id with <code>ModifyAckDeadline</code>.
+ # While a message is outstanding (i.e. it has been delivered to a pull
+ # subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub
+ # system will not deliver that message to another pull subscriber
+ # (on a best-effort basis).
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
+ # used to configure it.
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use "https://example.com/push".
+ },
+ "name": "A String", # Name of the subscription.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A subscription resource.
"ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
# subscriber receives a message before the subscriber should acknowledge or
# Nack the message. If the Ack deadline for a message passes without an
@@ -172,10 +209,10 @@
# accept the Ack, but it is possible that the message has been already
# delivered again. Multiple Acks to the message are allowed and will
# succeed.
- #
+ #
# For push delivery, this value is used to set the request timeout for
# the call to the push endpoint.
- #
+ #
# For pull delivery, this value is used as the initial value for the Ack
# deadline. It may be overridden for each message using its corresponding
# ack_id with <code>ModifyAckDeadline</code>.
@@ -190,44 +227,7 @@
# For example, a Webhook endpoint might use "https://example.com/push".
},
"name": "A String", # Name of the subscription.
- }
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # A subscription resource.
- "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
- # subscriber receives a message before the subscriber should acknowledge or
- # Nack the message. If the Ack deadline for a message passes without an
- # Ack or a Nack, the Pub/Sub system will eventually redeliver the message.
- # If a subscriber acknowledges after the deadline, the Pub/Sub system may
- # accept the Ack, but it is possible that the message has been already
- # delivered again. Multiple Acks to the message are allowed and will
- # succeed.
- #
- # For push delivery, this value is used to set the request timeout for
- # the call to the push endpoint.
- #
- # For pull delivery, this value is used as the initial value for the Ack
- # deadline. It may be overridden for each message using its corresponding
- # ack_id with <code>ModifyAckDeadline</code>.
- # While a message is outstanding (i.e. it has been delivered to a pull
- # subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub
- # system will not deliver that message to another pull subscriber
- # (on a best-effort basis).
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
- "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
- # used to configure it.
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use "https://example.com/push".
- },
- "name": "A String", # Name of the subscription.
- }</pre>
+ }</pre>
</div>
<div class="method">
@@ -278,33 +278,33 @@
An object of the form:
{ # A subscription resource.
- "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
- # subscriber receives a message before the subscriber should acknowledge or
- # Nack the message. If the Ack deadline for a message passes without an
- # Ack or a Nack, the Pub/Sub system will eventually redeliver the message.
- # If a subscriber acknowledges after the deadline, the Pub/Sub system may
- # accept the Ack, but it is possible that the message has been already
- # delivered again. Multiple Acks to the message are allowed and will
- # succeed.
- #
- # For push delivery, this value is used to set the request timeout for
- # the call to the push endpoint.
- #
- # For pull delivery, this value is used as the initial value for the Ack
- # deadline. It may be overridden for each message using its corresponding
- # ack_id with <code>ModifyAckDeadline</code>.
- # While a message is outstanding (i.e. it has been delivered to a pull
- # subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub
- # system will not deliver that message to another pull subscriber
- # (on a best-effort basis).
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
- "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
- # used to configure it.
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use "https://example.com/push".
- },
- "name": "A String", # Name of the subscription.
- }</pre>
+ "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
+ # subscriber receives a message before the subscriber should acknowledge or
+ # Nack the message. If the Ack deadline for a message passes without an
+ # Ack or a Nack, the Pub/Sub system will eventually redeliver the message.
+ # If a subscriber acknowledges after the deadline, the Pub/Sub system may
+ # accept the Ack, but it is possible that the message has been already
+ # delivered again. Multiple Acks to the message are allowed and will
+ # succeed.
+ #
+ # For push delivery, this value is used to set the request timeout for
+ # the call to the push endpoint.
+ #
+ # For pull delivery, this value is used as the initial value for the Ack
+ # deadline. It may be overridden for each message using its corresponding
+ # ack_id with <code>ModifyAckDeadline</code>.
+ # While a message is outstanding (i.e. it has been delivered to a pull
+ # subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub
+ # system will not deliver that message to another pull subscriber
+ # (on a best-effort basis).
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
+ # used to configure it.
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use "https://example.com/push".
+ },
+ "name": "A String", # Name of the subscription.
+ }</pre>
</div>
<div class="method">
@@ -330,33 +330,33 @@
# <code>ListSubscriptionsRequest</code> to continue.
"subscription": [ # The subscriptions that match the request.
{ # A subscription resource.
- "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
- # subscriber receives a message before the subscriber should acknowledge or
- # Nack the message. If the Ack deadline for a message passes without an
- # Ack or a Nack, the Pub/Sub system will eventually redeliver the message.
- # If a subscriber acknowledges after the deadline, the Pub/Sub system may
- # accept the Ack, but it is possible that the message has been already
- # delivered again. Multiple Acks to the message are allowed and will
- # succeed.
- #
- # For push delivery, this value is used to set the request timeout for
- # the call to the push endpoint.
- #
- # For pull delivery, this value is used as the initial value for the Ack
- # deadline. It may be overridden for each message using its corresponding
- # ack_id with <code>ModifyAckDeadline</code>.
- # While a message is outstanding (i.e. it has been delivered to a pull
- # subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub
- # system will not deliver that message to another pull subscriber
- # (on a best-effort basis).
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
- "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
- # used to configure it.
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use "https://example.com/push".
- },
- "name": "A String", # Name of the subscription.
+ "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
+ # subscriber receives a message before the subscriber should acknowledge or
+ # Nack the message. If the Ack deadline for a message passes without an
+ # Ack or a Nack, the Pub/Sub system will eventually redeliver the message.
+ # If a subscriber acknowledges after the deadline, the Pub/Sub system may
+ # accept the Ack, but it is possible that the message has been already
+ # delivered again. Multiple Acks to the message are allowed and will
+ # succeed.
+ #
+ # For push delivery, this value is used to set the request timeout for
+ # the call to the push endpoint.
+ #
+ # For pull delivery, this value is used as the initial value for the Ack
+ # deadline. It may be overridden for each message using its corresponding
+ # ack_id with <code>ModifyAckDeadline</code>.
+ # While a message is outstanding (i.e. it has been delivered to a pull
+ # subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub
+ # system will not deliver that message to another pull subscriber
+ # (on a best-effort basis).
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
+ # used to configure it.
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use "https://example.com/push".
},
+ "name": "A String", # Name of the subscription.
+ },
],
}</pre>
</div>
@@ -391,12 +391,12 @@
# request.
"ackId": "A String", # The acknowledgment ID. Either this or ack_ids must be populated,
# not both.
+ "subscription": "A String", # Next Index: 5
+ # The name of the subscription from which messages are being pulled.
"ackIds": [ # List of acknowledgment IDs. Either this field or ack_id
# should be populated, not both.
"A String",
],
- "subscription": "A String", # Next Index: 5
- # The name of the subscription from which messages are being pulled.
}
x__xgafv: string, V1 error format.
diff --git a/docs/dyn/pubsub_v1beta2.projects.subscriptions.html b/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
index 5d1a152..1f00d47 100644
--- a/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
+++ b/docs/dyn/pubsub_v1beta2.projects.subscriptions.html
@@ -174,23 +174,91 @@
The object takes the form of:
{ # A subscription resource.
+ "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.
+ "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.
+ "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",
+ },
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use "https://example.com/push".
+ },
+ "name": "A 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"`.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A subscription resource.
"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.
"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
@@ -231,75 +299,7 @@
# (`[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"`.
- }
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # A subscription resource.
- "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.
- "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.
- "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",
- },
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use "https://example.com/push".
- },
- "name": "A 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"`.
- }</pre>
+ }</pre>
</div>
<div class="method">
@@ -347,64 +347,64 @@
An object of the form:
{ # A subscription resource.
- "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).
+ "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.
+ "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.
+ "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.
#
- # 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).
+ # Every endpoint has a set of API supported attributes that can be used to
+ # control different aspects of the message delivery.
#
- # For push delivery, this value is also used to set the request timeout for
- # the call to the push endpoint.
+ # 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 the subscriber never acknowledges the message, the Pub/Sub
- # system will eventually redeliver the message.
+ # 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.
#
- # If this parameter is 0, a default value of 10 seconds is used.
- "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.
- "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",
- },
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use "https://example.com/push".
+ # 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",
},
- "name": "A 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"`.
- }</pre>
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use "https://example.com/push".
+ },
+ "name": "A 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"`.
+ }</pre>
</div>
<div class="method">
@@ -415,8 +415,7 @@
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)
+See the operation documentation for the appropriate value for this field. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -527,64 +526,64 @@
# `ListSubscriptionsRequest` to get more subscriptions.
"subscriptions": [ # The subscriptions that match the request.
{ # A subscription resource.
- "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).
+ "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.
+ "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.
+ "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.
#
- # 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).
+ # Every endpoint has a set of API supported attributes that can be used to
+ # control different aspects of the message delivery.
#
- # For push delivery, this value is also used to set the request timeout for
- # the call to the push endpoint.
+ # 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 the subscriber never acknowledges the message, the Pub/Sub
- # system will eventually redeliver the message.
+ # 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.
#
- # If this parameter is 0, a default value of 10 seconds is used.
- "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.
- "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",
- },
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use "https://example.com/push".
+ # 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",
},
- "name": "A 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"`.
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use "https://example.com/push".
},
+ "name": "A 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"`.
+ },
],
}</pre>
</div>
@@ -783,8 +782,7 @@
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)
+See the operation documentation for the appropriate value for this field. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -968,8 +966,7 @@
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)
+See the operation documentation for the appropriate value for this field. (required)
body: object, The request body. (required)
The object takes the form of:
diff --git a/docs/dyn/pubsub_v1beta2.projects.topics.html b/docs/dyn/pubsub_v1beta2.projects.topics.html
index 1f5c349..aec060c 100644
--- a/docs/dyn/pubsub_v1beta2.projects.topics.html
+++ b/docs/dyn/pubsub_v1beta2.projects.topics.html
@@ -210,8 +210,7 @@
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)
+See the operation documentation for the appropriate value for this field. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -401,8 +400,7 @@
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)
+See the operation documentation for the appropriate value for this field. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -586,8 +584,7 @@
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)
+See the operation documentation for the appropriate value for this field. (required)
body: object, The request body. (required)
The object takes the form of:
diff --git a/docs/dyn/reseller_v1.subscriptions.html b/docs/dyn/reseller_v1.subscriptions.html
index 40332da..19a66fa 100644
--- a/docs/dyn/reseller_v1.subscriptions.html
+++ b/docs/dyn/reseller_v1.subscriptions.html
@@ -148,6 +148,7 @@
},
"creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
"kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "skuName": "A String", # Read-only external display name for a product's SKU assigned to a customer in the subscription. SKU names are subject to change at Google's discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
"transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
"transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
"minimumTransferableSeats": 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
@@ -254,6 +255,7 @@
},
"creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
"kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "skuName": "A String", # Read-only external display name for a product's SKU assigned to a customer in the subscription. SKU names are subject to change at Google's discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
"transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
"transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
"minimumTransferableSeats": 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
@@ -340,6 +342,7 @@
},
"creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
"kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "skuName": "A String", # Read-only external display name for a product's SKU assigned to a customer in the subscription. SKU names are subject to change at Google's discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
"transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
"transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
"minimumTransferableSeats": 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
@@ -434,6 +437,7 @@
},
"creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
"kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "skuName": "A String", # Read-only external display name for a product's SKU assigned to a customer in the subscription. SKU names are subject to change at Google's discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
"transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
"transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
"minimumTransferableSeats": 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
@@ -534,6 +538,7 @@
},
"creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
"kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "skuName": "A String", # Read-only external display name for a product's SKU assigned to a customer in the subscription. SKU names are subject to change at Google's discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
"transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
"transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
"minimumTransferableSeats": 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
@@ -610,6 +615,7 @@
},
"creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
"kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "skuName": "A String", # Read-only external display name for a product's SKU assigned to a customer in the subscription. SKU names are subject to change at Google's discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
"transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
"transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
"minimumTransferableSeats": 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
@@ -681,6 +687,7 @@
},
"creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
"kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "skuName": "A String", # Read-only external display name for a product's SKU assigned to a customer in the subscription. SKU names are subject to change at Google's discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
"transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
"transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
"minimumTransferableSeats": 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
@@ -768,6 +775,7 @@
},
"creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
"kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "skuName": "A String", # Read-only external display name for a product's SKU assigned to a customer in the subscription. SKU names are subject to change at Google's discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
"transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
"transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
"minimumTransferableSeats": 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
@@ -862,6 +870,7 @@
},
"creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
"kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "skuName": "A String", # Read-only external display name for a product's SKU assigned to a customer in the subscription. SKU names are subject to change at Google's discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
"transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
"transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
"minimumTransferableSeats": 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
@@ -940,6 +949,7 @@
},
"creationTime": "A String", # The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.
"kind": "reseller#subscription", # Identifies the resource as a Subscription. Value: reseller#subscription
+ "skuName": "A String", # Read-only external display name for a product's SKU assigned to a customer in the subscription. SKU names are subject to change at Google's discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.
"transferInfo": { # Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.
"transferabilityExpirationTime": "A String", # The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.
"minimumTransferableSeats": 42, # When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.
diff --git a/docs/dyn/runtimeconfig_v1.operations.html b/docs/dyn/runtimeconfig_v1.operations.html
index 991cd90..21651dc 100644
--- a/docs/dyn/runtimeconfig_v1.operations.html
+++ b/docs/dyn/runtimeconfig_v1.operations.html
@@ -179,6 +179,7 @@
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.
@@ -188,6 +189,22 @@
# 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 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:
@@ -251,25 +268,8 @@
},
],
},
- "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`.
},
],
- "nextPageToken": "A String", # The standard List next-page token.
}</pre>
</div>
diff --git a/docs/dyn/runtimeconfig_v1beta1.projects.configs.waiters.html b/docs/dyn/runtimeconfig_v1beta1.projects.configs.waiters.html
index 4858e7a..1a2eefb 100644
--- a/docs/dyn/runtimeconfig_v1beta1.projects.configs.waiters.html
+++ b/docs/dyn/runtimeconfig_v1beta1.projects.configs.waiters.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(name=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about a single waiter.</p>
<p class="toc_element">
- <code><a href="#list">list(parent=None, 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">List waiters within the given configuration.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -564,7 +564,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(parent=None, 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>List waiters within the given configuration.
Args:
@@ -572,14 +572,14 @@
The configuration must exist beforehand; the path must by in the format:
`projects/[PROJECT_ID]/configs/[CONFIG_NAME]` (required)
- pageSize: integer, Specifies the number of results to return per page. If there are fewer
-elements than the specified number, returns all elements.
pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
returned by a previous list request to get the next page of results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
+ pageSize: integer, Specifies the number of results to return per page. If there are fewer
+elements than the specified number, returns all elements.
Returns:
An object of the form:
diff --git a/docs/dyn/safebrowsing_v4.encodedFullHashes.html b/docs/dyn/safebrowsing_v4.encodedFullHashes.html
index fe4247f..b6fba52 100644
--- a/docs/dyn/safebrowsing_v4.encodedFullHashes.html
+++ b/docs/dyn/safebrowsing_v4.encodedFullHashes.html
@@ -103,8 +103,8 @@
# to know the metadata key/value pairs associated with each threat type.
"entries": [ # The metadata entries.
{ # A single metadata entry.
- "key": "A String", # The metadata entry key. For JSON requests, the key is base64-encoded.
"value": "A String", # The metadata entry value. For JSON requests, the value is base64-encoded.
+ "key": "A String", # The metadata entry key. For JSON requests, the key is base64-encoded.
},
],
},
diff --git a/docs/dyn/safebrowsing_v4.fullHashes.html b/docs/dyn/safebrowsing_v4.fullHashes.html
index 3281c1a..2647d59 100644
--- a/docs/dyn/safebrowsing_v4.fullHashes.html
+++ b/docs/dyn/safebrowsing_v4.fullHashes.html
@@ -103,12 +103,6 @@
"threatTypes": [ # The threat types to be checked.
"A String",
],
- "threatEntryTypes": [ # The entry types to be checked.
- "A String",
- ],
- "platformTypes": [ # The platform types to be checked.
- "A String",
- ],
"threatEntries": [ # The threat entries to be checked.
{ # An individual threat; for example, a malicious URL or its hash
# representation. Only one of these fields should be set.
@@ -120,6 +114,12 @@
# binary and hex digests. For JSON requests, digests are base64-encoded.
},
],
+ "platformTypes": [ # The platform types to be checked.
+ "A String",
+ ],
+ "threatEntryTypes": [ # The entry types to be checked.
+ "A String",
+ ],
},
"clientStates": [ # The current client states for each of the client's local threat lists.
"A String",
@@ -142,8 +142,8 @@
# to know the metadata key/value pairs associated with each threat type.
"entries": [ # The metadata entries.
{ # A single metadata entry.
- "key": "A String", # The metadata entry key. For JSON requests, the key is base64-encoded.
"value": "A String", # The metadata entry value. For JSON requests, the value is base64-encoded.
+ "key": "A String", # The metadata entry key. For JSON requests, the key is base64-encoded.
},
],
},
diff --git a/docs/dyn/safebrowsing_v4.threatMatches.html b/docs/dyn/safebrowsing_v4.threatMatches.html
index cd7242a..3379a46 100644
--- a/docs/dyn/safebrowsing_v4.threatMatches.html
+++ b/docs/dyn/safebrowsing_v4.threatMatches.html
@@ -97,12 +97,6 @@
"threatTypes": [ # The threat types to be checked.
"A String",
],
- "threatEntryTypes": [ # The entry types to be checked.
- "A String",
- ],
- "platformTypes": [ # The platform types to be checked.
- "A String",
- ],
"threatEntries": [ # The threat entries to be checked.
{ # An individual threat; for example, a malicious URL or its hash
# representation. Only one of these fields should be set.
@@ -114,6 +108,12 @@
# binary and hex digests. For JSON requests, digests are base64-encoded.
},
],
+ "platformTypes": [ # The platform types to be checked.
+ "A String",
+ ],
+ "threatEntryTypes": [ # The entry types to be checked.
+ "A String",
+ ],
},
}
@@ -133,8 +133,8 @@
# to know the metadata key/value pairs associated with each threat type.
"entries": [ # The metadata entries.
{ # A single metadata entry.
- "key": "A String", # The metadata entry key. For JSON requests, the key is base64-encoded.
"value": "A String", # The metadata entry value. For JSON requests, the value is base64-encoded.
+ "key": "A String", # The metadata entry key. For JSON requests, the key is base64-encoded.
},
],
},
diff --git a/docs/dyn/script_v1.scripts.html b/docs/dyn/script_v1.scripts.html
index 1af2199..d40b75a 100644
--- a/docs/dyn/script_v1.scripts.html
+++ b/docs/dyn/script_v1.scripts.html
@@ -101,16 +101,6 @@
# based on the implementation of the script.
"function": "A String", # The name of the function to execute in the given script. The name does not
# include parentheses or parameters.
- "devMode": True or False, # If `true` and the user is an owner of the script, the script runs at the
- # most recently saved version rather than the version deployed for use with
- # the Execution API. Optional; default is `false`.
- "parameters": [ # The parameters to be passed to the function being executed. The object type
- # for each parameter should match the expected type in Apps Script.
- # Parameters cannot be Apps Script-specific object types (such as a
- # `Document` or a `Calendar`); they can only be primitive types such as
- # `string`, `number`, `array`, `object`, or `boolean`. Optional.
- "",
- ],
"sessionState": "A String", # For Android add-ons only. An ID that represents the user's current session
# in the Android app for Google Docs or Sheets, included as extra data in the
# [`Intent`](https://developer.android.com/guide/components/intents-filters.html)
@@ -121,6 +111,16 @@
# (in Docs) or selected cell (in Sheets). To retrieve the state, call
# `Intent.getStringExtra("com.google.android.apps.docs.addons.SessionState")`.
# Optional.
+ "parameters": [ # The parameters to be passed to the function being executed. The object type
+ # for each parameter should match the expected type in Apps Script.
+ # Parameters cannot be Apps Script-specific object types (such as a
+ # `Document` or a `Calendar`); they can only be primitive types such as
+ # `string`, `number`, `array`, `object`, or `boolean`. Optional.
+ "",
+ ],
+ "devMode": True or False, # If `true` and the user is an owner of the script, the script runs at the
+ # most recently saved version rather than the version deployed for use with
+ # the Execution API. Optional; default is `false`.
}
x__xgafv: string, V1 error format.
diff --git a/docs/dyn/servicecontrol_v1.services.html b/docs/dyn/servicecontrol_v1.services.html
index 5a42bf5..928e631 100644
--- a/docs/dyn/servicecontrol_v1.services.html
+++ b/docs/dyn/servicecontrol_v1.services.html
@@ -102,6 +102,16 @@
permission on the specified service. For more information, see
[Google Cloud IAM](https://cloud.google.com/iam).
+**NOTE:** the client code **must** fail-open if the server returns one
+of the following quota errors:
+- `PROJECT_STATUS_UNAVAILABLE`
+- `SERVICE_STATUS_UNAVAILABLE`
+- `BILLING_STATUS_UNAVAILABLE`
+- `QUOTA_SYSTEM_UNAVAILABLE`
+
+The server may inject above errors to prohibit any hard dependency
+on the quota system.
+
Args:
serviceName: string, Name of the service as specified in the service configuration. For example,
`"pubsub.googleapis.com"`.
@@ -133,14 +143,14 @@
"metricValues": [ # The values in this metric.
{ # Represents a single metric value.
"moneyValue": { # Represents an amount of money with its currency type. # A money value.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"labels": { # The labels describing the metric value.
@@ -276,15 +286,6 @@
An object of the form:
{ # Response message for the AllocateQuota method.
- "allocateErrors": [ # Indicates the decision of the allocate.
- {
- "code": "A String", # Error code.
- "description": "A String", # Free-form text that provides details on the cause of the error.
- "subject": "A String", # Subject to whom this error applies. See the specific enum for more details
- # on this field. For example, "clientip:<ip address of client>" or
- # "project:<Google developer project id>".
- },
- ],
"serviceConfigId": "A String", # ID of the actual config used to process the request.
"quotaMetrics": [ # Quota metrics to indicate the result of allocation. Depending on the
# request, one or more of the following metrics will be included:
@@ -300,20 +301,24 @@
# 3. For both rate quota and allocation quota, the quota limit reached
# condition will be specified using the following boolean metric:
# "serviceruntime.googleapis.com/quota/exceeded"
+ #
+ # 4. For allocation quota, value for each quota limit associated with
+ # the metrics will be specified using the following gauge metric:
+ # "serviceruntime.googleapis.com/quota/limit"
{ # Represents a set of metric values in the same metric.
# Each metric value in the set should have a unique combination of start time,
# end time, and label values.
"metricValues": [ # The values in this metric.
{ # Represents a single metric value.
"moneyValue": { # Represents an amount of money with its currency type. # A money value.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"labels": { # The labels describing the metric value.
@@ -411,6 +416,15 @@
"metricName": "A String", # The metric name defined in the service configuration.
},
],
+ "allocateErrors": [ # Indicates the decision of the allocate.
+ {
+ "code": "A String", # Error code.
+ "description": "A String", # Free-form text that provides details on the cause of the error.
+ "subject": "A String", # Subject to whom this error applies. See the specific enum for more details
+ # on this field. For example, "clientip:<ip address of client>" or
+ # "project:<Google developer project id>".
+ },
+ ],
"operationId": "A String", # The same operation_id value used in the AllocateQuotaRequest. Used for
# logging and diagnostics purposes.
}</pre>
@@ -449,7 +463,23 @@
# If unspecified or no matching version can be found, the
# latest one will be used.
"operation": { # Represents information regarding an operation. # The operation to be checked.
- "operationName": "A String", # Fully qualified name of the operation. Reserved for future use.
+ "labels": { # Labels describing the operation. Only the following labels are allowed:
+ #
+ # - Labels describing monitored resources as defined in
+ # the service configuration.
+ # - Default labels of metric values. When specified, labels defined in the
+ # metric value override these default.
+ # - The following labels defined by Google Cloud Platform:
+ # - `cloud.googleapis.com/location` describing the location where the
+ # operation happened,
+ # - `servicecontrol.googleapis.com/user_agent` describing the user agent
+ # of the API request,
+ # - `servicecontrol.googleapis.com/service_agent` describing the service
+ # used to handle the API request (e.g. ESP),
+ # - `servicecontrol.googleapis.com/platform` describing the platform
+ # where the API is served (e.g. GAE, GCE, GKE).
+ "a_key": "A String",
+ },
"metricValueSets": [ # Represents information about this operation. Each MetricValueSet
# corresponds to a metric defined in the service configuration.
# The data type used in the MetricValueSet must agree with
@@ -466,14 +496,14 @@
"metricValues": [ # The values in this metric.
{ # Represents a single metric value.
"moneyValue": { # Represents an amount of money with its currency type. # A money value.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"labels": { # The labels describing the metric value.
@@ -572,31 +602,9 @@
},
],
"importance": "A String", # DO NOT USE. This is an experimental field.
- "labels": { # Labels describing the operation. Only the following labels are allowed:
- #
- # - Labels describing monitored resources as defined in
- # the service configuration.
- # - Default labels of metric values. When specified, labels defined in the
- # metric value override these default.
- # - The following labels defined by Google Cloud Platform:
- # - `cloud.googleapis.com/location` describing the location where the
- # operation happened,
- # - `servicecontrol.googleapis.com/user_agent` describing the user agent
- # of the API request,
- # - `servicecontrol.googleapis.com/service_agent` describing the service
- # used to handle the API request (e.g. ESP),
- # - `servicecontrol.googleapis.com/platform` describing the platform
- # where the API is served (e.g. GAE, GCE, GKE).
- "a_key": "A String",
- },
+ "operationName": "A String", # Fully qualified name of the operation. Reserved for future use.
"quotaProperties": { # Represents the properties needed for quota operations. # Represents the properties needed for quota check. Applicable only if this
# operation is for a quota check request.
- #
- # Use the metric_value_sets field in Operation message to provide cost
- # override with metric_name in <service_name>/quota/<quota_group_name>/cost
- # format. Overrides for unmatched quota groups will be ignored.
- # Costs are expected to be >= 0. Cost 0 will cause no quota check,
- # but still traffic restrictions will be enforced.
"quotaMode": "A String", # Quota mode for this operation.
"limitByIds": { # LimitType IDs that should be used for checking quota. Key in this map
# should be a valid LimitType string, and the value is the ID to be used. For
@@ -622,9 +630,6 @@
# with.
"a_key": "A String",
},
- "endTime": "A String", # End time of the operation.
- # Required when the operation is used in ServiceController.Report,
- # but optional when the operation is used in ServiceController.Check.
"logEntries": [ # Represents information to be logged.
{ # An individual log entry.
"severity": "A String", # The severity of the log entry. The default value is
@@ -651,7 +656,6 @@
# `"book_log"`.
},
],
- "startTime": "A String", # Required. Start time of the operation.
"consumerId": "A String", # Identity of the consumer who is using the service.
# This field should be filled in for the operations initiated by a
# consumer, but not for service-initiated operations that are
@@ -661,6 +665,10 @@
# project:<project_id>,
# project_number:<project_number>,
# api_key:<api_key>.
+ "startTime": "A String", # Required. Start time of the operation.
+ "endTime": "A String", # End time of the operation.
+ # Required when the operation is used in ServiceController.Report,
+ # but optional when the operation is used in ServiceController.Check.
"operationId": "A String", # Identity of the operation. This must be unique within the scope of the
# service that generated the operation. If the service calls
# Check() and Report() on the same operation, the two calls should carry
@@ -685,6 +693,12 @@
{ # Response message for the Check method.
"serviceConfigId": "A String", # The actual config id used to process the request.
"quotaInfo": { # Contains the quota information for a quota check response. # Quota information for the check request associated with this response.
+ "quotaConsumed": { # Map of quota group name to the actual number of tokens consumed. If the
+ # quota check was not successful, then this will not be populated due to no
+ # quota consumption.
+ # Deprecated: Use quota_metrics to get per quota group usage.
+ "a_key": 42,
+ },
"quotaMetrics": [ # Quota metrics to indicate the usage. Depending on the check request, one or
# more of the following metrics will be included:
#
@@ -705,14 +719,14 @@
"metricValues": [ # The values in this metric.
{ # Represents a single metric value.
"moneyValue": { # Represents an amount of money with its currency type. # A money value.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"labels": { # The labels describing the metric value.
@@ -817,12 +831,6 @@
# Deprecated: Use quota_metrics to get per quota group limit exceeded status.
"A String",
],
- "quotaConsumed": { # Map of quota group name to the actual number of tokens consumed. If the
- # quota check was not successful, then this will not be populated due to no
- # quota consumption.
- # Deprecated: Use quota_metrics to get per quota group usage.
- "a_key": 42,
- },
},
"checkInfo": { # Feedback data returned from the server during processing a Check request.
"unusedArguments": [ # A list of fields and label keys that are ignored by the server.
@@ -885,14 +893,14 @@
"metricValues": [ # The values in this metric.
{ # Represents a single metric value.
"moneyValue": { # Represents an amount of money with its currency type. # A money value.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"labels": { # The labels describing the metric value.
@@ -1030,20 +1038,39 @@
{
"serviceConfigId": "A String", # ID of the actual config used to process the request.
"quotaMetrics": [ # Metric values as tracked by One Platform before the adjustment was made.
+ # The following metrics will be included:
+ #
+ # 1. Per quota metric total usage will be specified using the following gauge
+ # metric:
+ # "serviceruntime.googleapis.com/allocation/consumer/quota_used_count"
+ #
+ # 2. Value for each quota limit associated with the metrics will be specified
+ # using the following gauge metric:
+ # "serviceruntime.googleapis.com/quota/limit"
+ #
+ # 3. Delta value of the usage after the reconciliation for limits associated
+ # with the metrics will be specified using the following metric:
+ # "serviceruntime.googleapis.com/allocation/reconciliation_delta"
+ # The delta value is defined as:
+ # new_usage_from_client - existing_value_in_spanner.
+ # This metric is not defined in serviceruntime.yaml or in Cloud Monarch.
+ # This metric is meant for callers' use only. Since this metric is not
+ # defined in the monitoring backend, reporting on this metric will result in
+ # an error.
{ # Represents a set of metric values in the same metric.
# Each metric value in the set should have a unique combination of start time,
# end time, and label values.
"metricValues": [ # The values in this metric.
{ # Represents a single metric value.
"moneyValue": { # Represents an amount of money with its currency type. # A money value.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"labels": { # The labels describing the metric value.
@@ -1163,6 +1190,16 @@
permission on the specified service. For more information, see
[Google Cloud IAM](https://cloud.google.com/iam).
+**NOTE:** the client code **must** fail-open if the server returns one
+of the following quota errors:
+- `PROJECT_STATUS_UNAVAILABLE`
+- `SERVICE_STATUS_UNAVAILABLE`
+- `BILLING_STATUS_UNAVAILABLE`
+- `QUOTA_SYSTEM_UNAVAILABLE`
+
+The server may inject above errors to prohibit any hard dependency
+on the quota system.
+
Args:
serviceName: string, Name of the service as specified in the service configuration. For example,
`"pubsub.googleapis.com"`.
@@ -1189,14 +1226,14 @@
"metricValues": [ # The values in this metric.
{ # Represents a single metric value.
"moneyValue": { # Represents an amount of money with its currency type. # A money value.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"labels": { # The labels describing the metric value.
@@ -1346,20 +1383,24 @@
# 2. For allocation quota, per quota metric total usage will be specified
# using the following gauge metric:
# "serviceruntime.googleapis.com/allocation/consumer/quota_used_count"
+ #
+ # 3. For allocation quota, value for each quota limit associated with
+ # the metrics will be specified using the following gauge metric:
+ # "serviceruntime.googleapis.com/quota/limit"
{ # Represents a set of metric values in the same metric.
# Each metric value in the set should have a unique combination of start time,
# end time, and label values.
"metricValues": [ # The values in this metric.
{ # Represents a single metric value.
"moneyValue": { # Represents an amount of money with its currency type. # A money value.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"labels": { # The labels describing the metric value.
@@ -1508,7 +1549,23 @@
# should be no larger than 1MB. See ReportResponse.report_errors for
# partial failure behavior.
{ # Represents information regarding an operation.
- "operationName": "A String", # Fully qualified name of the operation. Reserved for future use.
+ "labels": { # Labels describing the operation. Only the following labels are allowed:
+ #
+ # - Labels describing monitored resources as defined in
+ # the service configuration.
+ # - Default labels of metric values. When specified, labels defined in the
+ # metric value override these default.
+ # - The following labels defined by Google Cloud Platform:
+ # - `cloud.googleapis.com/location` describing the location where the
+ # operation happened,
+ # - `servicecontrol.googleapis.com/user_agent` describing the user agent
+ # of the API request,
+ # - `servicecontrol.googleapis.com/service_agent` describing the service
+ # used to handle the API request (e.g. ESP),
+ # - `servicecontrol.googleapis.com/platform` describing the platform
+ # where the API is served (e.g. GAE, GCE, GKE).
+ "a_key": "A String",
+ },
"metricValueSets": [ # Represents information about this operation. Each MetricValueSet
# corresponds to a metric defined in the service configuration.
# The data type used in the MetricValueSet must agree with
@@ -1525,14 +1582,14 @@
"metricValues": [ # The values in this metric.
{ # Represents a single metric value.
"moneyValue": { # Represents an amount of money with its currency type. # A money value.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"labels": { # The labels describing the metric value.
@@ -1631,31 +1688,9 @@
},
],
"importance": "A String", # DO NOT USE. This is an experimental field.
- "labels": { # Labels describing the operation. Only the following labels are allowed:
- #
- # - Labels describing monitored resources as defined in
- # the service configuration.
- # - Default labels of metric values. When specified, labels defined in the
- # metric value override these default.
- # - The following labels defined by Google Cloud Platform:
- # - `cloud.googleapis.com/location` describing the location where the
- # operation happened,
- # - `servicecontrol.googleapis.com/user_agent` describing the user agent
- # of the API request,
- # - `servicecontrol.googleapis.com/service_agent` describing the service
- # used to handle the API request (e.g. ESP),
- # - `servicecontrol.googleapis.com/platform` describing the platform
- # where the API is served (e.g. GAE, GCE, GKE).
- "a_key": "A String",
- },
+ "operationName": "A String", # Fully qualified name of the operation. Reserved for future use.
"quotaProperties": { # Represents the properties needed for quota operations. # Represents the properties needed for quota check. Applicable only if this
# operation is for a quota check request.
- #
- # Use the metric_value_sets field in Operation message to provide cost
- # override with metric_name in <service_name>/quota/<quota_group_name>/cost
- # format. Overrides for unmatched quota groups will be ignored.
- # Costs are expected to be >= 0. Cost 0 will cause no quota check,
- # but still traffic restrictions will be enforced.
"quotaMode": "A String", # Quota mode for this operation.
"limitByIds": { # LimitType IDs that should be used for checking quota. Key in this map
# should be a valid LimitType string, and the value is the ID to be used. For
@@ -1681,9 +1716,6 @@
# with.
"a_key": "A String",
},
- "endTime": "A String", # End time of the operation.
- # Required when the operation is used in ServiceController.Report,
- # but optional when the operation is used in ServiceController.Check.
"logEntries": [ # Represents information to be logged.
{ # An individual log entry.
"severity": "A String", # The severity of the log entry. The default value is
@@ -1710,7 +1742,6 @@
# `"book_log"`.
},
],
- "startTime": "A String", # Required. Start time of the operation.
"consumerId": "A String", # Identity of the consumer who is using the service.
# This field should be filled in for the operations initiated by a
# consumer, but not for service-initiated operations that are
@@ -1720,6 +1751,10 @@
# project:<project_id>,
# project_number:<project_number>,
# api_key:<api_key>.
+ "startTime": "A String", # Required. Start time of the operation.
+ "endTime": "A String", # End time of the operation.
+ # Required when the operation is used in ServiceController.Report,
+ # but optional when the operation is used in ServiceController.Check.
"operationId": "A String", # Identity of the operation. This must be unique within the scope of the
# service that generated the operation. If the service calls
# Check() and Report() on the same operation, the two calls should carry
@@ -1747,7 +1782,87 @@
An object of the form:
{ # Response message for the Report method.
- "serviceConfigId": "A String", # The actual config id used to process the request.
+ "reportErrors": [ # Partial failures, one for each `Operation` in the request that failed
+ # processing. There are three possible combinations of the RPC status:
+ #
+ # 1. The combination of a successful RPC status and an empty `report_errors`
+ # list indicates a complete success where all `Operations` in the
+ # request are processed successfully.
+ # 2. The combination of a successful RPC status and a non-empty
+ # `report_errors` list indicates a partial success where some
+ # `Operations` in the request succeeded. Each
+ # `Operation` that failed processing has a corresponding item
+ # in this list.
+ # 3. A failed RPC status indicates a general non-deterministic failure.
+ # When this happens, it's impossible to know which of the
+ # 'Operations' in the request succeeded or failed.
+ { # Represents the processing error of one `Operation` in the request.
+ "status": { # The `Status` type defines a logical error model that is suitable for different # Details of the error when processing the `Operation`.
+ # 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.
+ },
+ ],
+ },
+ "operationId": "A String", # The Operation.operation_id value from the request.
+ },
+ ],
"reportInfos": [ # Quota usage for each quota release `Operation` request.
#
# Fully or partially failed quota release request may or may not be present
@@ -1758,6 +1873,12 @@
# If there is no quota release request, report_quota_info will be empty.
{
"quotaInfo": { # Contains the quota information for a quota check response. # Quota usage info when processing the `Operation`.
+ "quotaConsumed": { # Map of quota group name to the actual number of tokens consumed. If the
+ # quota check was not successful, then this will not be populated due to no
+ # quota consumption.
+ # Deprecated: Use quota_metrics to get per quota group usage.
+ "a_key": 42,
+ },
"quotaMetrics": [ # Quota metrics to indicate the usage. Depending on the check request, one or
# more of the following metrics will be included:
#
@@ -1778,14 +1899,14 @@
"metricValues": [ # The values in this metric.
{ # Represents a single metric value.
"moneyValue": { # Represents an amount of money with its currency type. # A money value.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"labels": { # The labels describing the metric value.
@@ -1890,97 +2011,11 @@
# Deprecated: Use quota_metrics to get per quota group limit exceeded status.
"A String",
],
- "quotaConsumed": { # Map of quota group name to the actual number of tokens consumed. If the
- # quota check was not successful, then this will not be populated due to no
- # quota consumption.
- # Deprecated: Use quota_metrics to get per quota group usage.
- "a_key": 42,
- },
},
"operationId": "A String", # The Operation.operation_id value from the request.
},
],
- "reportErrors": [ # Partial failures, one for each `Operation` in the request that failed
- # processing. There are three possible combinations of the RPC status:
- #
- # 1. The combination of a successful RPC status and an empty `report_errors`
- # list indicates a complete success where all `Operations` in the
- # request are processed successfully.
- # 2. The combination of a successful RPC status and a non-empty
- # `report_errors` list indicates a partial success where some
- # `Operations` in the request succeeded. Each
- # `Operation` that failed processing has a corresponding item
- # in this list.
- # 3. A failed RPC status indicates a general non-deterministic failure.
- # When this happens, it's impossible to know which of the
- # 'Operations' in the request succeeded or failed.
- { # Represents the processing error of one `Operation` in the request.
- "status": { # The `Status` type defines a logical error model that is suitable for different # Details of the error when processing the `Operation`.
- # 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.
- },
- ],
- },
- "operationId": "A String", # The Operation.operation_id value from the request.
- },
- ],
+ "serviceConfigId": "A String", # The actual config id used to process the request.
}</pre>
</div>
@@ -2041,14 +2076,14 @@
"metricValues": [ # The values in this metric.
{ # Represents a single metric value.
"moneyValue": { # Represents an amount of money with its currency type. # A money value.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"labels": { # The labels describing the metric value.
@@ -2186,21 +2221,29 @@
{
"serviceConfigId": "A String", # ID of the actual config used to process the request.
"quotaMetrics": [ # Metric values as tracked by One Platform before the start of
- # reconciliation.
+ # reconciliation. The following metrics will be included:
+ #
+ # 1. Per quota metric total usage will be specified using the following gauge
+ # metric:
+ # "serviceruntime.googleapis.com/allocation/consumer/quota_used_count"
+ #
+ # 2. Value for each quota limit associated with the metrics will be specified
+ # using the following gauge metric:
+ # "serviceruntime.googleapis.com/quota/limit"
{ # Represents a set of metric values in the same metric.
# Each metric value in the set should have a unique combination of start time,
# end time, and label values.
"metricValues": [ # The values in this metric.
{ # Represents a single metric value.
"moneyValue": { # Represents an amount of money with its currency type. # A money value.
- "units": "A String", # The whole units of the amount.
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"nanos": 42, # Number of nano (10^-9) units of the amount.
# The value must be between -999,999,999 and +999,999,999 inclusive.
# If `units` is positive, `nanos` must be positive or zero.
# If `units` is zero, `nanos` can be positive, zero, or negative.
# If `units` is negative, `nanos` must be negative or zero.
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount.
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
"currencyCode": "A String", # The 3-letter currency code defined in ISO 4217.
},
"labels": { # The labels describing the metric value.
diff --git a/docs/dyn/servicemanagement_v1.operations.html b/docs/dyn/servicemanagement_v1.operations.html
index acf76b4..26e7533 100644
--- a/docs/dyn/servicemanagement_v1.operations.html
+++ b/docs/dyn/servicemanagement_v1.operations.html
@@ -78,8 +78,8 @@
<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>
+ <code><a href="#list">list(name=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists service operations that match the specified filter in the request.</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>
@@ -191,17 +191,33 @@
</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`.
+ <code class="details" id="list">list(name=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists service operations that match the specified filter in the request.
Args:
- name: string, The name of the operation collection. (required)
- pageSize: integer, The standard list page size.
- filter: string, The standard list filter.
+ name: string, Not used.
+ pageSize: integer, The maximum number of operations to return. If unspecified, defaults to
+50. The maximum value is 100.
+ filter: string, A string for filtering Operations.
+ The following filter fields are supported:
+
+ * serviceName: Required. Only `=` operator is allowed.
+ * startTime: The time this job was started, in ISO 8601 format.
+ Allowed operators are `>=`, `>`, `<=`, and `<`.
+ * status: Can be `done`, `in_progress`, or `failed`. Allowed
+ operators are `=`, and `!=`.
+
+ Filter expression supports conjunction (AND) and disjunction (OR)
+ logical operators. However, the serviceName restriction must be at the
+ top-level and can only be combined with other restrictions via the AND
+ logical operator.
+
+ Examples:
+
+ * `serviceName={some-service}.googleapis.com`
+ * `serviceName={some-service}.googleapis.com AND startTime>="2017-02-01"`
+ * `serviceName={some-service}.googleapis.com AND status=done`
+ * `serviceName={some-service}.googleapis.com AND (status=done OR startTime>="2017-02-01")`
pageToken: string, The standard list page token.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/servicemanagement_v1.services.configs.html b/docs/dyn/servicemanagement_v1.services.configs.html
index 8db8b79..de8c44b 100644
--- a/docs/dyn/servicemanagement_v1.services.configs.html
+++ b/docs/dyn/servicemanagement_v1.services.configs.html
@@ -143,9 +143,10 @@
# 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.
+ "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"`.
"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"`.
@@ -155,10 +156,9 @@
"key": "A String", # The label key.
},
],
- "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"`.
+ "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.
"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
@@ -189,12 +189,12 @@
],
"displayName": "A String", # The human-readable name for this log. This information appears on
# the user interface and should be concise.
+ "description": "A String", # A human-readable description of this log. This information appears in
+ # the documentation and can contain details.
"name": "A String", # The name of the log. It must be less than 512 characters long and can
# include the following characters: upper- and lower-case alphanumeric
# characters [A-Za-z0-9], and punctuation characters including
# slash, underscore, hyphen, period [/_-.].
- "description": "A String", # A human-readable description of this log. This information appears in
- # the documentation and can contain details.
},
],
"id": "A String", # A unique ID for a specific instance of this message, typically assigned
@@ -496,11 +496,11 @@
# rules:
# - selector: "google.example.library.v1.LibraryService.CreateBook"
# allow_unregistered_calls: true
+ "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
"selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
# methods in all APIs.
#
# Refer to selector for syntax details.
- "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
},
],
"producerNotificationChannel": "A String", # The full resource name of a channel used for sending notifications to the
@@ -740,6 +740,9 @@
# `*` for mapping all fields not captured by the path pattern to the HTTP
# body. NOTE: the referred field must not be a repeated field and must be
# present at the top-level of request message type.
+ "selector": "A String", # Selects methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
"get": "A String", # Used for listing and getting information about resources.
"mediaDownload": { # Use this only for Scotty Requests. Do not use this for media support using # Use this only for Scotty Requests. Do not use this for bytestream methods.
# For media support, add instead [][google.bytestream.RestByteStream] as an
@@ -767,21 +770,18 @@
#
# Specify name of the upload service if one is used for upload.
},
- "selector": "A String", # Selects methods to which this rule applies.
- #
- # Refer to selector for syntax details.
+ "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
+ "path": "A String", # The path matched by this custom verb.
+ "kind": "A String", # The name of this custom HTTP verb.
+ },
"responseBody": "A String", # The name of the response field whose value is mapped to the HTTP body of
# response. Other response fields are ignored. This field is optional. When
# not set, the response message will be used as HTTP body of response.
# NOTE: the referred field must be not a repeated field and must be present
# at the top-level of response message type.
"put": "A String", # Used for updating a resource.
- "patch": "A String", # Used for updating a resource.
"post": "A String", # Used for creating a resource.
- "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
- "path": "A String", # The path matched by this custom verb.
- "kind": "A String", # The name of this custom HTTP verb.
- },
+ "patch": "A String", # Used for updating a resource.
"delete": "A String", # Used for deleting a resource.
},
],
@@ -1131,12 +1131,32 @@
# enums:
# - name: google.someapi.v1.SomeEnum
{ # Enum type definition.
- "syntax": "A String", # The source syntax.
"sourceContext": { # `SourceContext` represents information about the source of a # The source context.
# protobuf element, like the file in which it is defined.
"fileName": "A String", # The path-qualified name of the .proto file that contained the associated
# protobuf element. For example: `"google/protobuf/source_context.proto"`.
},
+ "enumvalue": [ # Enum value definitions.
+ { # Enum value definition.
+ "number": 42, # Enum value number.
+ "name": "A String", # Enum value name.
+ "options": [ # Protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For protobuf built-in options (options defined in
+ # descriptor.proto), this is the short name. For example, `"map_entry"`.
+ # For custom options, it should be the fully-qualified name. For example,
+ # `"google.api.http"`.
+ "value": { # The option's value packed in an Any message. If the value is a primitive,
+ # the corresponding wrapper type defined in google/protobuf/wrappers.proto
+ # should be used. If the value is an enum, it should be stored as an int32
+ # value using the google.protobuf.Int32Value type.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
"options": [ # Protocol buffer options.
{ # A protocol buffer option, which can be attached to a message, field,
# enumeration, etc.
@@ -1153,27 +1173,7 @@
},
],
"name": "A String", # Enum type name.
- "enumvalue": [ # Enum value definitions.
- { # Enum value definition.
- "options": [ # Protocol buffer options.
- { # A protocol buffer option, which can be attached to a message, field,
- # enumeration, etc.
- "name": "A String", # The option's name. For protobuf built-in options (options defined in
- # descriptor.proto), this is the short name. For example, `"map_entry"`.
- # For custom options, it should be the fully-qualified name. For example,
- # `"google.api.http"`.
- "value": { # The option's value packed in an Any message. If the value is a primitive,
- # the corresponding wrapper type defined in google/protobuf/wrappers.proto
- # should be used. If the value is an enum, it should be stored as an int32
- # value using the google.protobuf.Int32Value type.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- },
- ],
- "number": 42, # Enum value number.
- "name": "A String", # Enum value name.
- },
- ],
+ "syntax": "A String", # The source syntax.
},
],
"types": [ # A list of all proto message types included in this API service.
@@ -1379,8 +1379,19 @@
},
],
"documentationRootUrl": "A String", # The URL to the root of documentation.
- "summary": "A String", # A short summary of what the service does. Can only be provided by
- # plain text.
+ "overview": "A String", # Declares a single overview page. For example:
+ # <pre><code>documentation:
+ # summary: ...
+ # overview: (== include overview.md ==)
+ # </code></pre>
+ # This is a shortcut for the following declaration (using pages style):
+ # <pre><code>documentation:
+ # summary: ...
+ # pages:
+ # - name: Overview
+ # content: (== include overview.md ==)
+ # </code></pre>
+ # Note: you cannot specify both `overview` field and `pages` field.
"pages": [ # The top level pages for the documentation set.
{ # Represents a documentation page. A page can contain subpages to represent
# nested documentation set structure.
@@ -1406,19 +1417,8 @@
# `Java`.
},
],
- "overview": "A String", # Declares a single overview page. For example:
- # <pre><code>documentation:
- # summary: ...
- # overview: (== include overview.md ==)
- # </code></pre>
- # This is a shortcut for the following declaration (using pages style):
- # <pre><code>documentation:
- # summary: ...
- # pages:
- # - name: Overview
- # content: (== include overview.md ==)
- # </code></pre>
- # Note: you cannot specify both `overview` field and `pages` field.
+ "summary": "A String", # A short summary of what the service does. Can only be provided by
+ # plain text.
},
"sourceInfo": { # Source information used to create a Service Config # Output only. The source information for this configuration if available.
"sourceFiles": [ # All files used during config generation.
@@ -1515,12 +1515,12 @@
"provided": [ # A list of full type names of provided contexts.
"A String",
],
- "requested": [ # A list of full type names of requested contexts.
- "A String",
- ],
"selector": "A String", # Selects the methods to which this rule applies.
#
# Refer to selector for syntax details.
+ "requested": [ # A list of full type names of requested contexts.
+ "A String",
+ ],
},
],
},
@@ -1632,9 +1632,10 @@
# 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.
+ "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"`.
"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"`.
@@ -1644,10 +1645,9 @@
"key": "A String", # The label key.
},
],
- "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"`.
+ "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.
"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
@@ -1678,12 +1678,12 @@
],
"displayName": "A String", # The human-readable name for this log. This information appears on
# the user interface and should be concise.
+ "description": "A String", # A human-readable description of this log. This information appears in
+ # the documentation and can contain details.
"name": "A String", # The name of the log. It must be less than 512 characters long and can
# include the following characters: upper- and lower-case alphanumeric
# characters [A-Za-z0-9], and punctuation characters including
# slash, underscore, hyphen, period [/_-.].
- "description": "A String", # A human-readable description of this log. This information appears in
- # the documentation and can contain details.
},
],
"id": "A String", # A unique ID for a specific instance of this message, typically assigned
@@ -1985,11 +1985,11 @@
# rules:
# - selector: "google.example.library.v1.LibraryService.CreateBook"
# allow_unregistered_calls: true
+ "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
"selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
# methods in all APIs.
#
# Refer to selector for syntax details.
- "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
},
],
"producerNotificationChannel": "A String", # The full resource name of a channel used for sending notifications to the
@@ -2229,6 +2229,9 @@
# `*` for mapping all fields not captured by the path pattern to the HTTP
# body. NOTE: the referred field must not be a repeated field and must be
# present at the top-level of request message type.
+ "selector": "A String", # Selects methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
"get": "A String", # Used for listing and getting information about resources.
"mediaDownload": { # Use this only for Scotty Requests. Do not use this for media support using # Use this only for Scotty Requests. Do not use this for bytestream methods.
# For media support, add instead [][google.bytestream.RestByteStream] as an
@@ -2256,21 +2259,18 @@
#
# Specify name of the upload service if one is used for upload.
},
- "selector": "A String", # Selects methods to which this rule applies.
- #
- # Refer to selector for syntax details.
+ "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
+ "path": "A String", # The path matched by this custom verb.
+ "kind": "A String", # The name of this custom HTTP verb.
+ },
"responseBody": "A String", # The name of the response field whose value is mapped to the HTTP body of
# response. Other response fields are ignored. This field is optional. When
# not set, the response message will be used as HTTP body of response.
# NOTE: the referred field must be not a repeated field and must be present
# at the top-level of response message type.
"put": "A String", # Used for updating a resource.
- "patch": "A String", # Used for updating a resource.
"post": "A String", # Used for creating a resource.
- "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
- "path": "A String", # The path matched by this custom verb.
- "kind": "A String", # The name of this custom HTTP verb.
- },
+ "patch": "A String", # Used for updating a resource.
"delete": "A String", # Used for deleting a resource.
},
],
@@ -2620,12 +2620,32 @@
# enums:
# - name: google.someapi.v1.SomeEnum
{ # Enum type definition.
- "syntax": "A String", # The source syntax.
"sourceContext": { # `SourceContext` represents information about the source of a # The source context.
# protobuf element, like the file in which it is defined.
"fileName": "A String", # The path-qualified name of the .proto file that contained the associated
# protobuf element. For example: `"google/protobuf/source_context.proto"`.
},
+ "enumvalue": [ # Enum value definitions.
+ { # Enum value definition.
+ "number": 42, # Enum value number.
+ "name": "A String", # Enum value name.
+ "options": [ # Protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For protobuf built-in options (options defined in
+ # descriptor.proto), this is the short name. For example, `"map_entry"`.
+ # For custom options, it should be the fully-qualified name. For example,
+ # `"google.api.http"`.
+ "value": { # The option's value packed in an Any message. If the value is a primitive,
+ # the corresponding wrapper type defined in google/protobuf/wrappers.proto
+ # should be used. If the value is an enum, it should be stored as an int32
+ # value using the google.protobuf.Int32Value type.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
"options": [ # Protocol buffer options.
{ # A protocol buffer option, which can be attached to a message, field,
# enumeration, etc.
@@ -2642,27 +2662,7 @@
},
],
"name": "A String", # Enum type name.
- "enumvalue": [ # Enum value definitions.
- { # Enum value definition.
- "options": [ # Protocol buffer options.
- { # A protocol buffer option, which can be attached to a message, field,
- # enumeration, etc.
- "name": "A String", # The option's name. For protobuf built-in options (options defined in
- # descriptor.proto), this is the short name. For example, `"map_entry"`.
- # For custom options, it should be the fully-qualified name. For example,
- # `"google.api.http"`.
- "value": { # The option's value packed in an Any message. If the value is a primitive,
- # the corresponding wrapper type defined in google/protobuf/wrappers.proto
- # should be used. If the value is an enum, it should be stored as an int32
- # value using the google.protobuf.Int32Value type.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- },
- ],
- "number": 42, # Enum value number.
- "name": "A String", # Enum value name.
- },
- ],
+ "syntax": "A String", # The source syntax.
},
],
"types": [ # A list of all proto message types included in this API service.
@@ -2868,8 +2868,19 @@
},
],
"documentationRootUrl": "A String", # The URL to the root of documentation.
- "summary": "A String", # A short summary of what the service does. Can only be provided by
- # plain text.
+ "overview": "A String", # Declares a single overview page. For example:
+ # <pre><code>documentation:
+ # summary: ...
+ # overview: (== include overview.md ==)
+ # </code></pre>
+ # This is a shortcut for the following declaration (using pages style):
+ # <pre><code>documentation:
+ # summary: ...
+ # pages:
+ # - name: Overview
+ # content: (== include overview.md ==)
+ # </code></pre>
+ # Note: you cannot specify both `overview` field and `pages` field.
"pages": [ # The top level pages for the documentation set.
{ # Represents a documentation page. A page can contain subpages to represent
# nested documentation set structure.
@@ -2895,19 +2906,8 @@
# `Java`.
},
],
- "overview": "A String", # Declares a single overview page. For example:
- # <pre><code>documentation:
- # summary: ...
- # overview: (== include overview.md ==)
- # </code></pre>
- # This is a shortcut for the following declaration (using pages style):
- # <pre><code>documentation:
- # summary: ...
- # pages:
- # - name: Overview
- # content: (== include overview.md ==)
- # </code></pre>
- # Note: you cannot specify both `overview` field and `pages` field.
+ "summary": "A String", # A short summary of what the service does. Can only be provided by
+ # plain text.
},
"sourceInfo": { # Source information used to create a Service Config # Output only. The source information for this configuration if available.
"sourceFiles": [ # All files used during config generation.
@@ -3004,12 +3004,12 @@
"provided": [ # A list of full type names of provided contexts.
"A String",
],
- "requested": [ # A list of full type names of requested contexts.
- "A String",
- ],
"selector": "A String", # Selects the methods to which this rule applies.
#
# Refer to selector for syntax details.
+ "requested": [ # A list of full type names of requested contexts.
+ "A String",
+ ],
},
],
},
@@ -3132,9 +3132,10 @@
# 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.
+ "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"`.
"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"`.
@@ -3144,10 +3145,9 @@
"key": "A String", # The label key.
},
],
- "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"`.
+ "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.
"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
@@ -3178,12 +3178,12 @@
],
"displayName": "A String", # The human-readable name for this log. This information appears on
# the user interface and should be concise.
+ "description": "A String", # A human-readable description of this log. This information appears in
+ # the documentation and can contain details.
"name": "A String", # The name of the log. It must be less than 512 characters long and can
# include the following characters: upper- and lower-case alphanumeric
# characters [A-Za-z0-9], and punctuation characters including
# slash, underscore, hyphen, period [/_-.].
- "description": "A String", # A human-readable description of this log. This information appears in
- # the documentation and can contain details.
},
],
"id": "A String", # A unique ID for a specific instance of this message, typically assigned
@@ -3485,11 +3485,11 @@
# rules:
# - selector: "google.example.library.v1.LibraryService.CreateBook"
# allow_unregistered_calls: true
+ "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
"selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
# methods in all APIs.
#
# Refer to selector for syntax details.
- "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
},
],
"producerNotificationChannel": "A String", # The full resource name of a channel used for sending notifications to the
@@ -3729,6 +3729,9 @@
# `*` for mapping all fields not captured by the path pattern to the HTTP
# body. NOTE: the referred field must not be a repeated field and must be
# present at the top-level of request message type.
+ "selector": "A String", # Selects methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
"get": "A String", # Used for listing and getting information about resources.
"mediaDownload": { # Use this only for Scotty Requests. Do not use this for media support using # Use this only for Scotty Requests. Do not use this for bytestream methods.
# For media support, add instead [][google.bytestream.RestByteStream] as an
@@ -3756,21 +3759,18 @@
#
# Specify name of the upload service if one is used for upload.
},
- "selector": "A String", # Selects methods to which this rule applies.
- #
- # Refer to selector for syntax details.
+ "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
+ "path": "A String", # The path matched by this custom verb.
+ "kind": "A String", # The name of this custom HTTP verb.
+ },
"responseBody": "A String", # The name of the response field whose value is mapped to the HTTP body of
# response. Other response fields are ignored. This field is optional. When
# not set, the response message will be used as HTTP body of response.
# NOTE: the referred field must be not a repeated field and must be present
# at the top-level of response message type.
"put": "A String", # Used for updating a resource.
- "patch": "A String", # Used for updating a resource.
"post": "A String", # Used for creating a resource.
- "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
- "path": "A String", # The path matched by this custom verb.
- "kind": "A String", # The name of this custom HTTP verb.
- },
+ "patch": "A String", # Used for updating a resource.
"delete": "A String", # Used for deleting a resource.
},
],
@@ -4120,12 +4120,32 @@
# enums:
# - name: google.someapi.v1.SomeEnum
{ # Enum type definition.
- "syntax": "A String", # The source syntax.
"sourceContext": { # `SourceContext` represents information about the source of a # The source context.
# protobuf element, like the file in which it is defined.
"fileName": "A String", # The path-qualified name of the .proto file that contained the associated
# protobuf element. For example: `"google/protobuf/source_context.proto"`.
},
+ "enumvalue": [ # Enum value definitions.
+ { # Enum value definition.
+ "number": 42, # Enum value number.
+ "name": "A String", # Enum value name.
+ "options": [ # Protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For protobuf built-in options (options defined in
+ # descriptor.proto), this is the short name. For example, `"map_entry"`.
+ # For custom options, it should be the fully-qualified name. For example,
+ # `"google.api.http"`.
+ "value": { # The option's value packed in an Any message. If the value is a primitive,
+ # the corresponding wrapper type defined in google/protobuf/wrappers.proto
+ # should be used. If the value is an enum, it should be stored as an int32
+ # value using the google.protobuf.Int32Value type.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
"options": [ # Protocol buffer options.
{ # A protocol buffer option, which can be attached to a message, field,
# enumeration, etc.
@@ -4142,27 +4162,7 @@
},
],
"name": "A String", # Enum type name.
- "enumvalue": [ # Enum value definitions.
- { # Enum value definition.
- "options": [ # Protocol buffer options.
- { # A protocol buffer option, which can be attached to a message, field,
- # enumeration, etc.
- "name": "A String", # The option's name. For protobuf built-in options (options defined in
- # descriptor.proto), this is the short name. For example, `"map_entry"`.
- # For custom options, it should be the fully-qualified name. For example,
- # `"google.api.http"`.
- "value": { # The option's value packed in an Any message. If the value is a primitive,
- # the corresponding wrapper type defined in google/protobuf/wrappers.proto
- # should be used. If the value is an enum, it should be stored as an int32
- # value using the google.protobuf.Int32Value type.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- },
- ],
- "number": 42, # Enum value number.
- "name": "A String", # Enum value name.
- },
- ],
+ "syntax": "A String", # The source syntax.
},
],
"types": [ # A list of all proto message types included in this API service.
@@ -4368,8 +4368,19 @@
},
],
"documentationRootUrl": "A String", # The URL to the root of documentation.
- "summary": "A String", # A short summary of what the service does. Can only be provided by
- # plain text.
+ "overview": "A String", # Declares a single overview page. For example:
+ # <pre><code>documentation:
+ # summary: ...
+ # overview: (== include overview.md ==)
+ # </code></pre>
+ # This is a shortcut for the following declaration (using pages style):
+ # <pre><code>documentation:
+ # summary: ...
+ # pages:
+ # - name: Overview
+ # content: (== include overview.md ==)
+ # </code></pre>
+ # Note: you cannot specify both `overview` field and `pages` field.
"pages": [ # The top level pages for the documentation set.
{ # Represents a documentation page. A page can contain subpages to represent
# nested documentation set structure.
@@ -4395,19 +4406,8 @@
# `Java`.
},
],
- "overview": "A String", # Declares a single overview page. For example:
- # <pre><code>documentation:
- # summary: ...
- # overview: (== include overview.md ==)
- # </code></pre>
- # This is a shortcut for the following declaration (using pages style):
- # <pre><code>documentation:
- # summary: ...
- # pages:
- # - name: Overview
- # content: (== include overview.md ==)
- # </code></pre>
- # Note: you cannot specify both `overview` field and `pages` field.
+ "summary": "A String", # A short summary of what the service does. Can only be provided by
+ # plain text.
},
"sourceInfo": { # Source information used to create a Service Config # Output only. The source information for this configuration if available.
"sourceFiles": [ # All files used during config generation.
@@ -4504,12 +4504,12 @@
"provided": [ # A list of full type names of provided contexts.
"A String",
],
- "requested": [ # A list of full type names of requested contexts.
- "A String",
- ],
"selector": "A String", # Selects the methods to which this rule applies.
#
# Refer to selector for syntax details.
+ "requested": [ # A list of full type names of requested contexts.
+ "A String",
+ ],
},
],
},
@@ -4635,9 +4635,10 @@
# 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.
+ "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"`.
"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"`.
@@ -4647,10 +4648,9 @@
"key": "A String", # The label key.
},
],
- "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"`.
+ "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.
"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
@@ -4681,12 +4681,12 @@
],
"displayName": "A String", # The human-readable name for this log. This information appears on
# the user interface and should be concise.
+ "description": "A String", # A human-readable description of this log. This information appears in
+ # the documentation and can contain details.
"name": "A String", # The name of the log. It must be less than 512 characters long and can
# include the following characters: upper- and lower-case alphanumeric
# characters [A-Za-z0-9], and punctuation characters including
# slash, underscore, hyphen, period [/_-.].
- "description": "A String", # A human-readable description of this log. This information appears in
- # the documentation and can contain details.
},
],
"id": "A String", # A unique ID for a specific instance of this message, typically assigned
@@ -4988,11 +4988,11 @@
# rules:
# - selector: "google.example.library.v1.LibraryService.CreateBook"
# allow_unregistered_calls: true
+ "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
"selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
# methods in all APIs.
#
# Refer to selector for syntax details.
- "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
},
],
"producerNotificationChannel": "A String", # The full resource name of a channel used for sending notifications to the
@@ -5232,6 +5232,9 @@
# `*` for mapping all fields not captured by the path pattern to the HTTP
# body. NOTE: the referred field must not be a repeated field and must be
# present at the top-level of request message type.
+ "selector": "A String", # Selects methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
"get": "A String", # Used for listing and getting information about resources.
"mediaDownload": { # Use this only for Scotty Requests. Do not use this for media support using # Use this only for Scotty Requests. Do not use this for bytestream methods.
# For media support, add instead [][google.bytestream.RestByteStream] as an
@@ -5259,21 +5262,18 @@
#
# Specify name of the upload service if one is used for upload.
},
- "selector": "A String", # Selects methods to which this rule applies.
- #
- # Refer to selector for syntax details.
+ "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
+ "path": "A String", # The path matched by this custom verb.
+ "kind": "A String", # The name of this custom HTTP verb.
+ },
"responseBody": "A String", # The name of the response field whose value is mapped to the HTTP body of
# response. Other response fields are ignored. This field is optional. When
# not set, the response message will be used as HTTP body of response.
# NOTE: the referred field must be not a repeated field and must be present
# at the top-level of response message type.
"put": "A String", # Used for updating a resource.
- "patch": "A String", # Used for updating a resource.
"post": "A String", # Used for creating a resource.
- "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
- "path": "A String", # The path matched by this custom verb.
- "kind": "A String", # The name of this custom HTTP verb.
- },
+ "patch": "A String", # Used for updating a resource.
"delete": "A String", # Used for deleting a resource.
},
],
@@ -5623,12 +5623,32 @@
# enums:
# - name: google.someapi.v1.SomeEnum
{ # Enum type definition.
- "syntax": "A String", # The source syntax.
"sourceContext": { # `SourceContext` represents information about the source of a # The source context.
# protobuf element, like the file in which it is defined.
"fileName": "A String", # The path-qualified name of the .proto file that contained the associated
# protobuf element. For example: `"google/protobuf/source_context.proto"`.
},
+ "enumvalue": [ # Enum value definitions.
+ { # Enum value definition.
+ "number": 42, # Enum value number.
+ "name": "A String", # Enum value name.
+ "options": [ # Protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For protobuf built-in options (options defined in
+ # descriptor.proto), this is the short name. For example, `"map_entry"`.
+ # For custom options, it should be the fully-qualified name. For example,
+ # `"google.api.http"`.
+ "value": { # The option's value packed in an Any message. If the value is a primitive,
+ # the corresponding wrapper type defined in google/protobuf/wrappers.proto
+ # should be used. If the value is an enum, it should be stored as an int32
+ # value using the google.protobuf.Int32Value type.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
"options": [ # Protocol buffer options.
{ # A protocol buffer option, which can be attached to a message, field,
# enumeration, etc.
@@ -5645,27 +5665,7 @@
},
],
"name": "A String", # Enum type name.
- "enumvalue": [ # Enum value definitions.
- { # Enum value definition.
- "options": [ # Protocol buffer options.
- { # A protocol buffer option, which can be attached to a message, field,
- # enumeration, etc.
- "name": "A String", # The option's name. For protobuf built-in options (options defined in
- # descriptor.proto), this is the short name. For example, `"map_entry"`.
- # For custom options, it should be the fully-qualified name. For example,
- # `"google.api.http"`.
- "value": { # The option's value packed in an Any message. If the value is a primitive,
- # the corresponding wrapper type defined in google/protobuf/wrappers.proto
- # should be used. If the value is an enum, it should be stored as an int32
- # value using the google.protobuf.Int32Value type.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- },
- ],
- "number": 42, # Enum value number.
- "name": "A String", # Enum value name.
- },
- ],
+ "syntax": "A String", # The source syntax.
},
],
"types": [ # A list of all proto message types included in this API service.
@@ -5871,8 +5871,19 @@
},
],
"documentationRootUrl": "A String", # The URL to the root of documentation.
- "summary": "A String", # A short summary of what the service does. Can only be provided by
- # plain text.
+ "overview": "A String", # Declares a single overview page. For example:
+ # <pre><code>documentation:
+ # summary: ...
+ # overview: (== include overview.md ==)
+ # </code></pre>
+ # This is a shortcut for the following declaration (using pages style):
+ # <pre><code>documentation:
+ # summary: ...
+ # pages:
+ # - name: Overview
+ # content: (== include overview.md ==)
+ # </code></pre>
+ # Note: you cannot specify both `overview` field and `pages` field.
"pages": [ # The top level pages for the documentation set.
{ # Represents a documentation page. A page can contain subpages to represent
# nested documentation set structure.
@@ -5898,19 +5909,8 @@
# `Java`.
},
],
- "overview": "A String", # Declares a single overview page. For example:
- # <pre><code>documentation:
- # summary: ...
- # overview: (== include overview.md ==)
- # </code></pre>
- # This is a shortcut for the following declaration (using pages style):
- # <pre><code>documentation:
- # summary: ...
- # pages:
- # - name: Overview
- # content: (== include overview.md ==)
- # </code></pre>
- # Note: you cannot specify both `overview` field and `pages` field.
+ "summary": "A String", # A short summary of what the service does. Can only be provided by
+ # plain text.
},
"sourceInfo": { # Source information used to create a Service Config # Output only. The source information for this configuration if available.
"sourceFiles": [ # All files used during config generation.
@@ -6007,12 +6007,12 @@
"provided": [ # A list of full type names of provided contexts.
"A String",
],
- "requested": [ # A list of full type names of requested contexts.
- "A String",
- ],
"selector": "A String", # Selects the methods to which this rule applies.
#
# Refer to selector for syntax details.
+ "requested": [ # A list of full type names of requested contexts.
+ "A String",
+ ],
},
],
},
diff --git a/docs/dyn/servicemanagement_v1.services.html b/docs/dyn/servicemanagement_v1.services.html
index aaa8355..d1aebf3 100644
--- a/docs/dyn/servicemanagement_v1.services.html
+++ b/docs/dyn/servicemanagement_v1.services.html
@@ -692,9 +692,9 @@
# report
# belongs to.
{ # Represents a diagnostic message (error or warning)
+ "kind": "A String", # The kind of diagnostic information provided.
"message": "A String", # Message describing the error or warning.
"location": "A String", # File name and line number of the error or warning.
- "kind": "A String", # The kind of diagnostic information provided.
},
],
}</pre>
@@ -782,9 +782,10 @@
# 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.
+ "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"`.
"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"`.
@@ -794,10 +795,9 @@
"key": "A String", # The label key.
},
],
- "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"`.
+ "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.
"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
@@ -828,12 +828,12 @@
],
"displayName": "A String", # The human-readable name for this log. This information appears on
# the user interface and should be concise.
+ "description": "A String", # A human-readable description of this log. This information appears in
+ # the documentation and can contain details.
"name": "A String", # The name of the log. It must be less than 512 characters long and can
# include the following characters: upper- and lower-case alphanumeric
# characters [A-Za-z0-9], and punctuation characters including
# slash, underscore, hyphen, period [/_-.].
- "description": "A String", # A human-readable description of this log. This information appears in
- # the documentation and can contain details.
},
],
"id": "A String", # A unique ID for a specific instance of this message, typically assigned
@@ -1135,11 +1135,11 @@
# rules:
# - selector: "google.example.library.v1.LibraryService.CreateBook"
# allow_unregistered_calls: true
+ "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
"selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
# methods in all APIs.
#
# Refer to selector for syntax details.
- "allowUnregisteredCalls": True or False, # True, if the method allows unregistered calls; false otherwise.
},
],
"producerNotificationChannel": "A String", # The full resource name of a channel used for sending notifications to the
@@ -1379,6 +1379,9 @@
# `*` for mapping all fields not captured by the path pattern to the HTTP
# body. NOTE: the referred field must not be a repeated field and must be
# present at the top-level of request message type.
+ "selector": "A String", # Selects methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
"get": "A String", # Used for listing and getting information about resources.
"mediaDownload": { # Use this only for Scotty Requests. Do not use this for media support using # Use this only for Scotty Requests. Do not use this for bytestream methods.
# For media support, add instead [][google.bytestream.RestByteStream] as an
@@ -1406,21 +1409,18 @@
#
# Specify name of the upload service if one is used for upload.
},
- "selector": "A String", # Selects methods to which this rule applies.
- #
- # Refer to selector for syntax details.
+ "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
+ "path": "A String", # The path matched by this custom verb.
+ "kind": "A String", # The name of this custom HTTP verb.
+ },
"responseBody": "A String", # The name of the response field whose value is mapped to the HTTP body of
# response. Other response fields are ignored. This field is optional. When
# not set, the response message will be used as HTTP body of response.
# NOTE: the referred field must be not a repeated field and must be present
# at the top-level of response message type.
"put": "A String", # Used for updating a resource.
- "patch": "A String", # Used for updating a resource.
"post": "A String", # Used for creating a resource.
- "custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
- "path": "A String", # The path matched by this custom verb.
- "kind": "A String", # The name of this custom HTTP verb.
- },
+ "patch": "A String", # Used for updating a resource.
"delete": "A String", # Used for deleting a resource.
},
],
@@ -1770,12 +1770,32 @@
# enums:
# - name: google.someapi.v1.SomeEnum
{ # Enum type definition.
- "syntax": "A String", # The source syntax.
"sourceContext": { # `SourceContext` represents information about the source of a # The source context.
# protobuf element, like the file in which it is defined.
"fileName": "A String", # The path-qualified name of the .proto file that contained the associated
# protobuf element. For example: `"google/protobuf/source_context.proto"`.
},
+ "enumvalue": [ # Enum value definitions.
+ { # Enum value definition.
+ "number": 42, # Enum value number.
+ "name": "A String", # Enum value name.
+ "options": [ # Protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For protobuf built-in options (options defined in
+ # descriptor.proto), this is the short name. For example, `"map_entry"`.
+ # For custom options, it should be the fully-qualified name. For example,
+ # `"google.api.http"`.
+ "value": { # The option's value packed in an Any message. If the value is a primitive,
+ # the corresponding wrapper type defined in google/protobuf/wrappers.proto
+ # should be used. If the value is an enum, it should be stored as an int32
+ # value using the google.protobuf.Int32Value type.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
"options": [ # Protocol buffer options.
{ # A protocol buffer option, which can be attached to a message, field,
# enumeration, etc.
@@ -1792,27 +1812,7 @@
},
],
"name": "A String", # Enum type name.
- "enumvalue": [ # Enum value definitions.
- { # Enum value definition.
- "options": [ # Protocol buffer options.
- { # A protocol buffer option, which can be attached to a message, field,
- # enumeration, etc.
- "name": "A String", # The option's name. For protobuf built-in options (options defined in
- # descriptor.proto), this is the short name. For example, `"map_entry"`.
- # For custom options, it should be the fully-qualified name. For example,
- # `"google.api.http"`.
- "value": { # The option's value packed in an Any message. If the value is a primitive,
- # the corresponding wrapper type defined in google/protobuf/wrappers.proto
- # should be used. If the value is an enum, it should be stored as an int32
- # value using the google.protobuf.Int32Value type.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- },
- ],
- "number": 42, # Enum value number.
- "name": "A String", # Enum value name.
- },
- ],
+ "syntax": "A String", # The source syntax.
},
],
"types": [ # A list of all proto message types included in this API service.
@@ -2018,8 +2018,19 @@
},
],
"documentationRootUrl": "A String", # The URL to the root of documentation.
- "summary": "A String", # A short summary of what the service does. Can only be provided by
- # plain text.
+ "overview": "A String", # Declares a single overview page. For example:
+ # <pre><code>documentation:
+ # summary: ...
+ # overview: (== include overview.md ==)
+ # </code></pre>
+ # This is a shortcut for the following declaration (using pages style):
+ # <pre><code>documentation:
+ # summary: ...
+ # pages:
+ # - name: Overview
+ # content: (== include overview.md ==)
+ # </code></pre>
+ # Note: you cannot specify both `overview` field and `pages` field.
"pages": [ # The top level pages for the documentation set.
{ # Represents a documentation page. A page can contain subpages to represent
# nested documentation set structure.
@@ -2045,19 +2056,8 @@
# `Java`.
},
],
- "overview": "A String", # Declares a single overview page. For example:
- # <pre><code>documentation:
- # summary: ...
- # overview: (== include overview.md ==)
- # </code></pre>
- # This is a shortcut for the following declaration (using pages style):
- # <pre><code>documentation:
- # summary: ...
- # pages:
- # - name: Overview
- # content: (== include overview.md ==)
- # </code></pre>
- # Note: you cannot specify both `overview` field and `pages` field.
+ "summary": "A String", # A short summary of what the service does. Can only be provided by
+ # plain text.
},
"sourceInfo": { # Source information used to create a Service Config # Output only. The source information for this configuration if available.
"sourceFiles": [ # All files used during config generation.
@@ -2154,12 +2154,12 @@
"provided": [ # A list of full type names of provided contexts.
"A String",
],
- "requested": [ # A list of full type names of requested contexts.
- "A String",
- ],
"selector": "A String", # Selects the methods to which this rule applies.
#
# Refer to selector for syntax details.
+ "requested": [ # A list of full type names of requested contexts.
+ "A String",
+ ],
},
],
},
@@ -2360,7 +2360,7 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
@@ -2402,28 +2402,6 @@
"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 the only supported field names are
- # - "iam_principal", corresponding to IAMContext.principal;
- # - "" (empty string), resulting in one aggretated counter with no field.
- #
- # 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.
@@ -2674,7 +2652,7 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
@@ -2716,28 +2694,6 @@
"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 the only supported field names are
- # - "iam_principal", corresponding to IAMContext.principal;
- # - "" (empty string), resulting in one aggretated counter with no field.
- #
- # 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.
@@ -2929,7 +2885,7 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
@@ -2971,28 +2927,6 @@
"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 the only supported field names are
- # - "iam_principal", corresponding to IAMContext.principal;
- # - "" (empty string), resulting in one aggretated counter with no field.
- #
- # 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.
diff --git a/docs/dyn/servicemanagement_v1.services.rollouts.html b/docs/dyn/servicemanagement_v1.services.rollouts.html
index d183d56..7bf92d0 100644
--- a/docs/dyn/servicemanagement_v1.services.rollouts.html
+++ b/docs/dyn/servicemanagement_v1.services.rollouts.html
@@ -112,6 +112,14 @@
"status": "A String", # The status of this rollout. Readonly. In case of a failed rollout,
# the system will automatically rollback to the current Rollout
# version. Readonly.
+ "rolloutId": "A String", # Optional unique identifier of this Rollout. Only lower case letters, digits
+ # and '-' are allowed.
+ #
+ # If not specified by client, the server will generate one. The generated id
+ # will have the form of <date><revision number>, where "date" is the create
+ # date in ISO 8601 format. "revision number" is a monotonically increasing
+ # positive number that is reset every day for each service.
+ # An example of the generated rollout_id is '2016-02-16r1'
"trafficPercentStrategy": { # Strategy that specifies how Google Service Control should select # Google Service Control selects service configurations based on
# traffic percentage.
# different
@@ -148,20 +156,12 @@
"a_key": 3.14,
},
},
- "rolloutId": "A String", # Optional unique identifier of this Rollout. Only lower case letters, digits
- # and '-' are allowed.
- #
- # If not specified by client, the server will generate one. The generated id
- # will have the form of <date><revision number>, where "date" is the create
- # date in ISO 8601 format. "revision number" is a monotonically increasing
- # positive number that is reset every day for each service.
- # An example of the generated rollout_id is '2016-02-16r1'
- "serviceName": "A String", # The name of the service associated with this Rollout.
"createdBy": "A String", # The user who created the Rollout. Readonly.
"deleteServiceStrategy": { # Strategy used to delete a service. This strategy is a placeholder only # The strategy associated with a rollout to delete a `ManagedService`.
# Readonly.
# used by the system generated rollout to delete a service.
},
+ "serviceName": "A String", # The name of the service associated with this Rollout.
"createTime": "A String", # Creation time of the rollout. Readonly.
}
@@ -285,6 +285,14 @@
"status": "A String", # The status of this rollout. Readonly. In case of a failed rollout,
# the system will automatically rollback to the current Rollout
# version. Readonly.
+ "rolloutId": "A String", # Optional unique identifier of this Rollout. Only lower case letters, digits
+ # and '-' are allowed.
+ #
+ # If not specified by client, the server will generate one. The generated id
+ # will have the form of <date><revision number>, where "date" is the create
+ # date in ISO 8601 format. "revision number" is a monotonically increasing
+ # positive number that is reset every day for each service.
+ # An example of the generated rollout_id is '2016-02-16r1'
"trafficPercentStrategy": { # Strategy that specifies how Google Service Control should select # Google Service Control selects service configurations based on
# traffic percentage.
# different
@@ -321,20 +329,12 @@
"a_key": 3.14,
},
},
- "rolloutId": "A String", # Optional unique identifier of this Rollout. Only lower case letters, digits
- # and '-' are allowed.
- #
- # If not specified by client, the server will generate one. The generated id
- # will have the form of <date><revision number>, where "date" is the create
- # date in ISO 8601 format. "revision number" is a monotonically increasing
- # positive number that is reset every day for each service.
- # An example of the generated rollout_id is '2016-02-16r1'
- "serviceName": "A String", # The name of the service associated with this Rollout.
"createdBy": "A String", # The user who created the Rollout. Readonly.
"deleteServiceStrategy": { # Strategy used to delete a service. This strategy is a placeholder only # The strategy associated with a rollout to delete a `ManagedService`.
# Readonly.
# used by the system generated rollout to delete a service.
},
+ "serviceName": "A String", # The name of the service associated with this Rollout.
"createTime": "A String", # Creation time of the rollout. Readonly.
}</pre>
</div>
@@ -366,6 +366,14 @@
"status": "A String", # The status of this rollout. Readonly. In case of a failed rollout,
# the system will automatically rollback to the current Rollout
# version. Readonly.
+ "rolloutId": "A String", # Optional unique identifier of this Rollout. Only lower case letters, digits
+ # and '-' are allowed.
+ #
+ # If not specified by client, the server will generate one. The generated id
+ # will have the form of <date><revision number>, where "date" is the create
+ # date in ISO 8601 format. "revision number" is a monotonically increasing
+ # positive number that is reset every day for each service.
+ # An example of the generated rollout_id is '2016-02-16r1'
"trafficPercentStrategy": { # Strategy that specifies how Google Service Control should select # Google Service Control selects service configurations based on
# traffic percentage.
# different
@@ -402,20 +410,12 @@
"a_key": 3.14,
},
},
- "rolloutId": "A String", # Optional unique identifier of this Rollout. Only lower case letters, digits
- # and '-' are allowed.
- #
- # If not specified by client, the server will generate one. The generated id
- # will have the form of <date><revision number>, where "date" is the create
- # date in ISO 8601 format. "revision number" is a monotonically increasing
- # positive number that is reset every day for each service.
- # An example of the generated rollout_id is '2016-02-16r1'
- "serviceName": "A String", # The name of the service associated with this Rollout.
"createdBy": "A String", # The user who created the Rollout. Readonly.
"deleteServiceStrategy": { # Strategy used to delete a service. This strategy is a placeholder only # The strategy associated with a rollout to delete a `ManagedService`.
# Readonly.
# used by the system generated rollout to delete a service.
},
+ "serviceName": "A String", # The name of the service associated with this Rollout.
"createTime": "A String", # Creation time of the rollout. Readonly.
},
],
diff --git a/docs/dyn/serviceuser_v1.projects.services.html b/docs/dyn/serviceuser_v1.projects.services.html
index e74f34b..99d4f8a 100644
--- a/docs/dyn/serviceuser_v1.projects.services.html
+++ b/docs/dyn/serviceuser_v1.projects.services.html
@@ -392,9 +392,10 @@
# 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.
+ "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"`.
"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"`.
@@ -404,10 +405,9 @@
"key": "A String", # The label key.
},
],
- "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"`.
+ "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.
"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
@@ -446,6 +446,65 @@
# the documentation and can contain details.
},
],
+ "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
+ # and/or a URL query parameter. This configuration specifies which methods
+ # change the names of the system parameters.
+ "rules": [ # Define system parameters.
+ #
+ # The parameters defined here will override the default parameters
+ # implemented by the system. If this field is missing from the service
+ # config, default system parameters will be used. Default system parameters
+ # and names is implementation-dependent.
+ #
+ # Example: define api key for all methods
+ #
+ # system_parameters
+ # rules:
+ # - selector: "*"
+ # parameters:
+ # - name: api_key
+ # url_query_parameter: api_key
+ #
+ #
+ # Example: define 2 api key names for a specific method.
+ #
+ # system_parameters
+ # rules:
+ # - selector: "/ListShelves"
+ # parameters:
+ # - name: api_key
+ # http_header: Api-Key1
+ # - name: api_key
+ # http_header: Api-Key2
+ #
+ # **NOTE:** All service configuration rules follow "last one wins" order.
+ { # Define a system parameter rule mapping system parameter definitions to
+ # methods.
+ "parameters": [ # Define parameters. Multiple names may be defined for a parameter.
+ # For a given method call, only one of them should be used. If multiple
+ # names are used the behavior is implementation-dependent.
+ # If none of the specified names are present the behavior is
+ # parameter-dependent.
+ { # Define a parameter's name and location. The parameter may be passed as either
+ # an HTTP header or a URL query parameter, and if both are passed the behavior
+ # is implementation-dependent.
+ "urlQueryParameter": "A String", # Define the URL query parameter name to use for the parameter. It is case
+ # sensitive.
+ "httpHeader": "A String", # Define the HTTP header name to use for the parameter. It is case
+ # insensitive.
+ "name": "A String", # Define the name of the parameter, such as "api_key" . It is case sensitive.
+ },
+ ],
+ "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
+ # methods in all APIs.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ },
"id": "A String", # A unique ID for a specific instance of this message, typically assigned
# by the client for tracking purpose. If empty, the server may choose to
# generate one instead.
@@ -529,65 +588,7 @@
},
],
},
- "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
- # and/or a URL query parameter. This configuration specifies which methods
- # change the names of the system parameters.
- "rules": [ # Define system parameters.
- #
- # The parameters defined here will override the default parameters
- # implemented by the system. If this field is missing from the service
- # config, default system parameters will be used. Default system parameters
- # and names is implementation-dependent.
- #
- # Example: define api key for all methods
- #
- # system_parameters
- # rules:
- # - selector: "*"
- # parameters:
- # - name: api_key
- # url_query_parameter: api_key
- #
- #
- # Example: define 2 api key names for a specific method.
- #
- # system_parameters
- # rules:
- # - selector: "/ListShelves"
- # parameters:
- # - name: api_key
- # http_header: Api-Key1
- # - name: api_key
- # http_header: Api-Key2
- #
- # **NOTE:** All service configuration rules follow "last one wins" order.
- { # Define a system parameter rule mapping system parameter definitions to
- # methods.
- "parameters": [ # Define parameters. Multiple names may be defined for a parameter.
- # For a given method call, only one of them should be used. If multiple
- # names are used the behavior is implementation-dependent.
- # If none of the specified names are present the behavior is
- # parameter-dependent.
- { # Define a parameter's name and location. The parameter may be passed as either
- # an HTTP header or a URL query parameter, and if both are passed the behavior
- # is implementation-dependent.
- "urlQueryParameter": "A String", # Define the URL query parameter name to use for the parameter. It is case
- # sensitive.
- "name": "A String", # Define the name of the parameter, such as "api_key" . It is case sensitive.
- "httpHeader": "A String", # Define the HTTP header name to use for the parameter. It is case
- # insensitive.
- },
- ],
- "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
- # methods in all APIs.
- #
- # Refer to selector for syntax details.
- },
- ],
- },
+ "title": "A String", # The product title associated with this service.
"authentication": { # `Authentication` defines the authentication configuration for an API. # Auth configuration.
#
# Example for an API targeted for external use:
@@ -640,6 +641,13 @@
# canonical_scopes: https://www.googleapis.com/auth/calendar,
# https://www.googleapis.com/auth/calendar.read
},
+ "allowWithoutCredential": True or False, # Whether to allow requests without a credential. The credential can be
+ # an OAuth token, Google cookies (first-party auth) or EndUserCreds.
+ #
+ # For requests without credentials, if the service control environment is
+ # specified, each incoming request **must** be associated with a service
+ # consumer. This can be done by passing an API key that belongs to a consumer
+ # project.
"requirements": [ # Requirements for additional authentication providers.
{ # User-defined authentication requirements, including support for
# [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
@@ -666,13 +674,6 @@
# bookstore_web.apps.googleusercontent.com
},
],
- "allowWithoutCredential": True or False, # Whether to allow requests without a credential. The credential can be
- # an OAuth token, Google cookies (first-party auth) or EndUserCreds.
- #
- # For requests without credentials, if the service control environment is
- # specified, each incoming request **must** be associated with a service
- # consumer. This can be done by passing an API key that belongs to a consumer
- # project.
"selector": "A String", # Selects the methods to which this rule applies.
#
# Refer to selector for syntax details.
@@ -989,9 +990,6 @@
# `*` for mapping all fields not captured by the path pattern to the HTTP
# body. NOTE: the referred field must not be a repeated field and must be
# present at the top-level of request message type.
- "selector": "A String", # Selects methods to which this rule applies.
- #
- # Refer to selector for syntax details.
"get": "A String", # Used for listing and getting information about resources.
"mediaDownload": { # Use this only for Scotty Requests. Do not use this for media support using # Use this only for Scotty Requests. Do not use this for bytestream methods.
# For media support, add instead [][google.bytestream.RestByteStream] as an
@@ -1019,13 +1017,16 @@
#
# Specify name of the upload service if one is used for upload.
},
- "patch": "A String", # Used for updating a resource.
+ "selector": "A String", # Selects methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
"responseBody": "A String", # The name of the response field whose value is mapped to the HTTP body of
# response. Other response fields are ignored. This field is optional. When
# not set, the response message will be used as HTTP body of response.
# NOTE: the referred field must be not a repeated field and must be present
# at the top-level of response message type.
"put": "A String", # Used for updating a resource.
+ "patch": "A String", # Used for updating a resource.
"post": "A String", # Used for creating a resource.
"custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
"path": "A String", # The path matched by this custom verb.
@@ -1041,8 +1042,31 @@
# normalization process. It is an error to specify an API interface here
# which cannot be resolved against the associated IDL files.
{ # Api is a light-weight descriptor for a protocol buffer service.
- "name": "A String", # The fully qualified name of this api, including package name
- # followed by the api's simple name.
+ "methods": [ # The methods of this api, in unspecified order.
+ { # Method represents a method of an api.
+ "name": "A String", # The simple name of this method.
+ "requestStreaming": True or False, # If true, the request is streamed.
+ "responseTypeUrl": "A String", # The URL of the output message type.
+ "requestTypeUrl": "A String", # A URL of the input message type.
+ "responseStreaming": True or False, # If true, the response is streamed.
+ "syntax": "A String", # The source syntax of this method.
+ "options": [ # Any metadata attached to the method.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For protobuf built-in options (options defined in
+ # descriptor.proto), this is the short name. For example, `"map_entry"`.
+ # For custom options, it should be the fully-qualified name. For example,
+ # `"google.api.http"`.
+ "value": { # The option's value packed in an Any message. If the value is a primitive,
+ # the corresponding wrapper type defined in google/protobuf/wrappers.proto
+ # should be used. If the value is an enum, it should be stored as an int32
+ # value using the google.protobuf.Int32Value type.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
"sourceContext": { # `SourceContext` represents information about the source of a # Source context for the protocol buffer service represented by this
# message.
# protobuf element, like the file in which it is defined.
@@ -1168,31 +1192,8 @@
},
},
],
- "methods": [ # The methods of this api, in unspecified order.
- { # Method represents a method of an api.
- "name": "A String", # The simple name of this method.
- "requestStreaming": True or False, # If true, the request is streamed.
- "responseTypeUrl": "A String", # The URL of the output message type.
- "requestTypeUrl": "A String", # A URL of the input message type.
- "responseStreaming": True or False, # If true, the response is streamed.
- "syntax": "A String", # The source syntax of this method.
- "options": [ # Any metadata attached to the method.
- { # A protocol buffer option, which can be attached to a message, field,
- # enumeration, etc.
- "name": "A String", # The option's name. For protobuf built-in options (options defined in
- # descriptor.proto), this is the short name. For example, `"map_entry"`.
- # For custom options, it should be the fully-qualified name. For example,
- # `"google.api.http"`.
- "value": { # The option's value packed in an Any message. If the value is a primitive,
- # the corresponding wrapper type defined in google/protobuf/wrappers.proto
- # should be used. If the value is an enum, it should be stored as an int32
- # value using the google.protobuf.Int32Value type.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- },
- ],
- },
- ],
+ "name": "A String", # The fully qualified name of this api, including package name
+ # followed by the api's simple name.
},
],
"customError": { # Customize service error responses. For example, list any service # Custom error configuration.
@@ -1380,32 +1381,12 @@
# enums:
# - name: google.someapi.v1.SomeEnum
{ # Enum type definition.
+ "syntax": "A String", # The source syntax.
"sourceContext": { # `SourceContext` represents information about the source of a # The source context.
# protobuf element, like the file in which it is defined.
"fileName": "A String", # The path-qualified name of the .proto file that contained the associated
# protobuf element. For example: `"google/protobuf/source_context.proto"`.
},
- "enumvalue": [ # Enum value definitions.
- { # Enum value definition.
- "options": [ # Protocol buffer options.
- { # A protocol buffer option, which can be attached to a message, field,
- # enumeration, etc.
- "name": "A String", # The option's name. For protobuf built-in options (options defined in
- # descriptor.proto), this is the short name. For example, `"map_entry"`.
- # For custom options, it should be the fully-qualified name. For example,
- # `"google.api.http"`.
- "value": { # The option's value packed in an Any message. If the value is a primitive,
- # the corresponding wrapper type defined in google/protobuf/wrappers.proto
- # should be used. If the value is an enum, it should be stored as an int32
- # value using the google.protobuf.Int32Value type.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- },
- ],
- "number": 42, # Enum value number.
- "name": "A String", # Enum value name.
- },
- ],
"options": [ # Protocol buffer options.
{ # A protocol buffer option, which can be attached to a message, field,
# enumeration, etc.
@@ -1422,7 +1403,27 @@
},
],
"name": "A String", # Enum type name.
- "syntax": "A String", # The source syntax.
+ "enumvalue": [ # Enum value definitions.
+ { # Enum value definition.
+ "number": 42, # Enum value number.
+ "name": "A String", # Enum value name.
+ "options": [ # Protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For protobuf built-in options (options defined in
+ # descriptor.proto), this is the short name. For example, `"map_entry"`.
+ # For custom options, it should be the fully-qualified name. For example,
+ # `"google.api.http"`.
+ "value": { # The option's value packed in an Any message. If the value is a primitive,
+ # the corresponding wrapper type defined in google/protobuf/wrappers.proto
+ # should be used. If the value is an enum, it should be stored as an int32
+ # value using the google.protobuf.Int32Value type.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
},
],
"types": [ # A list of all proto message types included in this API service.
@@ -1761,10 +1762,10 @@
# **NOTE:** All service configuration rules follow "last one wins" order.
{ # A context rule provides information about the context for an individual API
# element.
- "requested": [ # A list of full type names of requested contexts.
+ "provided": [ # A list of full type names of provided contexts.
"A String",
],
- "provided": [ # A list of full type names of provided contexts.
+ "requested": [ # A list of full type names of requested contexts.
"A String",
],
"selector": "A String", # Selects the methods to which this rule applies.
@@ -1773,7 +1774,6 @@
},
],
},
- "title": "A String", # The product title associated with this service.
"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.
diff --git a/docs/dyn/serviceuser_v1.services.html b/docs/dyn/serviceuser_v1.services.html
index e400f30..ef95b92 100644
--- a/docs/dyn/serviceuser_v1.services.html
+++ b/docs/dyn/serviceuser_v1.services.html
@@ -149,9 +149,10 @@
# 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.
+ "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"`.
"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"`.
@@ -161,10 +162,9 @@
"key": "A String", # The label key.
},
],
- "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"`.
+ "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.
"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
@@ -203,6 +203,65 @@
# the documentation and can contain details.
},
],
+ "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
+ # and/or a URL query parameter. This configuration specifies which methods
+ # change the names of the system parameters.
+ "rules": [ # Define system parameters.
+ #
+ # The parameters defined here will override the default parameters
+ # implemented by the system. If this field is missing from the service
+ # config, default system parameters will be used. Default system parameters
+ # and names is implementation-dependent.
+ #
+ # Example: define api key for all methods
+ #
+ # system_parameters
+ # rules:
+ # - selector: "*"
+ # parameters:
+ # - name: api_key
+ # url_query_parameter: api_key
+ #
+ #
+ # Example: define 2 api key names for a specific method.
+ #
+ # system_parameters
+ # rules:
+ # - selector: "/ListShelves"
+ # parameters:
+ # - name: api_key
+ # http_header: Api-Key1
+ # - name: api_key
+ # http_header: Api-Key2
+ #
+ # **NOTE:** All service configuration rules follow "last one wins" order.
+ { # Define a system parameter rule mapping system parameter definitions to
+ # methods.
+ "parameters": [ # Define parameters. Multiple names may be defined for a parameter.
+ # For a given method call, only one of them should be used. If multiple
+ # names are used the behavior is implementation-dependent.
+ # If none of the specified names are present the behavior is
+ # parameter-dependent.
+ { # Define a parameter's name and location. The parameter may be passed as either
+ # an HTTP header or a URL query parameter, and if both are passed the behavior
+ # is implementation-dependent.
+ "urlQueryParameter": "A String", # Define the URL query parameter name to use for the parameter. It is case
+ # sensitive.
+ "httpHeader": "A String", # Define the HTTP header name to use for the parameter. It is case
+ # insensitive.
+ "name": "A String", # Define the name of the parameter, such as "api_key" . It is case sensitive.
+ },
+ ],
+ "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
+ # methods in all APIs.
+ #
+ # Refer to selector for syntax details.
+ },
+ ],
+ },
"id": "A String", # A unique ID for a specific instance of this message, typically assigned
# by the client for tracking purpose. If empty, the server may choose to
# generate one instead.
@@ -286,65 +345,7 @@
},
],
},
- "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
- # and/or a URL query parameter. This configuration specifies which methods
- # change the names of the system parameters.
- "rules": [ # Define system parameters.
- #
- # The parameters defined here will override the default parameters
- # implemented by the system. If this field is missing from the service
- # config, default system parameters will be used. Default system parameters
- # and names is implementation-dependent.
- #
- # Example: define api key for all methods
- #
- # system_parameters
- # rules:
- # - selector: "*"
- # parameters:
- # - name: api_key
- # url_query_parameter: api_key
- #
- #
- # Example: define 2 api key names for a specific method.
- #
- # system_parameters
- # rules:
- # - selector: "/ListShelves"
- # parameters:
- # - name: api_key
- # http_header: Api-Key1
- # - name: api_key
- # http_header: Api-Key2
- #
- # **NOTE:** All service configuration rules follow "last one wins" order.
- { # Define a system parameter rule mapping system parameter definitions to
- # methods.
- "parameters": [ # Define parameters. Multiple names may be defined for a parameter.
- # For a given method call, only one of them should be used. If multiple
- # names are used the behavior is implementation-dependent.
- # If none of the specified names are present the behavior is
- # parameter-dependent.
- { # Define a parameter's name and location. The parameter may be passed as either
- # an HTTP header or a URL query parameter, and if both are passed the behavior
- # is implementation-dependent.
- "urlQueryParameter": "A String", # Define the URL query parameter name to use for the parameter. It is case
- # sensitive.
- "name": "A String", # Define the name of the parameter, such as "api_key" . It is case sensitive.
- "httpHeader": "A String", # Define the HTTP header name to use for the parameter. It is case
- # insensitive.
- },
- ],
- "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all
- # methods in all APIs.
- #
- # Refer to selector for syntax details.
- },
- ],
- },
+ "title": "A String", # The product title associated with this service.
"authentication": { # `Authentication` defines the authentication configuration for an API. # Auth configuration.
#
# Example for an API targeted for external use:
@@ -397,6 +398,13 @@
# canonical_scopes: https://www.googleapis.com/auth/calendar,
# https://www.googleapis.com/auth/calendar.read
},
+ "allowWithoutCredential": True or False, # Whether to allow requests without a credential. The credential can be
+ # an OAuth token, Google cookies (first-party auth) or EndUserCreds.
+ #
+ # For requests without credentials, if the service control environment is
+ # specified, each incoming request **must** be associated with a service
+ # consumer. This can be done by passing an API key that belongs to a consumer
+ # project.
"requirements": [ # Requirements for additional authentication providers.
{ # User-defined authentication requirements, including support for
# [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
@@ -423,13 +431,6 @@
# bookstore_web.apps.googleusercontent.com
},
],
- "allowWithoutCredential": True or False, # Whether to allow requests without a credential. The credential can be
- # an OAuth token, Google cookies (first-party auth) or EndUserCreds.
- #
- # For requests without credentials, if the service control environment is
- # specified, each incoming request **must** be associated with a service
- # consumer. This can be done by passing an API key that belongs to a consumer
- # project.
"selector": "A String", # Selects the methods to which this rule applies.
#
# Refer to selector for syntax details.
@@ -746,9 +747,6 @@
# `*` for mapping all fields not captured by the path pattern to the HTTP
# body. NOTE: the referred field must not be a repeated field and must be
# present at the top-level of request message type.
- "selector": "A String", # Selects methods to which this rule applies.
- #
- # Refer to selector for syntax details.
"get": "A String", # Used for listing and getting information about resources.
"mediaDownload": { # Use this only for Scotty Requests. Do not use this for media support using # Use this only for Scotty Requests. Do not use this for bytestream methods.
# For media support, add instead [][google.bytestream.RestByteStream] as an
@@ -776,13 +774,16 @@
#
# Specify name of the upload service if one is used for upload.
},
- "patch": "A String", # Used for updating a resource.
+ "selector": "A String", # Selects methods to which this rule applies.
+ #
+ # Refer to selector for syntax details.
"responseBody": "A String", # The name of the response field whose value is mapped to the HTTP body of
# response. Other response fields are ignored. This field is optional. When
# not set, the response message will be used as HTTP body of response.
# NOTE: the referred field must be not a repeated field and must be present
# at the top-level of response message type.
"put": "A String", # Used for updating a resource.
+ "patch": "A String", # Used for updating a resource.
"post": "A String", # Used for creating a resource.
"custom": { # A custom pattern is used for defining custom HTTP verb. # Custom pattern is used for defining custom verbs.
"path": "A String", # The path matched by this custom verb.
@@ -798,8 +799,31 @@
# normalization process. It is an error to specify an API interface here
# which cannot be resolved against the associated IDL files.
{ # Api is a light-weight descriptor for a protocol buffer service.
- "name": "A String", # The fully qualified name of this api, including package name
- # followed by the api's simple name.
+ "methods": [ # The methods of this api, in unspecified order.
+ { # Method represents a method of an api.
+ "name": "A String", # The simple name of this method.
+ "requestStreaming": True or False, # If true, the request is streamed.
+ "responseTypeUrl": "A String", # The URL of the output message type.
+ "requestTypeUrl": "A String", # A URL of the input message type.
+ "responseStreaming": True or False, # If true, the response is streamed.
+ "syntax": "A String", # The source syntax of this method.
+ "options": [ # Any metadata attached to the method.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For protobuf built-in options (options defined in
+ # descriptor.proto), this is the short name. For example, `"map_entry"`.
+ # For custom options, it should be the fully-qualified name. For example,
+ # `"google.api.http"`.
+ "value": { # The option's value packed in an Any message. If the value is a primitive,
+ # the corresponding wrapper type defined in google/protobuf/wrappers.proto
+ # should be used. If the value is an enum, it should be stored as an int32
+ # value using the google.protobuf.Int32Value type.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
"sourceContext": { # `SourceContext` represents information about the source of a # Source context for the protocol buffer service represented by this
# message.
# protobuf element, like the file in which it is defined.
@@ -925,31 +949,8 @@
},
},
],
- "methods": [ # The methods of this api, in unspecified order.
- { # Method represents a method of an api.
- "name": "A String", # The simple name of this method.
- "requestStreaming": True or False, # If true, the request is streamed.
- "responseTypeUrl": "A String", # The URL of the output message type.
- "requestTypeUrl": "A String", # A URL of the input message type.
- "responseStreaming": True or False, # If true, the response is streamed.
- "syntax": "A String", # The source syntax of this method.
- "options": [ # Any metadata attached to the method.
- { # A protocol buffer option, which can be attached to a message, field,
- # enumeration, etc.
- "name": "A String", # The option's name. For protobuf built-in options (options defined in
- # descriptor.proto), this is the short name. For example, `"map_entry"`.
- # For custom options, it should be the fully-qualified name. For example,
- # `"google.api.http"`.
- "value": { # The option's value packed in an Any message. If the value is a primitive,
- # the corresponding wrapper type defined in google/protobuf/wrappers.proto
- # should be used. If the value is an enum, it should be stored as an int32
- # value using the google.protobuf.Int32Value type.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- },
- ],
- },
- ],
+ "name": "A String", # The fully qualified name of this api, including package name
+ # followed by the api's simple name.
},
],
"customError": { # Customize service error responses. For example, list any service # Custom error configuration.
@@ -1137,32 +1138,12 @@
# enums:
# - name: google.someapi.v1.SomeEnum
{ # Enum type definition.
+ "syntax": "A String", # The source syntax.
"sourceContext": { # `SourceContext` represents information about the source of a # The source context.
# protobuf element, like the file in which it is defined.
"fileName": "A String", # The path-qualified name of the .proto file that contained the associated
# protobuf element. For example: `"google/protobuf/source_context.proto"`.
},
- "enumvalue": [ # Enum value definitions.
- { # Enum value definition.
- "options": [ # Protocol buffer options.
- { # A protocol buffer option, which can be attached to a message, field,
- # enumeration, etc.
- "name": "A String", # The option's name. For protobuf built-in options (options defined in
- # descriptor.proto), this is the short name. For example, `"map_entry"`.
- # For custom options, it should be the fully-qualified name. For example,
- # `"google.api.http"`.
- "value": { # The option's value packed in an Any message. If the value is a primitive,
- # the corresponding wrapper type defined in google/protobuf/wrappers.proto
- # should be used. If the value is an enum, it should be stored as an int32
- # value using the google.protobuf.Int32Value type.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- },
- ],
- "number": 42, # Enum value number.
- "name": "A String", # Enum value name.
- },
- ],
"options": [ # Protocol buffer options.
{ # A protocol buffer option, which can be attached to a message, field,
# enumeration, etc.
@@ -1179,7 +1160,27 @@
},
],
"name": "A String", # Enum type name.
- "syntax": "A String", # The source syntax.
+ "enumvalue": [ # Enum value definitions.
+ { # Enum value definition.
+ "number": 42, # Enum value number.
+ "name": "A String", # Enum value name.
+ "options": [ # Protocol buffer options.
+ { # A protocol buffer option, which can be attached to a message, field,
+ # enumeration, etc.
+ "name": "A String", # The option's name. For protobuf built-in options (options defined in
+ # descriptor.proto), this is the short name. For example, `"map_entry"`.
+ # For custom options, it should be the fully-qualified name. For example,
+ # `"google.api.http"`.
+ "value": { # The option's value packed in an Any message. If the value is a primitive,
+ # the corresponding wrapper type defined in google/protobuf/wrappers.proto
+ # should be used. If the value is an enum, it should be stored as an int32
+ # value using the google.protobuf.Int32Value type.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ },
+ ],
},
],
"types": [ # A list of all proto message types included in this API service.
@@ -1518,10 +1519,10 @@
# **NOTE:** All service configuration rules follow "last one wins" order.
{ # A context rule provides information about the context for an individual API
# element.
- "requested": [ # A list of full type names of requested contexts.
+ "provided": [ # A list of full type names of provided contexts.
"A String",
],
- "provided": [ # A list of full type names of provided contexts.
+ "requested": [ # A list of full type names of requested contexts.
"A String",
],
"selector": "A String", # Selects the methods to which this rule applies.
@@ -1530,7 +1531,6 @@
},
],
},
- "title": "A String", # The product title associated with this service.
"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.
diff --git a/docs/dyn/sheets_v4.spreadsheets.html b/docs/dyn/sheets_v4.spreadsheets.html
index b38c17f..5d1b646 100644
--- a/docs/dyn/sheets_v4.spreadsheets.html
+++ b/docs/dyn/sheets_v4.spreadsheets.html
@@ -126,11 +126,6 @@
# Meaningful only if include_spreadsheet_response is 'true'.
"A String",
],
- "includeSpreadsheetInResponse": True or False, # Determines if the update response should include the spreadsheet
- # resource.
- "responseIncludeGridData": True or False, # True if grid data should be returned. Meaningful only if
- # if include_spreadsheet_response is 'true'.
- # This parameter is ignored if a field mask was set in the request.
"requests": [ # A list of updates to apply to the spreadsheet.
{ # A single kind of update to apply to a spreadsheet.
"duplicateFilterView": { # Duplicates a particular filter view. # Duplicates a filter view.
@@ -198,9 +193,9 @@
"columnIndex": 42, # The column index of the coordinate.
"sheetId": 42, # The sheet this coordinate is on.
},
+ "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
"offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset
# from the anchor cell.
- "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
"offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset
# from the anchor cell.
"heightPixels": 42, # The height of the object, in pixels. Defaults to 371.
@@ -215,99 +210,6 @@
# A single `"*"` can be used as short-hand for listing every field.
"objectId": 42, # The ID of the object to moved.
},
- "addFilterView": { # Adds a filter view. # Adds a filter view.
- "filter": { # A filter view. # The filter to add. The filterViewId
- # field is optional; if one is not set, an id will be randomly generated. (It
- # is an error to specify the ID of a filter that already exists.)
- "title": "A String", # The name of the filter view.
- "namedRangeId": "A String", # The named range this filter view is backed by, if any.
- #
- # When writing, only one of range or named_range_id
- # may be set.
- "filterViewId": 42, # The ID of the filter view.
- "range": { # A range on a sheet. # The range this filter view covers.
- #
- # When writing, only one of range or named_range_id
- # may be set.
- # All indexes are zero-based.
- # Indexes are half open, e.g the start index is inclusive
- # and the end index is exclusive -- [start_index, end_index).
- # Missing indexes indicate the range is unbounded on that side.
- #
- # For example, if `"Sheet1"` is sheet ID 0, then:
- #
- # `Sheet1!A1:A1 == sheet_id: 0,
- # start_row_index: 0, end_row_index: 1,
- # start_column_index: 0, end_column_index: 1`
- #
- # `Sheet1!A3:B4 == sheet_id: 0,
- # start_row_index: 2, end_row_index: 4,
- # start_column_index: 0, end_column_index: 2`
- #
- # `Sheet1!A:B == sheet_id: 0,
- # start_column_index: 0, end_column_index: 2`
- #
- # `Sheet1!A5:B == sheet_id: 0,
- # start_row_index: 4,
- # start_column_index: 0, end_column_index: 2`
- #
- # `Sheet1 == sheet_id:0`
- #
- # The start index must always be less than or equal to the end index.
- # If the start index equals the end index, then the range is empty.
- # Empty ranges are typically not meaningful and are usually rendered in the
- # UI as `#REF!`.
- "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
- "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
- "sheetId": 42, # The sheet this range is on.
- "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
- "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
- },
- "sortSpecs": [ # The sort order per column. Later specifications are used when values
- # are equal in the earlier specifications.
- { # A sort order associated with a specific column or row.
- "sortOrder": "A String", # The order data should be sorted.
- "dimensionIndex": 42, # The dimension the sort should be applied to.
- },
- ],
- "criteria": { # The criteria for showing/hiding values per column.
- # The map's key is the column index, and the value is the criteria for
- # that column.
- "a_key": { # Criteria for showing/hiding rows in a filter or filter view.
- "hiddenValues": [ # Values that should be hidden.
- "A String",
- ],
- "condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.
- # (This does not override hiddenValues -- if a value is listed there,
- # it will still be hidden.)
- # BooleanConditions are used by conditional formatting,
- # data validation, and the criteria in filters.
- "values": [ # The values of the condition. The number of supported values depends
- # on the condition type. Some support zero values,
- # others one or two values,
- # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
- { # The value of the condition.
- "relativeDate": "A String", # A relative date (based on the current date).
- # Valid only if the type is
- # DATE_BEFORE,
- # DATE_AFTER,
- # DATE_ON_OR_BEFORE or
- # DATE_ON_OR_AFTER.
- #
- # Relative dates are not supported in data validation.
- # They are supported only in conditional formatting and
- # conditional filters.
- "userEnteredValue": "A String", # A value the condition is based on.
- # The value will be parsed as if the user typed into a cell.
- # Formulas are supported (and must begin with an `=`).
- },
- ],
- "type": "A String", # The type of condition.
- },
- },
- },
- },
- },
"updateConditionalFormatRule": { # Updates a conditional format rule at the given index, # Updates an existing conditional format rule.
# or moves a conditional format rule to another index.
"index": 42, # The zero-based index of the rule that should be replaced or moved.
@@ -668,7 +570,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -939,140 +860,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -1207,27 +994,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
},
"gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.
@@ -1908,10 +1810,890 @@
"columnIndex": 42, # The column index of the coordinate.
"sheetId": 42, # The sheet this coordinate is on.
},
- "type": "A String", # How the data should be pasted.
+ "data": "A String", # The data to insert.
"delimiter": "A String", # The delimiter in the data.
"html": True or False, # True if the data is HTML.
- "data": "A String", # The data to insert.
+ "type": "A String", # How the data should be pasted.
+ },
+ "updateSpreadsheetProperties": { # Updates properties of a spreadsheet. # Updates the spreadsheet's properties.
+ "fields": "A String", # The fields that should be updated. At least one field must be specified.
+ # The root 'properties' is implied and should not be specified.
+ # A single `"*"` can be used as short-hand for listing every field.
+ "properties": { # Properties of a spreadsheet. # The properties to update.
+ "title": "A String", # The title of the spreadsheet.
+ "locale": "A String", # The locale of the spreadsheet in one of the following formats:
+ #
+ # * an ISO 639-1 language code such as `en`
+ #
+ # * an ISO 639-2 language code such as `fil`, if no 639-1 code exists
+ #
+ # * a combination of the ISO language code and country code, such as `en_US`
+ #
+ # Note: when updating this field, not all locales/languages are supported.
+ "defaultFormat": { # The format of a cell. # The default format of all cells in the spreadsheet.
+ # CellData.effectiveFormat will not be set if the
+ # cell's format is equal to this default format.
+ # This field is read-only.
+ "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/api/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.
+ },
+ "textDirection": "A String", # The direction of the text in the cell.
+ "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
+ # When updating padding, every field must be specified.
+ "top": 42, # The top padding of the cell.
+ "right": 42, # The right padding of the cell.
+ "left": 42, # The left padding of the cell.
+ "bottom": 42, # The bottom padding of the cell.
+ },
+ "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
+ "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
+ "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
+ # Absent values indicate that the field isn't specified.
+ "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "bold": True or False, # True if the text is bold.
+ "strikethrough": True or False, # True if the text has a strikethrough.
+ "fontFamily": "A String", # The font family.
+ "fontSize": 42, # The size of the font.
+ "italic": True or False, # True if the text is italicized.
+ "underline": True or False, # True if the text is underlined.
+ },
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
+ "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
+ "borders": { # The borders of the cell. # The borders of the cell.
+ "top": { # A border along a cell. # The top border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
+ "right": { # A border along a cell. # The right border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
+ "left": { # A border along a cell. # The left border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
+ },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ },
+ "autoRecalc": "A String", # The amount of time to wait before volatile functions are recalculated.
+ "iterativeCalculationSettings": { # Settings to control how circular dependencies are resolved with iterative # Determines whether and how circular references are resolved with iterative
+ # calculation. Absence of this field means that circular references will
+ # result in calculation errors.
+ # calculation.
+ "convergenceThreshold": 3.14, # When iterative calculation is enabled and successive results differ by
+ # less than this threshold value, the calculation rounds stop.
+ "maxIterations": 42, # When iterative calculation is enabled, the maximum number of calculation
+ # rounds to perform.
+ },
+ "timeZone": "A String", # The time zone of the spreadsheet, in CLDR format such as
+ # `America/New_York`. If the time zone isn't recognized, this may
+ # be a custom time zone such as `GMT-07:00`.
+ },
},
"appendCells": { # Adds new cells after the last row with data in a sheet, # Appends cells after the last row with data in a sheet.
# inserting new rows into the sheet if necessary.
@@ -2469,7 +3251,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -2740,140 +3541,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -3008,27 +3675,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
"userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.
#
@@ -3318,7 +4100,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -3589,140 +4390,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -3857,27 +4524,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
"dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.
#
@@ -4262,9 +5044,9 @@
"columnIndex": 42, # The column index of the coordinate.
"sheetId": 42, # The sheet this coordinate is on.
},
+ "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
"offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset
# from the anchor cell.
- "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
"offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset
# from the anchor cell.
"heightPixels": 42, # The height of the object, in pixels. Defaults to 371.
@@ -4548,6 +5330,8 @@
# A chart may not have more than one axis per
# axis position.
"position": "A String", # The position of this axis.
+ "title": "A String", # The title of this axis. If set, this overrides any title inferred
+ # from headers of the data.
"format": { # The format of a run of text in a cell. # The format of the title.
# Only valid if the axis is not associated with the domain.
# Absent values indicate that the field isn't specified.
@@ -4687,8 +5471,6 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "title": "A String", # The title of this axis. If set, this overrides any title inferred
- # from headers of the data.
},
],
},
@@ -5056,7 +5838,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -5327,140 +6128,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -5595,27 +6262,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
},
"gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.
@@ -6599,7 +7381,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -6870,140 +7671,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -7138,27 +7805,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
"userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.
#
@@ -7448,7 +8230,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -7719,140 +8520,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -7987,27 +8654,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
"dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.
#
@@ -8370,885 +9152,45 @@
},
},
},
- "updateSpreadsheetProperties": { # Updates properties of a spreadsheet. # Updates the spreadsheet's properties.
- "fields": "A String", # The fields that should be updated. At least one field must be specified.
- # The root 'properties' is implied and should not be specified.
- # A single `"*"` can be used as short-hand for listing every field.
- "properties": { # Properties of a spreadsheet. # The properties to update.
- "title": "A String", # The title of the spreadsheet.
- "locale": "A String", # The locale of the spreadsheet in one of the following formats:
- #
- # * an ISO 639-1 language code such as `en`
- #
- # * an ISO 639-2 language code such as `fil`, if no 639-1 code exists
- #
- # * a combination of the ISO language code and country code, such as `en_US`
- #
- # Note: when updating this field, not all locales/languages are supported.
- "autoRecalc": "A String", # The amount of time to wait before volatile functions are recalculated.
- "defaultFormat": { # The format of a cell. # The default format of all cells in the spreadsheet.
- # CellData.effectiveFormat will not be set if the
- # cell's format is equal to this default format.
- # This field is read-only.
- "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/api/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.
- },
- "textDirection": "A String", # The direction of the text in the cell.
- "padding": { # The amount of padding around the cell, in pixels. # The padding of the cell.
- # When updating padding, every field must be specified.
- "top": 42, # The top padding of the cell.
- "right": 42, # The right padding of the cell.
- "left": 42, # The left padding of the cell.
- "bottom": 42, # The bottom padding of the cell.
- },
- "horizontalAlignment": "A String", # The horizontal alignment of the value in the cell.
- "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed # The background color of the cell.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "verticalAlignment": "A String", # The vertical alignment of the value in the cell.
- "textFormat": { # The format of a run of text in a cell. # The format of the text in the cell (unless overridden by a format run).
- # Absent values indicate that the field isn't specified.
- "foregroundColor": { # Represents a color in the RGBA color space. This representation is designed # The foreground color of the text.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "bold": True or False, # True if the text is bold.
- "strikethrough": True or False, # True if the text has a strikethrough.
- "fontFamily": "A String", # The font family.
- "fontSize": 42, # The size of the font.
- "italic": True or False, # True if the text is italicized.
- "underline": True or False, # True if the text is underlined.
- },
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
- "hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
- "borders": { # The borders of the cell. # The borders of the cell.
- "top": { # A border along a cell. # The top border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
- "right": { # A border along a cell. # The right border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
- "left": { # A border along a cell. # The left border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
- },
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
- },
- "iterativeCalculationSettings": { # Settings to control how circular dependencies are resolved with iterative # Determines whether and how circular references are resolved with iterative
- # calculation. Absence of this field means that circular references will
- # result in calculation errors.
- # calculation.
- "convergenceThreshold": 3.14, # When iterative calculation is enabled and successive results differ by
- # less than this threshold value, the calculation rounds stop.
- "maxIterations": 42, # When iterative calculation is enabled, the maximum number of calculation
- # rounds to perform.
- },
- "timeZone": "A String", # The time zone of the spreadsheet, in CLDR format such as
- # `America/New_York`. If the time zone isn't recognized, this may
- # be a custom time zone such as `GMT-07:00`.
+ "insertRange": { # Inserts cells into a range, shifting the existing cells over or down. # Inserts new cells in a sheet, shifting the existing cells.
+ "range": { # A range on a sheet. # The range to insert new cells into.
+ # All indexes are zero-based.
+ # Indexes are half open, e.g the start index is inclusive
+ # and the end index is exclusive -- [start_index, end_index).
+ # Missing indexes indicate the range is unbounded on that side.
+ #
+ # For example, if `"Sheet1"` is sheet ID 0, then:
+ #
+ # `Sheet1!A1:A1 == sheet_id: 0,
+ # start_row_index: 0, end_row_index: 1,
+ # start_column_index: 0, end_column_index: 1`
+ #
+ # `Sheet1!A3:B4 == sheet_id: 0,
+ # start_row_index: 2, end_row_index: 4,
+ # start_column_index: 0, end_column_index: 2`
+ #
+ # `Sheet1!A:B == sheet_id: 0,
+ # start_column_index: 0, end_column_index: 2`
+ #
+ # `Sheet1!A5:B == sheet_id: 0,
+ # start_row_index: 4,
+ # start_column_index: 0, end_column_index: 2`
+ #
+ # `Sheet1 == sheet_id:0`
+ #
+ # The start index must always be less than or equal to the end index.
+ # If the start index equals the end index, then the range is empty.
+ # Empty ranges are typically not meaningful and are usually rendered in the
+ # UI as `#REF!`.
+ "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
+ "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
+ "sheetId": 42, # The sheet this range is on.
+ "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
+ "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
},
+ "shiftDimension": "A String", # The dimension which will be shifted when inserting cells.
+ # If ROWS, existing cells will be shifted down.
+ # If COLUMNS, existing cells will be shifted right.
},
"updateCells": { # Updates all cells in a range with new data. # Updates many cells at once.
"start": { # A coordinate in a sheet. # The coordinate to start writing data at.
@@ -9847,7 +9789,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -10118,140 +10079,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -10386,27 +10213,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
"userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.
#
@@ -10696,7 +10638,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -10967,140 +10928,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -11235,27 +11062,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
"dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.
#
@@ -11539,8 +11481,8 @@
},
"appendDimension": { # Appends rows or columns to the end of a sheet. # Appends dimensions to the end of a sheet.
"length": 42, # The number of rows or columns to append.
- "sheetId": 42, # The sheet to append rows or columns to.
"dimension": "A String", # Whether rows or columns should be appended.
+ "sheetId": 42, # The sheet to append rows or columns to.
},
"updateBanding": { # Updates properties of the supplied banded range. # Updates a banded range
"fields": "A String", # The fields that should be updated. At least one field must be specified.
@@ -12854,48 +12796,46 @@
"clearBasicFilter": { # Clears the basic filter, if any exists on the sheet. # Clears the basic filter on a sheet.
"sheetId": 42, # The sheet ID on which the basic filter should be cleared.
},
- "addNamedRange": { # Adds a named range to the spreadsheet. # Adds a named range.
- "namedRange": { # A named range. # The named range to add. The namedRangeId
- # field is optional; if one is not set, an id will be randomly generated. (It
- # is an error to specify the ID of a range that already exists.)
- "namedRangeId": "A String", # The ID of the named range.
- "range": { # A range on a sheet. # The range this represents.
- # All indexes are zero-based.
- # Indexes are half open, e.g the start index is inclusive
- # and the end index is exclusive -- [start_index, end_index).
- # Missing indexes indicate the range is unbounded on that side.
- #
- # For example, if `"Sheet1"` is sheet ID 0, then:
- #
- # `Sheet1!A1:A1 == sheet_id: 0,
- # start_row_index: 0, end_row_index: 1,
- # start_column_index: 0, end_column_index: 1`
- #
- # `Sheet1!A3:B4 == sheet_id: 0,
- # start_row_index: 2, end_row_index: 4,
- # start_column_index: 0, end_column_index: 2`
- #
- # `Sheet1!A:B == sheet_id: 0,
- # start_column_index: 0, end_column_index: 2`
- #
- # `Sheet1!A5:B == sheet_id: 0,
- # start_row_index: 4,
- # start_column_index: 0, end_column_index: 2`
- #
- # `Sheet1 == sheet_id:0`
- #
- # The start index must always be less than or equal to the end index.
- # If the start index equals the end index, then the range is empty.
- # Empty ranges are typically not meaningful and are usually rendered in the
- # UI as `#REF!`.
- "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
- "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
- "sheetId": 42, # The sheet this range is on.
- "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
- "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
- },
- "name": "A String", # The name of the named range.
+ "textToColumns": { # Splits a column of text into multiple columns, # Converts a column of text into many columns of text.
+ # based on a delimiter in each cell.
+ "source": { # A range on a sheet. # The source data range. This must span exactly one column.
+ # All indexes are zero-based.
+ # Indexes are half open, e.g the start index is inclusive
+ # and the end index is exclusive -- [start_index, end_index).
+ # Missing indexes indicate the range is unbounded on that side.
+ #
+ # For example, if `"Sheet1"` is sheet ID 0, then:
+ #
+ # `Sheet1!A1:A1 == sheet_id: 0,
+ # start_row_index: 0, end_row_index: 1,
+ # start_column_index: 0, end_column_index: 1`
+ #
+ # `Sheet1!A3:B4 == sheet_id: 0,
+ # start_row_index: 2, end_row_index: 4,
+ # start_column_index: 0, end_column_index: 2`
+ #
+ # `Sheet1!A:B == sheet_id: 0,
+ # start_column_index: 0, end_column_index: 2`
+ #
+ # `Sheet1!A5:B == sheet_id: 0,
+ # start_row_index: 4,
+ # start_column_index: 0, end_column_index: 2`
+ #
+ # `Sheet1 == sheet_id:0`
+ #
+ # The start index must always be less than or equal to the end index.
+ # If the start index equals the end index, then the range is empty.
+ # Empty ranges are typically not meaningful and are usually rendered in the
+ # UI as `#REF!`.
+ "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
+ "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
+ "sheetId": 42, # The sheet this range is on.
+ "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
+ "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
},
+ "delimiter": "A String", # The delimiter to use. Used only if delimiterType is
+ # CUSTOM.
+ "delimiterType": "A String", # The delimiter type to use.
},
"updateChartSpec": { # Updates a chart's specifications. # Updates a chart's specifications.
# (This does not move or resize a chart. To move or resize a chart, use
@@ -13179,6 +13119,8 @@
# A chart may not have more than one axis per
# axis position.
"position": "A String", # The position of this axis.
+ "title": "A String", # The title of this axis. If set, this overrides any title inferred
+ # from headers of the data.
"format": { # The format of a run of text in a cell. # The format of the title.
# Only valid if the axis is not associated with the domain.
# Absent values indicate that the field isn't specified.
@@ -13318,8 +13260,6 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "title": "A String", # The title of this axis. If set, this overrides any title inferred
- # from headers of the data.
},
],
},
@@ -13350,46 +13290,48 @@
# (the zero-based index of row 5).
# The end result would be `A1..A5` of `0, 3, 1, 2, 4`.
},
- "textToColumns": { # Splits a column of text into multiple columns, # Converts a column of text into many columns of text.
- # based on a delimiter in each cell.
- "source": { # A range on a sheet. # The source data range. This must span exactly one column.
- # All indexes are zero-based.
- # Indexes are half open, e.g the start index is inclusive
- # and the end index is exclusive -- [start_index, end_index).
- # Missing indexes indicate the range is unbounded on that side.
- #
- # For example, if `"Sheet1"` is sheet ID 0, then:
- #
- # `Sheet1!A1:A1 == sheet_id: 0,
- # start_row_index: 0, end_row_index: 1,
- # start_column_index: 0, end_column_index: 1`
- #
- # `Sheet1!A3:B4 == sheet_id: 0,
- # start_row_index: 2, end_row_index: 4,
- # start_column_index: 0, end_column_index: 2`
- #
- # `Sheet1!A:B == sheet_id: 0,
- # start_column_index: 0, end_column_index: 2`
- #
- # `Sheet1!A5:B == sheet_id: 0,
- # start_row_index: 4,
- # start_column_index: 0, end_column_index: 2`
- #
- # `Sheet1 == sheet_id:0`
- #
- # The start index must always be less than or equal to the end index.
- # If the start index equals the end index, then the range is empty.
- # Empty ranges are typically not meaningful and are usually rendered in the
- # UI as `#REF!`.
- "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
- "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
- "sheetId": 42, # The sheet this range is on.
- "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
- "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
+ "addNamedRange": { # Adds a named range to the spreadsheet. # Adds a named range.
+ "namedRange": { # A named range. # The named range to add. The namedRangeId
+ # field is optional; if one is not set, an id will be randomly generated. (It
+ # is an error to specify the ID of a range that already exists.)
+ "namedRangeId": "A String", # The ID of the named range.
+ "range": { # A range on a sheet. # The range this represents.
+ # All indexes are zero-based.
+ # Indexes are half open, e.g the start index is inclusive
+ # and the end index is exclusive -- [start_index, end_index).
+ # Missing indexes indicate the range is unbounded on that side.
+ #
+ # For example, if `"Sheet1"` is sheet ID 0, then:
+ #
+ # `Sheet1!A1:A1 == sheet_id: 0,
+ # start_row_index: 0, end_row_index: 1,
+ # start_column_index: 0, end_column_index: 1`
+ #
+ # `Sheet1!A3:B4 == sheet_id: 0,
+ # start_row_index: 2, end_row_index: 4,
+ # start_column_index: 0, end_column_index: 2`
+ #
+ # `Sheet1!A:B == sheet_id: 0,
+ # start_column_index: 0, end_column_index: 2`
+ #
+ # `Sheet1!A5:B == sheet_id: 0,
+ # start_row_index: 4,
+ # start_column_index: 0, end_column_index: 2`
+ #
+ # `Sheet1 == sheet_id:0`
+ #
+ # The start index must always be less than or equal to the end index.
+ # If the start index equals the end index, then the range is empty.
+ # Empty ranges are typically not meaningful and are usually rendered in the
+ # UI as `#REF!`.
+ "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
+ "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
+ "sheetId": 42, # The sheet this range is on.
+ "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
+ "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
+ },
+ "name": "A String", # The name of the named range.
},
- "delimiter": "A String", # The delimiter to use. Used only if delimiterType is
- # CUSTOM.
- "delimiterType": "A String", # The delimiter type to use.
},
"addBanding": { # Adds a new banded range to the spreadsheet. # Adds a new banded range
"bandedRange": { # A banded (alternating colors) range in a sheet. # The banded range to add. The bandedRangeId
@@ -14557,45 +14499,98 @@
"deleteProtectedRange": { # Deletes the protected range with the given ID. # Deletes a protected range.
"protectedRangeId": 42, # The ID of the protected range to delete.
},
- "insertRange": { # Inserts cells into a range, shifting the existing cells over or down. # Inserts new cells in a sheet, shifting the existing cells.
- "range": { # A range on a sheet. # The range to insert new cells into.
- # All indexes are zero-based.
- # Indexes are half open, e.g the start index is inclusive
- # and the end index is exclusive -- [start_index, end_index).
- # Missing indexes indicate the range is unbounded on that side.
- #
- # For example, if `"Sheet1"` is sheet ID 0, then:
- #
- # `Sheet1!A1:A1 == sheet_id: 0,
- # start_row_index: 0, end_row_index: 1,
- # start_column_index: 0, end_column_index: 1`
- #
- # `Sheet1!A3:B4 == sheet_id: 0,
- # start_row_index: 2, end_row_index: 4,
- # start_column_index: 0, end_column_index: 2`
- #
- # `Sheet1!A:B == sheet_id: 0,
- # start_column_index: 0, end_column_index: 2`
- #
- # `Sheet1!A5:B == sheet_id: 0,
- # start_row_index: 4,
- # start_column_index: 0, end_column_index: 2`
- #
- # `Sheet1 == sheet_id:0`
- #
- # The start index must always be less than or equal to the end index.
- # If the start index equals the end index, then the range is empty.
- # Empty ranges are typically not meaningful and are usually rendered in the
- # UI as `#REF!`.
- "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
- "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
- "sheetId": 42, # The sheet this range is on.
- "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
- "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
+ "addFilterView": { # Adds a filter view. # Adds a filter view.
+ "filter": { # A filter view. # The filter to add. The filterViewId
+ # field is optional; if one is not set, an id will be randomly generated. (It
+ # is an error to specify the ID of a filter that already exists.)
+ "title": "A String", # The name of the filter view.
+ "namedRangeId": "A String", # The named range this filter view is backed by, if any.
+ #
+ # When writing, only one of range or named_range_id
+ # may be set.
+ "filterViewId": 42, # The ID of the filter view.
+ "range": { # A range on a sheet. # The range this filter view covers.
+ #
+ # When writing, only one of range or named_range_id
+ # may be set.
+ # All indexes are zero-based.
+ # Indexes are half open, e.g the start index is inclusive
+ # and the end index is exclusive -- [start_index, end_index).
+ # Missing indexes indicate the range is unbounded on that side.
+ #
+ # For example, if `"Sheet1"` is sheet ID 0, then:
+ #
+ # `Sheet1!A1:A1 == sheet_id: 0,
+ # start_row_index: 0, end_row_index: 1,
+ # start_column_index: 0, end_column_index: 1`
+ #
+ # `Sheet1!A3:B4 == sheet_id: 0,
+ # start_row_index: 2, end_row_index: 4,
+ # start_column_index: 0, end_column_index: 2`
+ #
+ # `Sheet1!A:B == sheet_id: 0,
+ # start_column_index: 0, end_column_index: 2`
+ #
+ # `Sheet1!A5:B == sheet_id: 0,
+ # start_row_index: 4,
+ # start_column_index: 0, end_column_index: 2`
+ #
+ # `Sheet1 == sheet_id:0`
+ #
+ # The start index must always be less than or equal to the end index.
+ # If the start index equals the end index, then the range is empty.
+ # Empty ranges are typically not meaningful and are usually rendered in the
+ # UI as `#REF!`.
+ "endRowIndex": 42, # The end row (exclusive) of the range, or not set if unbounded.
+ "endColumnIndex": 42, # The end column (exclusive) of the range, or not set if unbounded.
+ "sheetId": 42, # The sheet this range is on.
+ "startColumnIndex": 42, # The start column (inclusive) of the range, or not set if unbounded.
+ "startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded.
+ },
+ "sortSpecs": [ # The sort order per column. Later specifications are used when values
+ # are equal in the earlier specifications.
+ { # A sort order associated with a specific column or row.
+ "sortOrder": "A String", # The order data should be sorted.
+ "dimensionIndex": 42, # The dimension the sort should be applied to.
+ },
+ ],
+ "criteria": { # The criteria for showing/hiding values per column.
+ # The map's key is the column index, and the value is the criteria for
+ # that column.
+ "a_key": { # Criteria for showing/hiding rows in a filter or filter view.
+ "hiddenValues": [ # Values that should be hidden.
+ "A String",
+ ],
+ "condition": { # A condition that can evaluate to true or false. # A condition that must be true for values to be shown.
+ # (This does not override hiddenValues -- if a value is listed there,
+ # it will still be hidden.)
+ # BooleanConditions are used by conditional formatting,
+ # data validation, and the criteria in filters.
+ "values": [ # The values of the condition. The number of supported values depends
+ # on the condition type. Some support zero values,
+ # others one or two values,
+ # and ConditionType.ONE_OF_LIST supports an arbitrary number of values.
+ { # The value of the condition.
+ "relativeDate": "A String", # A relative date (based on the current date).
+ # Valid only if the type is
+ # DATE_BEFORE,
+ # DATE_AFTER,
+ # DATE_ON_OR_BEFORE or
+ # DATE_ON_OR_AFTER.
+ #
+ # Relative dates are not supported in data validation.
+ # They are supported only in conditional formatting and
+ # conditional filters.
+ "userEnteredValue": "A String", # A value the condition is based on.
+ # The value will be parsed as if the user typed into a cell.
+ # Formulas are supported (and must begin with an `=`).
+ },
+ ],
+ "type": "A String", # The type of condition.
+ },
+ },
+ },
},
- "shiftDimension": "A String", # The dimension which will be shifted when inserting cells.
- # If ROWS, existing cells will be shifted down.
- # If COLUMNS, existing cells will be shifted right.
},
"deleteSheet": { # Deletes the requested sheet. # Deletes a sheet.
"sheetId": 42, # The ID of the sheet to delete.
@@ -15916,6 +15911,11 @@
},
},
],
+ "responseIncludeGridData": True or False, # True if grid data should be returned. Meaningful only if
+ # if include_spreadsheet_response is 'true'.
+ # This parameter is ignored if a field mask was set in the request.
+ "includeSpreadsheetInResponse": True or False, # Determines if the update response should include the spreadsheet
+ # resource.
}
x__xgafv: string, V1 error format.
@@ -15984,7 +15984,6 @@
# * a combination of the ISO language code and country code, such as `en_US`
#
# Note: when updating this field, not all locales/languages are supported.
- "autoRecalc": "A String", # The amount of time to wait before volatile functions are recalculated.
"defaultFormat": { # The format of a cell. # The default format of all cells in the spreadsheet.
# CellData.effectiveFormat will not be set if the
# cell's format is equal to this default format.
@@ -16274,7 +16273,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -16545,140 +16563,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -16813,28 +16697,144 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
+ "autoRecalc": "A String", # The amount of time to wait before volatile functions are recalculated.
"iterativeCalculationSettings": { # Settings to control how circular dependencies are resolved with iterative # Determines whether and how circular references are resolved with iterative
# calculation. Absence of this field means that circular references will
# result in calculation errors.
@@ -17208,7 +17208,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -17479,140 +17498,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -17747,27 +17632,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
},
"gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.
@@ -19440,9 +19440,9 @@
"columnIndex": 42, # The column index of the coordinate.
"sheetId": 42, # The sheet this coordinate is on.
},
+ "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
"offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset
# from the anchor cell.
- "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
"offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset
# from the anchor cell.
"heightPixels": 42, # The height of the object, in pixels. Defaults to 371.
@@ -19726,6 +19726,8 @@
# A chart may not have more than one axis per
# axis position.
"position": "A String", # The position of this axis.
+ "title": "A String", # The title of this axis. If set, this overrides any title inferred
+ # from headers of the data.
"format": { # The format of a run of text in a cell. # The format of the title.
# Only valid if the axis is not associated with the domain.
# Absent values indicate that the field isn't specified.
@@ -19865,8 +19867,6 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "title": "A String", # The title of this axis. If set, this overrides any title inferred
- # from headers of the data.
},
],
},
@@ -20088,6 +20088,17 @@
# while the second one will have `startRow 14` (zero-based row 15),
# and `startColumn 3` (zero-based column D).
{ # Data in the grid, as well as metadata about the dimensions.
+ "startRow": 42, # The first row this GridData refers to, zero-based.
+ "startColumn": 42, # The first column this GridData refers to, zero-based.
+ "columnMetadata": [ # Metadata about the requested columns in the grid, starting with the column
+ # in start_column.
+ { # Properties about a dimension.
+ "pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.
+ "hiddenByUser": True or False, # True if this dimension is explicitly hidden.
+ "hiddenByFilter": True or False, # True if this dimension is being filtered.
+ # This field is read-only.
+ },
+ ],
"rowMetadata": [ # Metadata about the requested rows in the grid, starting with the row
# in start_row.
{ # Properties about a dimension.
@@ -20097,8 +20108,6 @@
# This field is read-only.
},
],
- "startRow": 42, # The first row this GridData refers to, zero-based.
- "startColumn": 42, # The first column this GridData refers to, zero-based.
"rowData": [ # The data in the grid, one entry per row,
# starting with the row in startRow.
# The values in RowData will correspond to columns starting
@@ -20652,7 +20661,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -20923,140 +20951,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -21191,27 +21085,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
"userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.
#
@@ -21501,7 +21510,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -21772,140 +21800,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -22040,27 +21934,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
"dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.
#
@@ -22252,15 +22261,6 @@
],
},
],
- "columnMetadata": [ # Metadata about the requested columns in the grid, starting with the column
- # in start_column.
- { # Properties about a dimension.
- "pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.
- "hiddenByUser": True or False, # True if this dimension is explicitly hidden.
- "hiddenByFilter": True or False, # True if this dimension is being filtered.
- # This field is read-only.
- },
- ],
},
],
"properties": { # Properties of a sheet. # The properties of the sheet.
@@ -22693,9 +22693,9 @@
"columnIndex": 42, # The column index of the coordinate.
"sheetId": 42, # The sheet this coordinate is on.
},
+ "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
"offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset
# from the anchor cell.
- "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
"offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset
# from the anchor cell.
"heightPixels": 42, # The height of the object, in pixels. Defaults to 371.
@@ -22717,9 +22717,9 @@
"columnIndex": 42, # The column index of the coordinate.
"sheetId": 42, # The sheet this coordinate is on.
},
+ "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
"offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset
# from the anchor cell.
- "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
"offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset
# from the anchor cell.
"heightPixels": 42, # The height of the object, in pixels. Defaults to 371.
@@ -23003,6 +23003,8 @@
# A chart may not have more than one axis per
# axis position.
"position": "A String", # The position of this axis.
+ "title": "A String", # The title of this axis. If set, this overrides any title inferred
+ # from headers of the data.
"format": { # The format of a run of text in a cell. # The format of the title.
# Only valid if the axis is not associated with the domain.
# Absent values indicate that the field isn't specified.
@@ -23142,8 +23144,6 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "title": "A String", # The title of this axis. If set, this overrides any title inferred
- # from headers of the data.
},
],
},
@@ -23154,7 +23154,6 @@
"updateConditionalFormatRule": { # The result of updating a conditional format rule. # A reply from updating a conditional format rule.
"oldIndex": 42, # The old index of the rule. Not set if a rule was replaced
# (because it is the same as new_index).
- "newIndex": 42, # The index of the new rule.
"oldRule": { # A rule describing a conditional format. # The old (deleted) rule. Not set if a rule was moved
# (because it is the same as new_rule).
"ranges": [ # The ranges that will be formatted if the condition is true.
@@ -23513,7 +23512,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -23784,140 +23802,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -24052,27 +23936,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
},
"gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.
@@ -24492,6 +24491,7 @@
},
},
},
+ "newIndex": 42, # The index of the new rule.
"newRule": { # A rule describing a conditional format. # The new rule that replaced the old rule (if replacing),
# or the rule that was moved (if moved)
"ranges": [ # The ranges that will be formatted if the condition is true.
@@ -24850,7 +24850,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -25121,140 +25140,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -25389,27 +25274,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
},
"gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.
@@ -26512,7 +26512,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -26783,140 +26802,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -27051,27 +26936,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
},
"gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.
@@ -28771,7 +28771,6 @@
# * a combination of the ISO language code and country code, such as `en_US`
#
# Note: when updating this field, not all locales/languages are supported.
- "autoRecalc": "A String", # The amount of time to wait before volatile functions are recalculated.
"defaultFormat": { # The format of a cell. # The default format of all cells in the spreadsheet.
# CellData.effectiveFormat will not be set if the
# cell's format is equal to this default format.
@@ -29061,7 +29060,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -29332,140 +29350,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -29600,28 +29484,144 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
+ "autoRecalc": "A String", # The amount of time to wait before volatile functions are recalculated.
"iterativeCalculationSettings": { # Settings to control how circular dependencies are resolved with iterative # Determines whether and how circular references are resolved with iterative
# calculation. Absence of this field means that circular references will
# result in calculation errors.
@@ -29995,7 +29995,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -30266,140 +30285,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -30534,27 +30419,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
},
"gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.
@@ -32227,9 +32227,9 @@
"columnIndex": 42, # The column index of the coordinate.
"sheetId": 42, # The sheet this coordinate is on.
},
+ "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
"offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset
# from the anchor cell.
- "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
"offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset
# from the anchor cell.
"heightPixels": 42, # The height of the object, in pixels. Defaults to 371.
@@ -32513,6 +32513,8 @@
# A chart may not have more than one axis per
# axis position.
"position": "A String", # The position of this axis.
+ "title": "A String", # The title of this axis. If set, this overrides any title inferred
+ # from headers of the data.
"format": { # The format of a run of text in a cell. # The format of the title.
# Only valid if the axis is not associated with the domain.
# Absent values indicate that the field isn't specified.
@@ -32652,8 +32654,6 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "title": "A String", # The title of this axis. If set, this overrides any title inferred
- # from headers of the data.
},
],
},
@@ -32875,6 +32875,17 @@
# while the second one will have `startRow 14` (zero-based row 15),
# and `startColumn 3` (zero-based column D).
{ # Data in the grid, as well as metadata about the dimensions.
+ "startRow": 42, # The first row this GridData refers to, zero-based.
+ "startColumn": 42, # The first column this GridData refers to, zero-based.
+ "columnMetadata": [ # Metadata about the requested columns in the grid, starting with the column
+ # in start_column.
+ { # Properties about a dimension.
+ "pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.
+ "hiddenByUser": True or False, # True if this dimension is explicitly hidden.
+ "hiddenByFilter": True or False, # True if this dimension is being filtered.
+ # This field is read-only.
+ },
+ ],
"rowMetadata": [ # Metadata about the requested rows in the grid, starting with the row
# in start_row.
{ # Properties about a dimension.
@@ -32884,8 +32895,6 @@
# This field is read-only.
},
],
- "startRow": 42, # The first row this GridData refers to, zero-based.
- "startColumn": 42, # The first column this GridData refers to, zero-based.
"rowData": [ # The data in the grid, one entry per row,
# starting with the row in startRow.
# The values in RowData will correspond to columns starting
@@ -33439,7 +33448,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -33710,140 +33738,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -33978,27 +33872,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
"userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.
#
@@ -34288,7 +34297,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -34559,140 +34587,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -34827,27 +34721,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
"dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.
#
@@ -35039,15 +35048,6 @@
],
},
],
- "columnMetadata": [ # Metadata about the requested columns in the grid, starting with the column
- # in start_column.
- { # Properties about a dimension.
- "pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.
- "hiddenByUser": True or False, # True if this dimension is explicitly hidden.
- "hiddenByFilter": True or False, # True if this dimension is being filtered.
- # This field is read-only.
- },
- ],
},
],
"properties": { # Properties of a sheet. # The properties of the sheet.
@@ -35277,7 +35277,6 @@
# * a combination of the ISO language code and country code, such as `en_US`
#
# Note: when updating this field, not all locales/languages are supported.
- "autoRecalc": "A String", # The amount of time to wait before volatile functions are recalculated.
"defaultFormat": { # The format of a cell. # The default format of all cells in the spreadsheet.
# CellData.effectiveFormat will not be set if the
# cell's format is equal to this default format.
@@ -35567,7 +35566,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -35838,140 +35856,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -36106,28 +35990,144 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
+ "autoRecalc": "A String", # The amount of time to wait before volatile functions are recalculated.
"iterativeCalculationSettings": { # Settings to control how circular dependencies are resolved with iterative # Determines whether and how circular references are resolved with iterative
# calculation. Absence of this field means that circular references will
# result in calculation errors.
@@ -36501,7 +36501,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -36772,140 +36791,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -37040,27 +36925,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
},
"gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.
@@ -38733,9 +38733,9 @@
"columnIndex": 42, # The column index of the coordinate.
"sheetId": 42, # The sheet this coordinate is on.
},
+ "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
"offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset
# from the anchor cell.
- "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
"offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset
# from the anchor cell.
"heightPixels": 42, # The height of the object, in pixels. Defaults to 371.
@@ -39019,6 +39019,8 @@
# A chart may not have more than one axis per
# axis position.
"position": "A String", # The position of this axis.
+ "title": "A String", # The title of this axis. If set, this overrides any title inferred
+ # from headers of the data.
"format": { # The format of a run of text in a cell. # The format of the title.
# Only valid if the axis is not associated with the domain.
# Absent values indicate that the field isn't specified.
@@ -39158,8 +39160,6 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "title": "A String", # The title of this axis. If set, this overrides any title inferred
- # from headers of the data.
},
],
},
@@ -39381,6 +39381,17 @@
# while the second one will have `startRow 14` (zero-based row 15),
# and `startColumn 3` (zero-based column D).
{ # Data in the grid, as well as metadata about the dimensions.
+ "startRow": 42, # The first row this GridData refers to, zero-based.
+ "startColumn": 42, # The first column this GridData refers to, zero-based.
+ "columnMetadata": [ # Metadata about the requested columns in the grid, starting with the column
+ # in start_column.
+ { # Properties about a dimension.
+ "pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.
+ "hiddenByUser": True or False, # True if this dimension is explicitly hidden.
+ "hiddenByFilter": True or False, # True if this dimension is being filtered.
+ # This field is read-only.
+ },
+ ],
"rowMetadata": [ # Metadata about the requested rows in the grid, starting with the row
# in start_row.
{ # Properties about a dimension.
@@ -39390,8 +39401,6 @@
# This field is read-only.
},
],
- "startRow": 42, # The first row this GridData refers to, zero-based.
- "startColumn": 42, # The first column this GridData refers to, zero-based.
"rowData": [ # The data in the grid, one entry per row,
# starting with the row in startRow.
# The values in RowData will correspond to columns starting
@@ -39945,7 +39954,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -40216,140 +40244,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -40484,27 +40378,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
"userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.
#
@@ -40794,7 +40803,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -41065,140 +41093,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -41333,27 +41227,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
"dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.
#
@@ -41545,15 +41554,6 @@
],
},
],
- "columnMetadata": [ # Metadata about the requested columns in the grid, starting with the column
- # in start_column.
- { # Properties about a dimension.
- "pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.
- "hiddenByUser": True or False, # True if this dimension is explicitly hidden.
- "hiddenByFilter": True or False, # True if this dimension is being filtered.
- # This field is read-only.
- },
- ],
},
],
"properties": { # Properties of a sheet. # The properties of the sheet.
@@ -41813,7 +41813,6 @@
# * a combination of the ISO language code and country code, such as `en_US`
#
# Note: when updating this field, not all locales/languages are supported.
- "autoRecalc": "A String", # The amount of time to wait before volatile functions are recalculated.
"defaultFormat": { # The format of a cell. # The default format of all cells in the spreadsheet.
# CellData.effectiveFormat will not be set if the
# cell's format is equal to this default format.
@@ -42103,7 +42102,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -42374,140 +42392,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -42642,28 +42526,144 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
+ "autoRecalc": "A String", # The amount of time to wait before volatile functions are recalculated.
"iterativeCalculationSettings": { # Settings to control how circular dependencies are resolved with iterative # Determines whether and how circular references are resolved with iterative
# calculation. Absence of this field means that circular references will
# result in calculation errors.
@@ -43037,7 +43037,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -43308,140 +43327,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -43576,27 +43461,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
},
"gradientRule": { # A rule that applies a gradient color scale format, based on # The formatting will vary based on the gradients in the rule.
@@ -45269,9 +45269,9 @@
"columnIndex": 42, # The column index of the coordinate.
"sheetId": 42, # The sheet this coordinate is on.
},
+ "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
"offsetYPixels": 42, # The vertical offset, in pixels, that the object is offset
# from the anchor cell.
- "widthPixels": 42, # The width of the object, in pixels. Defaults to 600.
"offsetXPixels": 42, # The horizontal offset, in pixels, that the object is offset
# from the anchor cell.
"heightPixels": 42, # The height of the object, in pixels. Defaults to 371.
@@ -45555,6 +45555,8 @@
# A chart may not have more than one axis per
# axis position.
"position": "A String", # The position of this axis.
+ "title": "A String", # The title of this axis. If set, this overrides any title inferred
+ # from headers of the data.
"format": { # The format of a run of text in a cell. # The format of the title.
# Only valid if the axis is not associated with the domain.
# Absent values indicate that the field isn't specified.
@@ -45694,8 +45696,6 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "title": "A String", # The title of this axis. If set, this overrides any title inferred
- # from headers of the data.
},
],
},
@@ -45917,6 +45917,17 @@
# while the second one will have `startRow 14` (zero-based row 15),
# and `startColumn 3` (zero-based column D).
{ # Data in the grid, as well as metadata about the dimensions.
+ "startRow": 42, # The first row this GridData refers to, zero-based.
+ "startColumn": 42, # The first column this GridData refers to, zero-based.
+ "columnMetadata": [ # Metadata about the requested columns in the grid, starting with the column
+ # in start_column.
+ { # Properties about a dimension.
+ "pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.
+ "hiddenByUser": True or False, # True if this dimension is explicitly hidden.
+ "hiddenByFilter": True or False, # True if this dimension is being filtered.
+ # This field is read-only.
+ },
+ ],
"rowMetadata": [ # Metadata about the requested rows in the grid, starting with the row
# in start_row.
{ # Properties about a dimension.
@@ -45926,8 +45937,6 @@
# This field is read-only.
},
],
- "startRow": 42, # The first row this GridData refers to, zero-based.
- "startColumn": 42, # The first column this GridData refers to, zero-based.
"rowData": [ # The data in the grid, one entry per row,
# starting with the row in startRow.
# The values in RowData will correspond to columns starting
@@ -46481,7 +46490,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -46752,140 +46780,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -47020,27 +46914,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
"userEnteredFormat": { # The format of a cell. # The format the user entered for the cell.
#
@@ -47330,7 +47339,26 @@
"italic": True or False, # True if the text is italicized.
"underline": True or False, # True if the text is underlined.
},
- "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
+ "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
+ "angle": 42, # The angle between the standard orientation and the desired orientation.
+ # Measured in degrees. Valid values are between -90 and 90. Positive
+ # angles are angled upwards, negative are angled downwards.
+ #
+ # Note: For LTR text direction positive angles are in the counterclockwise
+ # direction, whereas for RTL they are in the clockwise direction
+ "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
+ # characters is unchanged.
+ # For example:
+ #
+ # | V |
+ # | e |
+ # | r |
+ # | t |
+ # | i |
+ # | c |
+ # | a |
+ # | l |
+ },
"hyperlinkDisplayType": "A String", # How a hyperlink, if it exists, should be displayed in the cell.
"borders": { # The borders of the cell. # The borders of the cell.
"top": { # A border along a cell. # The top border of the cell.
@@ -47601,140 +47629,6 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
- "bottom": { # A border along a cell. # The bottom border of the cell.
- "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
- # for simplicity of conversion to/from color representations in various
- # languages over compactness; for example, the fields of this representation
- # can be trivially provided to the constructor of "java.awt.Color" in Java; it
- # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
- # method in iOS; and, with just a little work, it can be easily formatted into
- # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
- #
- # Example (Java):
- #
- # import com.google.type.Color;
- #
- # // ...
- # public static java.awt.Color fromProto(Color protocolor) {
- # float alpha = protocolor.hasAlpha()
- # ? protocolor.getAlpha().getValue()
- # : 1.0;
- #
- # return new java.awt.Color(
- # protocolor.getRed(),
- # protocolor.getGreen(),
- # protocolor.getBlue(),
- # alpha);
- # }
- #
- # public static Color toProto(java.awt.Color color) {
- # float red = (float) color.getRed();
- # float green = (float) color.getGreen();
- # float blue = (float) color.getBlue();
- # float denominator = 255.0;
- # Color.Builder resultBuilder =
- # Color
- # .newBuilder()
- # .setRed(red / denominator)
- # .setGreen(green / denominator)
- # .setBlue(blue / denominator);
- # int alpha = color.getAlpha();
- # if (alpha != 255) {
- # result.setAlpha(
- # FloatValue
- # .newBuilder()
- # .setValue(((float) alpha) / denominator)
- # .build());
- # }
- # return resultBuilder.build();
- # }
- # // ...
- #
- # Example (iOS / Obj-C):
- #
- # // ...
- # static UIColor* fromProto(Color* protocolor) {
- # float red = [protocolor red];
- # float green = [protocolor green];
- # float blue = [protocolor blue];
- # FloatValue* alpha_wrapper = [protocolor alpha];
- # float alpha = 1.0;
- # if (alpha_wrapper != nil) {
- # alpha = [alpha_wrapper value];
- # }
- # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
- # }
- #
- # static Color* toProto(UIColor* color) {
- # CGFloat red, green, blue, alpha;
- # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
- # return nil;
- # }
- # Color* result = [Color alloc] init];
- # [result setRed:red];
- # [result setGreen:green];
- # [result setBlue:blue];
- # if (alpha <= 0.9999) {
- # [result setAlpha:floatWrapperWithValue(alpha)];
- # }
- # [result autorelease];
- # return result;
- # }
- # // ...
- #
- # Example (JavaScript):
- #
- # // ...
- #
- # var protoToCssColor = function(rgb_color) {
- # var redFrac = rgb_color.red || 0.0;
- # var greenFrac = rgb_color.green || 0.0;
- # var blueFrac = rgb_color.blue || 0.0;
- # var red = Math.floor(redFrac * 255);
- # var green = Math.floor(greenFrac * 255);
- # var blue = Math.floor(blueFrac * 255);
- #
- # if (!('alpha' in rgb_color)) {
- # return rgbToCssColor_(red, green, blue);
- # }
- #
- # var alphaFrac = rgb_color.alpha.value || 0.0;
- # var rgbParams = [red, green, blue].join(',');
- # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
- # };
- #
- # var rgbToCssColor_ = function(red, green, blue) {
- # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
- # var hexString = rgbNumber.toString(16);
- # var missingZeros = 6 - hexString.length;
- # var resultBuilder = ['#'];
- # for (var i = 0; i < missingZeros; i++) {
- # resultBuilder.push('0');
- # }
- # resultBuilder.push(hexString);
- # return resultBuilder.join('');
- # };
- #
- # // ...
- "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
- "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
- # the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color. This
- # uses a wrapper message rather than a simple float scalar so that it is
- # possible to distinguish between a default value and the value being unset.
- # If omitted, this color object is to be rendered as a solid color
- # (as if the alpha value had been explicitly given with a value of 1.0).
- "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
- "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
- },
- "width": 42, # The width of the border, in pixels.
- # Deprecated; the width is determined by the "style" field.
- "style": "A String", # The style of the border.
- },
"left": { # A border along a cell. # The left border of the cell.
"color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
# for simplicity of conversion to/from color representations in various
@@ -47869,27 +47763,142 @@
# Deprecated; the width is determined by the "style" field.
"style": "A String", # The style of the border.
},
+ "bottom": { # A border along a cell. # The bottom border of the cell.
+ "color": { # Represents a color in the RGBA color space. This representation is designed # The color of the border.
+ # for simplicity of conversion to/from color representations in various
+ # languages over compactness; for example, the fields of this representation
+ # can be trivially provided to the constructor of "java.awt.Color" in Java; it
+ # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+ # method in iOS; and, with just a little work, it can be easily formatted into
+ # a CSS "rgba()" string in JavaScript, as well. Here are some examples:
+ #
+ # Example (Java):
+ #
+ # import com.google.type.Color;
+ #
+ # // ...
+ # public static java.awt.Color fromProto(Color protocolor) {
+ # float alpha = protocolor.hasAlpha()
+ # ? protocolor.getAlpha().getValue()
+ # : 1.0;
+ #
+ # return new java.awt.Color(
+ # protocolor.getRed(),
+ # protocolor.getGreen(),
+ # protocolor.getBlue(),
+ # alpha);
+ # }
+ #
+ # public static Color toProto(java.awt.Color color) {
+ # float red = (float) color.getRed();
+ # float green = (float) color.getGreen();
+ # float blue = (float) color.getBlue();
+ # float denominator = 255.0;
+ # Color.Builder resultBuilder =
+ # Color
+ # .newBuilder()
+ # .setRed(red / denominator)
+ # .setGreen(green / denominator)
+ # .setBlue(blue / denominator);
+ # int alpha = color.getAlpha();
+ # if (alpha != 255) {
+ # result.setAlpha(
+ # FloatValue
+ # .newBuilder()
+ # .setValue(((float) alpha) / denominator)
+ # .build());
+ # }
+ # return resultBuilder.build();
+ # }
+ # // ...
+ #
+ # Example (iOS / Obj-C):
+ #
+ # // ...
+ # static UIColor* fromProto(Color* protocolor) {
+ # float red = [protocolor red];
+ # float green = [protocolor green];
+ # float blue = [protocolor blue];
+ # FloatValue* alpha_wrapper = [protocolor alpha];
+ # float alpha = 1.0;
+ # if (alpha_wrapper != nil) {
+ # alpha = [alpha_wrapper value];
+ # }
+ # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
+ # }
+ #
+ # static Color* toProto(UIColor* color) {
+ # CGFloat red, green, blue, alpha;
+ # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
+ # return nil;
+ # }
+ # Color* result = [Color alloc] init];
+ # [result setRed:red];
+ # [result setGreen:green];
+ # [result setBlue:blue];
+ # if (alpha <= 0.9999) {
+ # [result setAlpha:floatWrapperWithValue(alpha)];
+ # }
+ # [result autorelease];
+ # return result;
+ # }
+ # // ...
+ #
+ # Example (JavaScript):
+ #
+ # // ...
+ #
+ # var protoToCssColor = function(rgb_color) {
+ # var redFrac = rgb_color.red || 0.0;
+ # var greenFrac = rgb_color.green || 0.0;
+ # var blueFrac = rgb_color.blue || 0.0;
+ # var red = Math.floor(redFrac * 255);
+ # var green = Math.floor(greenFrac * 255);
+ # var blue = Math.floor(blueFrac * 255);
+ #
+ # if (!('alpha' in rgb_color)) {
+ # return rgbToCssColor_(red, green, blue);
+ # }
+ #
+ # var alphaFrac = rgb_color.alpha.value || 0.0;
+ # var rgbParams = [red, green, blue].join(',');
+ # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
+ # };
+ #
+ # var rgbToCssColor_ = function(red, green, blue) {
+ # var rgbNumber = new Number((red << 16) | (green << 8) | blue);
+ # var hexString = rgbNumber.toString(16);
+ # var missingZeros = 6 - hexString.length;
+ # var resultBuilder = ['#'];
+ # for (var i = 0; i < missingZeros; i++) {
+ # resultBuilder.push('0');
+ # }
+ # resultBuilder.push(hexString);
+ # return resultBuilder.join('');
+ # };
+ #
+ # // ...
+ "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+ "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is,
+ # the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color. This
+ # uses a wrapper message rather than a simple float scalar so that it is
+ # possible to distinguish between a default value and the value being unset.
+ # If omitted, this color object is to be rendered as a solid color
+ # (as if the alpha value had been explicitly given with a value of 1.0).
+ "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+ "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+ },
+ "width": 42, # The width of the border, in pixels.
+ # Deprecated; the width is determined by the "style" field.
+ "style": "A String", # The style of the border.
+ },
},
- "textRotation": { # The rotation applied to text in a cell. # The rotation applied to text in a cell
- "angle": 42, # The angle between the standard orientation and the desired orientation.
- # Measured in degrees. Valid values are between -90 and 90. Positive
- # angles are angled upwards, negative are angled downwards.
- #
- # Note: For LTR text direction positive angles are in the counterclockwise
- # direction, whereas for RTL they are in the clockwise direction
- "vertical": True or False, # If true, text reads top to bottom, but the orientation of individual
- # characters is unchanged.
- # For example:
- #
- # | V |
- # | e |
- # | r |
- # | t |
- # | i |
- # | c |
- # | a |
- # | l |
- },
+ "wrapStrategy": "A String", # The wrap strategy for the value in the cell.
},
"dataValidation": { # A data validation rule. # A data validation rule on the cell, if any.
#
@@ -48081,15 +48090,6 @@
],
},
],
- "columnMetadata": [ # Metadata about the requested columns in the grid, starting with the column
- # in start_column.
- { # Properties about a dimension.
- "pixelSize": 42, # The height (if a row) or width (if a column) of the dimension in pixels.
- "hiddenByUser": True or False, # True if this dimension is explicitly hidden.
- "hiddenByFilter": True or False, # True if this dimension is being filtered.
- # This field is read-only.
- },
- ],
},
],
"properties": { # Properties of a sheet. # The properties of the sheet.
diff --git a/docs/dyn/sheets_v4.spreadsheets.values.html b/docs/dyn/sheets_v4.spreadsheets.values.html
index afa78ae..613e7d1 100644
--- a/docs/dyn/sheets_v4.spreadsheets.values.html
+++ b/docs/dyn/sheets_v4.spreadsheets.values.html
@@ -81,7 +81,7 @@
<code><a href="#batchClear">batchClear(spreadsheetId, body, x__xgafv=None)</a></code></p>
<p class="firstline">Clears one or more ranges of values from a spreadsheet.</p>
<p class="toc_element">
- <code><a href="#batchGet">batchGet(spreadsheetId, ranges=None, majorDimension=None, dateTimeRenderOption=None, valueRenderOption=None, x__xgafv=None)</a></code></p>
+ <code><a href="#batchGet">batchGet(spreadsheetId, majorDimension=None, ranges=None, dateTimeRenderOption=None, valueRenderOption=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns one or more ranges of values from a spreadsheet.</p>
<p class="toc_element">
<code><a href="#batchUpdate">batchUpdate(spreadsheetId, body, x__xgafv=None)</a></code></p>
@@ -263,13 +263,12 @@
</div>
<div class="method">
- <code class="details" id="batchGet">batchGet(spreadsheetId, ranges=None, majorDimension=None, dateTimeRenderOption=None, valueRenderOption=None, x__xgafv=None)</code>
+ <code class="details" id="batchGet">batchGet(spreadsheetId, majorDimension=None, ranges=None, dateTimeRenderOption=None, valueRenderOption=None, x__xgafv=None)</code>
<pre>Returns one or more ranges of values from a spreadsheet.
The caller must specify the spreadsheet ID and one or more ranges.
Args:
spreadsheetId: string, The ID of the spreadsheet to retrieve data from. (required)
- ranges: string, The A1 notation of the values to retrieve. (repeated)
majorDimension: string, The major dimension that results should use.
For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,
@@ -277,6 +276,7 @@
`[[1,2],[3,4]]`,
whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return
`[[1,3],[2,4]]`.
+ ranges: string, The A1 notation of the values to retrieve. (repeated)
dateTimeRenderOption: string, How dates, times, and durations should be represented in the output.
This is ignored if value_render_option is
FORMATTED_VALUE.
@@ -346,8 +346,7 @@
The object takes the form of:
{ # The request for updating more than one range of values in a spreadsheet.
- "responseValueRenderOption": "A String", # Determines how values in the response should be rendered.
- # The default render option is ValueRenderOption.FORMATTED_VALUE.
+ "valueInputOption": "A String", # How the input data should be interpreted.
"data": [ # The new values to apply to the spreadsheet.
{ # Data within a range of the spreadsheet.
"range": "A String", # The range the values cover, in A1 notation.
@@ -384,11 +383,6 @@
# When writing, if this field is not set, it defaults to ROWS.
},
],
- "responseDateTimeRenderOption": "A String", # Determines how dates, times, and durations in the response should be
- # rendered. This is ignored if response_value_render_option is
- # FORMATTED_VALUE.
- # The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
- "valueInputOption": "A String", # How the input data should be interpreted.
"includeValuesInResponse": True or False, # Determines if the update response should include the values
# of the cells that were updated. By default, responses
# do not include the updated values. The `updatedData` field within
@@ -396,6 +390,12 @@
# the updated values. If the range to write was larger than than the range
# actually written, the response will include all values in the requested
# range (excluding trailing empty rows and columns).
+ "responseValueRenderOption": "A String", # Determines how values in the response should be rendered.
+ # The default render option is ValueRenderOption.FORMATTED_VALUE.
+ "responseDateTimeRenderOption": "A String", # Determines how dates, times, and durations in the response should be
+ # rendered. This is ignored if response_value_render_option is
+ # FORMATTED_VALUE.
+ # The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].
}
x__xgafv: string, V1 error format.
@@ -453,11 +453,11 @@
"updatedCells": 42, # The number of cells updated.
},
],
+ "totalUpdatedCells": 42, # The total number of cells updated.
"totalUpdatedColumns": 42, # The total number of columns where at least one cell in the column was
# updated.
- "totalUpdatedCells": 42, # The total number of cells updated.
- "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
"totalUpdatedRows": 42, # The total number of rows where at least one cell in the row was updated.
+ "spreadsheetId": "A String", # The spreadsheet the updates were applied to.
"totalUpdatedSheets": 42, # The total number of sheets where at least one cell in the sheet was
# updated.
}</pre>
diff --git a/docs/dyn/slides_v1.presentations.html b/docs/dyn/slides_v1.presentations.html
index b9b50f2..794e1be 100644
--- a/docs/dyn/slides_v1.presentations.html
+++ b/docs/dyn/slides_v1.presentations.html
@@ -208,10 +208,6 @@
},
},
},
- "id": "A String", # The video source's unique identifier for this video.
- #
- # e.g. For YouTube video https://www.youtube.com/watch?v=7U3axjORYZ0,
- # the ID is 7U3axjORYZ0.
"objectId": "A String", # A user-supplied object ID.
#
# If you specify an ID, it must be unique among all pages and page elements
@@ -222,6 +218,10 @@
# The length of the ID must not be less than 5 or greater than 50.
#
# If you don't specify an ID, a unique one is generated.
+ "id": "A String", # The video source's unique identifier for this video.
+ #
+ # e.g. For YouTube video https://www.youtube.com/watch?v=7U3axjORYZ0,
+ # the ID is 7U3axjORYZ0.
},
"deleteTableRow": { # Deletes a row from a table. # Deletes a row from a table.
"cellLocation": { # A location of a single table cell within a table. # The reference table cell location from which a row will be deleted.
@@ -356,17 +356,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -624,13 +624,6 @@
#
# The nesting level of each paragraph will be visually preserved by adding
# indent to the start of the corresponding paragraph.
- "cellLocation": { # A location of a single table cell within a table. # The optional table cell location if the text to be modified is in a table
- # cell. If present, the object_id must refer to a table.
- "rowIndex": 42, # The 0-based row index.
- "columnIndex": 42, # The 0-based column index.
- },
- "objectId": "A String", # The object ID of the shape or table containing the text to delete bullets
- # from.
"textRange": { # Specifies a contiguous range of an indexed collection, such as characters in # The range of text to delete bullets from, based on TextElement indexes.
# text.
"endIndex": 42, # The optional zero-based index of the end of the collection.
@@ -639,98 +632,37 @@
# Required for `SPECIFIC_RANGE` and `FROM_START_INDEX` ranges.
"type": "A String", # The type of range.
},
+ "objectId": "A String", # The object ID of the shape or table containing the text to delete bullets
+ # from.
+ "cellLocation": { # A location of a single table cell within a table. # The optional table cell location if the text to be modified is in a table
+ # cell. If present, the object_id must refer to a table.
+ "rowIndex": 42, # The 0-based row index.
+ "columnIndex": 42, # The 0-based column index.
+ },
},
- "updateTextStyle": { # Update the styling of text in a Shape or # Updates the styling of text within a Shape or Table.
- # Table.
+ "updateLineProperties": { # Updates the properties of a Line. # Updates the properties of a Line.
"fields": "A String", # The fields that should be updated.
#
- # At least one field must be specified. The root `style` is implied and
- # should not be specified. A single `"*"` can be used as short-hand for
- # listing every field.
+ # At least one field must be specified. The root `lineProperties` is
+ # implied and should not be specified. A single `"*"` can be used as
+ # short-hand for listing every field.
#
- # For example, to update the text style to bold, set `fields` to `"bold"`.
+ # For example to update the line solid fill color, set `fields` to
+ # `"lineFill.solidFill.color"`.
#
# To reset a property to its default value, include its field name in the
# field mask but leave the field itself unset.
- "style": { # Represents the styling that can be applied to a TextRun. # The style(s) to set on the text.
+ "lineProperties": { # The properties of the Line. # The line properties to update.
#
- # If the value for a particular style matches that of the parent, that style
- # will be set to inherit.
- #
- # Certain text style changes may cause other changes meant to mirror the
- # behavior of the Slides editor. See the documentation of
- # TextStyle for more information.
- #
- # If this text is contained in a shape with a parent placeholder, then these text styles may be
- # inherited from the parent. Which text styles are inherited depend on the
- # nesting level of lists:
- #
- # * A text run in a paragraph that is not in a list will inherit its text style
- # from the the newline character in the paragraph at the 0 nesting level of
- # the list inside the parent placeholder.
- # * A text run in a paragraph that is in a list will inherit its text style
- # from the newline character in the paragraph at its corresponding nesting
- # level of the list inside the parent placeholder.
- #
- # Inherited text styles are represented as unset fields in this message. If
- # text is contained in a shape without a parent placeholder, unsetting these
- # fields will revert the style to a value matching the defaults in the Slides
- # editor.
- "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or
- # transparent, depending on if the `opaque_color` field in it is set.
- "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
- # a transparent color.
- "themeColor": "A String", # An opaque theme color.
- "rgbColor": { # An RGB color. # An opaque RGB color.
- "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
- "green": 3.14, # The green component of the color, from 0.0 to 1.0.
- "red": 3.14, # The red component of the color, from 0.0 to 1.0.
- },
- },
- },
- "bold": True or False, # Whether or not the text is rendered as bold.
- "baselineOffset": "A String", # The text's vertical offset from its normal position.
- #
- # Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically
- # rendered in a smaller font size, computed based on the `font_size` field.
- # The `font_size` itself is not affected by changes in this field.
- "strikethrough": True or False, # Whether or not the text is struck through.
- "smallCaps": True or False, # Whether or not the text is in small capital letters.
- "fontFamily": "A String", # The font family of the text.
- #
- # The font family can be any font from the Font menu in Slides or from
- # [Google Fonts] (https://fonts.google.com/). If the font name is
- # unrecognized, the text is rendered in `Arial`.
- #
- # Some fonts can affect the weight of the text. If an update request
- # specifies values for both `font_family` and `bold`, the explicitly-set
- # `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
+ # When unset, these fields default to values that match the appearance of
+ # new lines created in the Slides editor.
+ "dashStyle": "A String", # The dash style of the line.
+ "weight": { # A magnitude in a single direction in the specified units. # The thickness of the line.
"magnitude": 3.14, # The magnitude.
"unit": "A String", # The units for magnitude.
},
- "italic": True or False, # Whether or not the text is italicized.
- "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
- # are not inherited from parent text.
- #
- # Changing the link in an update request causes some other changes to the
- # text style of the range:
- #
- # * When setting a link, the text foreground color will be set to
- # ThemeColorType.HYPERLINK and the text will
- # be underlined. If these fields are modified in the same
- # request, those values will be used instead of the link defaults.
- # * Setting a link on a text range that overlaps with an existing link will
- # also update the existing link to point to the new URL.
- # * Links are not settable on newline characters. As a result, setting a link
- # on a text range that crosses a paragraph boundary, such as `"ABC\n123"`,
- # will separate the newline character(s) into their own text runs. The
- # link will be applied separately to the runs before and after the newline.
- # * Removing a link will update the text style of the range to match the
- # style of the preceding text (or the default text styles if the preceding
- # text is another link) unless different styles are being set in the same
- # request.
+ "endArrow": "A String", # The style of the arrow at the end of the line.
+ "link": { # A hypertext link. # The hyperlink destination of the line. If unset, there is no link.
"url": "A String", # If set, indicates this is a link to the external web page at this URL.
"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index
# in the presentation. There may not be a slide at this index.
@@ -739,40 +671,33 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
- "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
- # transparent, depending on if the `opaque_color` field in it is set.
- "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
- # a transparent color.
- "themeColor": "A String", # An opaque theme color.
- "rgbColor": { # An RGB color. # An opaque RGB color.
- "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
- "green": 3.14, # The green component of the color, from 0.0 to 1.0.
- "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+ "lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new
+ # lines created in the Slides editor.
+ "solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.
+ # specified color value.
+ #
+ # If any field is unset, its value may be inherited from a parent placeholder
+ # if it exists.
+ "color": { # A themeable solid color value. # The color value of the solid fill.
+ "themeColor": "A String", # An opaque theme color.
+ "rgbColor": { # An RGB color. # An opaque RGB color.
+ "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+ "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+ "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+ },
},
+ "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel.
+ # That is, the final pixel color is defined by the equation:
+ #
+ # pixel color = alpha * (color) + (1.0 - alpha) * (background color)
+ #
+ # This means that a value of 1.0 corresponds to a solid color, whereas
+ # a value of 0.0 corresponds to a completely transparent color.
},
},
+ "startArrow": "A String", # The style of the arrow at the beginning of the line.
},
- "cellLocation": { # A location of a single table cell within a table. # The location of the cell in the table containing the text to style. If
- # `object_id` refers to a table, `cell_location` must have a value.
- # Otherwise, it must not.
- "rowIndex": 42, # The 0-based row index.
- "columnIndex": 42, # The 0-based column index.
- },
- "objectId": "A String", # The object ID of the shape or table with the text to be styled.
- "textRange": { # Specifies a contiguous range of an indexed collection, such as characters in # The range of text to style.
- #
- # The range may be extended to include adjacent newlines.
- #
- # If the range fully contains a paragraph belonging to a list, the
- # paragraph's bullet is also updated with the matching text style.
- # text.
- "endIndex": 42, # The optional zero-based index of the end of the collection.
- # Required for `SPECIFIC_RANGE` delete mode.
- "startIndex": 42, # The optional zero-based index of the beginning of the collection.
- # Required for `SPECIFIC_RANGE` and `FROM_START_INDEX` ranges.
- "type": "A String", # The type of range.
- },
+ "objectId": "A String", # The object ID of the line the update is applied to.
},
"deleteText": { # Deletes text from a shape or a table cell. # Deletes text from a shape or a table cell.
"textRange": { # Specifies a contiguous range of an indexed collection, such as characters in # The range of text to delete, based on TextElement indexes.
@@ -895,29 +820,113 @@
# field mask but leave the field itself unset.
"objectId": "A String", # The object ID of the page the update is applied to.
},
- "updateLineProperties": { # Updates the properties of a Line. # Updates the properties of a Line.
+ "updateTextStyle": { # Update the styling of text in a Shape or # Updates the styling of text within a Shape or Table.
+ # Table.
"fields": "A String", # The fields that should be updated.
#
- # At least one field must be specified. The root `lineProperties` is
- # implied and should not be specified. A single `"*"` can be used as
- # short-hand for listing every field.
+ # At least one field must be specified. The root `style` is implied and
+ # should not be specified. A single `"*"` can be used as short-hand for
+ # listing every field.
#
- # For example to update the line solid fill color, set `fields` to
- # `"lineFill.solidFill.color"`.
+ # For example, to update the text style to bold, set `fields` to `"bold"`.
#
# To reset a property to its default value, include its field name in the
# field mask but leave the field itself unset.
- "lineProperties": { # The properties of the Line. # The line properties to update.
+ "style": { # Represents the styling that can be applied to a TextRun. # The style(s) to set on the text.
#
- # When unset, these fields default to values that match the appearance of
- # new lines created in the Slides editor.
- "dashStyle": "A String", # The dash style of the line.
- "weight": { # A magnitude in a single direction in the specified units. # The thickness of the line.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
+ # If the value for a particular style matches that of the parent, that style
+ # will be set to inherit.
+ #
+ # Certain text style changes may cause other changes meant to mirror the
+ # behavior of the Slides editor. See the documentation of
+ # TextStyle for more information.
+ #
+ # If this text is contained in a shape with a parent placeholder, then these text styles may be
+ # inherited from the parent. Which text styles are inherited depend on the
+ # nesting level of lists:
+ #
+ # * A text run in a paragraph that is not in a list will inherit its text style
+ # from the the newline character in the paragraph at the 0 nesting level of
+ # the list inside the parent placeholder.
+ # * A text run in a paragraph that is in a list will inherit its text style
+ # from the newline character in the paragraph at its corresponding nesting
+ # level of the list inside the parent placeholder.
+ #
+ # Inherited text styles are represented as unset fields in this message. If
+ # text is contained in a shape without a parent placeholder, unsetting these
+ # fields will revert the style to a value matching the defaults in the Slides
+ # editor.
+ "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or
+ # transparent, depending on if the `opaque_color` field in it is set.
+ "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
+ # a transparent color.
+ "themeColor": "A String", # An opaque theme color.
+ "rgbColor": { # An RGB color. # An opaque RGB color.
+ "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+ "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+ "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+ },
+ },
},
- "endArrow": "A String", # The style of the arrow at the end of the line.
- "link": { # A hypertext link. # The hyperlink destination of the line. If unset, there is no link.
+ "bold": True or False, # Whether or not the text is rendered as bold.
+ "baselineOffset": "A String", # The text's vertical offset from its normal position.
+ #
+ # Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically
+ # rendered in a smaller font size, computed based on the `font_size` field.
+ # The `font_size` itself is not affected by changes in this field.
+ "strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
+ "smallCaps": True or False, # Whether or not the text is in small capital letters.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ #
+ # Some fonts can affect the weight of the text. If an update request
+ # specifies values for both `font_family` and `bold`, the explicitly-set
+ # `bold` value is used.
+ "italic": True or False, # Whether or not the text is italicized.
+ "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
+ # are not inherited from parent text.
+ #
+ # Changing the link in an update request causes some other changes to the
+ # text style of the range:
+ #
+ # * When setting a link, the text foreground color will be set to
+ # ThemeColorType.HYPERLINK and the text will
+ # be underlined. If these fields are modified in the same
+ # request, those values will be used instead of the link defaults.
+ # * Setting a link on a text range that overlaps with an existing link will
+ # also update the existing link to point to the new URL.
+ # * Links are not settable on newline characters. As a result, setting a link
+ # on a text range that crosses a paragraph boundary, such as `"ABC\n123"`,
+ # will separate the newline character(s) into their own text runs. The
+ # link will be applied separately to the runs before and after the newline.
+ # * Removing a link will update the text style of the range to match the
+ # style of the preceding text (or the default text styles if the preceding
+ # text is another link) unless different styles are being set in the same
+ # request.
"url": "A String", # If set, indicates this is a link to the external web page at this URL.
"slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index
# in the presentation. There may not be a slide at this index.
@@ -926,59 +935,58 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "startArrow": "A String", # The style of the arrow at the beginning of the line.
- "lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new
- # lines created in the Slides editor.
- "solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.
- # specified color value.
- #
- # If any field is unset, its value may be inherited from a parent placeholder
- # if it exists.
- "color": { # A themeable solid color value. # The color value of the solid fill.
- "themeColor": "A String", # An opaque theme color.
- "rgbColor": { # An RGB color. # An opaque RGB color.
- "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
- "green": 3.14, # The green component of the color, from 0.0 to 1.0.
- "red": 3.14, # The red component of the color, from 0.0 to 1.0.
- },
+ "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
+ # transparent, depending on if the `opaque_color` field in it is set.
+ "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
+ # a transparent color.
+ "themeColor": "A String", # An opaque theme color.
+ "rgbColor": { # An RGB color. # An opaque RGB color.
+ "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+ "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+ "red": 3.14, # The red component of the color, from 0.0 to 1.0.
},
- "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel.
- # That is, the final pixel color is defined by the equation:
- #
- # pixel color = alpha * (color) + (1.0 - alpha) * (background color)
- #
- # This means that a value of 1.0 corresponds to a solid color, whereas
- # a value of 0.0 corresponds to a completely transparent color.
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
- "objectId": "A String", # The object ID of the line the update is applied to.
+ "textRange": { # Specifies a contiguous range of an indexed collection, such as characters in # The range of text to style.
+ #
+ # The range may be extended to include adjacent newlines.
+ #
+ # If the range fully contains a paragraph belonging to a list, the
+ # paragraph's bullet is also updated with the matching text style.
+ # text.
+ "endIndex": 42, # The optional zero-based index of the end of the collection.
+ # Required for `SPECIFIC_RANGE` delete mode.
+ "startIndex": 42, # The optional zero-based index of the beginning of the collection.
+ # Required for `SPECIFIC_RANGE` and `FROM_START_INDEX` ranges.
+ "type": "A String", # The type of range.
+ },
+ "objectId": "A String", # The object ID of the shape or table with the text to be styled.
+ "cellLocation": { # A location of a single table cell within a table. # The location of the cell in the table containing the text to style. If
+ # `object_id` refers to a table, `cell_location` must have a value.
+ # Otherwise, it must not.
+ "rowIndex": 42, # The 0-based row index.
+ "columnIndex": 42, # The 0-based column index.
+ },
},
"updateTableCellProperties": { # Update the properties of a TableCell. # Updates the properties of a TableCell.
- "tableRange": { # A table range represents a reference to a subset of a table. # The table range representing the subset of the table to which the updates
- # are applied. If a table range is not specified, the updates will apply to
- # the entire table.
+ "fields": "A String", # The fields that should be updated.
#
- # It's important to note that the cells specified by a table range do not
- # necessarily form a rectangle. For example, let's say we have a 3 x 3 table
- # where all the cells of the last row are merged together. The table looks
- # like this:
+ # At least one field must be specified. The root `tableCellProperties` is
+ # implied and should not be specified. A single `"*"` can be used as
+ # short-hand for listing every field.
#
+ # For example to update the table cell background solid fill color, set
+ # `fields` to `"tableCellBackgroundFill.solidFill.color"`.
#
- # [ ]
- #
- # A table range with location = (0, 0), row span = 3 and column span = 2
- # specifies the following cells:
- #
- # x x
- # [ x ]
- "rowSpan": 42, # The row span of the table range.
- "columnSpan": 42, # The column span of the table range.
- "location": { # A location of a single table cell within a table. # The starting location of the table range.
- "rowIndex": 42, # The 0-based row index.
- "columnIndex": 42, # The 0-based column index.
- },
- },
+ # To reset a property to its default value, include its field name in the
+ # field mask but leave the field itself unset.
"tableCellProperties": { # The properties of the TableCell. # The table cell properties to update.
"tableCellBackgroundFill": { # The table cell background fill. # The background fill of the table cell. The default fill matches the fill
# for newly created table cells in the Slides editor.
@@ -1012,17 +1020,30 @@
},
},
"objectId": "A String", # The object ID of the table.
- "fields": "A String", # The fields that should be updated.
+ "tableRange": { # A table range represents a reference to a subset of a table. # The table range representing the subset of the table to which the updates
+ # are applied. If a table range is not specified, the updates will apply to
+ # the entire table.
#
- # At least one field must be specified. The root `tableCellProperties` is
- # implied and should not be specified. A single `"*"` can be used as
- # short-hand for listing every field.
+ # It's important to note that the cells specified by a table range do not
+ # necessarily form a rectangle. For example, let's say we have a 3 x 3 table
+ # where all the cells of the last row are merged together. The table looks
+ # like this:
#
- # For example to update the table cell background solid fill color, set
- # `fields` to `"tableCellBackgroundFill.solidFill.color"`.
#
- # To reset a property to its default value, include its field name in the
- # field mask but leave the field itself unset.
+ # [ ]
+ #
+ # A table range with location = (0, 0), row span = 3 and column span = 2
+ # specifies the following cells:
+ #
+ # x x
+ # [ x ]
+ "rowSpan": 42, # The row span of the table range.
+ "columnSpan": 42, # The column span of the table range.
+ "location": { # A location of a single table cell within a table. # The starting location of the table range.
+ "rowIndex": 42, # The 0-based row index.
+ "columnIndex": 42, # The 0-based column index.
+ },
+ },
},
"replaceAllShapesWithImage": { # Replaces all shapes that match the given criteria with the provided image. # Replaces all shapes matching some criteria with an image.
"imageUrl": "A String", # The image URL.
@@ -1180,13 +1201,6 @@
"chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet.
"linkingMode": "A String", # The mode with which the chart is linked to the source spreadsheet. When
# not specified, the chart will be an image that is not linked.
- "objectId": "A String", # A user-supplied object ID.
- #
- # If specified, the ID must be unique among all pages and page elements in
- # the presentation. The ID should start with a word character [a-zA-Z0-9_]
- # and then followed by any number of the following characters [a-zA-Z0-9_-:].
- # The length of the ID should not be less than 5 or greater than 50.
- # If empty, a unique identifier will be generated.
"elementProperties": { # Common properties for a page element. # The element properties for the chart.
#
# When the aspect ratio of the provided size does not match the chart aspect
@@ -1231,8 +1245,45 @@
},
},
},
+ "objectId": "A String", # A user-supplied object ID.
+ #
+ # If specified, the ID must be unique among all pages and page elements in
+ # the presentation. The ID should start with a word character [a-zA-Z0-9_]
+ # and then followed by any number of the following characters [a-zA-Z0-9_-:].
+ # The length of the ID should not be less than 5 or greater than 50.
+ # If empty, a unique identifier will be generated.
},
"createSlide": { # Creates a new slide. # Creates a new slide.
+ "placeholderIdMappings": [ # An optional list of object ID mappings from the placeholder(s) on the layout to the placeholder(s)
+ # that will be created on the new slide from that specified layout. Can only
+ # be used when `slide_layout_reference` is specified.
+ { # The user-specified ID mapping for a placeholder that will be created on a
+ # slide from a specified layout.
+ "layoutPlaceholder": { # The placeholder information that uniquely identifies a placeholder shape. # The placeholder on a layout that will be applied to a slide. Only type and index are needed. For example, a
+ # predefined `TITLE_AND_BODY` layout may usually have a TITLE placeholder
+ # with index 0 and a BODY placeholder with index 0.
+ "parentObjectId": "A String", # The object ID of this shape's parent placeholder.
+ # If unset, the parent placeholder shape does not exist, so the shape does
+ # not inherit properties from any other shape.
+ "index": 42, # The index of the placeholder. If the same placeholder types are the present
+ # in the same page, they would have different index values.
+ "type": "A String", # The type of the placeholder.
+ },
+ "objectId": "A String", # A user-supplied object ID for the placeholder identified above that to be
+ # created onto a slide.
+ #
+ # If you specify an ID, it must be unique among all pages and page elements
+ # in the presentation. The ID must start with an alphanumeric character or an
+ # underscore (matches regex `[a-zA-Z0-9_]`); remaining characters
+ # may include those as well as a hyphen or colon (matches regex
+ # `[a-zA-Z0-9_-:]`).
+ # The length of the ID must not be less than 5 or greater than 50.
+ #
+ # If you don't specify an ID, a unique one is generated.
+ "layoutPlaceholderObjectId": "A String", # The object ID of the placeholder on a layout that will be applied
+ # to a slide.
+ },
+ ],
"slideLayoutReference": { # Slide layout reference. This may reference either: # Layout reference of the slide to be inserted, based on the *current
# master*, which is one of the following:
#
@@ -1251,36 +1302,6 @@
"predefinedLayout": "A String", # Predefined layout.
"layoutId": "A String", # Layout ID: the object ID of one of the layouts in the presentation.
},
- "placeholderIdMappings": [ # An optional list of object ID mappings from the placeholder(s) on the layout to the placeholder(s)
- # that will be created on the new slide from that specified layout. Can only
- # be used when `slide_layout_reference` is specified.
- { # The user-specified ID mapping for a placeholder that will be created on a
- # slide from a specified layout.
- "layoutPlaceholder": { # The placeholder information that uniquely identifies a placeholder shape. # The placeholder on a layout that will be applied to a slide. Only type and index are needed. For example, a
- # predefined `TITLE_AND_BODY` layout may usually have a TITLE placeholder
- # with index 0 and a BODY placeholder with index 0.
- "parentObjectId": "A String", # The object ID of this shape's parent placeholder.
- # If unset, the parent placeholder shape does not exist, so the shape does
- # not inherit properties from any other shape.
- "index": 42, # The index of the placeholder. If the same placeholder types are the present
- # in the same page, they would have different index values.
- "type": "A String", # The type of the placeholder.
- },
- "layoutPlaceholderObjectId": "A String", # The object ID of the placeholder on a layout that will be applied
- # to a slide.
- "objectId": "A String", # A user-supplied object ID for the placeholder identified above that to be
- # created onto a slide.
- #
- # If you specify an ID, it must be unique among all pages and page elements
- # in the presentation. The ID must start with an alphanumeric character or an
- # underscore (matches regex `[a-zA-Z0-9_]`); remaining characters
- # may include those as well as a hyphen or colon (matches regex
- # `[a-zA-Z0-9_-:]`).
- # The length of the ID must not be less than 5 or greater than 50.
- #
- # If you don't specify an ID, a unique one is generated.
- },
- ],
"objectId": "A String", # A user-supplied object ID.
#
# If you specify an ID, it must be unique among all pages and page elements
@@ -1522,30 +1543,23 @@
# The length of the ID must not be less than 5 or greater than 50.
# If empty, a unique identifier will be generated.
},
- "updatePageElementTransform": { # Updates the transform of a page element. # Updates the transform of a page element.
- "applyMode": "A String", # The apply mode of the transform update.
- "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] # The input transform matrix used to update the page element.
- # to transform source coordinates (x,y) into destination coordinates (x', y')
- # according to:
+ "insertTableColumns": { # Inserts columns into a table. # Inserts columns into a table.
+ #
+ # Other columns in the table will be resized to fit the new column.
+ "insertRight": True or False, # Whether to insert new columns to the right of the reference cell location.
#
- # x' x = shear_y scale_y translate_y
- # 1 [ 1 ]
+ # - `True`: insert to the right.
+ # - `False`: insert to the left.
+ "number": 42, # The number of columns to be inserted. Maximum 20 per request.
+ "cellLocation": { # A location of a single table cell within a table. # The reference table cell location from which columns will be inserted.
#
- # After transformation,
- #
- # x' = scale_x * x + shear_x * y + translate_x;
- # y' = scale_y * y + shear_y * x + translate_y;
- #
- # This message is therefore composed of these six matrix elements.
- "translateX": 3.14, # The X coordinate translation element.
- "translateY": 3.14, # The Y coordinate translation element.
- "scaleX": 3.14, # The X coordinate scaling element.
- "scaleY": 3.14, # The Y coordinate scaling element.
- "shearY": 3.14, # The Y coordinate shearing element.
- "shearX": 3.14, # The X coordinate shearing element.
- "unit": "A String", # The units for translate elements.
+ # A new column will be inserted to the left (or right) of the column where
+ # the reference cell is. If the reference cell is a merged cell, a new
+ # column will be inserted to the left (or right) of the merged cell.
+ "rowIndex": 42, # The 0-based row index.
+ "columnIndex": 42, # The 0-based column index.
},
- "objectId": "A String", # The object ID of the page element to update.
+ "tableObjectId": "A String", # The table to insert columns into.
},
"createParagraphBullets": { # Creates bullets for all of the paragraphs that overlap with the given # Creates bullets for paragraphs.
# text index range.
@@ -1645,23 +1659,30 @@
},
"tableObjectId": "A String", # The table to delete columns from.
},
- "insertTableColumns": { # Inserts columns into a table. # Inserts columns into a table.
- #
- # Other columns in the table will be resized to fit the new column.
- "tableObjectId": "A String", # The table to insert columns into.
- "insertRight": True or False, # Whether to insert new columns to the right of the reference cell location.
+ "updatePageElementTransform": { # Updates the transform of a page element. # Updates the transform of a page element.
+ "applyMode": "A String", # The apply mode of the transform update.
+ "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] # The input transform matrix used to update the page element.
+ # to transform source coordinates (x,y) into destination coordinates (x', y')
+ # according to:
#
- # - `True`: insert to the right.
- # - `False`: insert to the left.
- "number": 42, # The number of columns to be inserted. Maximum 20 per request.
- "cellLocation": { # A location of a single table cell within a table. # The reference table cell location from which columns will be inserted.
+ # x' x = shear_y scale_y translate_y
+ # 1 [ 1 ]
#
- # A new column will be inserted to the left (or right) of the column where
- # the reference cell is. If the reference cell is a merged cell, a new
- # column will be inserted to the left (or right) of the merged cell.
- "rowIndex": 42, # The 0-based row index.
- "columnIndex": 42, # The 0-based column index.
+ # After transformation,
+ #
+ # x' = scale_x * x + shear_x * y + translate_x;
+ # y' = scale_y * y + shear_y * x + translate_y;
+ #
+ # This message is therefore composed of these six matrix elements.
+ "translateX": 3.14, # The X coordinate translation element.
+ "translateY": 3.14, # The Y coordinate translation element.
+ "scaleX": 3.14, # The X coordinate scaling element.
+ "scaleY": 3.14, # The Y coordinate scaling element.
+ "shearY": 3.14, # The Y coordinate shearing element.
+ "shearX": 3.14, # The X coordinate shearing element.
+ "unit": "A String", # The units for translate elements.
},
+ "objectId": "A String", # The object ID of the page element to update.
},
},
],
@@ -1885,17 +1906,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -2025,6 +2046,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -2035,11 +2077,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -2069,7 +2106,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -2082,6 +2118,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -2131,6 +2173,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -2141,11 +2204,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -2175,7 +2233,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -2188,6 +2245,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -2289,6 +2352,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -2299,11 +2383,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -2333,7 +2412,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -2346,6 +2424,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -2394,6 +2478,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -2404,11 +2509,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -2438,7 +2538,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -2451,6 +2550,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -2625,12 +2730,11 @@
"sheetsChart": { # A PageElement kind representing # A linked chart embedded from Google Sheets. Unlinked charts are
# represented as images.
# a linked chart embedded from Google Sheets.
- "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
- # embedded.
"contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30
# minutes. This URL is tagged with the account of the requester. Anyone with
# the URL effectively accesses the image as the original requester. Access to
# the image may be lost if the presentation's sharing settings change.
+ "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
"sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart.
"chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image.
"outline": { # The outline of a PageElement. # The outline of the image. If not set, the the image has no outline.
@@ -2742,17 +2846,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -2812,7 +2916,8 @@
# [-1.0, 1.0], where 0 means no effect. This property is read-only.
},
},
- "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+ "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
+ # embedded.
},
"video": { # A PageElement kind representing a # A video page element.
# video.
@@ -2866,6 +2971,12 @@
},
},
},
+ "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
+ # joined collection of PageElements.
+ "children": [ # The collection of elements in the group. The minimum size of a group is 2.
+ # Object with schema name: PageElement
+ ],
+ },
"table": { # A PageElement kind representing a # A table page element.
# table.
"tableColumns": [ # Properties of each column.
@@ -2936,6 +3047,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -2946,11 +3078,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -2980,7 +3107,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -2993,6 +3119,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -3042,6 +3174,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -3052,11 +3205,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -3086,7 +3234,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -3099,6 +3246,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -3200,6 +3353,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -3210,11 +3384,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -3244,7 +3413,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -3257,6 +3425,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -3305,6 +3479,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -3315,11 +3510,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -3349,7 +3539,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -3362,6 +3551,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -3437,7 +3632,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "startArrow": "A String", # The style of the arrow at the beginning of the line.
"lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new
# lines created in the Slides editor.
"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.
@@ -3462,6 +3656,7 @@
# a value of 0.0 corresponds to a completely transparent color.
},
},
+ "startArrow": "A String", # The style of the arrow at the beginning of the line.
},
"lineType": "A String", # The type of the line.
},
@@ -3475,12 +3670,6 @@
"unit": "A String", # The units for magnitude.
},
},
- "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
- # joined collection of PageElements.
- "children": [ # The collection of elements in the group. The minimum size of a group is 2.
- # Object with schema name: PageElement
- ],
- },
},
],
"notesProperties": { # The properties of Page that are only # Notes specific properties. Only set if page_type = NOTES.
@@ -3767,17 +3956,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -3907,6 +4096,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -3917,11 +4127,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -3951,7 +4156,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -3964,6 +4168,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -4013,6 +4223,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -4023,11 +4254,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -4057,7 +4283,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -4070,6 +4295,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -4171,6 +4402,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -4181,11 +4433,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -4215,7 +4462,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -4228,6 +4474,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -4276,6 +4528,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -4286,11 +4559,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -4320,7 +4588,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -4333,6 +4600,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -4507,12 +4780,11 @@
"sheetsChart": { # A PageElement kind representing # A linked chart embedded from Google Sheets. Unlinked charts are
# represented as images.
# a linked chart embedded from Google Sheets.
- "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
- # embedded.
"contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30
# minutes. This URL is tagged with the account of the requester. Anyone with
# the URL effectively accesses the image as the original requester. Access to
# the image may be lost if the presentation's sharing settings change.
+ "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
"sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart.
"chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image.
"outline": { # The outline of a PageElement. # The outline of the image. If not set, the the image has no outline.
@@ -4624,17 +4896,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -4694,7 +4966,8 @@
# [-1.0, 1.0], where 0 means no effect. This property is read-only.
},
},
- "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+ "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
+ # embedded.
},
"video": { # A PageElement kind representing a # A video page element.
# video.
@@ -4748,6 +5021,12 @@
},
},
},
+ "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
+ # joined collection of PageElements.
+ "children": [ # The collection of elements in the group. The minimum size of a group is 2.
+ # Object with schema name: PageElement
+ ],
+ },
"table": { # A PageElement kind representing a # A table page element.
# table.
"tableColumns": [ # Properties of each column.
@@ -4818,6 +5097,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -4828,11 +5128,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -4862,7 +5157,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -4875,6 +5169,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -4924,6 +5224,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -4934,11 +5255,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -4968,7 +5284,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -4981,6 +5296,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -5082,6 +5403,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -5092,11 +5434,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -5126,7 +5463,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -5139,6 +5475,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -5187,6 +5529,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -5197,11 +5560,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -5231,7 +5589,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -5244,6 +5601,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -5319,7 +5682,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "startArrow": "A String", # The style of the arrow at the beginning of the line.
"lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new
# lines created in the Slides editor.
"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.
@@ -5344,6 +5706,7 @@
# a value of 0.0 corresponds to a completely transparent color.
},
},
+ "startArrow": "A String", # The style of the arrow at the beginning of the line.
},
"lineType": "A String", # The type of the line.
},
@@ -5357,12 +5720,6 @@
"unit": "A String", # The units for magnitude.
},
},
- "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
- # joined collection of PageElements.
- "children": [ # The collection of elements in the group. The minimum size of a group is 2.
- # Object with schema name: PageElement
- ],
- },
},
],
"notesProperties": { # The properties of Page that are only # Notes specific properties. Only set if page_type = NOTES.
@@ -5620,17 +5977,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -5760,6 +6117,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -5770,11 +6148,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -5804,7 +6177,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -5817,6 +6189,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -5866,6 +6244,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -5876,11 +6275,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -5910,7 +6304,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -5923,6 +6316,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -6024,6 +6423,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -6034,11 +6454,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -6068,7 +6483,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -6081,6 +6495,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -6129,6 +6549,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -6139,11 +6580,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -6173,7 +6609,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -6186,6 +6621,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -6360,12 +6801,11 @@
"sheetsChart": { # A PageElement kind representing # A linked chart embedded from Google Sheets. Unlinked charts are
# represented as images.
# a linked chart embedded from Google Sheets.
- "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
- # embedded.
"contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30
# minutes. This URL is tagged with the account of the requester. Anyone with
# the URL effectively accesses the image as the original requester. Access to
# the image may be lost if the presentation's sharing settings change.
+ "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
"sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart.
"chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image.
"outline": { # The outline of a PageElement. # The outline of the image. If not set, the the image has no outline.
@@ -6477,17 +6917,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -6547,7 +6987,8 @@
# [-1.0, 1.0], where 0 means no effect. This property is read-only.
},
},
- "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+ "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
+ # embedded.
},
"video": { # A PageElement kind representing a # A video page element.
# video.
@@ -6601,6 +7042,12 @@
},
},
},
+ "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
+ # joined collection of PageElements.
+ "children": [ # The collection of elements in the group. The minimum size of a group is 2.
+ # Object with schema name: PageElement
+ ],
+ },
"table": { # A PageElement kind representing a # A table page element.
# table.
"tableColumns": [ # Properties of each column.
@@ -6671,6 +7118,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -6681,11 +7149,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -6715,7 +7178,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -6728,6 +7190,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -6777,6 +7245,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -6787,11 +7276,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -6821,7 +7305,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -6834,6 +7317,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -6935,6 +7424,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -6945,11 +7455,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -6979,7 +7484,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -6992,6 +7496,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -7040,6 +7550,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -7050,11 +7581,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -7084,7 +7610,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -7097,6 +7622,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -7172,7 +7703,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "startArrow": "A String", # The style of the arrow at the beginning of the line.
"lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new
# lines created in the Slides editor.
"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.
@@ -7197,6 +7727,7 @@
# a value of 0.0 corresponds to a completely transparent color.
},
},
+ "startArrow": "A String", # The style of the arrow at the beginning of the line.
},
"lineType": "A String", # The type of the line.
},
@@ -7210,12 +7741,6 @@
"unit": "A String", # The units for magnitude.
},
},
- "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
- # joined collection of PageElements.
- "children": [ # The collection of elements in the group. The minimum size of a group is 2.
- # Object with schema name: PageElement
- ],
- },
},
],
"notesProperties": { # The properties of Page that are only # Notes specific properties. Only set if page_type = NOTES.
@@ -7474,17 +7999,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -7614,6 +8139,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -7624,11 +8170,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -7658,7 +8199,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -7671,6 +8211,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -7720,6 +8266,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -7730,11 +8297,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -7764,7 +8326,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -7777,6 +8338,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -7878,6 +8445,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -7888,11 +8476,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -7922,7 +8505,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -7935,6 +8517,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -7983,6 +8571,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -7993,11 +8602,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -8027,7 +8631,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -8040,6 +8643,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -8214,12 +8823,11 @@
"sheetsChart": { # A PageElement kind representing # A linked chart embedded from Google Sheets. Unlinked charts are
# represented as images.
# a linked chart embedded from Google Sheets.
- "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
- # embedded.
"contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30
# minutes. This URL is tagged with the account of the requester. Anyone with
# the URL effectively accesses the image as the original requester. Access to
# the image may be lost if the presentation's sharing settings change.
+ "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
"sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart.
"chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image.
"outline": { # The outline of a PageElement. # The outline of the image. If not set, the the image has no outline.
@@ -8331,17 +8939,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -8401,7 +9009,8 @@
# [-1.0, 1.0], where 0 means no effect. This property is read-only.
},
},
- "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+ "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
+ # embedded.
},
"video": { # A PageElement kind representing a # A video page element.
# video.
@@ -8455,6 +9064,12 @@
},
},
},
+ "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
+ # joined collection of PageElements.
+ "children": [ # The collection of elements in the group. The minimum size of a group is 2.
+ # Object with schema name: PageElement
+ ],
+ },
"table": { # A PageElement kind representing a # A table page element.
# table.
"tableColumns": [ # Properties of each column.
@@ -8525,6 +9140,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -8535,11 +9171,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -8569,7 +9200,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -8582,6 +9212,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -8631,6 +9267,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -8641,11 +9298,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -8675,7 +9327,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -8688,6 +9339,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -8789,6 +9446,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -8799,11 +9477,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -8833,7 +9506,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -8846,6 +9518,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -8894,6 +9572,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -8904,11 +9603,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -8938,7 +9632,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -8951,6 +9644,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -9026,7 +9725,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "startArrow": "A String", # The style of the arrow at the beginning of the line.
"lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new
# lines created in the Slides editor.
"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.
@@ -9051,6 +9749,7 @@
# a value of 0.0 corresponds to a completely transparent color.
},
},
+ "startArrow": "A String", # The style of the arrow at the beginning of the line.
},
"lineType": "A String", # The type of the line.
},
@@ -9064,12 +9763,6 @@
"unit": "A String", # The units for magnitude.
},
},
- "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
- # joined collection of PageElements.
- "children": [ # The collection of elements in the group. The minimum size of a group is 2.
- # Object with schema name: PageElement
- ],
- },
},
],
"notesProperties": { # The properties of Page that are only # Notes specific properties. Only set if page_type = NOTES.
@@ -9347,17 +10040,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -9487,6 +10180,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -9497,11 +10211,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -9531,7 +10240,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -9544,6 +10252,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -9593,6 +10307,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -9603,11 +10338,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -9637,7 +10367,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -9650,6 +10379,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -9751,6 +10486,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -9761,11 +10517,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -9795,7 +10546,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -9808,6 +10558,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -9856,6 +10612,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -9866,11 +10643,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -9900,7 +10672,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -9913,6 +10684,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -10087,12 +10864,11 @@
"sheetsChart": { # A PageElement kind representing # A linked chart embedded from Google Sheets. Unlinked charts are
# represented as images.
# a linked chart embedded from Google Sheets.
- "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
- # embedded.
"contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30
# minutes. This URL is tagged with the account of the requester. Anyone with
# the URL effectively accesses the image as the original requester. Access to
# the image may be lost if the presentation's sharing settings change.
+ "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
"sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart.
"chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image.
"outline": { # The outline of a PageElement. # The outline of the image. If not set, the the image has no outline.
@@ -10204,17 +10980,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -10274,7 +11050,8 @@
# [-1.0, 1.0], where 0 means no effect. This property is read-only.
},
},
- "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+ "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
+ # embedded.
},
"video": { # A PageElement kind representing a # A video page element.
# video.
@@ -10328,6 +11105,12 @@
},
},
},
+ "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
+ # joined collection of PageElements.
+ "children": [ # The collection of elements in the group. The minimum size of a group is 2.
+ # Object with schema name: PageElement
+ ],
+ },
"table": { # A PageElement kind representing a # A table page element.
# table.
"tableColumns": [ # Properties of each column.
@@ -10398,6 +11181,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -10408,11 +11212,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -10442,7 +11241,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -10455,6 +11253,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -10504,6 +11308,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -10514,11 +11339,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -10548,7 +11368,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -10561,6 +11380,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -10662,6 +11487,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -10672,11 +11518,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -10706,7 +11547,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -10719,6 +11559,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -10767,6 +11613,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -10777,11 +11644,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -10811,7 +11673,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -10824,6 +11685,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -10899,7 +11766,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "startArrow": "A String", # The style of the arrow at the beginning of the line.
"lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new
# lines created in the Slides editor.
"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.
@@ -10924,6 +11790,7 @@
# a value of 0.0 corresponds to a completely transparent color.
},
},
+ "startArrow": "A String", # The style of the arrow at the beginning of the line.
},
"lineType": "A String", # The type of the line.
},
@@ -10937,12 +11804,6 @@
"unit": "A String", # The units for magnitude.
},
},
- "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
- # joined collection of PageElements.
- "children": [ # The collection of elements in the group. The minimum size of a group is 2.
- # Object with schema name: PageElement
- ],
- },
},
],
"notesProperties": { # The properties of Page that are only # Notes specific properties. Only set if page_type = NOTES.
@@ -11229,17 +12090,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -11369,6 +12230,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -11379,11 +12261,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -11413,7 +12290,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -11426,6 +12302,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -11475,6 +12357,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -11485,11 +12388,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -11519,7 +12417,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -11532,6 +12429,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -11633,6 +12536,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -11643,11 +12567,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -11677,7 +12596,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -11690,6 +12608,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -11738,6 +12662,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -11748,11 +12693,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -11782,7 +12722,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -11795,6 +12734,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -11969,12 +12914,11 @@
"sheetsChart": { # A PageElement kind representing # A linked chart embedded from Google Sheets. Unlinked charts are
# represented as images.
# a linked chart embedded from Google Sheets.
- "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
- # embedded.
"contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30
# minutes. This URL is tagged with the account of the requester. Anyone with
# the URL effectively accesses the image as the original requester. Access to
# the image may be lost if the presentation's sharing settings change.
+ "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
"sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart.
"chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image.
"outline": { # The outline of a PageElement. # The outline of the image. If not set, the the image has no outline.
@@ -12086,17 +13030,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -12156,7 +13100,8 @@
# [-1.0, 1.0], where 0 means no effect. This property is read-only.
},
},
- "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+ "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
+ # embedded.
},
"video": { # A PageElement kind representing a # A video page element.
# video.
@@ -12210,6 +13155,12 @@
},
},
},
+ "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
+ # joined collection of PageElements.
+ "children": [ # The collection of elements in the group. The minimum size of a group is 2.
+ # Object with schema name: PageElement
+ ],
+ },
"table": { # A PageElement kind representing a # A table page element.
# table.
"tableColumns": [ # Properties of each column.
@@ -12280,6 +13231,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -12290,11 +13262,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -12324,7 +13291,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -12337,6 +13303,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -12386,6 +13358,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -12396,11 +13389,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -12430,7 +13418,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -12443,6 +13430,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -12544,6 +13537,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -12554,11 +13568,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -12588,7 +13597,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -12601,6 +13609,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -12649,6 +13663,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -12659,11 +13694,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -12693,7 +13723,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -12706,6 +13735,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -12781,7 +13816,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "startArrow": "A String", # The style of the arrow at the beginning of the line.
"lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new
# lines created in the Slides editor.
"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.
@@ -12806,6 +13840,7 @@
# a value of 0.0 corresponds to a completely transparent color.
},
},
+ "startArrow": "A String", # The style of the arrow at the beginning of the line.
},
"lineType": "A String", # The type of the line.
},
@@ -12819,12 +13854,6 @@
"unit": "A String", # The units for magnitude.
},
},
- "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
- # joined collection of PageElements.
- "children": [ # The collection of elements in the group. The minimum size of a group is 2.
- # Object with schema name: PageElement
- ],
- },
},
],
"notesProperties": { # The properties of Page that are only # Notes specific properties. Only set if page_type = NOTES.
@@ -13082,17 +14111,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -13222,6 +14251,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -13232,11 +14282,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -13266,7 +14311,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -13279,6 +14323,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -13328,6 +14378,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -13338,11 +14409,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -13372,7 +14438,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -13385,6 +14450,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -13486,6 +14557,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -13496,11 +14588,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -13530,7 +14617,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -13543,6 +14629,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -13591,6 +14683,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -13601,11 +14714,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -13635,7 +14743,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -13648,6 +14755,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -13822,12 +14935,11 @@
"sheetsChart": { # A PageElement kind representing # A linked chart embedded from Google Sheets. Unlinked charts are
# represented as images.
# a linked chart embedded from Google Sheets.
- "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
- # embedded.
"contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30
# minutes. This URL is tagged with the account of the requester. Anyone with
# the URL effectively accesses the image as the original requester. Access to
# the image may be lost if the presentation's sharing settings change.
+ "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
"sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart.
"chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image.
"outline": { # The outline of a PageElement. # The outline of the image. If not set, the the image has no outline.
@@ -13939,17 +15051,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -14009,7 +15121,8 @@
# [-1.0, 1.0], where 0 means no effect. This property is read-only.
},
},
- "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+ "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
+ # embedded.
},
"video": { # A PageElement kind representing a # A video page element.
# video.
@@ -14063,6 +15176,12 @@
},
},
},
+ "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
+ # joined collection of PageElements.
+ "children": [ # The collection of elements in the group. The minimum size of a group is 2.
+ # Object with schema name: PageElement
+ ],
+ },
"table": { # A PageElement kind representing a # A table page element.
# table.
"tableColumns": [ # Properties of each column.
@@ -14133,6 +15252,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -14143,11 +15283,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -14177,7 +15312,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -14190,6 +15324,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -14239,6 +15379,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -14249,11 +15410,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -14283,7 +15439,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -14296,6 +15451,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -14397,6 +15558,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -14407,11 +15589,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -14441,7 +15618,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -14454,6 +15630,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -14502,6 +15684,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -14512,11 +15715,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -14546,7 +15744,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -14559,6 +15756,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -14634,7 +15837,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "startArrow": "A String", # The style of the arrow at the beginning of the line.
"lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new
# lines created in the Slides editor.
"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.
@@ -14659,6 +15861,7 @@
# a value of 0.0 corresponds to a completely transparent color.
},
},
+ "startArrow": "A String", # The style of the arrow at the beginning of the line.
},
"lineType": "A String", # The type of the line.
},
@@ -14672,12 +15875,6 @@
"unit": "A String", # The units for magnitude.
},
},
- "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
- # joined collection of PageElements.
- "children": [ # The collection of elements in the group. The minimum size of a group is 2.
- # Object with schema name: PageElement
- ],
- },
},
],
"notesProperties": { # The properties of Page that are only # Notes specific properties. Only set if page_type = NOTES.
@@ -14936,17 +16133,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -15076,6 +16273,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -15086,11 +16304,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -15120,7 +16333,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -15133,6 +16345,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -15182,6 +16400,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -15192,11 +16431,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -15226,7 +16460,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -15239,6 +16472,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -15340,6 +16579,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -15350,11 +16610,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -15384,7 +16639,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -15397,6 +16651,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -15445,6 +16705,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -15455,11 +16736,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -15489,7 +16765,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -15502,6 +16777,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -15676,12 +16957,11 @@
"sheetsChart": { # A PageElement kind representing # A linked chart embedded from Google Sheets. Unlinked charts are
# represented as images.
# a linked chart embedded from Google Sheets.
- "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
- # embedded.
"contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30
# minutes. This URL is tagged with the account of the requester. Anyone with
# the URL effectively accesses the image as the original requester. Access to
# the image may be lost if the presentation's sharing settings change.
+ "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
"sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart.
"chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image.
"outline": { # The outline of a PageElement. # The outline of the image. If not set, the the image has no outline.
@@ -15793,17 +17073,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -15863,7 +17143,8 @@
# [-1.0, 1.0], where 0 means no effect. This property is read-only.
},
},
- "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+ "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
+ # embedded.
},
"video": { # A PageElement kind representing a # A video page element.
# video.
@@ -15917,6 +17198,12 @@
},
},
},
+ "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
+ # joined collection of PageElements.
+ "children": [ # The collection of elements in the group. The minimum size of a group is 2.
+ # Object with schema name: PageElement
+ ],
+ },
"table": { # A PageElement kind representing a # A table page element.
# table.
"tableColumns": [ # Properties of each column.
@@ -15987,6 +17274,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -15997,11 +17305,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -16031,7 +17334,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -16044,6 +17346,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -16093,6 +17401,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -16103,11 +17432,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -16137,7 +17461,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -16150,6 +17473,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -16251,6 +17580,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -16261,11 +17611,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -16295,7 +17640,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -16308,6 +17652,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -16356,6 +17706,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -16366,11 +17737,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -16400,7 +17766,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -16413,6 +17778,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -16488,7 +17859,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "startArrow": "A String", # The style of the arrow at the beginning of the line.
"lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new
# lines created in the Slides editor.
"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.
@@ -16513,6 +17883,7 @@
# a value of 0.0 corresponds to a completely transparent color.
},
},
+ "startArrow": "A String", # The style of the arrow at the beginning of the line.
},
"lineType": "A String", # The type of the line.
},
@@ -16526,12 +17897,6 @@
"unit": "A String", # The units for magnitude.
},
},
- "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
- # joined collection of PageElements.
- "children": [ # The collection of elements in the group. The minimum size of a group is 2.
- # Object with schema name: PageElement
- ],
- },
},
],
"notesProperties": { # The properties of Page that are only # Notes specific properties. Only set if page_type = NOTES.
@@ -16816,17 +18181,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -16956,6 +18321,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -16966,11 +18352,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -17000,7 +18381,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -17013,6 +18393,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -17062,6 +18448,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -17072,11 +18479,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -17106,7 +18508,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -17119,6 +18520,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -17220,6 +18627,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -17230,11 +18658,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -17264,7 +18687,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -17277,6 +18699,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -17325,6 +18753,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -17335,11 +18784,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -17369,7 +18813,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -17382,6 +18825,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -17556,12 +19005,11 @@
"sheetsChart": { # A PageElement kind representing # A linked chart embedded from Google Sheets. Unlinked charts are
# represented as images.
# a linked chart embedded from Google Sheets.
- "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
- # embedded.
"contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30
# minutes. This URL is tagged with the account of the requester. Anyone with
# the URL effectively accesses the image as the original requester. Access to
# the image may be lost if the presentation's sharing settings change.
+ "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
"sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart.
"chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image.
"outline": { # The outline of a PageElement. # The outline of the image. If not set, the the image has no outline.
@@ -17673,17 +19121,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -17743,7 +19191,8 @@
# [-1.0, 1.0], where 0 means no effect. This property is read-only.
},
},
- "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+ "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
+ # embedded.
},
"video": { # A PageElement kind representing a # A video page element.
# video.
@@ -17797,6 +19246,12 @@
},
},
},
+ "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
+ # joined collection of PageElements.
+ "children": [ # The collection of elements in the group. The minimum size of a group is 2.
+ # Object with schema name: PageElement
+ ],
+ },
"table": { # A PageElement kind representing a # A table page element.
# table.
"tableColumns": [ # Properties of each column.
@@ -17867,6 +19322,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -17877,11 +19353,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -17911,7 +19382,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -17924,6 +19394,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -17973,6 +19449,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -17983,11 +19480,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -18017,7 +19509,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -18030,6 +19521,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -18131,6 +19628,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -18141,11 +19659,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -18175,7 +19688,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -18188,6 +19700,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -18236,6 +19754,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -18246,11 +19785,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -18280,7 +19814,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -18293,6 +19826,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -18368,7 +19907,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "startArrow": "A String", # The style of the arrow at the beginning of the line.
"lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new
# lines created in the Slides editor.
"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.
@@ -18393,6 +19931,7 @@
# a value of 0.0 corresponds to a completely transparent color.
},
},
+ "startArrow": "A String", # The style of the arrow at the beginning of the line.
},
"lineType": "A String", # The type of the line.
},
@@ -18406,12 +19945,6 @@
"unit": "A String", # The units for magnitude.
},
},
- "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
- # joined collection of PageElements.
- "children": [ # The collection of elements in the group. The minimum size of a group is 2.
- # Object with schema name: PageElement
- ],
- },
},
],
"notesProperties": { # The properties of Page that are only # Notes specific properties. Only set if page_type = NOTES.
@@ -18698,17 +20231,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -18838,6 +20371,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -18848,11 +20402,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -18882,7 +20431,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -18895,6 +20443,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -18944,6 +20498,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -18954,11 +20529,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -18988,7 +20558,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -19001,6 +20570,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -19102,6 +20677,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -19112,11 +20708,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -19146,7 +20737,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -19159,6 +20749,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -19207,6 +20803,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -19217,11 +20834,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -19251,7 +20863,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -19264,6 +20875,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -19438,12 +21055,11 @@
"sheetsChart": { # A PageElement kind representing # A linked chart embedded from Google Sheets. Unlinked charts are
# represented as images.
# a linked chart embedded from Google Sheets.
- "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
- # embedded.
"contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30
# minutes. This URL is tagged with the account of the requester. Anyone with
# the URL effectively accesses the image as the original requester. Access to
# the image may be lost if the presentation's sharing settings change.
+ "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
"sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart.
"chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image.
"outline": { # The outline of a PageElement. # The outline of the image. If not set, the the image has no outline.
@@ -19555,17 +21171,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -19625,7 +21241,8 @@
# [-1.0, 1.0], where 0 means no effect. This property is read-only.
},
},
- "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+ "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
+ # embedded.
},
"video": { # A PageElement kind representing a # A video page element.
# video.
@@ -19679,6 +21296,12 @@
},
},
},
+ "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
+ # joined collection of PageElements.
+ "children": [ # The collection of elements in the group. The minimum size of a group is 2.
+ # Object with schema name: PageElement
+ ],
+ },
"table": { # A PageElement kind representing a # A table page element.
# table.
"tableColumns": [ # Properties of each column.
@@ -19749,6 +21372,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -19759,11 +21403,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -19793,7 +21432,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -19806,6 +21444,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -19855,6 +21499,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -19865,11 +21530,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -19899,7 +21559,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -19912,6 +21571,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -20013,6 +21678,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -20023,11 +21709,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -20057,7 +21738,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -20070,6 +21750,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -20118,6 +21804,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -20128,11 +21835,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -20162,7 +21864,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -20175,6 +21876,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -20250,7 +21957,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "startArrow": "A String", # The style of the arrow at the beginning of the line.
"lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new
# lines created in the Slides editor.
"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.
@@ -20275,6 +21981,7 @@
# a value of 0.0 corresponds to a completely transparent color.
},
},
+ "startArrow": "A String", # The style of the arrow at the beginning of the line.
},
"lineType": "A String", # The type of the line.
},
@@ -20288,12 +21995,6 @@
"unit": "A String", # The units for magnitude.
},
},
- "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
- # joined collection of PageElements.
- "children": [ # The collection of elements in the group. The minimum size of a group is 2.
- # Object with schema name: PageElement
- ],
- },
},
],
"notesProperties": { # The properties of Page that are only # Notes specific properties. Only set if page_type = NOTES.
@@ -20551,17 +22252,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -20691,6 +22392,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -20701,11 +22423,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -20735,7 +22452,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -20748,6 +22464,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -20797,6 +22519,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -20807,11 +22550,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -20841,7 +22579,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -20854,6 +22591,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -20955,6 +22698,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -20965,11 +22729,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -20999,7 +22758,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -21012,6 +22770,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -21060,6 +22824,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -21070,11 +22855,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -21104,7 +22884,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -21117,6 +22896,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -21291,12 +23076,11 @@
"sheetsChart": { # A PageElement kind representing # A linked chart embedded from Google Sheets. Unlinked charts are
# represented as images.
# a linked chart embedded from Google Sheets.
- "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
- # embedded.
"contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30
# minutes. This URL is tagged with the account of the requester. Anyone with
# the URL effectively accesses the image as the original requester. Access to
# the image may be lost if the presentation's sharing settings change.
+ "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
"sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart.
"chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image.
"outline": { # The outline of a PageElement. # The outline of the image. If not set, the the image has no outline.
@@ -21408,17 +23192,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -21478,7 +23262,8 @@
# [-1.0, 1.0], where 0 means no effect. This property is read-only.
},
},
- "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+ "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
+ # embedded.
},
"video": { # A PageElement kind representing a # A video page element.
# video.
@@ -21532,6 +23317,12 @@
},
},
},
+ "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
+ # joined collection of PageElements.
+ "children": [ # The collection of elements in the group. The minimum size of a group is 2.
+ # Object with schema name: PageElement
+ ],
+ },
"table": { # A PageElement kind representing a # A table page element.
# table.
"tableColumns": [ # Properties of each column.
@@ -21602,6 +23393,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -21612,11 +23424,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -21646,7 +23453,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -21659,6 +23465,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -21708,6 +23520,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -21718,11 +23551,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -21752,7 +23580,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -21765,6 +23592,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -21866,6 +23699,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -21876,11 +23730,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -21910,7 +23759,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -21923,6 +23771,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -21971,6 +23825,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -21981,11 +23856,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -22015,7 +23885,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -22028,6 +23897,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -22103,7 +23978,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "startArrow": "A String", # The style of the arrow at the beginning of the line.
"lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new
# lines created in the Slides editor.
"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.
@@ -22128,6 +24002,7 @@
# a value of 0.0 corresponds to a completely transparent color.
},
},
+ "startArrow": "A String", # The style of the arrow at the beginning of the line.
},
"lineType": "A String", # The type of the line.
},
@@ -22141,12 +24016,6 @@
"unit": "A String", # The units for magnitude.
},
},
- "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
- # joined collection of PageElements.
- "children": [ # The collection of elements in the group. The minimum size of a group is 2.
- # Object with schema name: PageElement
- ],
- },
},
],
"notesProperties": { # The properties of Page that are only # Notes specific properties. Only set if page_type = NOTES.
@@ -22405,17 +24274,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -22545,6 +24414,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -22555,11 +24445,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -22589,7 +24474,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -22602,6 +24486,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -22651,6 +24541,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -22661,11 +24572,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -22695,7 +24601,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -22708,6 +24613,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -22809,6 +24720,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -22819,11 +24751,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -22853,7 +24780,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -22866,6 +24792,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -22914,6 +24846,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -22924,11 +24877,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -22958,7 +24906,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -22971,6 +24918,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -23145,12 +25098,11 @@
"sheetsChart": { # A PageElement kind representing # A linked chart embedded from Google Sheets. Unlinked charts are
# represented as images.
# a linked chart embedded from Google Sheets.
- "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
- # embedded.
"contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30
# minutes. This URL is tagged with the account of the requester. Anyone with
# the URL effectively accesses the image as the original requester. Access to
# the image may be lost if the presentation's sharing settings change.
+ "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
"sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart.
"chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image.
"outline": { # The outline of a PageElement. # The outline of the image. If not set, the the image has no outline.
@@ -23262,17 +25214,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -23332,7 +25284,8 @@
# [-1.0, 1.0], where 0 means no effect. This property is read-only.
},
},
- "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+ "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
+ # embedded.
},
"video": { # A PageElement kind representing a # A video page element.
# video.
@@ -23386,6 +25339,12 @@
},
},
},
+ "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
+ # joined collection of PageElements.
+ "children": [ # The collection of elements in the group. The minimum size of a group is 2.
+ # Object with schema name: PageElement
+ ],
+ },
"table": { # A PageElement kind representing a # A table page element.
# table.
"tableColumns": [ # Properties of each column.
@@ -23456,6 +25415,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -23466,11 +25446,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -23500,7 +25475,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -23513,6 +25487,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -23562,6 +25542,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -23572,11 +25573,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -23606,7 +25602,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -23619,6 +25614,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -23720,6 +25721,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -23730,11 +25752,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -23764,7 +25781,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -23777,6 +25793,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -23825,6 +25847,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -23835,11 +25878,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -23869,7 +25907,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -23882,6 +25919,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -23957,7 +26000,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "startArrow": "A String", # The style of the arrow at the beginning of the line.
"lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new
# lines created in the Slides editor.
"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.
@@ -23982,6 +26024,7 @@
# a value of 0.0 corresponds to a completely transparent color.
},
},
+ "startArrow": "A String", # The style of the arrow at the beginning of the line.
},
"lineType": "A String", # The type of the line.
},
@@ -23995,12 +26038,6 @@
"unit": "A String", # The units for magnitude.
},
},
- "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
- # joined collection of PageElements.
- "children": [ # The collection of elements in the group. The minimum size of a group is 2.
- # Object with schema name: PageElement
- ],
- },
},
],
"notesProperties": { # The properties of Page that are only # Notes specific properties. Only set if page_type = NOTES.
diff --git a/docs/dyn/slides_v1.presentations.pages.html b/docs/dyn/slides_v1.presentations.pages.html
index 78511b7..868a42e 100644
--- a/docs/dyn/slides_v1.presentations.pages.html
+++ b/docs/dyn/slides_v1.presentations.pages.html
@@ -77,6 +77,9 @@
<p class="toc_element">
<code><a href="#get">get(presentationId, pageObjectId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the latest version of the specified page in the presentation.</p>
+<p class="toc_element">
+ <code><a href="#getThumbnail">getThumbnail(presentationId, pageObjectId, thumbnailProperties_mimeType=None, thumbnailProperties_thumbnailSize=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Generates a thumbnail of the latest version of the specified page in the</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(presentationId, pageObjectId, x__xgafv=None)</code>
@@ -229,17 +232,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -369,6 +372,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -379,11 +403,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -413,7 +432,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -426,6 +444,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -475,6 +499,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -485,11 +530,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -519,7 +559,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -532,6 +571,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -633,6 +678,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -643,11 +709,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -677,7 +738,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -690,6 +750,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -738,6 +804,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -748,11 +835,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -782,7 +864,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -795,6 +876,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -969,12 +1056,11 @@
"sheetsChart": { # A PageElement kind representing # A linked chart embedded from Google Sheets. Unlinked charts are
# represented as images.
# a linked chart embedded from Google Sheets.
- "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
- # embedded.
"contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30
# minutes. This URL is tagged with the account of the requester. Anyone with
# the URL effectively accesses the image as the original requester. Access to
# the image may be lost if the presentation's sharing settings change.
+ "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
"sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart.
"chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image.
"outline": { # The outline of a PageElement. # The outline of the image. If not set, the the image has no outline.
@@ -1086,17 +1172,17 @@
"leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to
# the right of the original bounding rectangle left edge, relative to the
# object's original width.
- "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
- # Rotation angle is applied after the offset.
+ "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
+ # below the original bounding rectangle top edge, relative to the object's
+ # original height.
"rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located
# to the left of the original bounding rectangle right edge, relative to the
# object's original width.
"bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located
# above the original bounding rectangle bottom edge, relative to the object's
# original height.
- "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located
- # below the original bounding rectangle top edge, relative to the object's
- # original height.
+ "angle": 3.14, # The rotation angle of the crop window around its center, in radians.
+ # Rotation angle is applied after the offset.
},
"shadow": { # The shadow properties of a page element. # The shadow of the image. If not set, the image has no shadow. This property
# is read-only.
@@ -1156,7 +1242,8 @@
# [-1.0, 1.0], where 0 means no effect. This property is read-only.
},
},
- "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+ "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is
+ # embedded.
},
"video": { # A PageElement kind representing a # A video page element.
# video.
@@ -1210,6 +1297,12 @@
},
},
},
+ "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
+ # joined collection of PageElements.
+ "children": [ # The collection of elements in the group. The minimum size of a group is 2.
+ # Object with schema name: PageElement
+ ],
+ },
"table": { # A PageElement kind representing a # A table page element.
# table.
"tableColumns": [ # Properties of each column.
@@ -1280,6 +1373,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -1290,11 +1404,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -1324,7 +1433,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -1337,6 +1445,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -1386,6 +1500,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -1396,11 +1531,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -1430,7 +1560,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -1443,6 +1572,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"type": "A String", # The type of this auto text.
},
@@ -1544,6 +1679,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -1554,11 +1710,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -1588,7 +1739,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -1601,6 +1751,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
"glyph": "A String", # The rendered bullet glyph for this paragraph.
},
@@ -1649,6 +1805,27 @@
# rendered in a smaller font size, computed based on the `font_size` field.
# The `font_size` itself is not affected by changes in this field.
"strikethrough": True or False, # Whether or not the text is struck through.
+ "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This property is
+ # read-only.
+ #
+ # This field is an extension of `font_family` meant to support explicit font
+ # weights without breaking backwards compatibility. As such, when reading the
+ # style of a range of text, the value of `weighted_font_family.font_family`
+ # will always be equal to that of `font_family`.
+ "fontFamily": "A String", # The font family of the text.
+ #
+ # The font family can be any font from the Font menu in Slides or from
+ # [Google Fonts] (https://fonts.google.com/). If the font name is
+ # unrecognized, the text is rendered in `Arial`.
+ "weight": 42, # The rendered weight of the text. This field can have any value that is a
+ # multiple of 100 between 100 and 900, inclusive. This range corresponds to
+ # only the numerical values described in the "Cascading Style Sheets Level
+ # 2 Revision 1 (CSS 2.1) Specification",
+ # [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness). The
+ # non-numerical values in the specification are disallowed. Weights greater
+ # than or equal to 700 are considered bold, and weights less than 700 are
+ # not bold. The default value is `400` ("normal").
+ },
"smallCaps": True or False, # Whether or not the text is in small capital letters.
"fontFamily": "A String", # The font family of the text.
#
@@ -1659,11 +1836,6 @@
# Some fonts can affect the weight of the text. If an update request
# specifies values for both `font_family` and `bold`, the explicitly-set
# `bold` value is used.
- "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
- # points.
- "magnitude": 3.14, # The magnitude.
- "unit": "A String", # The units for magnitude.
- },
"italic": True or False, # Whether or not the text is italicized.
"link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links
# are not inherited from parent text.
@@ -1693,7 +1865,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "underline": True or False, # Whether or not the text is underlined.
"backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or
# transparent, depending on if the `opaque_color` field in it is set.
"opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents
@@ -1706,6 +1877,12 @@
},
},
},
+ "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in
+ # points.
+ "magnitude": 3.14, # The magnitude.
+ "unit": "A String", # The units for magnitude.
+ },
+ "underline": True or False, # Whether or not the text is underlined.
},
},
},
@@ -1781,7 +1958,6 @@
"relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation,
# addressed by its position.
},
- "startArrow": "A String", # The style of the arrow at the beginning of the line.
"lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new
# lines created in the Slides editor.
"solidFill": { # A solid color fill. The page or page element is filled entirely with the # Solid color fill.
@@ -1806,6 +1982,7 @@
# a value of 0.0 corresponds to a completely transparent color.
},
},
+ "startArrow": "A String", # The style of the arrow at the beginning of the line.
},
"lineType": "A String", # The type of the line.
},
@@ -1819,12 +1996,6 @@
"unit": "A String", # The units for magnitude.
},
},
- "elementGroup": { # A PageElement kind representing a # A collection of page elements joined as a single unit.
- # joined collection of PageElements.
- "children": [ # The collection of elements in the group. The minimum size of a group is 2.
- # Object with schema name: PageElement
- ],
- },
},
],
"notesProperties": { # The properties of Page that are only # Notes specific properties. Only set if page_type = NOTES.
@@ -1945,4 +2116,41 @@
}</pre>
</div>
+<div class="method">
+ <code class="details" id="getThumbnail">getThumbnail(presentationId, pageObjectId, thumbnailProperties_mimeType=None, thumbnailProperties_thumbnailSize=None, x__xgafv=None)</code>
+ <pre>Generates a thumbnail of the latest version of the specified page in the
+presentation and returns a URL to the thumbnail image.
+
+Args:
+ presentationId: string, The ID of the presentation to retrieve. (required)
+ pageObjectId: string, The object ID of the page whose thumbnail to retrieve. (required)
+ thumbnailProperties_mimeType: string, The optional mime type of the thumbnail image.
+
+If you don't specify the mime type, the default mime type will be PNG.
+ thumbnailProperties_thumbnailSize: string, The optional thumbnail image size.
+
+If you don't specify the size, the server chooses a default size of the
+image.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The thumbnail of a page.
+ "contentUrl": "A String", # The content URL of the thumbnail image.
+ #
+ # The URL to the image has a default lifetime of 30 minutes.
+ # This URL is tagged with the account of the requester. Anyone with the URL
+ # effectively accesses the image as the original requester. Access to the
+ # image may be lost if the presentation's sharing settings change.
+ # The mime type of the thumbnail image is the same as specified in the
+ # `GetPageThumbnailRequest`.
+ "width": 42, # The positive width in pixels of the thumbnail image.
+ "height": 42, # The positive height in pixels of the thumbnail image.
+ }</pre>
+</div>
+
</body></html>
\ No newline at end of file
diff --git a/docs/dyn/sourcerepo_v1.projects.repos.html b/docs/dyn/sourcerepo_v1.projects.repos.html
index e700c2a..12a375a 100644
--- a/docs/dyn/sourcerepo_v1.projects.repos.html
+++ b/docs/dyn/sourcerepo_v1.projects.repos.html
@@ -265,8 +265,8 @@
# [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -345,7 +345,7 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
@@ -387,28 +387,6 @@
"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 the only supported field names are
- # - "iam_principal", corresponding to IAMContext.principal;
- # - "" (empty string), resulting in one aggretated counter with no field.
- #
- # 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.
@@ -560,8 +538,8 @@
# [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -640,7 +618,7 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
@@ -682,28 +660,6 @@
"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 the only supported field names are
- # - "iam_principal", corresponding to IAMContext.principal;
- # - "" (empty string), resulting in one aggretated counter with no field.
- #
- # 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.
@@ -768,8 +724,8 @@
"iamOwned": True or False,
},
"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
- # the fields in the mask will be modified. If no mask is provided, a default
- # mask is used:
+ # the fields in the mask will be modified. If no mask is provided, the
+ # following default mask is used:
# paths: "bindings, etag"
# This field is only used by Cloud IAM.
}
@@ -815,8 +771,8 @@
# [IAM developer's guide](https://cloud.google.com/iam).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
- # It consists of which permission types are logged, and what identities, if
- # any, are exempted from logging.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
# An AuditConifg must have one or more AuditLogConfigs.
#
# If there are AuditConfigs for both `allServices` and a specific service,
@@ -895,7 +851,7 @@
},
],
"service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `resourcemanager`, `storage`, `compute`.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
# `allServices` is a special value that covers all services.
},
],
@@ -937,28 +893,6 @@
"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 the only supported field names are
- # - "iam_principal", corresponding to IAMContext.principal;
- # - "" (empty string), resulting in one aggretated counter with no field.
- #
- # 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.
diff --git a/docs/dyn/spanner_v1.projects.instances.databases.html b/docs/dyn/spanner_v1.projects.instances.databases.html
index 281e53e..ee90725 100644
--- a/docs/dyn/spanner_v1.projects.instances.databases.html
+++ b/docs/dyn/spanner_v1.projects.instances.databases.html
@@ -100,7 +100,7 @@
<code><a href="#getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a database resource. Returns an empty</p>
<p class="toc_element">
- <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Cloud Spanner databases.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -160,22 +160,6 @@
# 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 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:
@@ -239,6 +223,22 @@
},
],
},
+ "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`.
}</pre>
</div>
@@ -543,12 +543,14 @@
</div>
<div class="method">
- <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Cloud Spanner databases.
Args:
parent: string, Required. The instance whose databases should be listed.
Values are of the form `projects/<project>/instances/<instance>`. (required)
+ pageSize: integer, Number of databases to be returned in the response. If 0 or less,
+defaults to the server's maximum allowed page size.
pageToken: string, If non-empty, `page_token` should contain a
next_page_token from a
previous ListDatabasesResponse.
@@ -556,8 +558,6 @@
Allowed values
1 - v1 error format
2 - v2 error format
- pageSize: integer, Number of databases to be returned in the response. If 0 or less,
-defaults to the server's maximum allowed page size.
Returns:
An object of the form:
@@ -1133,22 +1133,6 @@
# 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 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:
@@ -1212,6 +1196,22 @@
},
],
},
+ "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`.
}</pre>
</div>
diff --git a/docs/dyn/spanner_v1.projects.instances.databases.operations.html b/docs/dyn/spanner_v1.projects.instances.databases.operations.html
index 62ba24f..62881f2 100644
--- a/docs/dyn/spanner_v1.projects.instances.databases.operations.html
+++ b/docs/dyn/spanner_v1.projects.instances.databases.operations.html
@@ -178,22 +178,6 @@
# 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 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:
@@ -257,6 +241,22 @@
},
],
},
+ "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`.
}</pre>
</div>
@@ -292,22 +292,6 @@
# 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 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:
@@ -371,6 +355,22 @@
},
],
},
+ "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`.
},
],
}</pre>
diff --git a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html
index a8af489..2674a45 100644
--- a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html
+++ b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html
@@ -550,6 +550,14 @@
# If the same key is specified multiple times in the set (for example
# if two ranges, two keys, or a key and a range overlap), Cloud Spanner
# behaves as if the key were only specified once.
+ "keys": [ # A list of specific keys. Entries in `keys` should have exactly as
+ # many elements as there are columns in the primary or index key
+ # with which this `KeySet` is used. Individual key values are
+ # encoded as described here.
+ [
+ "",
+ ],
+ ],
"ranges": [ # A list of key ranges. See KeyRange for more information about
# key range specifications.
{ # KeyRange represents a range of rows in a table or index.
@@ -656,14 +664,6 @@
],
},
],
- "keys": [ # A list of specific keys. Entries in `keys` should have exactly as
- # many elements as there are columns in the primary or index key
- # with which this `KeySet` is used. Individual key values are
- # encoded as described here.
- [
- "",
- ],
- ],
"all": True or False, # For convenience `all` can be set to `true` to indicate that this
# `KeySet` matches all keys in the table or index. Note that any keys
# specified in `keys` or `ranges` are only yielded once.
@@ -983,10 +983,9 @@
Cloud Spanner limits the number of sessions that can exist at any given
time; thus, it is a good idea to delete idle and/or unneeded sessions.
-Aside from explicit deletes, Cloud Spanner can delete sessions for
-which no operations are sent for more than an hour, or due to
-internal errors. If a session is deleted, requests to it
-return `NOT_FOUND`.
+Aside from explicit deletes, Cloud Spanner can delete sessions for which no
+operations are sent for more than an hour. If a session is deleted,
+requests to it return `NOT_FOUND`.
Idle sessions can be kept alive by sending a trivial SQL query
periodically, e.g., `"SELECT 1"`.
@@ -2434,14 +2433,6 @@
{ # Partial results from a streaming read or SQL query. Streaming reads and
# SQL queries better tolerate large result sets, large rows, and large
# values, but are a little trickier to consume.
- "resumeToken": "A String", # Streaming calls might be interrupted for a variety of reasons, such
- # as TCP connection loss. If this occurs, the stream of results can
- # be resumed by re-sending the original request and including
- # `resume_token`. Note that executing any other transaction in the
- # same session invalidates the token.
- "chunkedValue": True or False, # If true, then the final value in values is chunked, and must
- # be combined with more values from subsequent `PartialResultSet`s
- # to obtain a complete field value.
"values": [ # A streamed result set consists of a stream of values, which might
# be split into many `PartialResultSet` messages to accommodate
# large rows and/or large values. Every N complete values defines a
@@ -2517,6 +2508,14 @@
# field value `"World" = "W" + "orl" + "d"`.
"",
],
+ "chunkedValue": True or False, # If true, then the final value in values is chunked, and must
+ # be combined with more values from subsequent `PartialResultSet`s
+ # to obtain a complete field value.
+ "resumeToken": "A String", # Streaming calls might be interrupted for a variety of reasons, such
+ # as TCP connection loss. If this occurs, the stream of results can
+ # be resumed by re-sending the original request and including
+ # `resume_token`. Note that executing any other transaction in the
+ # same session invalidates the token.
"stats": { # Additional statistics about a ResultSet or PartialResultSet. # Query plan and execution statistics for the query that produced this
# streaming result set. These can be requested by setting
# ExecuteSqlRequest.query_mode and are sent
@@ -3275,6 +3274,14 @@
# If the same key is specified multiple times in the set (for example
# if two ranges, two keys, or a key and a range overlap), Cloud Spanner
# behaves as if the key were only specified once.
+ "keys": [ # A list of specific keys. Entries in `keys` should have exactly as
+ # many elements as there are columns in the primary or index key
+ # with which this `KeySet` is used. Individual key values are
+ # encoded as described here.
+ [
+ "",
+ ],
+ ],
"ranges": [ # A list of key ranges. See KeyRange for more information about
# key range specifications.
{ # KeyRange represents a range of rows in a table or index.
@@ -3381,14 +3388,6 @@
],
},
],
- "keys": [ # A list of specific keys. Entries in `keys` should have exactly as
- # many elements as there are columns in the primary or index key
- # with which this `KeySet` is used. Individual key values are
- # encoded as described here.
- [
- "",
- ],
- ],
"all": True or False, # For convenience `all` can be set to `true` to indicate that this
# `KeySet` matches all keys in the table or index. Note that any keys
# specified in `keys` or `ranges` are only yielded once.
@@ -4189,6 +4188,14 @@
# If the same key is specified multiple times in the set (for example
# if two ranges, two keys, or a key and a range overlap), Cloud Spanner
# behaves as if the key were only specified once.
+ "keys": [ # A list of specific keys. Entries in `keys` should have exactly as
+ # many elements as there are columns in the primary or index key
+ # with which this `KeySet` is used. Individual key values are
+ # encoded as described here.
+ [
+ "",
+ ],
+ ],
"ranges": [ # A list of key ranges. See KeyRange for more information about
# key range specifications.
{ # KeyRange represents a range of rows in a table or index.
@@ -4295,14 +4302,6 @@
],
},
],
- "keys": [ # A list of specific keys. Entries in `keys` should have exactly as
- # many elements as there are columns in the primary or index key
- # with which this `KeySet` is used. Individual key values are
- # encoded as described here.
- [
- "",
- ],
- ],
"all": True or False, # For convenience `all` can be set to `true` to indicate that this
# `KeySet` matches all keys in the table or index. Note that any keys
# specified in `keys` or `ranges` are only yielded once.
@@ -4327,14 +4326,6 @@
{ # Partial results from a streaming read or SQL query. Streaming reads and
# SQL queries better tolerate large result sets, large rows, and large
# values, but are a little trickier to consume.
- "resumeToken": "A String", # Streaming calls might be interrupted for a variety of reasons, such
- # as TCP connection loss. If this occurs, the stream of results can
- # be resumed by re-sending the original request and including
- # `resume_token`. Note that executing any other transaction in the
- # same session invalidates the token.
- "chunkedValue": True or False, # If true, then the final value in values is chunked, and must
- # be combined with more values from subsequent `PartialResultSet`s
- # to obtain a complete field value.
"values": [ # A streamed result set consists of a stream of values, which might
# be split into many `PartialResultSet` messages to accommodate
# large rows and/or large values. Every N complete values defines a
@@ -4410,6 +4401,14 @@
# field value `"World" = "W" + "orl" + "d"`.
"",
],
+ "chunkedValue": True or False, # If true, then the final value in values is chunked, and must
+ # be combined with more values from subsequent `PartialResultSet`s
+ # to obtain a complete field value.
+ "resumeToken": "A String", # Streaming calls might be interrupted for a variety of reasons, such
+ # as TCP connection loss. If this occurs, the stream of results can
+ # be resumed by re-sending the original request and including
+ # `resume_token`. Note that executing any other transaction in the
+ # same session invalidates the token.
"stats": { # Additional statistics about a ResultSet or PartialResultSet. # Query plan and execution statistics for the query that produced this
# streaming result set. These can be requested by setting
# ExecuteSqlRequest.query_mode and are sent
diff --git a/docs/dyn/spanner_v1.projects.instances.html b/docs/dyn/spanner_v1.projects.instances.html
index 9f0407f..70fcf06 100644
--- a/docs/dyn/spanner_v1.projects.instances.html
+++ b/docs/dyn/spanner_v1.projects.instances.html
@@ -219,22 +219,6 @@
# 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 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:
@@ -298,6 +282,22 @@
},
],
},
+ "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`.
}</pre>
</div>
@@ -840,22 +840,6 @@
# 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 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:
@@ -919,6 +903,22 @@
},
],
},
+ "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`.
}</pre>
</div>
diff --git a/docs/dyn/spanner_v1.projects.instances.operations.html b/docs/dyn/spanner_v1.projects.instances.operations.html
index 547dda2..877b045 100644
--- a/docs/dyn/spanner_v1.projects.instances.operations.html
+++ b/docs/dyn/spanner_v1.projects.instances.operations.html
@@ -178,22 +178,6 @@
# 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 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:
@@ -257,6 +241,22 @@
},
],
},
+ "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`.
}</pre>
</div>
@@ -292,22 +292,6 @@
# 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 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:
@@ -371,6 +355,22 @@
},
],
},
+ "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`.
},
],
}</pre>
diff --git a/docs/dyn/storage_v1.buckets.html b/docs/dyn/storage_v1.buckets.html
index e4928c9..8ad21b4 100644
--- a/docs/dyn/storage_v1.buckets.html
+++ b/docs/dyn/storage_v1.buckets.html
@@ -81,6 +81,9 @@
<code><a href="#get">get(bucket, projection=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None)</a></code></p>
<p class="firstline">Returns metadata for the specified bucket.</p>
<p class="toc_element">
+ <code><a href="#getIamPolicy">getIamPolicy(bucket)</a></code></p>
+<p class="firstline">Returns an IAM policy for the specified bucket.</p>
+<p class="toc_element">
<code><a href="#insert">insert(project, body, projection=None, predefinedDefaultObjectAcl=None, predefinedAcl=None)</a></code></p>
<p class="firstline">Creates a new bucket.</p>
<p class="toc_element">
@@ -93,6 +96,12 @@
<code><a href="#patch">patch(bucket, body, projection=None, ifMetagenerationMatch=None, predefinedDefaultObjectAcl=None, predefinedAcl=None, ifMetagenerationNotMatch=None)</a></code></p>
<p class="firstline">Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. This method supports patch semantics.</p>
<p class="toc_element">
+ <code><a href="#setIamPolicy">setIamPolicy(bucket, body)</a></code></p>
+<p class="firstline">Updates an IAM policy for the specified bucket.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(bucket, permissions)</a></code></p>
+<p class="firstline">Tests a set of permissions on the given bucket to see which, if any, are held by the caller.</p>
+<p class="toc_element">
<code><a href="#update">update(bucket, body, projection=None, ifMetagenerationMatch=None, predefinedDefaultObjectAcl=None, predefinedAcl=None, ifMetagenerationNotMatch=None)</a></code></p>
<p class="firstline">Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.</p>
<h3>Method Details</h3>
@@ -247,6 +256,50 @@
</div>
<div class="method">
+ <code class="details" id="getIamPolicy">getIamPolicy(bucket)</code>
+ <pre>Returns an IAM policy for the specified bucket.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+
+Returns:
+ An object of the form:
+
+ { # A bucket/object IAM policy.
+ "resourceId": "A String", # The ID of the resource to which this policy belongs. Will be of the form buckets/bucket for buckets, and buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
+ "bindings": [ # An association between a role, which comes with a set of permissions, and members who may assume that role.
+ {
+ "role": "A String", # The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole.
+ # The new IAM roles are:
+ # - roles/storage.admin — Full control of Google Cloud Storage resources.
+ # - roles/storage.objectViewer — Read-Only access to Google Cloud Storage objects.
+ # - roles/storage.objectCreator — Access to create objects in Google Cloud Storage.
+ # - roles/storage.objectAdmin — Full control of Google Cloud Storage objects. The legacy IAM roles are:
+ # - roles/storage.legacyObjectReader — Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role.
+ # - roles/storage.legacyObjectOwner — Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role.
+ # - roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role.
+ # - roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role.
+ # - roles/storage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role.
+ "members": [ # A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows:
+ # - allUsers — A special identifier that represents anyone 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 account. For example, user:alice@gmail.com or user:joe@example.com.
+ # - serviceAccount:emailid — An email address that represents a service account. For example, serviceAccount:my-other-app@appspot.gserviceaccount.com .
+ # - group:emailid — An email address that represents a Google group. For example, group:admins@example.com.
+ # - domain:domain — A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com.
+ # - projectOwner:projectid — Owners of the given project. For example, projectOwner:my-example-project
+ # - projectEditor:projectid — Editors of the given project. For example, projectEditor:my-example-project
+ # - projectViewer:projectid — Viewers of the given project. For example, projectViewer:my-example-project
+ "A String",
+ ],
+ },
+ ],
+ "etag": "A String", # HTTP 1.1 Entity tag for the policy.
+ "kind": "storage#policy", # The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="insert">insert(project, body, projection=None, predefinedDefaultObjectAcl=None, predefinedAcl=None)</code>
<pre>Creates a new bucket.
@@ -963,6 +1016,119 @@
</div>
<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(bucket, body)</code>
+ <pre>Updates an IAM policy for the specified bucket.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A bucket/object IAM policy.
+ "resourceId": "A String", # The ID of the resource to which this policy belongs. Will be of the form buckets/bucket for buckets, and buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
+ "bindings": [ # An association between a role, which comes with a set of permissions, and members who may assume that role.
+ {
+ "role": "A String", # The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole.
+ # The new IAM roles are:
+ # - roles/storage.admin — Full control of Google Cloud Storage resources.
+ # - roles/storage.objectViewer — Read-Only access to Google Cloud Storage objects.
+ # - roles/storage.objectCreator — Access to create objects in Google Cloud Storage.
+ # - roles/storage.objectAdmin — Full control of Google Cloud Storage objects. The legacy IAM roles are:
+ # - roles/storage.legacyObjectReader — Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role.
+ # - roles/storage.legacyObjectOwner — Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role.
+ # - roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role.
+ # - roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role.
+ # - roles/storage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role.
+ "members": [ # A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows:
+ # - allUsers — A special identifier that represents anyone 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 account. For example, user:alice@gmail.com or user:joe@example.com.
+ # - serviceAccount:emailid — An email address that represents a service account. For example, serviceAccount:my-other-app@appspot.gserviceaccount.com .
+ # - group:emailid — An email address that represents a Google group. For example, group:admins@example.com.
+ # - domain:domain — A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com.
+ # - projectOwner:projectid — Owners of the given project. For example, projectOwner:my-example-project
+ # - projectEditor:projectid — Editors of the given project. For example, projectEditor:my-example-project
+ # - projectViewer:projectid — Viewers of the given project. For example, projectViewer:my-example-project
+ "A String",
+ ],
+ },
+ ],
+ "etag": "A String", # HTTP 1.1 Entity tag for the policy.
+ "kind": "storage#policy", # The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.
+}
+
+
+Returns:
+ An object of the form:
+
+ { # A bucket/object IAM policy.
+ "resourceId": "A String", # The ID of the resource to which this policy belongs. Will be of the form buckets/bucket for buckets, and buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
+ "bindings": [ # An association between a role, which comes with a set of permissions, and members who may assume that role.
+ {
+ "role": "A String", # The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole.
+ # The new IAM roles are:
+ # - roles/storage.admin — Full control of Google Cloud Storage resources.
+ # - roles/storage.objectViewer — Read-Only access to Google Cloud Storage objects.
+ # - roles/storage.objectCreator — Access to create objects in Google Cloud Storage.
+ # - roles/storage.objectAdmin — Full control of Google Cloud Storage objects. The legacy IAM roles are:
+ # - roles/storage.legacyObjectReader — Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role.
+ # - roles/storage.legacyObjectOwner — Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role.
+ # - roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role.
+ # - roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role.
+ # - roles/storage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role.
+ "members": [ # A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows:
+ # - allUsers — A special identifier that represents anyone 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 account. For example, user:alice@gmail.com or user:joe@example.com.
+ # - serviceAccount:emailid — An email address that represents a service account. For example, serviceAccount:my-other-app@appspot.gserviceaccount.com .
+ # - group:emailid — An email address that represents a Google group. For example, group:admins@example.com.
+ # - domain:domain — A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com.
+ # - projectOwner:projectid — Owners of the given project. For example, projectOwner:my-example-project
+ # - projectEditor:projectid — Editors of the given project. For example, projectEditor:my-example-project
+ # - projectViewer:projectid — Viewers of the given project. For example, projectViewer:my-example-project
+ "A String",
+ ],
+ },
+ ],
+ "etag": "A String", # HTTP 1.1 Entity tag for the policy.
+ "kind": "storage#policy", # The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(bucket, permissions)</code>
+ <pre>Tests a set of permissions on the given bucket to see which, if any, are held by the caller.
+
+Args:
+ bucket: string, Name of a bucket. (required)
+ permissions: string, Permissions to test. (required) (repeated)
+
+Returns:
+ An object of the form:
+
+ { # A storage.(buckets|objects).testIamPermissions response.
+ "kind": "storage#testIamPermissionsResponse", # The kind of item this is.
+ "permissions": [ # The permissions held by the caller. Permissions are always of the format storage.resource.capability, where resource is one of buckets or objects. The supported permissions are as follows:
+ # - storage.buckets.delete — Delete bucket.
+ # - storage.buckets.get — Read bucket metadata.
+ # - storage.buckets.getIamPolicy — Read bucket IAM policy.
+ # - storage.buckets.create — Create bucket.
+ # - storage.buckets.list — List buckets.
+ # - storage.buckets.setIamPolicy — Update bucket IAM policy.
+ # - storage.buckets.update — Update bucket metadata.
+ # - storage.objects.delete — Delete object.
+ # - storage.objects.get — Read object data and metadata.
+ # - storage.objects.getIamPolicy — Read object IAM policy.
+ # - storage.objects.create — Create object.
+ # - storage.objects.list — List objects.
+ # - storage.objects.setIamPolicy — Update object IAM policy.
+ # - storage.objects.update — Update object metadata.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="update">update(bucket, body, projection=None, ifMetagenerationMatch=None, predefinedDefaultObjectAcl=None, predefinedAcl=None, ifMetagenerationNotMatch=None)</code>
<pre>Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
diff --git a/docs/dyn/storage_v1.objects.html b/docs/dyn/storage_v1.objects.html
index 2993d9f..cfbeeb9 100644
--- a/docs/dyn/storage_v1.objects.html
+++ b/docs/dyn/storage_v1.objects.html
@@ -93,6 +93,9 @@
<code><a href="#get">get(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="#getIamPolicy">getIamPolicy(bucket, object, generation=None)</a></code></p>
+<p class="firstline">Returns an IAM policy for the specified object.</p>
+<p class="toc_element">
<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">
@@ -114,6 +117,12 @@
<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="#setIamPolicy">setIamPolicy(bucket, object, body, generation=None)</a></code></p>
+<p class="firstline">Updates an IAM policy for the specified object.</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(bucket, object, permissions, generation=None)</a></code></p>
+<p class="firstline">Tests a set of permissions on the given object to see which, if any, are held by the caller.</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>
<p class="firstline">Updates an object's metadata.</p>
<p class="toc_element">
@@ -790,6 +799,52 @@
</div>
<div class="method">
+ <code class="details" id="getIamPolicy">getIamPolicy(bucket, object, generation=None)</code>
+ <pre>Returns an IAM policy for the specified object.
+
+Args:
+ bucket: string, Name of the bucket in which the object resides. (required)
+ object: string, Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (required)
+ generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
+
+Returns:
+ An object of the form:
+
+ { # A bucket/object IAM policy.
+ "resourceId": "A String", # The ID of the resource to which this policy belongs. Will be of the form buckets/bucket for buckets, and buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
+ "bindings": [ # An association between a role, which comes with a set of permissions, and members who may assume that role.
+ {
+ "role": "A String", # The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole.
+ # The new IAM roles are:
+ # - roles/storage.admin — Full control of Google Cloud Storage resources.
+ # - roles/storage.objectViewer — Read-Only access to Google Cloud Storage objects.
+ # - roles/storage.objectCreator — Access to create objects in Google Cloud Storage.
+ # - roles/storage.objectAdmin — Full control of Google Cloud Storage objects. The legacy IAM roles are:
+ # - roles/storage.legacyObjectReader — Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role.
+ # - roles/storage.legacyObjectOwner — Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role.
+ # - roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role.
+ # - roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role.
+ # - roles/storage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role.
+ "members": [ # A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows:
+ # - allUsers — A special identifier that represents anyone 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 account. For example, user:alice@gmail.com or user:joe@example.com.
+ # - serviceAccount:emailid — An email address that represents a service account. For example, serviceAccount:my-other-app@appspot.gserviceaccount.com .
+ # - group:emailid — An email address that represents a Google group. For example, group:admins@example.com.
+ # - domain:domain — A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com.
+ # - projectOwner:projectid — Owners of the given project. For example, projectOwner:my-example-project
+ # - projectEditor:projectid — Editors of the given project. For example, projectEditor:my-example-project
+ # - projectViewer:projectid — Viewers of the given project. For example, projectViewer:my-example-project
+ "A String",
+ ],
+ },
+ ],
+ "etag": "A String", # HTTP 1.1 Entity tag for the policy.
+ "kind": "storage#policy", # The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="get_media">get_media(bucket, object, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, ifGenerationMatch=None, ifMetagenerationNotMatch=None, projection=None)</code>
<pre>Retrieves an object or its metadata.
@@ -1549,6 +1604,123 @@
</div>
<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(bucket, object, body, generation=None)</code>
+ <pre>Updates an IAM policy for the specified object.
+
+Args:
+ bucket: string, Name of the bucket in which the object resides. (required)
+ object: string, Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A bucket/object IAM policy.
+ "resourceId": "A String", # The ID of the resource to which this policy belongs. Will be of the form buckets/bucket for buckets, and buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
+ "bindings": [ # An association between a role, which comes with a set of permissions, and members who may assume that role.
+ {
+ "role": "A String", # The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole.
+ # The new IAM roles are:
+ # - roles/storage.admin — Full control of Google Cloud Storage resources.
+ # - roles/storage.objectViewer — Read-Only access to Google Cloud Storage objects.
+ # - roles/storage.objectCreator — Access to create objects in Google Cloud Storage.
+ # - roles/storage.objectAdmin — Full control of Google Cloud Storage objects. The legacy IAM roles are:
+ # - roles/storage.legacyObjectReader — Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role.
+ # - roles/storage.legacyObjectOwner — Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role.
+ # - roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role.
+ # - roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role.
+ # - roles/storage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role.
+ "members": [ # A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows:
+ # - allUsers — A special identifier that represents anyone 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 account. For example, user:alice@gmail.com or user:joe@example.com.
+ # - serviceAccount:emailid — An email address that represents a service account. For example, serviceAccount:my-other-app@appspot.gserviceaccount.com .
+ # - group:emailid — An email address that represents a Google group. For example, group:admins@example.com.
+ # - domain:domain — A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com.
+ # - projectOwner:projectid — Owners of the given project. For example, projectOwner:my-example-project
+ # - projectEditor:projectid — Editors of the given project. For example, projectEditor:my-example-project
+ # - projectViewer:projectid — Viewers of the given project. For example, projectViewer:my-example-project
+ "A String",
+ ],
+ },
+ ],
+ "etag": "A String", # HTTP 1.1 Entity tag for the policy.
+ "kind": "storage#policy", # The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.
+}
+
+ generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
+
+Returns:
+ An object of the form:
+
+ { # A bucket/object IAM policy.
+ "resourceId": "A String", # The ID of the resource to which this policy belongs. Will be of the form buckets/bucket for buckets, and buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
+ "bindings": [ # An association between a role, which comes with a set of permissions, and members who may assume that role.
+ {
+ "role": "A String", # The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole.
+ # The new IAM roles are:
+ # - roles/storage.admin — Full control of Google Cloud Storage resources.
+ # - roles/storage.objectViewer — Read-Only access to Google Cloud Storage objects.
+ # - roles/storage.objectCreator — Access to create objects in Google Cloud Storage.
+ # - roles/storage.objectAdmin — Full control of Google Cloud Storage objects. The legacy IAM roles are:
+ # - roles/storage.legacyObjectReader — Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role.
+ # - roles/storage.legacyObjectOwner — Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role.
+ # - roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role.
+ # - roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role.
+ # - roles/storage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role.
+ "members": [ # A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows:
+ # - allUsers — A special identifier that represents anyone 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 account. For example, user:alice@gmail.com or user:joe@example.com.
+ # - serviceAccount:emailid — An email address that represents a service account. For example, serviceAccount:my-other-app@appspot.gserviceaccount.com .
+ # - group:emailid — An email address that represents a Google group. For example, group:admins@example.com.
+ # - domain:domain — A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com.
+ # - projectOwner:projectid — Owners of the given project. For example, projectOwner:my-example-project
+ # - projectEditor:projectid — Editors of the given project. For example, projectEditor:my-example-project
+ # - projectViewer:projectid — Viewers of the given project. For example, projectViewer:my-example-project
+ "A String",
+ ],
+ },
+ ],
+ "etag": "A String", # HTTP 1.1 Entity tag for the policy.
+ "kind": "storage#policy", # The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(bucket, object, permissions, generation=None)</code>
+ <pre>Tests a set of permissions on the given object to see which, if any, are held by the caller.
+
+Args:
+ bucket: string, Name of the bucket in which the object resides. (required)
+ object: string, Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. (required)
+ permissions: string, Permissions to test. (required) (repeated)
+ generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
+
+Returns:
+ An object of the form:
+
+ { # A storage.(buckets|objects).testIamPermissions response.
+ "kind": "storage#testIamPermissionsResponse", # The kind of item this is.
+ "permissions": [ # The permissions held by the caller. Permissions are always of the format storage.resource.capability, where resource is one of buckets or objects. The supported permissions are as follows:
+ # - storage.buckets.delete — Delete bucket.
+ # - storage.buckets.get — Read bucket metadata.
+ # - storage.buckets.getIamPolicy — Read bucket IAM policy.
+ # - storage.buckets.create — Create bucket.
+ # - storage.buckets.list — List buckets.
+ # - storage.buckets.setIamPolicy — Update bucket IAM policy.
+ # - storage.buckets.update — Update bucket metadata.
+ # - storage.objects.delete — Delete object.
+ # - storage.objects.get — Read object data and metadata.
+ # - storage.objects.getIamPolicy — Read object IAM policy.
+ # - storage.objects.create — Create object.
+ # - storage.objects.list — List objects.
+ # - storage.objects.setIamPolicy — Update object IAM policy.
+ # - storage.objects.update — Update object metadata.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
<code class="details" id="update">update(bucket, object, body, ifGenerationMatch=None, ifGenerationNotMatch=None, generation=None, ifMetagenerationMatch=None, predefinedAcl=None, ifMetagenerationNotMatch=None, projection=None)</code>
<pre>Updates an object's metadata.
diff --git a/docs/dyn/toolresults_v1beta3.projects.histories.executions.steps.html b/docs/dyn/toolresults_v1beta3.projects.histories.executions.steps.html
index 09621b3..f030b3f 100644
--- a/docs/dyn/toolresults_v1beta3.projects.histories.executions.steps.html
+++ b/docs/dyn/toolresults_v1beta3.projects.histories.executions.steps.html
@@ -179,7 +179,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
},
"testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
@@ -496,7 +496,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
#
@@ -715,7 +715,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
#
@@ -774,7 +774,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
},
"testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
@@ -1091,7 +1091,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
#
@@ -1310,7 +1310,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
#
@@ -1388,7 +1388,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
},
"testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
@@ -1705,7 +1705,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
#
@@ -1924,7 +1924,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
#
@@ -2051,7 +2051,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
},
"testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
@@ -2368,7 +2368,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
#
@@ -2587,7 +2587,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
#
@@ -2680,7 +2680,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
},
"testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
@@ -2997,7 +2997,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
#
@@ -3216,7 +3216,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
#
@@ -3275,7 +3275,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
},
"testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
@@ -3592,7 +3592,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
#
@@ -3811,7 +3811,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
#
@@ -3910,7 +3910,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
},
"testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
@@ -4227,7 +4227,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
#
@@ -4446,7 +4446,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
#
diff --git a/docs/dyn/toolresults_v1beta3firstparty.projects.histories.executions.steps.html b/docs/dyn/toolresults_v1beta3firstparty.projects.histories.executions.steps.html
index 5773820..b89a929 100644
--- a/docs/dyn/toolresults_v1beta3firstparty.projects.histories.executions.steps.html
+++ b/docs/dyn/toolresults_v1beta3firstparty.projects.histories.executions.steps.html
@@ -179,7 +179,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
},
"testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
@@ -496,7 +496,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
#
@@ -715,7 +715,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
#
@@ -774,7 +774,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
},
"testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
@@ -1091,7 +1091,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
#
@@ -1310,7 +1310,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
#
@@ -1388,7 +1388,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
},
"testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
@@ -1705,7 +1705,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
#
@@ -1924,7 +1924,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
#
@@ -2051,7 +2051,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
},
"testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
@@ -2368,7 +2368,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
#
@@ -2587,7 +2587,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
#
@@ -2680,7 +2680,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
},
"testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
@@ -2997,7 +2997,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
#
@@ -3216,7 +3216,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
#
@@ -3275,7 +3275,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
},
"testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
@@ -3592,7 +3592,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
#
@@ -3811,7 +3811,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
#
@@ -3910,7 +3910,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
},
"testSuiteOverviews": [ # List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded.
@@ -4227,7 +4227,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"description": "A String", # A description of this tool For example: mvn clean package -D skipTests=true
#
@@ -4446,7 +4446,7 @@
#
# In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s".
"nanos": 42, # Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.
- "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive.
+ "seconds": "A String", # Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
"hasImages": True or False, # Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails.
#
diff --git a/docs/dyn/tracing_v1.projects.traces.html b/docs/dyn/tracing_v1.projects.traces.html
index 382f6ed..c73bd7e 100644
--- a/docs/dyn/tracing_v1.projects.traces.html
+++ b/docs/dyn/tracing_v1.projects.traces.html
@@ -84,7 +84,7 @@
<code><a href="#list">list(parent, orderBy=None, startTime=None, pageSize=None, x__xgafv=None, pageToken=None, filter=None, endTime=None)</a></code></p>
<p class="firstline">Returns of a list of traces that match the specified filter conditions.</p>
<p class="toc_element">
- <code><a href="#listSpans">listSpans(name, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#listSpans">listSpans(name=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of spans within a trace.</p>
<p class="toc_element">
<code><a href="#listSpans_next">listSpans_next(previous_request, previous_response)</a></code></p>
@@ -111,11 +111,12 @@
"a_key": { # Collection of spans to update.
"spans": [ # A collection of spans.
{ # A span represents a single operation within a trace. Spans can be nested
- # and form a trace tree. Often, a trace contains a root span that describes the
- # end-to-end latency and, optionally, one or more subspans for
- # its sub-operations. Spans do not need to be contiguous. There may be gaps
- # between spans in a trace.
- "status": { # The `Status` type defines a logical error model that is suitable for different # The final status of the Span. This is optional.
+ # to form a trace tree. Often, a trace contains a root span that
+ # describes the end-to-end latency and, optionally, one or more subspans for
+ # its sub-operations. (A trace could alternatively contain multiple root spans,
+ # or none at all.) Spans do not need to be contiguous. There may be gaps
+ # and/or overlaps between spans in a trace.
+ "status": { # The `Status` type defines a logical error model that is suitable for different # An optional final status for this span.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
@@ -178,21 +179,24 @@
},
],
},
- "stackTrace": { # StackTrace collected in a trace. # Stack trace captured at the start of the span. This is optional.
- "stackTraceHashId": "A String", # User can choose to use their own hash function to hash large attributes to
- # save network bandwidth and storage.
- # Typical usage is to pass both stack_frame and stack_trace_hash_id initially
- # to inform the storage of the mapping. And in subsequent calls, pass in
- # stack_trace_hash_id only. User shall verify the hash value is
- # successfully stored.
+ "stackTrace": { # StackTrace collected in a trace. # Stack trace captured at the start of the span.
+ "stackTraceHashId": "A String", # The hash ID is used to conserve network bandwidth for duplicate
+ # stack traces within a single trace.
+ #
+ # Often multiple spans will have identical stack traces.
+ # The first occurance of a stack trace should contain both the
+ # `stackFrame` content and a value in `stackTraceHashId`.
+ #
+ # Subsequent spans within the same request can refer
+ # to that stack trace by only setting `stackTraceHashId`.
"stackFrame": [ # Stack frames of this stack trace.
- { # Presents a single stack frame in a stack trace.
- "columnNumber": "A String", # Column number is important in JavaScript(anonymous functions),
- # Might not be available in some languages.
- "functionName": "A String", # Fully qualified names which uniquely identify function/method/etc.
- "fileName": "A String", # File name of the frame.
- "sourceVersion": "A String", # source_version is deployment specific. It might be
- # better to be stored in deployment metadata.
+ { # Represents a single stack frame in a stack trace.
+ "columnNumber": "A String", # Column number is important in JavaScript (anonymous functions).
+ # May not be available in some languages.
+ "functionName": "A String", # The fully-qualified name that uniquely identifies this function or
+ # method.
+ "fileName": "A String", # The filename of the file containing this frame.
+ "sourceVersion": "A String", # The version of the deployed source code.
"loadModule": { # Binary module. # Binary module the code is loaded from.
"buildId": "A String", # Build_id is a unique identifier for the module,
# usually a hash of its contents
@@ -200,85 +204,92 @@
# such as libc.so, sharedlib.so
},
"lineNumber": "A String", # Line number of the frame.
- "originalFunctionName": "A String", # Used when function name is ‘mangled’. Not guaranteed to be fully
- # qualified but usually it is.
+ "originalFunctionName": "A String", # Used when the function name is
+ # [mangled](http://www.avabodh.com/cxxin/namemangling.html). May be
+ # fully-qualified.
},
],
},
- "hasRemoteParent": True or False, # True if this Span has a remote parent (is an RPC server Span).
- "links": [ # A collection of links.
- { # Link one span with another which may be in a different Trace. Used (for
- # example) in batching operations, where a single batch handler processes
- # multiple requests from different traces.
- "spanId": "A String", # The span identifier of the linked span.
- "traceId": "A String", # The trace identifier of the linked span.
- "type": "A String", # The type of the link.
- },
- ],
- "parentId": "A String", # ID of parent span. 0 or missing if this is a root span.
- "localEndTime": "A String", # Local machine clock time from the UNIX epoch,
- # at which span execution ended.
- # On the server side these are the times when the server application
- # handler finishes running.
- "attributes": { # Properties of a span. Attributes at the span level.
- # E.g.
- # "/instance_id": "my-instance"
- # "/zone": "us-central1-a"
- # "/grpc/peer_address": "ip:port" (dns, etc.)
- # "/grpc/deadline": "Duration"
- # "/http/user_agent"
- # "/http/request_bytes": 300
- # "/http/response_bytes": 1200
- # "/http/url": google.com/apis
- # "/pid"
- # "abc.com/myattribute": "my attribute value"
- #
- # Maximum length for attribute key is 128 characters, for string attribute
- # value is 2K characters.
- "a_key": { # Allowed attribute values.
- "stringValue": "A String", # A string value.
- "boolValue": True or False, # A boolean value.
- "intValue": "A String", # An integer value.
- },
- },
- "timeEvents": [ # A collection of time-stamped events.
- { # A time-stamped annotation in the Span.
- "networkEvent": { # An event describing an RPC message sent/received on the network. # Optional field that can be used only for network events.
- "messageSize": "A String", # Number of bytes send/receive.
- "type": "A String", # Type of a NetworkEvent.
- "kernelTime": "A String", # If available, this is the kernel time:
- # For sent messages, this is the time at which the first bit was sent.
- # For received messages, this is the time at which the last bit was
- # received.
- "messageId": "A String", # Every message has an identifier, which must be different from all the
- # network messages in this span.
- # This is especially important when the request/response are streamed.
- },
- "annotation": { # Text annotation with a set of attributes. # Optional field for user supplied <string, AttributeValue> map
- "attributes": { # A set of attributes on the annotation.
- "a_key": { # Allowed attribute values.
- "stringValue": "A String", # A string value.
- "boolValue": True or False, # A boolean value.
- "intValue": "A String", # An integer value.
- },
- },
- "description": "A String", # A user-supplied message describing the event.
- },
- "localTime": "A String", # The local machine absolute timestamp when this event happened.
- },
- ],
- "id": "A String", # Identifier for the span. Must be a 64-bit integer other than 0 and
- # unique within a trace.
- "localStartTime": "A String", # Local machine clock time from the UNIX epoch,
- # at which span execution started.
- # On the server side these are the times when the server application
- # handler starts running.
"name": "A String", # Name of the span. The span name is sanitized and displayed in the
# Stackdriver Trace tool in the {% dynamic print site_values.console_name %}.
# The name may be a method name or some other per-call site name.
# For the same executable and the same call point, a best practice is
# to use a consistent name, which makes it easier to correlate
# cross-trace spans.
+ "links": [ # A collection of links, which are references from this span to another span
+ # in a different trace.
+ { # A pointer from this span to another span in a different `Trace`. Used
+ # (for example) in batching operations, where a single batch handler
+ # processes multiple requests from different traces.
+ "spanId": "A String", # The `id` of the linked span.
+ "traceId": "A String", # The ID of the parent trace of the linked span.
+ "type": "A String", # The relationship of the current span relative to the linked span.
+ },
+ ],
+ "parentId": "A String", # ID of the parent span. If this is a root span, the value must be `0` or
+ # empty.
+ "localEndTime": "A String", # End time of the span.
+ # On the client side, this is the local machine clock time at which the span
+ # execution was ended; on the server
+ # side, this is the time at which the server application handler stopped
+ # running.
+ "attributes": { # Properties of a span in key:value format. The maximum length for the
+ # key is 128 characters. The value can be a string (up to 2000 characters),
+ # int, or boolean.
+ #
+ # Some common pair examples:
+ #
+ # "/instance_id": "my-instance"
+ # "/zone": "us-central1-a"
+ # "/grpc/peer_address": "ip:port" (dns, etc.)
+ # "/grpc/deadline": "Duration"
+ # "/http/user_agent"
+ # "/http/request_bytes": 300
+ # "/http/response_bytes": 1200
+ # "/http/url": google.com/apis
+ # "abc.com/myattribute": true
+ "a_key": { # The allowed types for the value side of an attribute key:value pair.
+ "stringValue": "A String", # A string value.
+ "intValue": "A String", # An integer value.
+ "boolValue": True or False, # A boolean value.
+ },
+ },
+ "timeEvents": [ # A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation
+ # on the span, consisting of either user-supplied key:value pairs, or
+ # details of an RPC message sent/received on the network.
+ { # A time-stamped annotation in the Span.
+ "networkEvent": { # An event describing an RPC message sent/received on the network. # An event describing an RPC message sent/received on the network.
+ "messageSize": "A String", # The number of bytes sent or received.
+ "type": "A String", # Type of NetworkEvent. Indicates whether the RPC message was sent or
+ # received.
+ "kernelTime": "A String", # If available, this is the kernel time:
+ #
+ # * For sent messages, this is the time at which the first bit was sent.
+ # * For received messages, this is the time at which the last bit was
+ # received.
+ "messageId": "A String", # An identifier for the message, which must be unique in this span.
+ },
+ "annotation": { # Text annotation with a set of attributes. # One or more key:value pairs.
+ "attributes": { # A set of attributes on the annotation.
+ "a_key": { # The allowed types for the value side of an attribute key:value pair.
+ "stringValue": "A String", # A string value.
+ "intValue": "A String", # An integer value.
+ "boolValue": True or False, # A boolean value.
+ },
+ },
+ "description": "A String", # A user-supplied message describing the event.
+ },
+ "localTime": "A String", # The timestamp indicating the time the event occurred.
+ },
+ ],
+ "id": "A String", # Identifier for the span. Must be a 64-bit integer other than 0 and
+ # unique within a trace.
+ "localStartTime": "A String", # Start time of the span.
+ # On the client side, this is the local machine clock time at which the span
+ # execution was started; on the server
+ # side, this is the time at which the server application handler started
+ # running.
+ "hasRemoteParent": True or False, # True if this span has a remote parent (is an RPC server span).
},
],
},
@@ -310,7 +321,7 @@
<pre>Returns a specific trace.
Args:
- name: string, ID of the trace which is "projects/<project_id>/traces/<trace_id>". (required)
+ name: string, ID of the trace. Format is `projects/PROJECT_ID/traces/TRACE_ID`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -320,11 +331,11 @@
An object of the form:
{ # A trace describes how long it takes for an application to perform some
- # operations. It consists of a set of spans, each of which contains details
- # about an operation with time information and operation details.
- "name": "A String", # ID of the trace which is "projects/<project_id>/traces/<trace_id>".
- # trace_id is globally unique identifier for the trace. Common to all the
- # spans. It is conceptually a 128-bit hex-encoded value.
+ # operations. It consists of a set of spans, each representing
+ # an operation and including time information and operation details.
+ "name": "A String", # A globally unique identifier for the trace in the format
+ # `projects/PROJECT_NUMBER/traces/TRACE_ID`. `TRACE_ID` is a base16-encoded
+ # string of a 128-bit number and is required to be 32 char long.
}</pre>
</div>
@@ -350,7 +361,7 @@
startTime: string, Start of the time interval (inclusive) during which the trace data was
collected from the application.
pageSize: integer, Maximum number of traces to return. If not specified or <= 0, the
-implementation selects a reasonable value. The implementation may
+implementation selects a reasonable value. The implementation may
return fewer traces than the requested page size. Optional.
x__xgafv: string, V1 error format.
Allowed values
@@ -360,8 +371,8 @@
value of the `next_page_token` field from a previous request. Optional.
filter: string, An optional filter for the request.
Example:
-"version_label_key:a some_label:some_label_key"
-returns traces from version a and has some_label with some_label_key.
+`version_label_key:a some_label:some_label_key`
+returns traces from version `a` and has `some_label` with `some_label_key`.
endTime: string, End of the time interval (inclusive) during which the trace data was
collected from the application.
@@ -374,24 +385,25 @@
# retrieving additional traces.
"traces": [ # List of trace records returned.
{ # A trace describes how long it takes for an application to perform some
- # operations. It consists of a set of spans, each of which contains details
- # about an operation with time information and operation details.
- "name": "A String", # ID of the trace which is "projects/<project_id>/traces/<trace_id>".
- # trace_id is globally unique identifier for the trace. Common to all the
- # spans. It is conceptually a 128-bit hex-encoded value.
+ # operations. It consists of a set of spans, each representing
+ # an operation and including time information and operation details.
+ "name": "A String", # A globally unique identifier for the trace in the format
+ # `projects/PROJECT_NUMBER/traces/TRACE_ID`. `TRACE_ID` is a base16-encoded
+ # string of a 128-bit number and is required to be 32 char long.
},
],
}</pre>
</div>
<div class="method">
- <code class="details" id="listSpans">listSpans(name, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="listSpans">listSpans(name=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns a list of spans within a trace.
Args:
- name: string, ID of the span set where is "projects/<project_id>/traces/<trace_id>". (required)
+ name: string, ID of the trace for which to list child spans. Format is
+`projects/PROJECT_ID/traces/TRACE_ID`. (required)
pageToken: string, Token identifying the page of results to return. If provided, use the
-value of the `page_token` field from a previous request. Optional.
+value of the `nextPageToken` field from a previous request. Optional.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -400,17 +412,18 @@
Returns:
An object of the form:
- { # The response message for the 'ListSpans' method.
- "nextPageToken": "A String", # If defined, indicates that there are more spans that match the request
- # and that this value should be passed to the next request to continue
- # retrieving additional spans.
- "spans": [ # The requested spans if they are any in the specified trace.
+ { # The response message for the `ListSpans` method.
+ "nextPageToken": "A String", # If defined, indicates that there are more spans that match the request.
+ # Pass this as the value of `pageToken` in a subsequent request to retrieve
+ # additional spans.
+ "spans": [ # The requested spans if there are any in the specified trace.
{ # A span represents a single operation within a trace. Spans can be nested
- # and form a trace tree. Often, a trace contains a root span that describes the
- # end-to-end latency and, optionally, one or more subspans for
- # its sub-operations. Spans do not need to be contiguous. There may be gaps
- # between spans in a trace.
- "status": { # The `Status` type defines a logical error model that is suitable for different # The final status of the Span. This is optional.
+ # to form a trace tree. Often, a trace contains a root span that
+ # describes the end-to-end latency and, optionally, one or more subspans for
+ # its sub-operations. (A trace could alternatively contain multiple root spans,
+ # or none at all.) Spans do not need to be contiguous. There may be gaps
+ # and/or overlaps between spans in a trace.
+ "status": { # The `Status` type defines a logical error model that is suitable for different # An optional final status for this span.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
#
@@ -473,21 +486,24 @@
},
],
},
- "stackTrace": { # StackTrace collected in a trace. # Stack trace captured at the start of the span. This is optional.
- "stackTraceHashId": "A String", # User can choose to use their own hash function to hash large attributes to
- # save network bandwidth and storage.
- # Typical usage is to pass both stack_frame and stack_trace_hash_id initially
- # to inform the storage of the mapping. And in subsequent calls, pass in
- # stack_trace_hash_id only. User shall verify the hash value is
- # successfully stored.
+ "stackTrace": { # StackTrace collected in a trace. # Stack trace captured at the start of the span.
+ "stackTraceHashId": "A String", # The hash ID is used to conserve network bandwidth for duplicate
+ # stack traces within a single trace.
+ #
+ # Often multiple spans will have identical stack traces.
+ # The first occurance of a stack trace should contain both the
+ # `stackFrame` content and a value in `stackTraceHashId`.
+ #
+ # Subsequent spans within the same request can refer
+ # to that stack trace by only setting `stackTraceHashId`.
"stackFrame": [ # Stack frames of this stack trace.
- { # Presents a single stack frame in a stack trace.
- "columnNumber": "A String", # Column number is important in JavaScript(anonymous functions),
- # Might not be available in some languages.
- "functionName": "A String", # Fully qualified names which uniquely identify function/method/etc.
- "fileName": "A String", # File name of the frame.
- "sourceVersion": "A String", # source_version is deployment specific. It might be
- # better to be stored in deployment metadata.
+ { # Represents a single stack frame in a stack trace.
+ "columnNumber": "A String", # Column number is important in JavaScript (anonymous functions).
+ # May not be available in some languages.
+ "functionName": "A String", # The fully-qualified name that uniquely identifies this function or
+ # method.
+ "fileName": "A String", # The filename of the file containing this frame.
+ "sourceVersion": "A String", # The version of the deployed source code.
"loadModule": { # Binary module. # Binary module the code is loaded from.
"buildId": "A String", # Build_id is a unique identifier for the module,
# usually a hash of its contents
@@ -495,85 +511,92 @@
# such as libc.so, sharedlib.so
},
"lineNumber": "A String", # Line number of the frame.
- "originalFunctionName": "A String", # Used when function name is ‘mangled’. Not guaranteed to be fully
- # qualified but usually it is.
+ "originalFunctionName": "A String", # Used when the function name is
+ # [mangled](http://www.avabodh.com/cxxin/namemangling.html). May be
+ # fully-qualified.
},
],
},
- "hasRemoteParent": True or False, # True if this Span has a remote parent (is an RPC server Span).
- "links": [ # A collection of links.
- { # Link one span with another which may be in a different Trace. Used (for
- # example) in batching operations, where a single batch handler processes
- # multiple requests from different traces.
- "spanId": "A String", # The span identifier of the linked span.
- "traceId": "A String", # The trace identifier of the linked span.
- "type": "A String", # The type of the link.
- },
- ],
- "parentId": "A String", # ID of parent span. 0 or missing if this is a root span.
- "localEndTime": "A String", # Local machine clock time from the UNIX epoch,
- # at which span execution ended.
- # On the server side these are the times when the server application
- # handler finishes running.
- "attributes": { # Properties of a span. Attributes at the span level.
- # E.g.
- # "/instance_id": "my-instance"
- # "/zone": "us-central1-a"
- # "/grpc/peer_address": "ip:port" (dns, etc.)
- # "/grpc/deadline": "Duration"
- # "/http/user_agent"
- # "/http/request_bytes": 300
- # "/http/response_bytes": 1200
- # "/http/url": google.com/apis
- # "/pid"
- # "abc.com/myattribute": "my attribute value"
- #
- # Maximum length for attribute key is 128 characters, for string attribute
- # value is 2K characters.
- "a_key": { # Allowed attribute values.
- "stringValue": "A String", # A string value.
- "boolValue": True or False, # A boolean value.
- "intValue": "A String", # An integer value.
- },
- },
- "timeEvents": [ # A collection of time-stamped events.
- { # A time-stamped annotation in the Span.
- "networkEvent": { # An event describing an RPC message sent/received on the network. # Optional field that can be used only for network events.
- "messageSize": "A String", # Number of bytes send/receive.
- "type": "A String", # Type of a NetworkEvent.
- "kernelTime": "A String", # If available, this is the kernel time:
- # For sent messages, this is the time at which the first bit was sent.
- # For received messages, this is the time at which the last bit was
- # received.
- "messageId": "A String", # Every message has an identifier, which must be different from all the
- # network messages in this span.
- # This is especially important when the request/response are streamed.
- },
- "annotation": { # Text annotation with a set of attributes. # Optional field for user supplied <string, AttributeValue> map
- "attributes": { # A set of attributes on the annotation.
- "a_key": { # Allowed attribute values.
- "stringValue": "A String", # A string value.
- "boolValue": True or False, # A boolean value.
- "intValue": "A String", # An integer value.
- },
- },
- "description": "A String", # A user-supplied message describing the event.
- },
- "localTime": "A String", # The local machine absolute timestamp when this event happened.
- },
- ],
- "id": "A String", # Identifier for the span. Must be a 64-bit integer other than 0 and
- # unique within a trace.
- "localStartTime": "A String", # Local machine clock time from the UNIX epoch,
- # at which span execution started.
- # On the server side these are the times when the server application
- # handler starts running.
"name": "A String", # Name of the span. The span name is sanitized and displayed in the
# Stackdriver Trace tool in the {% dynamic print site_values.console_name %}.
# The name may be a method name or some other per-call site name.
# For the same executable and the same call point, a best practice is
# to use a consistent name, which makes it easier to correlate
# cross-trace spans.
+ "links": [ # A collection of links, which are references from this span to another span
+ # in a different trace.
+ { # A pointer from this span to another span in a different `Trace`. Used
+ # (for example) in batching operations, where a single batch handler
+ # processes multiple requests from different traces.
+ "spanId": "A String", # The `id` of the linked span.
+ "traceId": "A String", # The ID of the parent trace of the linked span.
+ "type": "A String", # The relationship of the current span relative to the linked span.
+ },
+ ],
+ "parentId": "A String", # ID of the parent span. If this is a root span, the value must be `0` or
+ # empty.
+ "localEndTime": "A String", # End time of the span.
+ # On the client side, this is the local machine clock time at which the span
+ # execution was ended; on the server
+ # side, this is the time at which the server application handler stopped
+ # running.
+ "attributes": { # Properties of a span in key:value format. The maximum length for the
+ # key is 128 characters. The value can be a string (up to 2000 characters),
+ # int, or boolean.
+ #
+ # Some common pair examples:
+ #
+ # "/instance_id": "my-instance"
+ # "/zone": "us-central1-a"
+ # "/grpc/peer_address": "ip:port" (dns, etc.)
+ # "/grpc/deadline": "Duration"
+ # "/http/user_agent"
+ # "/http/request_bytes": 300
+ # "/http/response_bytes": 1200
+ # "/http/url": google.com/apis
+ # "abc.com/myattribute": true
+ "a_key": { # The allowed types for the value side of an attribute key:value pair.
+ "stringValue": "A String", # A string value.
+ "intValue": "A String", # An integer value.
+ "boolValue": True or False, # A boolean value.
+ },
+ },
+ "timeEvents": [ # A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation
+ # on the span, consisting of either user-supplied key:value pairs, or
+ # details of an RPC message sent/received on the network.
+ { # A time-stamped annotation in the Span.
+ "networkEvent": { # An event describing an RPC message sent/received on the network. # An event describing an RPC message sent/received on the network.
+ "messageSize": "A String", # The number of bytes sent or received.
+ "type": "A String", # Type of NetworkEvent. Indicates whether the RPC message was sent or
+ # received.
+ "kernelTime": "A String", # If available, this is the kernel time:
+ #
+ # * For sent messages, this is the time at which the first bit was sent.
+ # * For received messages, this is the time at which the last bit was
+ # received.
+ "messageId": "A String", # An identifier for the message, which must be unique in this span.
+ },
+ "annotation": { # Text annotation with a set of attributes. # One or more key:value pairs.
+ "attributes": { # A set of attributes on the annotation.
+ "a_key": { # The allowed types for the value side of an attribute key:value pair.
+ "stringValue": "A String", # A string value.
+ "intValue": "A String", # An integer value.
+ "boolValue": True or False, # A boolean value.
+ },
+ },
+ "description": "A String", # A user-supplied message describing the event.
+ },
+ "localTime": "A String", # The timestamp indicating the time the event occurred.
+ },
+ ],
+ "id": "A String", # Identifier for the span. Must be a 64-bit integer other than 0 and
+ # unique within a trace.
+ "localStartTime": "A String", # Start time of the span.
+ # On the client side, this is the local machine clock time at which the span
+ # execution was started; on the server
+ # side, this is the time at which the server application handler started
+ # running.
+ "hasRemoteParent": True or False, # True if this span has a remote parent (is an RPC server span).
},
],
}</pre>
diff --git a/docs/dyn/vision_v1.images.html b/docs/dyn/vision_v1.images.html
index 4070632..9471feb 100644
--- a/docs/dyn/vision_v1.images.html
+++ b/docs/dyn/vision_v1.images.html
@@ -257,10 +257,10 @@
# methods over safe-search verticals (for example, adult, spoof, medical,
# violence).
"medical": "A String", # Likelihood that this is a medical image.
+ "violence": "A String", # Violence likelihood.
"spoof": "A String", # Spoof likelihood. The likelihood that an modification
# was made to the image's canonical version to make it appear
# funny or offensive.
- "violence": "A String", # Violence likelihood.
"adult": "A String", # Represents the adult content likelihood for the image.
},
"textAnnotations": [ # If present, text (OCR) detection has completed successfully.
@@ -356,6 +356,14 @@
},
],
"webDetection": { # Relevant information for the image from the Internet. # If present, web detection has completed successfully.
+ "webEntities": [ # Deduced entities from similar images on the Internet.
+ { # Entity deduced from similar images on the Internet.
+ "entityId": "A String", # Opaque entity ID.
+ "score": 3.14, # Overall relevancy score for the entity.
+ # Not normalized and not comparable across different image queries.
+ "description": "A String", # Canonical description of the entity, in English.
+ },
+ ],
"pagesWithMatchingImages": [ # Web pages containing the matching images from the Internet.
{ # Metadata for web pages.
"url": "A String", # The result web page URL.
@@ -363,12 +371,11 @@
# Not normalized and not comparable across different image queries.
},
],
- "webEntities": [ # Deduced entities from similar images on the Internet.
- { # Entity deduced from similar images on the Internet.
- "entityId": "A String", # Opaque entity ID.
- "score": 3.14, # Overall relevancy score for the entity.
+ "visuallySimilarImages": [ # The visually similar image results.
+ { # Metadata for online images.
+ "url": "A String", # The result image URL.
+ "score": 3.14, # Overall relevancy score for the image.
# Not normalized and not comparable across different image queries.
- "description": "A String", # Canonical description of the entity, in English.
},
],
"partialMatchingImages": [ # Partial matching images from the Internet.
@@ -390,68 +397,202 @@
},
],
},
- "error": { # The `Status` type defines a logical error model that is suitable for different # If set, represents the error message for the operation.
- # Note that filled-in image annotations are guaranteed to be
- # correct, even when `error` is set.
- # 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.
+ "fullTextAnnotation": { # TextAnnotation contains a structured representation of OCR extracted text. # If present, text (OCR) detection or document (OCR) text detection has
+ # completed successfully.
+ # This annotation provides the structural hierarchy for the OCR detected
+ # text.
+ # The hierarchy of an OCR extracted text structure is like this:
+ # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol
+ # Each structural component, starting from Page, may further have their own
+ # properties. Properties describe detected languages, breaks etc.. Please
+ # refer to the google.cloud.vision.v1.TextAnnotation.TextProperty message
+ # definition below for more detail.
+ "text": "A String", # UTF-8 text detected on the pages.
+ "pages": [ # List of pages detected by OCR.
+ { # Detected page from OCR.
+ "width": 42, # Page width in pixels.
+ "property": { # Additional information detected on the structural component. # Additional information detected on the page.
+ "detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
+ "isPrefix": True or False, # True if break prepends the element.
+ "type": "A String", # Detected break type.
+ },
+ "detectedLanguages": [ # A list of detected languages together with confidence.
+ { # Detected language for a structural component.
+ "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+ # information, see
+ # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ "confidence": 3.14, # Confidence of detected language. Range [0, 1].
+ },
+ ],
+ },
+ "blocks": [ # List of blocks of text, images etc on this page.
+ { # Logical element on the page.
+ "boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the block.
+ # The vertices are in the order of top-left, top-right, bottom-right,
+ # bottom-left. When a rotation of the bounding box is detected the rotation
+ # is represented as around the top-left corner as defined when the text is
+ # read in the 'natural' orientation.
+ # For example:
+ # * when the text is horizontal it might look like:
+ # 0----1
+ # | |
+ # 3----2
+ # * when it's rotated 180 degrees around the top-left corner it becomes:
+ # 2----3
+ # | |
+ # 1----0
+ # and the vertice order will still be (0, 1, 2, 3).
+ "vertices": [ # The bounding polygon vertices.
+ { # A vertex represents a 2D point in the image.
+ # NOTE: the vertex coordinates are in the same scale as the original image.
+ "y": 42, # Y coordinate.
+ "x": 42, # X coordinate.
+ },
+ ],
+ },
+ "blockType": "A String", # Detected block type (text, image etc) for this block.
+ "property": { # Additional information detected on the structural component. # Additional information detected for the block.
+ "detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
+ "isPrefix": True or False, # True if break prepends the element.
+ "type": "A String", # Detected break type.
+ },
+ "detectedLanguages": [ # A list of detected languages together with confidence.
+ { # Detected language for a structural component.
+ "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+ # information, see
+ # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ "confidence": 3.14, # Confidence of detected language. Range [0, 1].
+ },
+ ],
+ },
+ "paragraphs": [ # List of paragraphs in this block (if this blocks is of type text).
+ { # Structural unit of text representing a number of words in certain order.
+ "boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the paragraph.
+ # The vertices are in the order of top-left, top-right, bottom-right,
+ # bottom-left. When a rotation of the bounding box is detected the rotation
+ # is represented as around the top-left corner as defined when the text is
+ # read in the 'natural' orientation.
+ # For example:
+ # * when the text is horizontal it might look like:
+ # 0----1
+ # | |
+ # 3----2
+ # * when it's rotated 180 degrees around the top-left corner it becomes:
+ # 2----3
+ # | |
+ # 1----0
+ # and the vertice order will still be (0, 1, 2, 3).
+ "vertices": [ # The bounding polygon vertices.
+ { # A vertex represents a 2D point in the image.
+ # NOTE: the vertex coordinates are in the same scale as the original image.
+ "y": 42, # Y coordinate.
+ "x": 42, # X coordinate.
+ },
+ ],
+ },
+ "property": { # Additional information detected on the structural component. # Additional information detected for the paragraph.
+ "detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
+ "isPrefix": True or False, # True if break prepends the element.
+ "type": "A String", # Detected break type.
+ },
+ "detectedLanguages": [ # A list of detected languages together with confidence.
+ { # Detected language for a structural component.
+ "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+ # information, see
+ # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ "confidence": 3.14, # Confidence of detected language. Range [0, 1].
+ },
+ ],
+ },
+ "words": [ # List of words in this paragraph.
+ { # A word representation.
+ "boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the word.
+ # The vertices are in the order of top-left, top-right, bottom-right,
+ # bottom-left. When a rotation of the bounding box is detected the rotation
+ # is represented as around the top-left corner as defined when the text is
+ # read in the 'natural' orientation.
+ # For example:
+ # * when the text is horizontal it might look like:
+ # 0----1
+ # | |
+ # 3----2
+ # * when it's rotated 180 degrees around the top-left corner it becomes:
+ # 2----3
+ # | |
+ # 1----0
+ # and the vertice order will still be (0, 1, 2, 3).
+ "vertices": [ # The bounding polygon vertices.
+ { # A vertex represents a 2D point in the image.
+ # NOTE: the vertex coordinates are in the same scale as the original image.
+ "y": 42, # Y coordinate.
+ "x": 42, # X coordinate.
+ },
+ ],
+ },
+ "symbols": [ # List of symbols in the word.
+ # The order of the symbols follows the natural reading order.
+ { # A single symbol representation.
+ "boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the symbol.
+ # The vertices are in the order of top-left, top-right, bottom-right,
+ # bottom-left. When a rotation of the bounding box is detected the rotation
+ # is represented as around the top-left corner as defined when the text is
+ # read in the 'natural' orientation.
+ # For example:
+ # * when the text is horizontal it might look like:
+ # 0----1
+ # | |
+ # 3----2
+ # * when it's rotated 180 degrees around the top-left corner it becomes:
+ # 2----3
+ # | |
+ # 1----0
+ # and the vertice order will still be (0, 1, 2, 3).
+ "vertices": [ # The bounding polygon vertices.
+ { # A vertex represents a 2D point in the image.
+ # NOTE: the vertex coordinates are in the same scale as the original image.
+ "y": 42, # Y coordinate.
+ "x": 42, # X coordinate.
+ },
+ ],
+ },
+ "text": "A String", # The actual UTF-8 representation of the symbol.
+ "property": { # Additional information detected on the structural component. # Additional information detected for the symbol.
+ "detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
+ "isPrefix": True or False, # True if break prepends the element.
+ "type": "A String", # Detected break type.
+ },
+ "detectedLanguages": [ # A list of detected languages together with confidence.
+ { # Detected language for a structural component.
+ "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+ # information, see
+ # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ "confidence": 3.14, # Confidence of detected language. Range [0, 1].
+ },
+ ],
+ },
+ },
+ ],
+ "property": { # Additional information detected on the structural component. # Additional information detected for the word.
+ "detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
+ "isPrefix": True or False, # True if break prepends the element.
+ "type": "A String", # Detected break type.
+ },
+ "detectedLanguages": [ # A list of detected languages together with confidence.
+ { # Detected language for a structural component.
+ "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
+ # information, see
+ # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
+ "confidence": 3.14, # Confidence of detected language. Range [0, 1].
+ },
+ ],
+ },
+ },
+ ],
+ },
+ ],
+ },
+ ],
+ "height": 42, # Page height in pixels.
},
],
},
@@ -693,8 +834,11 @@
"panAngle": 3.14, # Yaw angle, which indicates the leftward/rightward angle that the face is
# pointing relative to the vertical plane perpendicular to the image. Range
# [-180,180].
- "underExposedLikelihood": "A String", # Under-exposed likelihood.
+ "sorrowLikelihood": "A String", # Sorrow likelihood.
+ "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1].
"detectionConfidence": 3.14, # Detection confidence. Range [0, 1].
+ "tiltAngle": 3.14, # Pitch angle, which indicates the upwards/downwards angle that the face is
+ # pointing relative to the image's horizontal plane. Range [-180,180].
"joyLikelihood": "A String", # Joy likelihood.
"landmarks": [ # Detected face landmarks.
{ # A face-specific landmark (for example, a face feature).
@@ -712,10 +856,9 @@
"type": "A String", # Face landmark type.
},
],
- "sorrowLikelihood": "A String", # Sorrow likelihood.
+ "surpriseLikelihood": "A String", # Surprise likelihood.
"blurredLikelihood": "A String", # Blurred likelihood.
- "tiltAngle": 3.14, # Pitch angle, which indicates the upwards/downwards angle that the face is
- # pointing relative to the image's horizontal plane. Range [-180,180].
+ "underExposedLikelihood": "A String", # Under-exposed likelihood.
"angerLikelihood": "A String", # Anger likelihood.
"boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon around the face. The coordinates of the bounding box
# are in the original image's scale, as returned in `ImageParams`.
@@ -736,7 +879,6 @@
# of the face relative to the image vertical about the axis perpendicular to
# the face. Range [-180,180].
"headwearLikelihood": "A String", # Headwear likelihood.
- "surpriseLikelihood": "A String", # Surprise likelihood.
"fdBoundingPoly": { # A bounding polygon for the detected image annotation. # The `fd_bounding_poly` bounding polygon is tighter than the
# `boundingPoly`, and encloses only the skin part of the face. Typically, it
# is used to eliminate the face from any image analysis that detects the
@@ -751,7 +893,6 @@
},
],
},
- "landmarkingConfidence": 3.14, # Face landmarking confidence. Range [0, 1].
},
],
"logoAnnotations": [ # If present, logo detection has completed successfully.
@@ -938,202 +1079,68 @@
],
},
],
- "fullTextAnnotation": { # TextAnnotation contains a structured representation of OCR extracted text. # If present, text (OCR) detection or document (OCR) text detection has
- # completed successfully.
- # This annotation provides the structural hierarchy for the OCR detected
- # text.
- # The hierarchy of an OCR extracted text structure is like this:
- # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol
- # Each structural component, starting from Page, may further have their own
- # properties. Properties describe detected languages, breaks etc.. Please
- # refer to the google.cloud.vision.v1.TextAnnotation.TextProperty message
- # definition below for more detail.
- "text": "A String", # UTF-8 text detected on the pages.
- "pages": [ # List of pages detected by OCR.
- { # Detected page from OCR.
- "width": 42, # Page width in pixels.
- "property": { # Additional information detected on the structural component. # Additional information detected on the page.
- "detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
- "isPrefix": True or False, # True if break prepends the element.
- "type": "A String", # Detected break type.
- },
- "detectedLanguages": [ # A list of detected languages together with confidence.
- { # Detected language for a structural component.
- "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
- # information, see
- # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
- "confidence": 3.14, # Confidence of detected language. Range [0, 1].
- },
- ],
- },
- "blocks": [ # List of blocks of text, images etc on this page.
- { # Logical element on the page.
- "boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the block.
- # The vertices are in the order of top-left, top-right, bottom-right,
- # bottom-left. When a rotation of the bounding box is detected the rotation
- # is represented as around the top-left corner as defined when the text is
- # read in the 'natural' orientation.
- # For example:
- # * when the text is horizontal it might look like:
- # 0----1
- # | |
- # 3----2
- # * when it's rotated 180 degrees around the top-left corner it becomes:
- # 2----3
- # | |
- # 1----0
- # and the vertice order will still be (0, 1, 2, 3).
- "vertices": [ # The bounding polygon vertices.
- { # A vertex represents a 2D point in the image.
- # NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
- "x": 42, # X coordinate.
- },
- ],
- },
- "blockType": "A String", # Detected block type (text, image etc) for this block.
- "property": { # Additional information detected on the structural component. # Additional information detected for the block.
- "detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
- "isPrefix": True or False, # True if break prepends the element.
- "type": "A String", # Detected break type.
- },
- "detectedLanguages": [ # A list of detected languages together with confidence.
- { # Detected language for a structural component.
- "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
- # information, see
- # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
- "confidence": 3.14, # Confidence of detected language. Range [0, 1].
- },
- ],
- },
- "paragraphs": [ # List of paragraphs in this block (if this blocks is of type text).
- { # Structural unit of text representing a number of words in certain order.
- "boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the paragraph.
- # The vertices are in the order of top-left, top-right, bottom-right,
- # bottom-left. When a rotation of the bounding box is detected the rotation
- # is represented as around the top-left corner as defined when the text is
- # read in the 'natural' orientation.
- # For example:
- # * when the text is horizontal it might look like:
- # 0----1
- # | |
- # 3----2
- # * when it's rotated 180 degrees around the top-left corner it becomes:
- # 2----3
- # | |
- # 1----0
- # and the vertice order will still be (0, 1, 2, 3).
- "vertices": [ # The bounding polygon vertices.
- { # A vertex represents a 2D point in the image.
- # NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
- "x": 42, # X coordinate.
- },
- ],
- },
- "property": { # Additional information detected on the structural component. # Additional information detected for the paragraph.
- "detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
- "isPrefix": True or False, # True if break prepends the element.
- "type": "A String", # Detected break type.
- },
- "detectedLanguages": [ # A list of detected languages together with confidence.
- { # Detected language for a structural component.
- "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
- # information, see
- # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
- "confidence": 3.14, # Confidence of detected language. Range [0, 1].
- },
- ],
- },
- "words": [ # List of words in this paragraph.
- { # A word representation.
- "symbols": [ # List of symbols in the word.
- # The order of the symbols follows the natural reading order.
- { # A single symbol representation.
- "boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the symbol.
- # The vertices are in the order of top-left, top-right, bottom-right,
- # bottom-left. When a rotation of the bounding box is detected the rotation
- # is represented as around the top-left corner as defined when the text is
- # read in the 'natural' orientation.
- # For example:
- # * when the text is horizontal it might look like:
- # 0----1
- # | |
- # 3----2
- # * when it's rotated 180 degrees around the top-left corner it becomes:
- # 2----3
- # | |
- # 1----0
- # and the vertice order will still be (0, 1, 2, 3).
- "vertices": [ # The bounding polygon vertices.
- { # A vertex represents a 2D point in the image.
- # NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
- "x": 42, # X coordinate.
- },
- ],
- },
- "text": "A String", # The actual UTF-8 representation of the symbol.
- "property": { # Additional information detected on the structural component. # Additional information detected for the symbol.
- "detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
- "isPrefix": True or False, # True if break prepends the element.
- "type": "A String", # Detected break type.
- },
- "detectedLanguages": [ # A list of detected languages together with confidence.
- { # Detected language for a structural component.
- "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
- # information, see
- # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
- "confidence": 3.14, # Confidence of detected language. Range [0, 1].
- },
- ],
- },
- },
- ],
- "boundingBox": { # A bounding polygon for the detected image annotation. # The bounding box for the word.
- # The vertices are in the order of top-left, top-right, bottom-right,
- # bottom-left. When a rotation of the bounding box is detected the rotation
- # is represented as around the top-left corner as defined when the text is
- # read in the 'natural' orientation.
- # For example:
- # * when the text is horizontal it might look like:
- # 0----1
- # | |
- # 3----2
- # * when it's rotated 180 degrees around the top-left corner it becomes:
- # 2----3
- # | |
- # 1----0
- # and the vertice order will still be (0, 1, 2, 3).
- "vertices": [ # The bounding polygon vertices.
- { # A vertex represents a 2D point in the image.
- # NOTE: the vertex coordinates are in the same scale as the original image.
- "y": 42, # Y coordinate.
- "x": 42, # X coordinate.
- },
- ],
- },
- "property": { # Additional information detected on the structural component. # Additional information detected for the word.
- "detectedBreak": { # Detected start or end of a structural component. # Detected start or end of a text segment.
- "isPrefix": True or False, # True if break prepends the element.
- "type": "A String", # Detected break type.
- },
- "detectedLanguages": [ # A list of detected languages together with confidence.
- { # Detected language for a structural component.
- "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more
- # information, see
- # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
- "confidence": 3.14, # Confidence of detected language. Range [0, 1].
- },
- ],
- },
- },
- ],
- },
- ],
- },
- ],
- "height": 42, # Page height in pixels.
+ "error": { # The `Status` type defines a logical error model that is suitable for different # If set, represents the error message for the operation.
+ # Note that filled-in image annotations are guaranteed to be
+ # correct, even when `error` is set.
+ # 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.
},
],
},
diff --git a/docs/dyn/youtubereporting_v1.jobs.reports.html b/docs/dyn/youtubereporting_v1.jobs.reports.html
index 9071c0a..f2d9d8c 100644
--- a/docs/dyn/youtubereporting_v1.jobs.reports.html
+++ b/docs/dyn/youtubereporting_v1.jobs.reports.html
@@ -105,13 +105,13 @@
# downloaded.
"jobExpireTime": "A String", # The date/time when the job this report belongs to will expire/expired.
"jobId": "A String", # The ID of the job that created this report.
+ "createTime": "A String", # The date/time when this report was created.
"downloadUrl": "A String", # The URL from which the report can be downloaded (max. 1000 characters).
"startTime": "A String", # The start of the time period that the report instance covers. The value is
# inclusive.
- "id": "A String", # The server-generated ID of the report.
"endTime": "A String", # The end of the time period that the report instance covers. The value is
# exclusive.
- "createTime": "A String", # The date/time when this report was created.
+ "id": "A String", # The server-generated ID of the report.
}</pre>
</div>
@@ -154,13 +154,13 @@
# downloaded.
"jobExpireTime": "A String", # The date/time when the job this report belongs to will expire/expired.
"jobId": "A String", # The ID of the job that created this report.
+ "createTime": "A String", # The date/time when this report was created.
"downloadUrl": "A String", # The URL from which the report can be downloaded (max. 1000 characters).
"startTime": "A String", # The start of the time period that the report instance covers. The value is
# inclusive.
- "id": "A String", # The server-generated ID of the report.
"endTime": "A String", # The end of the time period that the report instance covers. The value is
# exclusive.
- "createTime": "A String", # The date/time when this report was created.
+ "id": "A String", # The server-generated ID of the report.
},
],
}</pre>
diff --git a/docs/dyn/youtubereporting_v1.reportTypes.html b/docs/dyn/youtubereporting_v1.reportTypes.html
index e51234e..440cdea 100644
--- a/docs/dyn/youtubereporting_v1.reportTypes.html
+++ b/docs/dyn/youtubereporting_v1.reportTypes.html
@@ -113,12 +113,12 @@
# page of results.
"reportTypes": [ # The list of report types.
{ # A report type.
- "id": "A String", # The ID of the report type (max. 100 characters).
+ "deprecateTime": "A String", # The date/time when this report type was/will be deprecated.
"systemManaged": True or False, # True if this a system-managed report type; otherwise false. Reporting jobs
# for system-managed report types are created automatically and can thus not
# be used in the `CreateJob` method.
"name": "A String", # The name of the report type (max. 100 characters).
- "deprecateTime": "A String", # The date/time when this report type was/will be deprecated.
+ "id": "A String", # The ID of the report type (max. 100 characters).
},
],
}</pre>
diff --git a/docs/epy/class-tree.html b/docs/epy/class-tree.html
index 353daa6..e53d6d3 100644
--- a/docs/epy/class-tree.html
+++ b/docs/epy/class-tree.html
@@ -163,7 +163,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient-module.html b/docs/epy/googleapiclient-module.html
index af7fe35..19f3e5a 100644
--- a/docs/epy/googleapiclient-module.html
+++ b/docs/epy/googleapiclient-module.html
@@ -149,7 +149,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient-pysrc.html b/docs/epy/googleapiclient-pysrc.html
index 5c97f6b..228bb06 100644
--- a/docs/epy/googleapiclient-pysrc.html
+++ b/docs/epy/googleapiclient-pysrc.html
@@ -115,7 +115,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.NullHandler-class.html b/docs/epy/googleapiclient.NullHandler-class.html
index 11896b8..f03c81e 100644
--- a/docs/epy/googleapiclient.NullHandler-class.html
+++ b/docs/epy/googleapiclient.NullHandler-class.html
@@ -284,7 +284,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient._auth-module.html b/docs/epy/googleapiclient._auth-module.html
index be8840b..08a35b8 100644
--- a/docs/epy/googleapiclient._auth-module.html
+++ b/docs/epy/googleapiclient._auth-module.html
@@ -272,7 +272,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient._auth-pysrc.html b/docs/epy/googleapiclient._auth-pysrc.html
index f231a04..e0f09b6 100644
--- a/docs/epy/googleapiclient._auth-pysrc.html
+++ b/docs/epy/googleapiclient._auth-pysrc.html
@@ -181,7 +181,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.channel-module.html b/docs/epy/googleapiclient.channel-module.html
index 20c9e4f..4670836 100644
--- a/docs/epy/googleapiclient.channel-module.html
+++ b/docs/epy/googleapiclient.channel-module.html
@@ -455,7 +455,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.channel-pysrc.html b/docs/epy/googleapiclient.channel-pysrc.html
index 77bd96c..437b0a7 100644
--- a/docs/epy/googleapiclient.channel-pysrc.html
+++ b/docs/epy/googleapiclient.channel-pysrc.html
@@ -386,7 +386,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.channel.Channel-class.html b/docs/epy/googleapiclient.channel.Channel-class.html
index b490a07..d8a440a 100644
--- a/docs/epy/googleapiclient.channel.Channel-class.html
+++ b/docs/epy/googleapiclient.channel.Channel-class.html
@@ -376,7 +376,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.channel.Notification-class.html b/docs/epy/googleapiclient.channel.Notification-class.html
index e242528..4731491 100644
--- a/docs/epy/googleapiclient.channel.Notification-class.html
+++ b/docs/epy/googleapiclient.channel.Notification-class.html
@@ -249,7 +249,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery-module.html b/docs/epy/googleapiclient.discovery-module.html
index a877cc7..7098f56 100644
--- a/docs/epy/googleapiclient.discovery-module.html
+++ b/docs/epy/googleapiclient.discovery-module.html
@@ -1370,7 +1370,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery-pysrc.html b/docs/epy/googleapiclient.discovery-pysrc.html
index f3f3fa9..1acf353 100644
--- a/docs/epy/googleapiclient.discovery-pysrc.html
+++ b/docs/epy/googleapiclient.discovery-pysrc.html
@@ -1471,7 +1471,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery.Resource-class.html b/docs/epy/googleapiclient.discovery.Resource-class.html
index 24fb5a3..f60ccd5 100644
--- a/docs/epy/googleapiclient.discovery.Resource-class.html
+++ b/docs/epy/googleapiclient.discovery.Resource-class.html
@@ -458,7 +458,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery.ResourceMethodParameters-class.html b/docs/epy/googleapiclient.discovery.ResourceMethodParameters-class.html
index 5562d5e..4df3fbd 100644
--- a/docs/epy/googleapiclient.discovery.ResourceMethodParameters-class.html
+++ b/docs/epy/googleapiclient.discovery.ResourceMethodParameters-class.html
@@ -300,7 +300,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery._BytesGenerator-class.html b/docs/epy/googleapiclient.discovery._BytesGenerator-class.html
index cf52f46..0a74916 100644
--- a/docs/epy/googleapiclient.discovery._BytesGenerator-class.html
+++ b/docs/epy/googleapiclient.discovery._BytesGenerator-class.html
@@ -116,7 +116,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache-module.html b/docs/epy/googleapiclient.discovery_cache-module.html
index 052ca91..2475395 100644
--- a/docs/epy/googleapiclient.discovery_cache-module.html
+++ b/docs/epy/googleapiclient.discovery_cache-module.html
@@ -225,7 +225,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache-pysrc.html b/docs/epy/googleapiclient.discovery_cache-pysrc.html
index 4a5caa2..38a14df 100644
--- a/docs/epy/googleapiclient.discovery_cache-pysrc.html
+++ b/docs/epy/googleapiclient.discovery_cache-pysrc.html
@@ -144,7 +144,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache.appengine_memcache-module.html b/docs/epy/googleapiclient.discovery_cache.appengine_memcache-module.html
index f0f68d1..a30fc8d 100644
--- a/docs/epy/googleapiclient.discovery_cache.appengine_memcache-module.html
+++ b/docs/epy/googleapiclient.discovery_cache.appengine_memcache-module.html
@@ -153,7 +153,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache.appengine_memcache-pysrc.html b/docs/epy/googleapiclient.discovery_cache.appengine_memcache-pysrc.html
index 1095e99..044736e 100644
--- a/docs/epy/googleapiclient.discovery_cache.appengine_memcache-pysrc.html
+++ b/docs/epy/googleapiclient.discovery_cache.appengine_memcache-pysrc.html
@@ -165,7 +165,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache.appengine_memcache.Cache-class.html b/docs/epy/googleapiclient.discovery_cache.appengine_memcache.Cache-class.html
index 7ba1d27..5ed8c12 100644
--- a/docs/epy/googleapiclient.discovery_cache.appengine_memcache.Cache-class.html
+++ b/docs/epy/googleapiclient.discovery_cache.appengine_memcache.Cache-class.html
@@ -358,7 +358,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache.base-module.html b/docs/epy/googleapiclient.discovery_cache.base-module.html
index 13f2e01..0016e65 100644
--- a/docs/epy/googleapiclient.discovery_cache.base-module.html
+++ b/docs/epy/googleapiclient.discovery_cache.base-module.html
@@ -114,7 +114,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache.base-pysrc.html b/docs/epy/googleapiclient.discovery_cache.base-pysrc.html
index fb29498..9ac889d 100644
--- a/docs/epy/googleapiclient.discovery_cache.base-pysrc.html
+++ b/docs/epy/googleapiclient.discovery_cache.base-pysrc.html
@@ -135,7 +135,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache.base.Cache-class.html b/docs/epy/googleapiclient.discovery_cache.base.Cache-class.html
index 5824d7e..6dd33cc 100644
--- a/docs/epy/googleapiclient.discovery_cache.base.Cache-class.html
+++ b/docs/epy/googleapiclient.discovery_cache.base.Cache-class.html
@@ -309,7 +309,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache.file_cache-module.html b/docs/epy/googleapiclient.discovery_cache.file_cache-module.html
index 79f10a4..70b3109 100644
--- a/docs/epy/googleapiclient.discovery_cache.file_cache-module.html
+++ b/docs/epy/googleapiclient.discovery_cache.file_cache-module.html
@@ -215,7 +215,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache.file_cache-pysrc.html b/docs/epy/googleapiclient.discovery_cache.file_cache-pysrc.html
index 5bc935b..11b56d7 100644
--- a/docs/epy/googleapiclient.discovery_cache.file_cache-pysrc.html
+++ b/docs/epy/googleapiclient.discovery_cache.file_cache-pysrc.html
@@ -276,7 +276,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.discovery_cache.file_cache.Cache-class.html b/docs/epy/googleapiclient.discovery_cache.file_cache.Cache-class.html
index 921c828..27f6d4a 100644
--- a/docs/epy/googleapiclient.discovery_cache.file_cache.Cache-class.html
+++ b/docs/epy/googleapiclient.discovery_cache.file_cache.Cache-class.html
@@ -358,7 +358,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors-module.html b/docs/epy/googleapiclient.errors-module.html
index fbb2425..4495ddd 100644
--- a/docs/epy/googleapiclient.errors-module.html
+++ b/docs/epy/googleapiclient.errors-module.html
@@ -224,7 +224,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors-pysrc.html b/docs/epy/googleapiclient.errors-pysrc.html
index 2ab462c..c1df72b 100644
--- a/docs/epy/googleapiclient.errors-pysrc.html
+++ b/docs/epy/googleapiclient.errors-pysrc.html
@@ -296,7 +296,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.BatchError-class.html b/docs/epy/googleapiclient.errors.BatchError-class.html
index 4771076..9c57b33 100644
--- a/docs/epy/googleapiclient.errors.BatchError-class.html
+++ b/docs/epy/googleapiclient.errors.BatchError-class.html
@@ -64,20 +64,20 @@
<area shape="rect" id="node1_16" href="googleapiclient.errors.BatchError-class.html#__str__" title="str(x)" alt="" coords="17,541,308,561"/>
<area shape="rect" id="node1" href="googleapiclient.errors.BatchError-class.html" title="Error occured during batch operations." alt="" coords="5,467,320,567"/>
<area shape="rect" id="node2" href="googleapiclient.errors.HttpError-class.html" title="HTTP data was invalid or unexpected." alt="" coords="122,403,201,448"/>
-<area shape="rect" id="node3_17" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="84,31,241,51"/>
-<area shape="rect" id="node3_18" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="84,51,241,71"/>
-<area shape="rect" id="node3_19" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="84,73,241,93"/>
-<area shape="rect" id="node3_20" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="84,93,241,113"/>
-<area shape="rect" id="node3_21" href="javascript:void(0);" title="x[y]" alt="" coords="84,113,241,133"/>
-<area shape="rect" id="node3_22" href="javascript:void(0);" title="x[i:j]" alt="" coords="84,133,241,153"/>
-<area shape="rect" id="node3_23" href="javascript:void(0);" title="helper for pickle" alt="" coords="84,153,241,173"/>
-<area shape="rect" id="node3_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="84,173,241,193"/>
-<area shape="rect" id="node3_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="84,193,241,213"/>
-<area shape="rect" id="node3_26" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="84,213,241,233"/>
-<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="72,5,253,240"/>
+<area shape="rect" id="node3" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="134,339,189,384"/>
+<area shape="rect" id="node4_17" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="84,31,241,51"/>
+<area shape="rect" id="node4_18" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="84,51,241,71"/>
+<area shape="rect" id="node4_19" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="84,73,241,93"/>
+<area shape="rect" id="node4_20" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="84,93,241,113"/>
+<area shape="rect" id="node4_21" href="javascript:void(0);" title="x[y]" alt="" coords="84,113,241,133"/>
+<area shape="rect" id="node4_22" href="javascript:void(0);" title="x[i:j]" alt="" coords="84,133,241,153"/>
+<area shape="rect" id="node4_23" href="javascript:void(0);" title="helper for pickle" alt="" coords="84,153,241,173"/>
+<area shape="rect" id="node4_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="84,173,241,193"/>
+<area shape="rect" id="node4_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="84,193,241,213"/>
+<area shape="rect" id="node4_26" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="84,213,241,233"/>
+<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="72,5,253,240"/>
<area shape="rect" id="node5_27" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="99,293,225,313"/>
<area shape="rect" id="node5" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="86,259,237,319"/>
-<area shape="rect" id="node4" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="134,339,189,384"/>
</map>
<img src="uml_class_diagram_for_googleap_10.gif" alt='' usemap="#uml_class_diagram_for_googleap_10" ismap="ismap" class="graph-without-title" />
</center>
@@ -349,7 +349,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.Error-class.html b/docs/epy/googleapiclient.errors.Error-class.html
index 8640e39..e18f423 100644
--- a/docs/epy/googleapiclient.errors.Error-class.html
+++ b/docs/epy/googleapiclient.errors.Error-class.html
@@ -186,7 +186,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.HttpError-class.html b/docs/epy/googleapiclient.errors.HttpError-class.html
index 9bf505e..f2909e7 100644
--- a/docs/epy/googleapiclient.errors.HttpError-class.html
+++ b/docs/epy/googleapiclient.errors.HttpError-class.html
@@ -362,7 +362,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.InvalidChunkSizeError-class.html b/docs/epy/googleapiclient.errors.InvalidChunkSizeError-class.html
index 14d918c..9db9dd0 100644
--- a/docs/epy/googleapiclient.errors.InvalidChunkSizeError-class.html
+++ b/docs/epy/googleapiclient.errors.InvalidChunkSizeError-class.html
@@ -187,7 +187,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.InvalidJsonError-class.html b/docs/epy/googleapiclient.errors.InvalidJsonError-class.html
index c329126..c1c3b1b 100644
--- a/docs/epy/googleapiclient.errors.InvalidJsonError-class.html
+++ b/docs/epy/googleapiclient.errors.InvalidJsonError-class.html
@@ -187,7 +187,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.InvalidNotificationError-class.html b/docs/epy/googleapiclient.errors.InvalidNotificationError-class.html
index ef2a419..394d10b 100644
--- a/docs/epy/googleapiclient.errors.InvalidNotificationError-class.html
+++ b/docs/epy/googleapiclient.errors.InvalidNotificationError-class.html
@@ -187,7 +187,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.MediaUploadSizeError-class.html b/docs/epy/googleapiclient.errors.MediaUploadSizeError-class.html
index 782109c..139bc0a 100644
--- a/docs/epy/googleapiclient.errors.MediaUploadSizeError-class.html
+++ b/docs/epy/googleapiclient.errors.MediaUploadSizeError-class.html
@@ -187,7 +187,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.ResumableUploadError-class.html b/docs/epy/googleapiclient.errors.ResumableUploadError-class.html
index f687ad5..861fe8c 100644
--- a/docs/epy/googleapiclient.errors.ResumableUploadError-class.html
+++ b/docs/epy/googleapiclient.errors.ResumableUploadError-class.html
@@ -64,20 +64,20 @@
<area shape="rect" id="node2_15" href="googleapiclient.errors.HttpError-class.html#__repr__" title="str(x)" alt="" coords="17,457,244,477"/>
<area shape="rect" id="node2_16" href="googleapiclient.errors.HttpError-class.html#__str__" title="str(x)" alt="" coords="17,477,244,497"/>
<area shape="rect" id="node2" href="googleapiclient.errors.HttpError-class.html" title="HTTP data was invalid or unexpected." alt="" coords="5,403,256,503"/>
-<area shape="rect" id="node3_17" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="52,31,209,51"/>
-<area shape="rect" id="node3_18" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="52,51,209,71"/>
-<area shape="rect" id="node3_19" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="52,73,209,93"/>
-<area shape="rect" id="node3_20" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="52,93,209,113"/>
-<area shape="rect" id="node3_21" href="javascript:void(0);" title="x[y]" alt="" coords="52,113,209,133"/>
-<area shape="rect" id="node3_22" href="javascript:void(0);" title="x[i:j]" alt="" coords="52,133,209,153"/>
-<area shape="rect" id="node3_23" href="javascript:void(0);" title="helper for pickle" alt="" coords="52,153,209,173"/>
-<area shape="rect" id="node3_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="52,173,209,193"/>
-<area shape="rect" id="node3_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="52,193,209,213"/>
-<area shape="rect" id="node3_26" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="52,213,209,233"/>
-<area shape="rect" id="node3" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="40,5,221,240"/>
+<area shape="rect" id="node3" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="102,339,157,384"/>
+<area shape="rect" id="node4_17" href="javascript:void(0);" title="exceptions.BaseException.args" alt="" coords="52,31,209,51"/>
+<area shape="rect" id="node4_18" href="javascript:void(0);" title="exceptions.BaseException.message" alt="" coords="52,51,209,71"/>
+<area shape="rect" id="node4_19" href="javascript:void(0);" title="x.__delattr__('name') <==> del x.name" alt="" coords="52,73,209,93"/>
+<area shape="rect" id="node4_20" href="javascript:void(0);" title="x.__getattribute__('name') <==> x.name" alt="" coords="52,93,209,113"/>
+<area shape="rect" id="node4_21" href="javascript:void(0);" title="x[y]" alt="" coords="52,113,209,133"/>
+<area shape="rect" id="node4_22" href="javascript:void(0);" title="x[i:j]" alt="" coords="52,133,209,153"/>
+<area shape="rect" id="node4_23" href="javascript:void(0);" title="helper for pickle" alt="" coords="52,153,209,173"/>
+<area shape="rect" id="node4_24" href="javascript:void(0);" title="x.__setattr__('name', value) <==> x.name = value" alt="" coords="52,173,209,193"/>
+<area shape="rect" id="node4_25" href="javascript:void(0);" title="exceptions.BaseException.__setstate__" alt="" coords="52,193,209,213"/>
+<area shape="rect" id="node4_26" href="javascript:void(0);" title="exceptions.BaseException.__unicode__" alt="" coords="52,213,209,233"/>
+<area shape="rect" id="node4" href="javascript:void(0);" title="Common base class for all exceptions" alt="" coords="40,5,221,240"/>
<area shape="rect" id="node5_27" href="javascript:void(0);" title="exceptions.Exception.__new__" alt="" coords="67,293,193,313"/>
<area shape="rect" id="node5" href="javascript:void(0);" title="Common base class for all non-exit exceptions." alt="" coords="54,259,205,319"/>
-<area shape="rect" id="node4" href="googleapiclient.errors.Error-class.html" title="Base error for this module." alt="" coords="102,339,157,384"/>
</map>
<img src="uml_class_diagram_for_googleap_17.gif" alt='' usemap="#uml_class_diagram_for_googleap_17" ismap="ismap" class="graph-without-title" />
</center>
@@ -193,7 +193,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.UnacceptableMimeTypeError-class.html b/docs/epy/googleapiclient.errors.UnacceptableMimeTypeError-class.html
index 636e66a..c0f21dc 100644
--- a/docs/epy/googleapiclient.errors.UnacceptableMimeTypeError-class.html
+++ b/docs/epy/googleapiclient.errors.UnacceptableMimeTypeError-class.html
@@ -187,7 +187,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.UnexpectedBodyError-class.html b/docs/epy/googleapiclient.errors.UnexpectedBodyError-class.html
index e215368..76a5826 100644
--- a/docs/epy/googleapiclient.errors.UnexpectedBodyError-class.html
+++ b/docs/epy/googleapiclient.errors.UnexpectedBodyError-class.html
@@ -252,7 +252,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.UnexpectedMethodError-class.html b/docs/epy/googleapiclient.errors.UnexpectedMethodError-class.html
index eede12a..efdff34 100644
--- a/docs/epy/googleapiclient.errors.UnexpectedMethodError-class.html
+++ b/docs/epy/googleapiclient.errors.UnexpectedMethodError-class.html
@@ -254,7 +254,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.UnknownApiNameOrVersion-class.html b/docs/epy/googleapiclient.errors.UnknownApiNameOrVersion-class.html
index 01a3733..2d34894 100644
--- a/docs/epy/googleapiclient.errors.UnknownApiNameOrVersion-class.html
+++ b/docs/epy/googleapiclient.errors.UnknownApiNameOrVersion-class.html
@@ -187,7 +187,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.UnknownFileType-class.html b/docs/epy/googleapiclient.errors.UnknownFileType-class.html
index d1feb15..8c93cd9 100644
--- a/docs/epy/googleapiclient.errors.UnknownFileType-class.html
+++ b/docs/epy/googleapiclient.errors.UnknownFileType-class.html
@@ -187,7 +187,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.errors.UnknownLinkType-class.html b/docs/epy/googleapiclient.errors.UnknownLinkType-class.html
index 9cb5b99..49b2fe2 100644
--- a/docs/epy/googleapiclient.errors.UnknownLinkType-class.html
+++ b/docs/epy/googleapiclient.errors.UnknownLinkType-class.html
@@ -187,7 +187,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http-module.html b/docs/epy/googleapiclient.http-module.html
index 4cd797e..b376a96 100644
--- a/docs/epy/googleapiclient.http-module.html
+++ b/docs/epy/googleapiclient.http-module.html
@@ -598,7 +598,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http-pysrc.html b/docs/epy/googleapiclient.http-pysrc.html
index f506551..875d2a1 100644
--- a/docs/epy/googleapiclient.http-pysrc.html
+++ b/docs/epy/googleapiclient.http-pysrc.html
@@ -2189,7 +2189,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.BatchHttpRequest-class.html b/docs/epy/googleapiclient.http.BatchHttpRequest-class.html
index 37b77b2..c8ce788 100644
--- a/docs/epy/googleapiclient.http.BatchHttpRequest-class.html
+++ b/docs/epy/googleapiclient.http.BatchHttpRequest-class.html
@@ -740,7 +740,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.HttpMock-class.html b/docs/epy/googleapiclient.http.HttpMock-class.html
index f5edd08..ba32d86 100644
--- a/docs/epy/googleapiclient.http.HttpMock-class.html
+++ b/docs/epy/googleapiclient.http.HttpMock-class.html
@@ -250,7 +250,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.HttpMockSequence-class.html b/docs/epy/googleapiclient.http.HttpMockSequence-class.html
index add3ddf..80ec969 100644
--- a/docs/epy/googleapiclient.http.HttpMockSequence-class.html
+++ b/docs/epy/googleapiclient.http.HttpMockSequence-class.html
@@ -267,7 +267,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.HttpRequest-class.html b/docs/epy/googleapiclient.http.HttpRequest-class.html
index 972edcc..baf4980 100644
--- a/docs/epy/googleapiclient.http.HttpRequest-class.html
+++ b/docs/epy/googleapiclient.http.HttpRequest-class.html
@@ -561,7 +561,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.HttpRequestMock-class.html b/docs/epy/googleapiclient.http.HttpRequestMock-class.html
index 40cf6b6..5f3e9cb 100644
--- a/docs/epy/googleapiclient.http.HttpRequestMock-class.html
+++ b/docs/epy/googleapiclient.http.HttpRequestMock-class.html
@@ -279,7 +279,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.MediaDownloadProgress-class.html b/docs/epy/googleapiclient.http.MediaDownloadProgress-class.html
index aafe8fa..0bea7fe 100644
--- a/docs/epy/googleapiclient.http.MediaDownloadProgress-class.html
+++ b/docs/epy/googleapiclient.http.MediaDownloadProgress-class.html
@@ -272,7 +272,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.MediaFileUpload-class.html b/docs/epy/googleapiclient.http.MediaFileUpload-class.html
index bc854e1..afb71a8 100644
--- a/docs/epy/googleapiclient.http.MediaFileUpload-class.html
+++ b/docs/epy/googleapiclient.http.MediaFileUpload-class.html
@@ -392,7 +392,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.MediaInMemoryUpload-class.html b/docs/epy/googleapiclient.http.MediaInMemoryUpload-class.html
index 016d8ee..4c566cd 100644
--- a/docs/epy/googleapiclient.http.MediaInMemoryUpload-class.html
+++ b/docs/epy/googleapiclient.http.MediaInMemoryUpload-class.html
@@ -297,7 +297,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.MediaIoBaseDownload-class.html b/docs/epy/googleapiclient.http.MediaIoBaseDownload-class.html
index 84d60ed..666969e 100644
--- a/docs/epy/googleapiclient.http.MediaIoBaseDownload-class.html
+++ b/docs/epy/googleapiclient.http.MediaIoBaseDownload-class.html
@@ -314,7 +314,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.MediaIoBaseUpload-class.html b/docs/epy/googleapiclient.http.MediaIoBaseUpload-class.html
index e21d656..5467666 100644
--- a/docs/epy/googleapiclient.http.MediaIoBaseUpload-class.html
+++ b/docs/epy/googleapiclient.http.MediaIoBaseUpload-class.html
@@ -674,7 +674,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.MediaUpload-class.html b/docs/epy/googleapiclient.http.MediaUpload-class.html
index 172c34b..16f4a14 100644
--- a/docs/epy/googleapiclient.http.MediaUpload-class.html
+++ b/docs/epy/googleapiclient.http.MediaUpload-class.html
@@ -681,7 +681,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.MediaUploadProgress-class.html b/docs/epy/googleapiclient.http.MediaUploadProgress-class.html
index d2d9db4..91e2fd0 100644
--- a/docs/epy/googleapiclient.http.MediaUploadProgress-class.html
+++ b/docs/epy/googleapiclient.http.MediaUploadProgress-class.html
@@ -273,7 +273,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http.RequestMockBuilder-class.html b/docs/epy/googleapiclient.http.RequestMockBuilder-class.html
index 84bf774..4910f2c 100644
--- a/docs/epy/googleapiclient.http.RequestMockBuilder-class.html
+++ b/docs/epy/googleapiclient.http.RequestMockBuilder-class.html
@@ -319,7 +319,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.http._StreamSlice-class.html b/docs/epy/googleapiclient.http._StreamSlice-class.html
index 8de77a3..4a2838e 100644
--- a/docs/epy/googleapiclient.http._StreamSlice-class.html
+++ b/docs/epy/googleapiclient.http._StreamSlice-class.html
@@ -285,7 +285,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.mimeparse-module.html b/docs/epy/googleapiclient.mimeparse-module.html
index 25864ee..3074739 100644
--- a/docs/epy/googleapiclient.mimeparse-module.html
+++ b/docs/epy/googleapiclient.mimeparse-module.html
@@ -490,7 +490,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.mimeparse-pysrc.html b/docs/epy/googleapiclient.mimeparse-pysrc.html
index 12affe3..69a291d 100644
--- a/docs/epy/googleapiclient.mimeparse-pysrc.html
+++ b/docs/epy/googleapiclient.mimeparse-pysrc.html
@@ -264,7 +264,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.model-module.html b/docs/epy/googleapiclient.model-module.html
index e753552..08a911d 100644
--- a/docs/epy/googleapiclient.model-module.html
+++ b/docs/epy/googleapiclient.model-module.html
@@ -306,7 +306,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.model-pysrc.html b/docs/epy/googleapiclient.model-pysrc.html
index 2e2af9b..6b82cb6 100644
--- a/docs/epy/googleapiclient.model-pysrc.html
+++ b/docs/epy/googleapiclient.model-pysrc.html
@@ -635,7 +635,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.model.BaseModel-class.html b/docs/epy/googleapiclient.model.BaseModel-class.html
index 659736c..bbebb04 100644
--- a/docs/epy/googleapiclient.model.BaseModel-class.html
+++ b/docs/epy/googleapiclient.model.BaseModel-class.html
@@ -545,7 +545,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.model.JsonModel-class.html b/docs/epy/googleapiclient.model.JsonModel-class.html
index 4931050..6b25d24 100644
--- a/docs/epy/googleapiclient.model.JsonModel-class.html
+++ b/docs/epy/googleapiclient.model.JsonModel-class.html
@@ -432,7 +432,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.model.MediaModel-class.html b/docs/epy/googleapiclient.model.MediaModel-class.html
index fd5d0b2..c519ca0 100644
--- a/docs/epy/googleapiclient.model.MediaModel-class.html
+++ b/docs/epy/googleapiclient.model.MediaModel-class.html
@@ -339,7 +339,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.model.Model-class.html b/docs/epy/googleapiclient.model.Model-class.html
index e2a0ae0..04964b9 100644
--- a/docs/epy/googleapiclient.model.Model-class.html
+++ b/docs/epy/googleapiclient.model.Model-class.html
@@ -297,7 +297,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.model.ProtocolBufferModel-class.html b/docs/epy/googleapiclient.model.ProtocolBufferModel-class.html
index 24ed10c..b96eb38 100644
--- a/docs/epy/googleapiclient.model.ProtocolBufferModel-class.html
+++ b/docs/epy/googleapiclient.model.ProtocolBufferModel-class.html
@@ -436,7 +436,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.model.RawModel-class.html b/docs/epy/googleapiclient.model.RawModel-class.html
index 907ef1f..fd5d01a 100644
--- a/docs/epy/googleapiclient.model.RawModel-class.html
+++ b/docs/epy/googleapiclient.model.RawModel-class.html
@@ -339,7 +339,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.sample_tools-module.html b/docs/epy/googleapiclient.sample_tools-module.html
index 850eb63..54a2fbe 100644
--- a/docs/epy/googleapiclient.sample_tools-module.html
+++ b/docs/epy/googleapiclient.sample_tools-module.html
@@ -204,7 +204,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.sample_tools-pysrc.html b/docs/epy/googleapiclient.sample_tools-pysrc.html
index 2a8ae26..78869ea 100644
--- a/docs/epy/googleapiclient.sample_tools-pysrc.html
+++ b/docs/epy/googleapiclient.sample_tools-pysrc.html
@@ -195,7 +195,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.schema-module.html b/docs/epy/googleapiclient.schema-module.html
index 81722aa..fbcd7fe 100644
--- a/docs/epy/googleapiclient.schema-module.html
+++ b/docs/epy/googleapiclient.schema-module.html
@@ -167,7 +167,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.schema-pysrc.html b/docs/epy/googleapiclient.schema-pysrc.html
index 632b772..b642ae6 100644
--- a/docs/epy/googleapiclient.schema-pysrc.html
+++ b/docs/epy/googleapiclient.schema-pysrc.html
@@ -463,7 +463,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:57 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.schema.Schemas-class.html b/docs/epy/googleapiclient.schema.Schemas-class.html
index 52d63bb..9f94cb7 100644
--- a/docs/epy/googleapiclient.schema.Schemas-class.html
+++ b/docs/epy/googleapiclient.schema.Schemas-class.html
@@ -488,7 +488,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/googleapiclient.schema._SchemaToStruct-class.html b/docs/epy/googleapiclient.schema._SchemaToStruct-class.html
index 8ffadd7..34f9203 100644
--- a/docs/epy/googleapiclient.schema._SchemaToStruct-class.html
+++ b/docs/epy/googleapiclient.schema._SchemaToStruct-class.html
@@ -509,7 +509,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:56 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:54 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/help.html b/docs/epy/help.html
index cb030a8..23ebed9 100644
--- a/docs/epy/help.html
+++ b/docs/epy/help.html
@@ -246,7 +246,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/identifier-index.html b/docs/epy/identifier-index.html
index af1ff40..559313f 100644
--- a/docs/epy/identifier-index.html
+++ b/docs/epy/identifier-index.html
@@ -1027,7 +1027,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
diff --git a/docs/epy/module-tree.html b/docs/epy/module-tree.html
index 056264a..974c219 100644
--- a/docs/epy/module-tree.html
+++ b/docs/epy/module-tree.html
@@ -102,7 +102,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Fri Mar 10 15:54:55 2017
+ Generated by Epydoc 3.0.1 on Fri Mar 24 14:25:53 2017
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"