Retrieves a user.
insert(body=None, resolveConflictAccount=None, x__xgafv=None)
Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case.
+Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case. If `resolveConflictAccount` is set to `true`, a `202` response code means that a conflicting unmanaged account exists and was invited to join the organization. A `409` response code means that a conflicting account exists so the user wasn't created based on the [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) option selected.
Retrieves a paginated list of either deleted users or all users in a domain.
@@ -228,7 +228,7 @@insert(body=None, resolveConflictAccount=None, x__xgafv=None)
- Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case. +Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case. If `resolveConflictAccount` is set to `true`, a `202` response code means that a conflicting unmanaged account exists and was invited to join the organization. A `409` response code means that a conflicting account exists so the user wasn't created based on the [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) option selected. Args: body: object, The request body. diff --git a/docs/dyn/adsenseplatform_v1.html b/docs/dyn/adsenseplatform_v1.html new file mode 100644 index 00000000000..ba547cb16b8 --- /dev/null +++ b/docs/dyn/adsenseplatform_v1.html @@ -0,0 +1,111 @@ + + + +AdSense Platform API
+Instance Methods
++
+platforms()+Returns the platforms Resource.
+ ++
+close()Close httplib2 connections.
+ +Create a BatchHttpRequest object based on the discovery document.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1.platforms.accounts.events.html b/docs/dyn/adsenseplatform_v1.platforms.accounts.events.html new file mode 100644 index 00000000000..7f12463dc4b --- /dev/null +++ b/docs/dyn/adsenseplatform_v1.platforms.accounts.events.html @@ -0,0 +1,147 @@ + + + +new_batch_http_request()+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. ++AdSense Platform API . platforms . accounts . events
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(parent, body=None, x__xgafv=None)Creates an account event.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1.platforms.accounts.html b/docs/dyn/adsenseplatform_v1.platforms.accounts.html new file mode 100644 index 00000000000..06f3491d1fa --- /dev/null +++ b/docs/dyn/adsenseplatform_v1.platforms.accounts.html @@ -0,0 +1,271 @@ + + + +create(parent, body=None, x__xgafv=None)+Creates an account event. + +Args: + parent: string, Required. Account to log events about. Format: platforms/{platform}/accounts/{account} (required) + body: object, The request body. + The object takes the form of: + +{ # A platform sub-account event to record spam signals. + "eventInfo": { # Private information for partner recorded events (PII). # Required. Information associated with the event. + "billingAddress": { # Address data. # The billing address of the publisher associated with this event, if available. + "address1": "A String", # First line of address. Max length 64 bytes or 30 characters. + "address2": "A String", # Second line of address. Max length 64 bytes or 30 characters. + "city": "A String", # City. Max length 60 bytes or 30 characters. + "company": "A String", # Name of the company. Max length 255 bytes or 34 characters. + "contact": "A String", # Contact name of the company. Max length 128 bytes or 34 characters. + "fax": "A String", # Fax number with international code (i.e. +441234567890). + "phone": "A String", # Phone number with international code (i.e. +441234567890). + "regionCode": "A String", # Country/Region code. The region is specified as a CLDR region code (e.g. "US", "FR"). + "state": "A String", # State. Max length 60 bytes or 30 characters. + "zip": "A String", # Zip/post code. Max length 10 bytes or 10 characters. + }, + "email": "A String", # Required. The email address that is associated with the publisher when performing the event. + }, + "eventTime": "A String", # Required. Event timestamp. + "eventType": "A String", # Required. Event type. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A platform sub-account event to record spam signals. + "eventInfo": { # Private information for partner recorded events (PII). # Required. Information associated with the event. + "billingAddress": { # Address data. # The billing address of the publisher associated with this event, if available. + "address1": "A String", # First line of address. Max length 64 bytes or 30 characters. + "address2": "A String", # Second line of address. Max length 64 bytes or 30 characters. + "city": "A String", # City. Max length 60 bytes or 30 characters. + "company": "A String", # Name of the company. Max length 255 bytes or 34 characters. + "contact": "A String", # Contact name of the company. Max length 128 bytes or 34 characters. + "fax": "A String", # Fax number with international code (i.e. +441234567890). + "phone": "A String", # Phone number with international code (i.e. +441234567890). + "regionCode": "A String", # Country/Region code. The region is specified as a CLDR region code (e.g. "US", "FR"). + "state": "A String", # State. Max length 60 bytes or 30 characters. + "zip": "A String", # Zip/post code. Max length 10 bytes or 10 characters. + }, + "email": "A String", # Required. The email address that is associated with the publisher when performing the event. + }, + "eventTime": "A String", # Required. Event timestamp. + "eventType": "A String", # Required. Event type. +}+AdSense Platform API . platforms . accounts
+Instance Methods
++
+events()+Returns the events Resource.
+ ++
+sites()+Returns the sites Resource.
+ ++
+close(name, body=None, x__xgafv=None)Closes a sub-account.
++
+create(parent, body=None, x__xgafv=None)Creates a sub-account.
+ +Gets information about the selected sub-account.
++
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)Lists a partial view of sub-accounts for a specific parent account.
+ +Retrieves the next page of results.
++
+lookup(parent, creationRequestId=None, x__xgafv=None)Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.
+Method Details
+++ +close(name, body=None, x__xgafv=None)+Closes a sub-account. + +Args: + name: string, Required. Account to close. Format: platforms/{platform}/accounts/{account_id} (required) + body: object, The request body. + The object takes the form of: + +{ # Request definition for the account close rpc. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response definition for the account close rpc. +}+++ +create(parent, body=None, x__xgafv=None)+Creates a sub-account. + +Args: + parent: string, Required. Platform to create an account for. Format: platforms/{platform} (required) + body: object, The request body. + The object takes the form of: + +{ # Representation of an Account. + "createTime": "A String", # Output only. Creation time of the account. + "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error. + "displayName": "A String", # Display name of this account. + "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+ + "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code. + "state": "A String", # Output only. Approval state of the account. + "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts. + "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". + "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". + }, +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Representation of an Account. + "createTime": "A String", # Output only. Creation time of the account. + "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error. + "displayName": "A String", # Display name of this account. + "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+ + "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code. + "state": "A String", # Output only. Approval state of the account. + "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts. + "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". + "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". + }, +}+++ +get(name, x__xgafv=None)+Gets information about the selected sub-account. + +Args: + name: string, Required. Account to get information about. Format: platforms/{platform}/accounts/{account_id} (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Representation of an Account. + "createTime": "A String", # Output only. Creation time of the account. + "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error. + "displayName": "A String", # Display name of this account. + "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+ + "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code. + "state": "A String", # Output only. Approval state of the account. + "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts. + "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". + "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". + }, +}+++ +list(parent, pageSize=None, pageToken=None, x__xgafv=None)+Lists a partial view of sub-accounts for a specific parent account. + +Args: + parent: string, Required. Platform who parents the accounts. Format: platforms/{platform} (required) + pageSize: integer, Optional. The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000. + pageToken: string, Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response definition for the list accounts rpc. + "accounts": [ # The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`. + { # Representation of an Account. + "createTime": "A String", # Output only. Creation time of the account. + "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error. + "displayName": "A String", # Display name of this account. + "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+ + "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code. + "state": "A String", # Output only. Approval state of the account. + "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts. + "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". + "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". + }, + }, + ], + "nextPageToken": "A String", # Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this. +}+++ +list_next()+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. ++++ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1.platforms.accounts.sites.html b/docs/dyn/adsenseplatform_v1.platforms.accounts.sites.html new file mode 100644 index 00000000000..4a95b8d4c14 --- /dev/null +++ b/docs/dyn/adsenseplatform_v1.platforms.accounts.sites.html @@ -0,0 +1,233 @@ + + + +lookup(parent, creationRequestId=None, x__xgafv=None)+Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404. + +Args: + parent: string, Required. Platform who parents the account. Format: platforms/{platform} (required) + creationRequestId: string, Optional. The creation_request_id provided when calling createAccount. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response definition for the lookup account rpc. + "name": "A String", # The name of the Account Format: platforms/{platform}/accounts/{account_id} +}+AdSense Platform API . platforms . accounts . sites
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(parent, body=None, x__xgafv=None)Creates a site for a specified account.
+ +Deletes a site from a specified account.
+ +Gets a site from a specified sub-account.
++
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)Lists sites for a specific account.
+ +Retrieves the next page of results.
++
+requestReview(name, x__xgafv=None)Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, body=None, x__xgafv=None)+Creates a site for a specified account. + +Args: + parent: string, Required. Account to create site. Format: platforms/{platform}/accounts/{account_id} (required) + body: object, The request body. + The object takes the form of: + +{ # Representation of a Site. + "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters. + "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site} + "state": "A String", # Output only. State of a site. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Representation of a Site. + "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters. + "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site} + "state": "A String", # Output only. State of a site. +}+++ +delete(name, x__xgafv=None)+Deletes a site from a specified account. + +Args: + name: string, Required. The name of the site to delete. Format: platforms/{platform}/accounts/{account}/sites/{site} (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); } +}+++ +get(name, x__xgafv=None)+Gets a site from a specified sub-account. + +Args: + name: string, Required. The name of the site to retrieve. Format: platforms/{platform}/accounts/{account}/sites/{site} (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Representation of a Site. + "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters. + "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site} + "state": "A String", # Output only. State of a site. +}+++ +list(parent, pageSize=None, pageToken=None, x__xgafv=None)+Lists sites for a specific account. + +Args: + parent: string, Required. The account which owns the sites. Format: platforms/{platform}/accounts/{account} (required) + pageSize: integer, The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000. + pageToken: string, A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response definition for the site list rpc. + "nextPageToken": "A String", # Continuation token used to page through sites. To retrieve the next page of the results, set the next request's "page_token" value to this. + "sites": [ # The sites returned in this list response. + { # Representation of a Site. + "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters. + "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site} + "state": "A String", # Output only. State of a site. + }, + ], +}+++ +list_next()+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. ++++ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1.platforms.html b/docs/dyn/adsenseplatform_v1.platforms.html new file mode 100644 index 00000000000..f29fbe80cf9 --- /dev/null +++ b/docs/dyn/adsenseplatform_v1.platforms.html @@ -0,0 +1,91 @@ + + + +requestReview(name, x__xgafv=None)+Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review. + +Args: + name: string, Required. The name of the site to submit for review. Format: platforms/{platform}/accounts/{account}/sites/{site} (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response definition for the site request review rpc. +}+AdSense Platform API . platforms
+Instance Methods
++
+accounts()+Returns the accounts Resource.
+ ++
+close()Close httplib2 connections.
+Method Details
+++ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1alpha.html b/docs/dyn/adsenseplatform_v1alpha.html new file mode 100644 index 00000000000..9a196ffc224 --- /dev/null +++ b/docs/dyn/adsenseplatform_v1alpha.html @@ -0,0 +1,111 @@ + + + +close()+Close httplib2 connections.+AdSense Platform API
+Instance Methods
++
+platforms()+Returns the platforms Resource.
+ ++
+close()Close httplib2 connections.
+ +Create a BatchHttpRequest object based on the discovery document.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.events.html b/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.events.html new file mode 100644 index 00000000000..3e3ecadc7ec --- /dev/null +++ b/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.events.html @@ -0,0 +1,147 @@ + + + +new_batch_http_request()+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. ++AdSense Platform API . platforms . accounts . events
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(parent, body=None, x__xgafv=None)Creates an account event.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.html b/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.html new file mode 100644 index 00000000000..d2be5261406 --- /dev/null +++ b/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.html @@ -0,0 +1,271 @@ + + + +create(parent, body=None, x__xgafv=None)+Creates an account event. + +Args: + parent: string, Required. Account to log events about. Format: platforms/{platform}/accounts/{account} (required) + body: object, The request body. + The object takes the form of: + +{ # A platform sub-account event to record spam signals. + "eventInfo": { # Private information for partner recorded events (PII). # Required. Information associated with the event. + "billingAddress": { # Address data. # The billing address of the publisher associated with this event, if available. + "address1": "A String", # First line of address. Max length 64 bytes or 30 characters. + "address2": "A String", # Second line of address. Max length 64 bytes or 30 characters. + "city": "A String", # City. Max length 60 bytes or 30 characters. + "company": "A String", # Name of the company. Max length 255 bytes or 34 characters. + "contact": "A String", # Contact name of the company. Max length 128 bytes or 34 characters. + "fax": "A String", # Fax number with international code (i.e. +441234567890). + "phone": "A String", # Phone number with international code (i.e. +441234567890). + "regionCode": "A String", # Country/Region code. The region is specified as a CLDR region code (e.g. "US", "FR"). + "state": "A String", # State. Max length 60 bytes or 30 characters. + "zip": "A String", # Zip/post code. Max length 10 bytes or 10 characters. + }, + "email": "A String", # Required. The email address that is associated with the publisher when performing the event. + }, + "eventTime": "A String", # Required. Event timestamp. + "eventType": "A String", # Required. Event type. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A platform sub-account event to record spam signals. + "eventInfo": { # Private information for partner recorded events (PII). # Required. Information associated with the event. + "billingAddress": { # Address data. # The billing address of the publisher associated with this event, if available. + "address1": "A String", # First line of address. Max length 64 bytes or 30 characters. + "address2": "A String", # Second line of address. Max length 64 bytes or 30 characters. + "city": "A String", # City. Max length 60 bytes or 30 characters. + "company": "A String", # Name of the company. Max length 255 bytes or 34 characters. + "contact": "A String", # Contact name of the company. Max length 128 bytes or 34 characters. + "fax": "A String", # Fax number with international code (i.e. +441234567890). + "phone": "A String", # Phone number with international code (i.e. +441234567890). + "regionCode": "A String", # Country/Region code. The region is specified as a CLDR region code (e.g. "US", "FR"). + "state": "A String", # State. Max length 60 bytes or 30 characters. + "zip": "A String", # Zip/post code. Max length 10 bytes or 10 characters. + }, + "email": "A String", # Required. The email address that is associated with the publisher when performing the event. + }, + "eventTime": "A String", # Required. Event timestamp. + "eventType": "A String", # Required. Event type. +}+AdSense Platform API . platforms . accounts
+Instance Methods
++
+events()+Returns the events Resource.
+ ++
+sites()+Returns the sites Resource.
+ ++
+close(name, body=None, x__xgafv=None)Closes a sub-account.
++
+create(parent, body=None, x__xgafv=None)Creates a sub-account.
+ +Gets information about the selected sub-account.
++
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)Lists a partial view of sub-accounts for a specific parent account.
+ +Retrieves the next page of results.
++
+lookup(parent, creationRequestId=None, x__xgafv=None)Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.
+Method Details
+++ +close(name, body=None, x__xgafv=None)+Closes a sub-account. + +Args: + name: string, Required. Account to close. Format: platforms/{platform}/accounts/{account_id} (required) + body: object, The request body. + The object takes the form of: + +{ # Request definition for the account close rpc. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response definition for the account close rpc. +}+++ +create(parent, body=None, x__xgafv=None)+Creates a sub-account. + +Args: + parent: string, Required. Platform to create an account for. Format: platforms/{platform} (required) + body: object, The request body. + The object takes the form of: + +{ # Representation of an Account. + "createTime": "A String", # Output only. Creation time of the account. + "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error. + "displayName": "A String", # Display name of this account. + "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+ + "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code. + "state": "A String", # Output only. Approval state of the account. + "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts. + "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". + "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". + }, +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Representation of an Account. + "createTime": "A String", # Output only. Creation time of the account. + "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error. + "displayName": "A String", # Display name of this account. + "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+ + "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code. + "state": "A String", # Output only. Approval state of the account. + "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts. + "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". + "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". + }, +}+++ +get(name, x__xgafv=None)+Gets information about the selected sub-account. + +Args: + name: string, Required. Account to get information about. Format: platforms/{platform}/accounts/{account_id} (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Representation of an Account. + "createTime": "A String", # Output only. Creation time of the account. + "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error. + "displayName": "A String", # Display name of this account. + "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+ + "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code. + "state": "A String", # Output only. Approval state of the account. + "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts. + "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". + "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". + }, +}+++ +list(parent, pageSize=None, pageToken=None, x__xgafv=None)+Lists a partial view of sub-accounts for a specific parent account. + +Args: + parent: string, Required. Platform who parents the accounts. Format: platforms/{platform} (required) + pageSize: integer, Optional. The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000. + pageToken: string, Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response definition for the list accounts rpc. + "accounts": [ # The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`. + { # Representation of an Account. + "createTime": "A String", # Output only. Creation time of the account. + "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error. + "displayName": "A String", # Display name of this account. + "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+ + "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code. + "state": "A String", # Output only. Approval state of the account. + "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts. + "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York". + "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a". + }, + }, + ], + "nextPageToken": "A String", # Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this. +}+++ +list_next()+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. ++++ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.sites.html b/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.sites.html new file mode 100644 index 00000000000..e3f66b86721 --- /dev/null +++ b/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.sites.html @@ -0,0 +1,233 @@ + + + +lookup(parent, creationRequestId=None, x__xgafv=None)+Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404. + +Args: + parent: string, Required. Platform who parents the account. Format: platforms/{platform} (required) + creationRequestId: string, Optional. The creation_request_id provided when calling createAccount. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response definition for the lookup account rpc. + "name": "A String", # The name of the Account Format: platforms/{platform}/accounts/{account_id} +}+AdSense Platform API . platforms . accounts . sites
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(parent, body=None, x__xgafv=None)Creates a site for a specified account.
+ +Deletes a site from a specified account.
+ +Gets a site from a specified sub-account.
++
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)Lists sites for a specific account.
+ +Retrieves the next page of results.
++
+requestReview(name, x__xgafv=None)Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, body=None, x__xgafv=None)+Creates a site for a specified account. + +Args: + parent: string, Required. Account to create site. Format: platforms/{platform}/accounts/{account_id} (required) + body: object, The request body. + The object takes the form of: + +{ # Representation of a Site. + "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters. + "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site} + "state": "A String", # Output only. State of a site. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Representation of a Site. + "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters. + "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site} + "state": "A String", # Output only. State of a site. +}+++ +delete(name, x__xgafv=None)+Deletes a site from a specified account. + +Args: + name: string, Required. The name of the site to delete. Format: platforms/{platform}/accounts/{account}/sites/{site} (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); } +}+++ +get(name, x__xgafv=None)+Gets a site from a specified sub-account. + +Args: + name: string, Required. The name of the site to retrieve. Format: platforms/{platform}/accounts/{account}/sites/{site} (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Representation of a Site. + "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters. + "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site} + "state": "A String", # Output only. State of a site. +}+++ +list(parent, pageSize=None, pageToken=None, x__xgafv=None)+Lists sites for a specific account. + +Args: + parent: string, Required. The account which owns the sites. Format: platforms/{platform}/accounts/{account} (required) + pageSize: integer, The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000. + pageToken: string, A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response definition for the site list rpc. + "nextPageToken": "A String", # Continuation token used to page through sites. To retrieve the next page of the results, set the next request's "page_token" value to this. + "sites": [ # The sites returned in this list response. + { # Representation of a Site. + "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters. + "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site} + "state": "A String", # Output only. State of a site. + }, + ], +}+++ +list_next()+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. ++++ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1alpha.platforms.html b/docs/dyn/adsenseplatform_v1alpha.platforms.html new file mode 100644 index 00000000000..dea2d7dab99 --- /dev/null +++ b/docs/dyn/adsenseplatform_v1alpha.platforms.html @@ -0,0 +1,91 @@ + + + +requestReview(name, x__xgafv=None)+Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review. + +Args: + name: string, Required. The name of the site to submit for review. Format: platforms/{platform}/accounts/{account}/sites/{site} (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response definition for the site request review rpc. +}+AdSense Platform API . platforms
+Instance Methods
++
+accounts()+Returns the accounts Resource.
+ ++
+close()Close httplib2 connections.
+Method Details
+++ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.customJobs.html b/docs/dyn/aiplatform_v1.projects.locations.customJobs.html index 6144b94f678..e8f43c5be17 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.customJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.customJobs.html @@ -175,6 +175,7 @@close()+Close httplib2 connections.+Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -289,6 +290,7 @@Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -445,6 +447,7 @@Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -572,6 +575,7 @@Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. diff --git a/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html b/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html index d834f3c933d..27ac91cb8ce 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html +++ b/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html @@ -120,7 +120,7 @@Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. } @@ -210,7 +210,7 @@Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. }
Updates a DatasetVersion.
Args:
- name: string, Output only. The resource name of the DatasetVersion. (required)
+ name: string, Output only. Identifier. The resource name of the DatasetVersion. (required)
body: object, The request body.
The object takes the form of:
@@ -281,7 +281,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
}
@@ -301,7 +301,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
}
diff --git a/docs/dyn/aiplatform_v1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1.projects.locations.datasets.html
index 039f667f418..b14cce7c329 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.datasets.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.datasets.html
@@ -163,7 +163,7 @@ Updates a Dataset.
Args:
- name: string, Output only. The resource name of the Dataset. (required)
+ name: string, Output only. Identifier. The resource name of the Dataset. (required)
body: object, The request body.
The object takes the form of:
@@ -510,7 +510,7 @@ Method Details
"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
"metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
"modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
- "name": "A String", # Output only. The resource name of the Dataset.
+ "name": "A String", # Output only. Identifier. The resource name of the Dataset.
"savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
{ # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
"annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset.
@@ -553,7 +553,7 @@ Method Details
"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
"metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
"modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
- "name": "A String", # Output only. The resource name of the Dataset.
+ "name": "A String", # Output only. Identifier. The resource name of the Dataset.
"savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
{ # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
"annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
index 15a076e84f3..3b52e278156 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
@@ -158,7 +158,7 @@ Method Details
The object takes the form of:
{ # Request message for ComputeTokens RPC call.
- "contents": [ # Required. Input content.
+ "contents": [ # Optional. Input content.
{ # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
"parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
{ # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
@@ -192,10 +192,10 @@ Method Details
"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
},
],
- "instances": [ # Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.
+ "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.
"",
],
- "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*
+ "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*
}
x__xgafv: string, V1 error format.
@@ -231,7 +231,7 @@ Method Details
The object takes the form of:
{ # Request message for PredictionService.CountTokens.
- "contents": [ # Required. Input content.
+ "contents": [ # Optional. Input content.
{ # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
"parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
{ # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
@@ -265,10 +265,88 @@ Method Details
"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
},
],
- "instances": [ # Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.
+ "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.
"",
],
- "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`
+ "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`
+ "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.
+ "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+ { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+ "fileData": { # URI based data. # Optional. URI based data.
+ "fileUri": "A String", # Required. URI.
+ "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+ },
+ "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+ "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+ "a_key": "", # Properties of the object.
+ },
+ "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
+ },
+ "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+ "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+ "response": { # Required. The function response in JSON object format.
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
+ "data": "A String", # Required. Raw bytes.
+ "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+ },
+ "text": "A String", # Optional. Text part (can be code).
+ "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+ "endOffset": "A String", # Optional. The end offset of the video.
+ "startOffset": "A String", # Optional. The start offset of the video.
+ },
+ },
+ ],
+ "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+ },
+ "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
+ { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
+ "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided.
+ { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
+ "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
+ "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64.
+ "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
+ "default": "", # Optional. Default value of the data.
+ "description": "A String", # Optional. The description of the data.
+ "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
+ "A String",
+ ],
+ "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+ "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+ "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+ "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+ "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+ "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+ "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+ "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+ "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+ "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+ "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+ "nullable": True or False, # Optional. Indicates if the value may be null.
+ "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+ "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+ "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+ },
+ "required": [ # Optional. Required properties of Type.OBJECT.
+ "A String",
+ ],
+ "title": "A String", # Optional. The title of the Schema.
+ "type": "A String", # Optional. The type of the data.
+ },
+ },
+ ],
+ "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
+ },
+ "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
+ "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
+ "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+ },
+ },
+ },
+ ],
}
x__xgafv: string, V1 error format.
@@ -296,6 +374,8 @@ Method Details
{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
"createTime": "A String", # Output only. Timestamp when this Endpoint was created.
+ "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.
+ "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.
"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.
{ # A deployment of a Model. Endpoints contain one or more DeployedModels.
"automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
@@ -1262,7 +1342,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
@@ -1333,21 +1413,6 @@ Method Details
"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.
"finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
"groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content.
- "groundingAttributions": [ # Optional. List of grounding attributions.
- { # Grounding attribution.
- "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident.
- "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to.
- "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
- "partIndex": 42, # Output only. The index of a Part object within its parent Content object.
- "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
- "text": "A String", # Output only. The text corresponding to the segment from the response.
- },
- "web": { # Attribution from the web. # Optional. Attribution from the web.
- "title": "A String", # Output only. Title of the attribution.
- "uri": "A String", # Output only. URI reference of the attribution.
- },
- },
- ],
"groundingChunks": [ # List of supporting references retrieved from specified grounding source.
{ # Grounding chunk.
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
@@ -1395,6 +1460,7 @@ Method Details
"severityScore": 3.14, # Output only. Harm severity score.
},
],
+ "score": 3.14, # Output only. Confidence score of the candidate.
},
],
"promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.
@@ -1435,6 +1501,8 @@ Method Details
{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
"createTime": "A String", # Output only. Timestamp when this Endpoint was created.
+ "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.
+ "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.
"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.
{ # A deployment of a Model. Endpoints contain one or more DeployedModels.
"automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
@@ -1639,6 +1707,8 @@ Method Details
"endpoints": [ # List of Endpoints in the requested page.
{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
"createTime": "A String", # Output only. Timestamp when this Endpoint was created.
+ "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.
+ "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.
"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.
{ # A deployment of a Model. Endpoints contain one or more DeployedModels.
"automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
@@ -2036,6 +2106,8 @@ Method Details
{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
"createTime": "A String", # Output only. Timestamp when this Endpoint was created.
+ "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.
+ "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.
"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.
{ # A deployment of a Model. Endpoints contain one or more DeployedModels.
"automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
@@ -2227,6 +2299,8 @@ Method Details
{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
"createTime": "A String", # Output only. Timestamp when this Endpoint was created.
+ "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.
+ "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.
"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.
{ # A deployment of a Model. Endpoints contain one or more DeployedModels.
"automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
@@ -2843,7 +2917,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
@@ -2914,21 +2988,6 @@ Method Details
"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.
"finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
"groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content.
- "groundingAttributions": [ # Optional. List of grounding attributions.
- { # Grounding attribution.
- "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident.
- "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to.
- "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
- "partIndex": 42, # Output only. The index of a Part object within its parent Content object.
- "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
- "text": "A String", # Output only. The text corresponding to the segment from the response.
- },
- "web": { # Attribution from the web. # Optional. Attribution from the web.
- "title": "A String", # Output only. Title of the attribution.
- "uri": "A String", # Output only. URI reference of the attribution.
- },
- },
- ],
"groundingChunks": [ # List of supporting references retrieved from specified grounding source.
{ # Grounding chunk.
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
@@ -2976,6 +3035,7 @@ Method Details
"severityScore": 3.14, # Output only. Harm severity score.
},
],
+ "score": 3.14, # Output only. Confidence score of the candidate.
},
],
"promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html
index a19f08ffba7..4f891b3ba45 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html
@@ -570,6 +570,15 @@ Method Details
},
"entityId": "A String", # Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id.
"neighborCount": 42, # Optional. The number of similar entities to be retrieved from feature view for each query.
+ "numericFilters": [ # Optional. The list of numeric filters.
+ { # Numeric filter is used to search a subset of the entities by using boolean rules on numeric columns. For example: Database Point 0: {name: “a” value_int: 42} {name: “b” value_float: 1.0} Database Point 1: {name: “a” value_int: 10} {name: “b” value_float: 2.0} Database Point 2: {name: “a” value_int: -1} {name: “b” value_float: 3.0} Query: {name: “a” value_int: 12 operator: LESS} // Matches Point 1, 2 {name: “b” value_float: 2.0 operator: EQUAL} // Matches Point 1
+ "name": "A String", # Required. Column name in BigQuery that used as filters.
+ "op": "A String", # Optional. This MUST be specified for queries and must NOT be specified for database points.
+ "valueDouble": 3.14, # double value type.
+ "valueFloat": 3.14, # float value type.
+ "valueInt": "A String", # int value type.
+ },
+ ],
"parameters": { # Parameters that can be overrided in each query to tune query latency and recall. # Optional. Parameters that can be set to tune query on the fly.
"approximateNeighborCandidates": 42, # Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be > neighbor_count.
"leafNodesSearchFraction": 3.14, # Optional. The fraction of the number of leaves to search, set at query time allows user to tune search performance. This value increase result in both search accuracy and latency increase. The value should be between 0.0 and 1.0.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html
index db0bc1330e6..b6d1cb1a1cc 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html
@@ -276,6 +276,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -525,6 +526,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -816,6 +818,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -1078,6 +1081,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html b/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html
index 3b6a4c7c463..8c5da88f63b 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html
@@ -231,6 +231,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -313,6 +314,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -481,6 +483,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -563,6 +566,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -773,6 +777,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -855,6 +860,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -1036,6 +1042,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -1118,6 +1125,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html b/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html
index d753195ab0f..a0ec7bf8358 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html
@@ -82,10 +82,273 @@ Instance Methods
Close httplib2 connections.
+
+ create(parent, body=None, notebookExecutionJobId=None, x__xgafv=None)
+Creates a NotebookExecutionJob.
+
+Deletes a NotebookExecutionJob.
+
+ get(name, view=None, x__xgafv=None)
+Gets a NotebookExecutionJob.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
+Lists NotebookExecutionJobs in a Location.
+
+Retrieves the next page of results.
Method Details
close()
Close httplib2 connections.
+
+ create(parent, body=None, notebookExecutionJobId=None, x__xgafv=None)
+ Creates a NotebookExecutionJob.
+
+Args:
+ parent: string, Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # NotebookExecutionJob represents an instance of a notebook execution.
+ "createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
+ "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
+ "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
+ "dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
+ },
+ "directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
+ "content": "A String", # The base64-encoded contents of the input notebook file.
+ },
+ "displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+ "executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
+ "executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
+ "gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
+ "generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
+ "uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
+ },
+ "gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
+ "jobState": "A String", # Output only. The state of the NotebookExecutionJob.
+ "labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
+ "notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
+ "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "serviceAccount": "A String", # The service account to run the execution as.
+ "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
+ "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 is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "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.
+ },
+ "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
+}
+
+ notebookExecutionJobId: string, Optional. User specified ID for the NotebookExecutionJob.
+ 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.
+ "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.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "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 is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "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.
+ },
+ "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 be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. 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.
+ },
+}
+
+
+
+ delete(name, x__xgafv=None)
+ Deletes a NotebookExecutionJob.
+
+Args:
+ name: string, Required. The name of the NotebookExecutionJob 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:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "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.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "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 is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "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.
+ },
+ "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 be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. 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.
+ },
+}
+
+
+
+ get(name, view=None, x__xgafv=None)
+ Gets a NotebookExecutionJob.
+
+Args:
+ name: string, Required. The name of the NotebookExecutionJob resource. (required)
+ view: string, Optional. The NotebookExecutionJob view. Defaults to BASIC.
+ Allowed values
+ NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED - When unspecified, the API defaults to the BASIC view.
+ NOTEBOOK_EXECUTION_JOB_VIEW_BASIC - Includes all fields except for direct notebook inputs.
+ NOTEBOOK_EXECUTION_JOB_VIEW_FULL - Includes all fields.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # NotebookExecutionJob represents an instance of a notebook execution.
+ "createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
+ "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
+ "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
+ "dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
+ },
+ "directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
+ "content": "A String", # The base64-encoded contents of the input notebook file.
+ },
+ "displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+ "executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
+ "executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
+ "gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
+ "generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
+ "uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
+ },
+ "gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
+ "jobState": "A String", # Output only. The state of the NotebookExecutionJob.
+ "labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
+ "notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
+ "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "serviceAccount": "A String", # The service account to run the execution as.
+ "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
+ "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 is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "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.
+ },
+ "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
+}
+
+
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
+ Lists NotebookExecutionJobs in a Location.
+
+Args:
+ parent: string, Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}` (required)
+ filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`
+ orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
+ pageSize: integer, Optional. The standard list page size.
+ pageToken: string, Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobs.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.
+ view: string, Optional. The NotebookExecutionJob view. Defaults to BASIC.
+ Allowed values
+ NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED - When unspecified, the API defaults to the BASIC view.
+ NOTEBOOK_EXECUTION_JOB_VIEW_BASIC - Includes all fields except for direct notebook inputs.
+ NOTEBOOK_EXECUTION_JOB_VIEW_FULL - Includes all fields.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for [NotebookService.CreateNotebookExecutionJob]
+ "nextPageToken": "A String", # A token to retrieve next page of results. Pass to ListNotebookExecutionJobs.page_token to obtain that page.
+ "notebookExecutionJobs": [ # List of NotebookExecutionJobs in the requested page.
+ { # NotebookExecutionJob represents an instance of a notebook execution.
+ "createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
+ "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
+ "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
+ "dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
+ },
+ "directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
+ "content": "A String", # The base64-encoded contents of the input notebook file.
+ },
+ "displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+ "executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
+ "executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
+ "gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
+ "generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
+ "uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
+ },
+ "gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
+ "jobState": "A String", # Output only. The state of the NotebookExecutionJob.
+ "labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
+ "notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
+ "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+ "serviceAccount": "A String", # The service account to run the execution as.
+ "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
+ "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 is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "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.
+ },
+ "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
+ },
+ ],
+}
+
+
+
+ list_next()
+ 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.
+
+
+