Updates a user link on an account or property.
Args:
- name: string, Example format: properties/1234/userLinks/5678 (required)
+ name: string, Output only. Example format: properties/1234/userLinks/5678 (required)
body: object, The request body.
The object takes the form of:
@@ -453,8 +453,8 @@ Method Details
"directRoles": [ # Roles directly assigned to this user for this account or property. Valid values: predefinedRoles/read predefinedRoles/collaborate predefinedRoles/edit predefinedRoles/manage-users Excludes roles that are inherited from a higher-level entity, group, or organization admin role. A UserLink that is updated to have an empty list of direct_roles will be deleted.
"A String",
],
- "emailAddress": "A String", # Email address of the user to link
- "name": "A String", # Example format: properties/1234/userLinks/5678
+ "emailAddress": "A String", # Immutable. Email address of the user to link
+ "name": "A String", # Output only. Example format: properties/1234/userLinks/5678
}
x__xgafv: string, V1 error format.
@@ -469,8 +469,8 @@ Method Details
"directRoles": [ # Roles directly assigned to this user for this account or property. Valid values: predefinedRoles/read predefinedRoles/collaborate predefinedRoles/edit predefinedRoles/manage-users Excludes roles that are inherited from a higher-level entity, group, or organization admin role. A UserLink that is updated to have an empty list of direct_roles will be deleted.
"A String",
],
- "emailAddress": "A String", # Email address of the user to link
- "name": "A String", # Example format: properties/1234/userLinks/5678
+ "emailAddress": "A String", # Immutable. Email address of the user to link
+ "name": "A String", # Output only. Example format: properties/1234/userLinks/5678
}
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.userLinks.html b/docs/dyn/analyticsadmin_v1alpha.properties.userLinks.html
index 93c6976d0bd..2ed18367b27 100644
--- a/docs/dyn/analyticsadmin_v1alpha.properties.userLinks.html
+++ b/docs/dyn/analyticsadmin_v1alpha.properties.userLinks.html
@@ -186,8 +186,8 @@ Updates a user link on an account or property.
Args:
- name: string, Example format: properties/1234/userLinks/5678 (required)
+ name: string, Output only. Example format: properties/1234/userLinks/5678 (required)
body: object, The request body.
The object takes the form of:
@@ -453,8 +453,8 @@ Method Details
"directRoles": [ # Roles directly assigned to this user for this account or property. Valid values: predefinedRoles/read predefinedRoles/collaborate predefinedRoles/edit predefinedRoles/manage-users Excludes roles that are inherited from a higher-level entity, group, or organization admin role. A UserLink that is updated to have an empty list of direct_roles will be deleted.
"A String",
],
- "emailAddress": "A String", # Email address of the user to link
- "name": "A String", # Example format: properties/1234/userLinks/5678
+ "emailAddress": "A String", # Immutable. Email address of the user to link
+ "name": "A String", # Output only. Example format: properties/1234/userLinks/5678
}
x__xgafv: string, V1 error format.
@@ -469,8 +469,8 @@ Method Details
"directRoles": [ # Roles directly assigned to this user for this account or property. Valid values: predefinedRoles/read predefinedRoles/collaborate predefinedRoles/edit predefinedRoles/manage-users Excludes roles that are inherited from a higher-level entity, group, or organization admin role. A UserLink that is updated to have an empty list of direct_roles will be deleted.
"A String",
],
- "emailAddress": "A String", # Email address of the user to link
- "name": "A String", # Example format: properties/1234/userLinks/5678
+ "emailAddress": "A String", # Immutable. Email address of the user to link
+ "name": "A String", # Output only. Example format: properties/1234/userLinks/5678
}
diff --git a/docs/dyn/appengine_v1.apps.html b/docs/dyn/appengine_v1.apps.html
index 541796f206c..1e441b932b3 100644
--- a/docs/dyn/appengine_v1.apps.html
+++ b/docs/dyn/appengine_v1.apps.html
@@ -120,7 +120,7 @@ Gets information about an application.
patch(appsId, body=None, updateMask=None, x__xgafv=None)
Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application.
+Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application. iap - Identity-Aware Proxy properties for the application.
repair(appsId, body=None, x__xgafv=None)
Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.
@@ -246,7 +246,7 @@patch(appsId, body=None, updateMask=None, x__xgafv=None)
- Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application. +Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application. iap - Identity-Aware Proxy properties for the application. Args: appsId: string, Part of `name`. Name of the Application resource to update. Example: apps/myapp. (required) diff --git a/docs/dyn/appengine_v1beta.apps.html b/docs/dyn/appengine_v1beta.apps.html index 80ad5718acd..0f057715c32 100644 --- a/docs/dyn/appengine_v1beta.apps.html +++ b/docs/dyn/appengine_v1beta.apps.html @@ -120,7 +120,7 @@Instance Methods
Gets information about an application.
-
patch(appsId, body=None, updateMask=None, x__xgafv=None)Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application.
+Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application. iap - Identity-Aware Proxy properties for the application.
repair(appsId, body=None, x__xgafv=None)Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account. If you have deleted your App Engine service account, this will not be able to recreate it. Instead, you should attempt to use the IAM undelete API if possible at https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts/undelete?apix_params=%7B"name"%3A"projects%2F-%2FserviceAccounts%2Funique_id"%2C"resource"%3A%7B%7D%7D . If the deletion was recent, the numeric ID can be found in the Cloud Console Activity Log.
@@ -246,7 +246,7 @@Method Details
patch(appsId, body=None, updateMask=None, x__xgafv=None)-Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application. +Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application. iap - Identity-Aware Proxy properties for the application. Args: appsId: string, Part of `name`. Name of the Application resource to update. Example: apps/myapp. (required) diff --git a/docs/dyn/baremetalsolution_v1.html b/docs/dyn/baremetalsolution_v1.html new file mode 100644 index 00000000000..b8717fc739f --- /dev/null +++ b/docs/dyn/baremetalsolution_v1.html @@ -0,0 +1,111 @@ + + + +Bare Metal Solution API
+Instance Methods
++
+projects()+Returns the projects 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/baremetalsolution_v1.projects.html b/docs/dyn/baremetalsolution_v1.projects.html new file mode 100644 index 00000000000..6597391d876 --- /dev/null +++ b/docs/dyn/baremetalsolution_v1.projects.html @@ -0,0 +1,91 @@ + + + +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. ++Bare Metal Solution API . projects
+Instance Methods
++
+locations()+Returns the locations Resource.
+ ++
+close()Close httplib2 connections.
+Method Details
+++ + \ No newline at end of file diff --git a/docs/dyn/baremetalsolution_v1.projects.locations.html b/docs/dyn/baremetalsolution_v1.projects.locations.html new file mode 100644 index 00000000000..0433254a44d --- /dev/null +++ b/docs/dyn/baremetalsolution_v1.projects.locations.html @@ -0,0 +1,91 @@ + + + +close()+Close httplib2 connections.+Bare Metal Solution API . projects . locations
+Instance Methods
++
+instances()+Returns the instances Resource.
+ ++
+close()Close httplib2 connections.
+Method Details
+++ + \ No newline at end of file diff --git a/docs/dyn/baremetalsolution_v1.projects.locations.instances.html b/docs/dyn/baremetalsolution_v1.projects.locations.instances.html new file mode 100644 index 00000000000..a24e1e47770 --- /dev/null +++ b/docs/dyn/baremetalsolution_v1.projects.locations.instances.html @@ -0,0 +1,113 @@ + + + +close()+Close httplib2 connections.+Bare Metal Solution API . projects . locations . instances
+Instance Methods
++
+close()Close httplib2 connections.
++
+resetInstance(instance, body=None, x__xgafv=None)Perform an ungraceful, hard reset on a machine (equivalent to shutting the power off, and then turning it back on).
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index 859d1f61d1c..f0a0ffa3fc6 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -474,6 +474,11 @@resetInstance(instance, body=None, x__xgafv=None)+Perform an ungraceful, hard reset on a machine (equivalent to shutting the power off, and then turning it back on). + +Args: + instance: string, Required. Name of the instance to reset. (required) + body: object, The request body. + The object takes the form of: + +{ # Request for ResetInstance. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response for ResetInstance. +}+Method Details
"billingTier": 42, # [Output-only] Billing tier for the job. "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. "ddlAffectedRowAccessPolicyCount": "A String", # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries. + "ddlDestinationTable": { # [Output-only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + }, "ddlOperationPerformed": "A String", # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target. "ddlTargetDataset": { # [Output-only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries. "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -1076,6 +1081,11 @@Method Details
"billingTier": 42, # [Output-only] Billing tier for the job. "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. "ddlAffectedRowAccessPolicyCount": "A String", # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries. + "ddlDestinationTable": { # [Output-only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + }, "ddlOperationPerformed": "A String", # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target. "ddlTargetDataset": { # [Output-only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries. "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -1747,6 +1757,11 @@Method Details
"billingTier": 42, # [Output-only] Billing tier for the job. "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. "ddlAffectedRowAccessPolicyCount": "A String", # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries. + "ddlDestinationTable": { # [Output-only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + }, "ddlOperationPerformed": "A String", # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target. "ddlTargetDataset": { # [Output-only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries. "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -2324,6 +2339,11 @@Method Details
"billingTier": 42, # [Output-only] Billing tier for the job. "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. "ddlAffectedRowAccessPolicyCount": "A String", # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries. + "ddlDestinationTable": { # [Output-only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + }, "ddlOperationPerformed": "A String", # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target. "ddlTargetDataset": { # [Output-only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries. "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -2929,6 +2949,11 @@Method Details
"billingTier": 42, # [Output-only] Billing tier for the job. "cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache. "ddlAffectedRowAccessPolicyCount": "A String", # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries. + "ddlDestinationTable": { # [Output-only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information. + "datasetId": "A String", # [Required] The ID of the dataset containing this table. + "projectId": "A String", # [Required] The ID of the project containing this table. + "tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. + }, "ddlOperationPerformed": "A String", # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target. "ddlTargetDataset": { # [Output-only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries. "datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. diff --git a/docs/dyn/bigtableadmin_v2.projects.locations.html b/docs/dyn/bigtableadmin_v2.projects.locations.html index b5b5d1e1cf5..c135c58b9f1 100644 --- a/docs/dyn/bigtableadmin_v2.projects.locations.html +++ b/docs/dyn/bigtableadmin_v2.projects.locations.html @@ -126,7 +126,7 @@Method Details
Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/cloudchannel_v1.accounts.channelPartnerLinks.customers.html b/docs/dyn/cloudchannel_v1.accounts.channelPartnerLinks.customers.html index 4fea37e7b83..86f97d2ad9f 100644 --- a/docs/dyn/cloudchannel_v1.accounts.channelPartnerLinks.customers.html +++ b/docs/dyn/cloudchannel_v1.accounts.channelPartnerLinks.customers.html @@ -82,10 +82,10 @@Instance Methods
Creates a new Customer resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource.
-Deletes the given Customer permanently and irreversibly. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No Customer resource found for the name in the request.
+Deletes the given Customer permanently. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No Customer resource found for the name in the request.
-Returns a requested Customer resource. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource.
+Returns the requested Customer resource. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)List Customers. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of Customers, or an empty list if there are no customers.
@@ -111,9 +111,9 @@Method Details
The object takes the form of: { # Entity representing a customer of a reseller or distributor. - "alternateEmail": "A String", # Secondary contact email. Alternate email and primary contact email are required to have different domains if primary contact email is present. When creating admin.google.com accounts, users get notified credentials at this email. This email address is also used as a recovery email. + "alternateEmail": "A String", # Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. "channelPartnerId": "A String", # Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer. - "cloudIdentityId": "A String", # Output only. Customer's cloud_identity_id. Populated only if a Cloud Identity resource exists for this customer. + "cloudIdentityId": "A String", # Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource. "cloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer. "adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard. "alternateEmail": "A String", # The alternate email. @@ -128,12 +128,12 @@Method Details
"phoneNumber": "A String", # Phone number associated with the Cloud Identity. "primaryDomain": "A String", # Output only. The primary domain name. }, - "createTime": "A String", # Output only. The time at which the customer is created. - "domain": "A String", # Required. Primary domain used by the customer. Domain of primary contact email is required to be same as the provided domain. + "createTime": "A String", # Output only. Time when the customer was created. + "domain": "A String", # Required. The customer's primary domain. Must match the primary contact email's domain. "languageCode": "A String", # Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "name": "A String", # Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id} "orgDisplayName": "A String", # Required. Name of the organization that the customer entity represents. - "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Address of the organization of the customer entity. Region and zip codes are required to enforce US laws and embargoes. Valid address lines are required for all customers. Language code is discarded. Use the Customer-level language code to set the customer's language. + "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -151,14 +151,14 @@Method Details
"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. }, "primaryContactInfo": { # Contact information for a customer account. # Primary contact info. - "displayName": "A String", # Output only. Display name of the contact in the customer account. Populated by combining customer first name and last name. - "email": "A String", # Email of the contact in the customer account. Email is required for entitlements that need creation of admin.google.com accounts. The email will be the username used in credentials to access the admin.google.com account. - "firstName": "A String", # First name of the contact in the customer account. - "lastName": "A String", # Last name of the contact in the customer account. - "phone": "A String", # Phone number of the contact in the customer account. - "title": "A String", # Optional. Job title of the contact in the customer account. + "displayName": "A String", # Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name. + "email": "A String", # The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. + "firstName": "A String", # The customer account contact's first name. + "lastName": "A String", # The customer account contact's last name. + "phone": "A String", # The customer account's contact phone number. + "title": "A String", # Optional. The customer account contact's job title. }, - "updateTime": "A String", # Output only. The time at which the customer is updated. + "updateTime": "A String", # Output only. Time when the customer was updated. } x__xgafv: string, V1 error format. @@ -170,9 +170,9 @@Method Details
An object of the form: { # Entity representing a customer of a reseller or distributor. - "alternateEmail": "A String", # Secondary contact email. Alternate email and primary contact email are required to have different domains if primary contact email is present. When creating admin.google.com accounts, users get notified credentials at this email. This email address is also used as a recovery email. + "alternateEmail": "A String", # Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. "channelPartnerId": "A String", # Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer. - "cloudIdentityId": "A String", # Output only. Customer's cloud_identity_id. Populated only if a Cloud Identity resource exists for this customer. + "cloudIdentityId": "A String", # Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource. "cloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer. "adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard. "alternateEmail": "A String", # The alternate email. @@ -187,12 +187,12 @@Method Details
"phoneNumber": "A String", # Phone number associated with the Cloud Identity. "primaryDomain": "A String", # Output only. The primary domain name. }, - "createTime": "A String", # Output only. The time at which the customer is created. - "domain": "A String", # Required. Primary domain used by the customer. Domain of primary contact email is required to be same as the provided domain. + "createTime": "A String", # Output only. Time when the customer was created. + "domain": "A String", # Required. The customer's primary domain. Must match the primary contact email's domain. "languageCode": "A String", # Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "name": "A String", # Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id} "orgDisplayName": "A String", # Required. Name of the organization that the customer entity represents. - "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Address of the organization of the customer entity. Region and zip codes are required to enforce US laws and embargoes. Valid address lines are required for all customers. Language code is discarded. Use the Customer-level language code to set the customer's language. + "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -210,20 +210,20 @@Method Details
"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. }, "primaryContactInfo": { # Contact information for a customer account. # Primary contact info. - "displayName": "A String", # Output only. Display name of the contact in the customer account. Populated by combining customer first name and last name. - "email": "A String", # Email of the contact in the customer account. Email is required for entitlements that need creation of admin.google.com accounts. The email will be the username used in credentials to access the admin.google.com account. - "firstName": "A String", # First name of the contact in the customer account. - "lastName": "A String", # Last name of the contact in the customer account. - "phone": "A String", # Phone number of the contact in the customer account. - "title": "A String", # Optional. Job title of the contact in the customer account. + "displayName": "A String", # Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name. + "email": "A String", # The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. + "firstName": "A String", # The customer account contact's first name. + "lastName": "A String", # The customer account contact's last name. + "phone": "A String", # The customer account's contact phone number. + "title": "A String", # Optional. The customer account contact's job title. }, - "updateTime": "A String", # Output only. The time at which the customer is updated. + "updateTime": "A String", # Output only. Time when the customer was updated. }diff --git a/docs/dyn/cloudchannel_v1.accounts.channelPartnerLinks.html b/docs/dyn/cloudchannel_v1.accounts.channelPartnerLinks.html index 244f3c2385f..0551d762256 100644 --- a/docs/dyn/cloudchannel_v1.accounts.channelPartnerLinks.html +++ b/docs/dyn/cloudchannel_v1.accounts.channelPartnerLinks.html @@ -87,7 +87,7 @@delete(name, x__xgafv=None)-Deletes the given Customer permanently and irreversibly. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No Customer resource found for the name in the request. +Deletes the given Customer permanently. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No Customer resource found for the name in the request. Args: name: string, Required. The resource name of the customer to delete. (required) @@ -241,7 +241,7 @@Method Details
@@ -324,9 +324,9 @@get(name, x__xgafv=None)-Returns a requested Customer resource. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource. +Returns the requested Customer resource. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource. Args: name: string, Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id} (required) @@ -254,9 +254,9 @@Method Details
An object of the form: { # Entity representing a customer of a reseller or distributor. - "alternateEmail": "A String", # Secondary contact email. Alternate email and primary contact email are required to have different domains if primary contact email is present. When creating admin.google.com accounts, users get notified credentials at this email. This email address is also used as a recovery email. + "alternateEmail": "A String", # Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. "channelPartnerId": "A String", # Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer. - "cloudIdentityId": "A String", # Output only. Customer's cloud_identity_id. Populated only if a Cloud Identity resource exists for this customer. + "cloudIdentityId": "A String", # Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource. "cloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer. "adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard. "alternateEmail": "A String", # The alternate email. @@ -271,12 +271,12 @@Method Details
"phoneNumber": "A String", # Phone number associated with the Cloud Identity. "primaryDomain": "A String", # Output only. The primary domain name. }, - "createTime": "A String", # Output only. The time at which the customer is created. - "domain": "A String", # Required. Primary domain used by the customer. Domain of primary contact email is required to be same as the provided domain. + "createTime": "A String", # Output only. Time when the customer was created. + "domain": "A String", # Required. The customer's primary domain. Must match the primary contact email's domain. "languageCode": "A String", # Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "name": "A String", # Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id} "orgDisplayName": "A String", # Required. Name of the organization that the customer entity represents. - "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Address of the organization of the customer entity. Region and zip codes are required to enforce US laws and embargoes. Valid address lines are required for all customers. Language code is discarded. Use the Customer-level language code to set the customer's language. + "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -294,14 +294,14 @@Method Details
"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. }, "primaryContactInfo": { # Contact information for a customer account. # Primary contact info. - "displayName": "A String", # Output only. Display name of the contact in the customer account. Populated by combining customer first name and last name. - "email": "A String", # Email of the contact in the customer account. Email is required for entitlements that need creation of admin.google.com accounts. The email will be the username used in credentials to access the admin.google.com account. - "firstName": "A String", # First name of the contact in the customer account. - "lastName": "A String", # Last name of the contact in the customer account. - "phone": "A String", # Phone number of the contact in the customer account. - "title": "A String", # Optional. Job title of the contact in the customer account. + "displayName": "A String", # Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name. + "email": "A String", # The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. + "firstName": "A String", # The customer account contact's first name. + "lastName": "A String", # The customer account contact's last name. + "phone": "A String", # The customer account's contact phone number. + "title": "A String", # Optional. The customer account contact's job title. }, - "updateTime": "A String", # Output only. The time at which the customer is updated. + "updateTime": "A String", # Output only. Time when the customer was updated. }Method Details
{ # Response message for CloudChannelService.ListCustomers. "customers": [ # The customers belonging to a reseller or distributor. { # Entity representing a customer of a reseller or distributor. - "alternateEmail": "A String", # Secondary contact email. Alternate email and primary contact email are required to have different domains if primary contact email is present. When creating admin.google.com accounts, users get notified credentials at this email. This email address is also used as a recovery email. + "alternateEmail": "A String", # Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. "channelPartnerId": "A String", # Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer. - "cloudIdentityId": "A String", # Output only. Customer's cloud_identity_id. Populated only if a Cloud Identity resource exists for this customer. + "cloudIdentityId": "A String", # Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource. "cloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer. "adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard. "alternateEmail": "A String", # The alternate email. @@ -341,12 +341,12 @@Method Details
"phoneNumber": "A String", # Phone number associated with the Cloud Identity. "primaryDomain": "A String", # Output only. The primary domain name. }, - "createTime": "A String", # Output only. The time at which the customer is created. - "domain": "A String", # Required. Primary domain used by the customer. Domain of primary contact email is required to be same as the provided domain. + "createTime": "A String", # Output only. Time when the customer was created. + "domain": "A String", # Required. The customer's primary domain. Must match the primary contact email's domain. "languageCode": "A String", # Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "name": "A String", # Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id} "orgDisplayName": "A String", # Required. Name of the organization that the customer entity represents. - "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Address of the organization of the customer entity. Region and zip codes are required to enforce US laws and embargoes. Valid address lines are required for all customers. Language code is discarded. Use the Customer-level language code to set the customer's language. + "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -364,14 +364,14 @@Method Details
"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. }, "primaryContactInfo": { # Contact information for a customer account. # Primary contact info. - "displayName": "A String", # Output only. Display name of the contact in the customer account. Populated by combining customer first name and last name. - "email": "A String", # Email of the contact in the customer account. Email is required for entitlements that need creation of admin.google.com accounts. The email will be the username used in credentials to access the admin.google.com account. - "firstName": "A String", # First name of the contact in the customer account. - "lastName": "A String", # Last name of the contact in the customer account. - "phone": "A String", # Phone number of the contact in the customer account. - "title": "A String", # Optional. Job title of the contact in the customer account. + "displayName": "A String", # Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name. + "email": "A String", # The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. + "firstName": "A String", # The customer account contact's first name. + "lastName": "A String", # The customer account contact's last name. + "phone": "A String", # The customer account's contact phone number. + "title": "A String", # Optional. The customer account contact's job title. }, - "updateTime": "A String", # Output only. The time at which the customer is updated. + "updateTime": "A String", # Output only. Time when the customer was updated. }, ], "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListCustomersRequest.page_token to obtain that page. @@ -402,9 +402,9 @@Method Details
The object takes the form of: { # Entity representing a customer of a reseller or distributor. - "alternateEmail": "A String", # Secondary contact email. Alternate email and primary contact email are required to have different domains if primary contact email is present. When creating admin.google.com accounts, users get notified credentials at this email. This email address is also used as a recovery email. + "alternateEmail": "A String", # Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. "channelPartnerId": "A String", # Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer. - "cloudIdentityId": "A String", # Output only. Customer's cloud_identity_id. Populated only if a Cloud Identity resource exists for this customer. + "cloudIdentityId": "A String", # Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource. "cloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer. "adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard. "alternateEmail": "A String", # The alternate email. @@ -419,12 +419,12 @@Method Details
"phoneNumber": "A String", # Phone number associated with the Cloud Identity. "primaryDomain": "A String", # Output only. The primary domain name. }, - "createTime": "A String", # Output only. The time at which the customer is created. - "domain": "A String", # Required. Primary domain used by the customer. Domain of primary contact email is required to be same as the provided domain. + "createTime": "A String", # Output only. Time when the customer was created. + "domain": "A String", # Required. The customer's primary domain. Must match the primary contact email's domain. "languageCode": "A String", # Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "name": "A String", # Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id} "orgDisplayName": "A String", # Required. Name of the organization that the customer entity represents. - "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Address of the organization of the customer entity. Region and zip codes are required to enforce US laws and embargoes. Valid address lines are required for all customers. Language code is discarded. Use the Customer-level language code to set the customer's language. + "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -442,14 +442,14 @@Method Details
"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. }, "primaryContactInfo": { # Contact information for a customer account. # Primary contact info. - "displayName": "A String", # Output only. Display name of the contact in the customer account. Populated by combining customer first name and last name. - "email": "A String", # Email of the contact in the customer account. Email is required for entitlements that need creation of admin.google.com accounts. The email will be the username used in credentials to access the admin.google.com account. - "firstName": "A String", # First name of the contact in the customer account. - "lastName": "A String", # Last name of the contact in the customer account. - "phone": "A String", # Phone number of the contact in the customer account. - "title": "A String", # Optional. Job title of the contact in the customer account. + "displayName": "A String", # Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name. + "email": "A String", # The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. + "firstName": "A String", # The customer account contact's first name. + "lastName": "A String", # The customer account contact's last name. + "phone": "A String", # The customer account's contact phone number. + "title": "A String", # Optional. The customer account contact's job title. }, - "updateTime": "A String", # Output only. The time at which the customer is updated. + "updateTime": "A String", # Output only. Time when the customer was updated. } updateMask: string, The update mask that applies to the resource. Optional. @@ -462,9 +462,9 @@Method Details
An object of the form: { # Entity representing a customer of a reseller or distributor. - "alternateEmail": "A String", # Secondary contact email. Alternate email and primary contact email are required to have different domains if primary contact email is present. When creating admin.google.com accounts, users get notified credentials at this email. This email address is also used as a recovery email. + "alternateEmail": "A String", # Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. "channelPartnerId": "A String", # Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer. - "cloudIdentityId": "A String", # Output only. Customer's cloud_identity_id. Populated only if a Cloud Identity resource exists for this customer. + "cloudIdentityId": "A String", # Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource. "cloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer. "adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard. "alternateEmail": "A String", # The alternate email. @@ -479,12 +479,12 @@Method Details
"phoneNumber": "A String", # Phone number associated with the Cloud Identity. "primaryDomain": "A String", # Output only. The primary domain name. }, - "createTime": "A String", # Output only. The time at which the customer is created. - "domain": "A String", # Required. Primary domain used by the customer. Domain of primary contact email is required to be same as the provided domain. + "createTime": "A String", # Output only. Time when the customer was created. + "domain": "A String", # Required. The customer's primary domain. Must match the primary contact email's domain. "languageCode": "A String", # Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "name": "A String", # Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id} "orgDisplayName": "A String", # Required. Name of the organization that the customer entity represents. - "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Address of the organization of the customer entity. Region and zip codes are required to enforce US laws and embargoes. Valid address lines are required for all customers. Language code is discarded. Use the Customer-level language code to set the customer's language. + "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -502,14 +502,14 @@Method Details
"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. }, "primaryContactInfo": { # Contact information for a customer account. # Primary contact info. - "displayName": "A String", # Output only. Display name of the contact in the customer account. Populated by combining customer first name and last name. - "email": "A String", # Email of the contact in the customer account. Email is required for entitlements that need creation of admin.google.com accounts. The email will be the username used in credentials to access the admin.google.com account. - "firstName": "A String", # First name of the contact in the customer account. - "lastName": "A String", # Last name of the contact in the customer account. - "phone": "A String", # Phone number of the contact in the customer account. - "title": "A String", # Optional. Job title of the contact in the customer account. + "displayName": "A String", # Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name. + "email": "A String", # The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. + "firstName": "A String", # The customer account contact's first name. + "lastName": "A String", # The customer account contact's last name. + "phone": "A String", # The customer account's contact phone number. + "title": "A String", # Optional. The customer account contact's job title. }, - "updateTime": "A String", # Output only. The time at which the customer is updated. + "updateTime": "A String", # Output only. Time when the customer was updated. }Instance Methods
Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel. Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * ALREADY_EXISTS: The ChannelPartnerLink sent in the request already exists. * NOT_FOUND: No Cloud Identity customer exists for provided domain. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The new ChannelPartnerLink resource.
-
get(name, view=None, x__xgafv=None)Returns a requested ChannelPartnerLink resource. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name. Return value: The ChannelPartnerLink resource.
+Returns the requested ChannelPartnerLink resource. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name. Return value: The ChannelPartnerLink resource.
list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)List ChannelPartnerLinks belonging to a distributor. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: The list of the distributor account's ChannelPartnerLink resources.
@@ -171,7 +171,7 @@Method Details
get(name, view=None, x__xgafv=None)-Returns a requested ChannelPartnerLink resource. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name. Return value: The ChannelPartnerLink resource. +Returns the requested ChannelPartnerLink resource. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name. Return value: The ChannelPartnerLink resource. Args: name: string, Required. The resource name of the channel partner link to retrieve. Name uses the format: accounts/{account_id}/channelPartnerLinks/{id} where {id} is the Cloud Identity ID of the partner. (required) diff --git a/docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html b/docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html index 9337eeaa79a..a0fa88a69e0 100644 --- a/docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html +++ b/docs/dyn/cloudchannel_v1.accounts.customers.entitlements.html @@ -97,7 +97,7 @@Instance Methods
Creates an entitlement for a customer. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * There is already a customer entitlement for a SKU from the same product family. * INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: * The SKU was already purchased for the customer. * The customer's primary email already exists. Retry after changing the customer's primary contact email. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The domain required for purchasing a SKU has not been verified. * A pre-requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive. * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.
-Returns a requested Entitlement resource. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer entitlement was not found. Return value: The requested Entitlement resource.
+Returns the requested Entitlement resource. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer entitlement was not found. Return value: The requested Entitlement resource.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)Lists Entitlements belonging to a customer. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: A list of the customer's Entitlements.
@@ -466,7 +466,7 @@Method Details
get(name, x__xgafv=None)-Returns a requested Entitlement resource. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer entitlement was not found. Return value: The requested Entitlement resource. +Returns the requested Entitlement resource. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer entitlement was not found. Return value: The requested Entitlement resource. Args: name: string, Required. The resource name of the entitlement to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} (required) diff --git a/docs/dyn/cloudchannel_v1.accounts.customers.html b/docs/dyn/cloudchannel_v1.accounts.customers.html index a508f8daf6b..3627e55b843 100644 --- a/docs/dyn/cloudchannel_v1.accounts.customers.html +++ b/docs/dyn/cloudchannel_v1.accounts.customers.html @@ -87,10 +87,10 @@Instance Methods
Creates a new Customer resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource.
-Deletes the given Customer permanently and irreversibly. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No Customer resource found for the name in the request.
+Deletes the given Customer permanently. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No Customer resource found for the name in the request.
-Returns a requested Customer resource. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource.
+Returns the requested Customer resource. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)List Customers. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of Customers, or an empty list if there are no customers.
@@ -137,9 +137,9 @@Method Details
The object takes the form of: { # Entity representing a customer of a reseller or distributor. - "alternateEmail": "A String", # Secondary contact email. Alternate email and primary contact email are required to have different domains if primary contact email is present. When creating admin.google.com accounts, users get notified credentials at this email. This email address is also used as a recovery email. + "alternateEmail": "A String", # Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. "channelPartnerId": "A String", # Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer. - "cloudIdentityId": "A String", # Output only. Customer's cloud_identity_id. Populated only if a Cloud Identity resource exists for this customer. + "cloudIdentityId": "A String", # Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource. "cloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer. "adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard. "alternateEmail": "A String", # The alternate email. @@ -154,12 +154,12 @@Method Details
"phoneNumber": "A String", # Phone number associated with the Cloud Identity. "primaryDomain": "A String", # Output only. The primary domain name. }, - "createTime": "A String", # Output only. The time at which the customer is created. - "domain": "A String", # Required. Primary domain used by the customer. Domain of primary contact email is required to be same as the provided domain. + "createTime": "A String", # Output only. Time when the customer was created. + "domain": "A String", # Required. The customer's primary domain. Must match the primary contact email's domain. "languageCode": "A String", # Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "name": "A String", # Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id} "orgDisplayName": "A String", # Required. Name of the organization that the customer entity represents. - "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Address of the organization of the customer entity. Region and zip codes are required to enforce US laws and embargoes. Valid address lines are required for all customers. Language code is discarded. Use the Customer-level language code to set the customer's language. + "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -177,14 +177,14 @@Method Details
"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. }, "primaryContactInfo": { # Contact information for a customer account. # Primary contact info. - "displayName": "A String", # Output only. Display name of the contact in the customer account. Populated by combining customer first name and last name. - "email": "A String", # Email of the contact in the customer account. Email is required for entitlements that need creation of admin.google.com accounts. The email will be the username used in credentials to access the admin.google.com account. - "firstName": "A String", # First name of the contact in the customer account. - "lastName": "A String", # Last name of the contact in the customer account. - "phone": "A String", # Phone number of the contact in the customer account. - "title": "A String", # Optional. Job title of the contact in the customer account. + "displayName": "A String", # Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name. + "email": "A String", # The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. + "firstName": "A String", # The customer account contact's first name. + "lastName": "A String", # The customer account contact's last name. + "phone": "A String", # The customer account's contact phone number. + "title": "A String", # Optional. The customer account contact's job title. }, - "updateTime": "A String", # Output only. The time at which the customer is updated. + "updateTime": "A String", # Output only. Time when the customer was updated. } x__xgafv: string, V1 error format. @@ -196,9 +196,9 @@Method Details
An object of the form: { # Entity representing a customer of a reseller or distributor. - "alternateEmail": "A String", # Secondary contact email. Alternate email and primary contact email are required to have different domains if primary contact email is present. When creating admin.google.com accounts, users get notified credentials at this email. This email address is also used as a recovery email. + "alternateEmail": "A String", # Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. "channelPartnerId": "A String", # Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer. - "cloudIdentityId": "A String", # Output only. Customer's cloud_identity_id. Populated only if a Cloud Identity resource exists for this customer. + "cloudIdentityId": "A String", # Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource. "cloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer. "adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard. "alternateEmail": "A String", # The alternate email. @@ -213,12 +213,12 @@Method Details
"phoneNumber": "A String", # Phone number associated with the Cloud Identity. "primaryDomain": "A String", # Output only. The primary domain name. }, - "createTime": "A String", # Output only. The time at which the customer is created. - "domain": "A String", # Required. Primary domain used by the customer. Domain of primary contact email is required to be same as the provided domain. + "createTime": "A String", # Output only. Time when the customer was created. + "domain": "A String", # Required. The customer's primary domain. Must match the primary contact email's domain. "languageCode": "A String", # Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "name": "A String", # Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id} "orgDisplayName": "A String", # Required. Name of the organization that the customer entity represents. - "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Address of the organization of the customer entity. Region and zip codes are required to enforce US laws and embargoes. Valid address lines are required for all customers. Language code is discarded. Use the Customer-level language code to set the customer's language. + "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -236,20 +236,20 @@Method Details
"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. }, "primaryContactInfo": { # Contact information for a customer account. # Primary contact info. - "displayName": "A String", # Output only. Display name of the contact in the customer account. Populated by combining customer first name and last name. - "email": "A String", # Email of the contact in the customer account. Email is required for entitlements that need creation of admin.google.com accounts. The email will be the username used in credentials to access the admin.google.com account. - "firstName": "A String", # First name of the contact in the customer account. - "lastName": "A String", # Last name of the contact in the customer account. - "phone": "A String", # Phone number of the contact in the customer account. - "title": "A String", # Optional. Job title of the contact in the customer account. + "displayName": "A String", # Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name. + "email": "A String", # The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. + "firstName": "A String", # The customer account contact's first name. + "lastName": "A String", # The customer account contact's last name. + "phone": "A String", # The customer account's contact phone number. + "title": "A String", # Optional. The customer account contact's job title. }, - "updateTime": "A String", # Output only. The time at which the customer is updated. + "updateTime": "A String", # Output only. Time when the customer was updated. }diff --git a/docs/dyn/clouderrorreporting_v1beta1.projects.events.html b/docs/dyn/clouderrorreporting_v1beta1.projects.events.html index 7771c2a0a77..4742aff4dce 100644 --- a/docs/dyn/clouderrorreporting_v1beta1.projects.events.html +++ b/docs/dyn/clouderrorreporting_v1beta1.projects.events.html @@ -85,7 +85,7 @@delete(name, x__xgafv=None)-Deletes the given Customer permanently and irreversibly. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No Customer resource found for the name in the request. +Deletes the given Customer permanently. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No Customer resource found for the name in the request. Args: name: string, Required. The resource name of the customer to delete. (required) @@ -267,7 +267,7 @@Method Details
@@ -350,9 +350,9 @@get(name, x__xgafv=None)-Returns a requested Customer resource. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource. +Returns the requested Customer resource. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource. Args: name: string, Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id} (required) @@ -280,9 +280,9 @@Method Details
An object of the form: { # Entity representing a customer of a reseller or distributor. - "alternateEmail": "A String", # Secondary contact email. Alternate email and primary contact email are required to have different domains if primary contact email is present. When creating admin.google.com accounts, users get notified credentials at this email. This email address is also used as a recovery email. + "alternateEmail": "A String", # Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. "channelPartnerId": "A String", # Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer. - "cloudIdentityId": "A String", # Output only. Customer's cloud_identity_id. Populated only if a Cloud Identity resource exists for this customer. + "cloudIdentityId": "A String", # Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource. "cloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer. "adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard. "alternateEmail": "A String", # The alternate email. @@ -297,12 +297,12 @@Method Details
"phoneNumber": "A String", # Phone number associated with the Cloud Identity. "primaryDomain": "A String", # Output only. The primary domain name. }, - "createTime": "A String", # Output only. The time at which the customer is created. - "domain": "A String", # Required. Primary domain used by the customer. Domain of primary contact email is required to be same as the provided domain. + "createTime": "A String", # Output only. Time when the customer was created. + "domain": "A String", # Required. The customer's primary domain. Must match the primary contact email's domain. "languageCode": "A String", # Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "name": "A String", # Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id} "orgDisplayName": "A String", # Required. Name of the organization that the customer entity represents. - "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Address of the organization of the customer entity. Region and zip codes are required to enforce US laws and embargoes. Valid address lines are required for all customers. Language code is discarded. Use the Customer-level language code to set the customer's language. + "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -320,14 +320,14 @@Method Details
"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. }, "primaryContactInfo": { # Contact information for a customer account. # Primary contact info. - "displayName": "A String", # Output only. Display name of the contact in the customer account. Populated by combining customer first name and last name. - "email": "A String", # Email of the contact in the customer account. Email is required for entitlements that need creation of admin.google.com accounts. The email will be the username used in credentials to access the admin.google.com account. - "firstName": "A String", # First name of the contact in the customer account. - "lastName": "A String", # Last name of the contact in the customer account. - "phone": "A String", # Phone number of the contact in the customer account. - "title": "A String", # Optional. Job title of the contact in the customer account. + "displayName": "A String", # Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name. + "email": "A String", # The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. + "firstName": "A String", # The customer account contact's first name. + "lastName": "A String", # The customer account contact's last name. + "phone": "A String", # The customer account's contact phone number. + "title": "A String", # Optional. The customer account contact's job title. }, - "updateTime": "A String", # Output only. The time at which the customer is updated. + "updateTime": "A String", # Output only. Time when the customer was updated. }Method Details
{ # Response message for CloudChannelService.ListCustomers. "customers": [ # The customers belonging to a reseller or distributor. { # Entity representing a customer of a reseller or distributor. - "alternateEmail": "A String", # Secondary contact email. Alternate email and primary contact email are required to have different domains if primary contact email is present. When creating admin.google.com accounts, users get notified credentials at this email. This email address is also used as a recovery email. + "alternateEmail": "A String", # Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. "channelPartnerId": "A String", # Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer. - "cloudIdentityId": "A String", # Output only. Customer's cloud_identity_id. Populated only if a Cloud Identity resource exists for this customer. + "cloudIdentityId": "A String", # Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource. "cloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer. "adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard. "alternateEmail": "A String", # The alternate email. @@ -367,12 +367,12 @@Method Details
"phoneNumber": "A String", # Phone number associated with the Cloud Identity. "primaryDomain": "A String", # Output only. The primary domain name. }, - "createTime": "A String", # Output only. The time at which the customer is created. - "domain": "A String", # Required. Primary domain used by the customer. Domain of primary contact email is required to be same as the provided domain. + "createTime": "A String", # Output only. Time when the customer was created. + "domain": "A String", # Required. The customer's primary domain. Must match the primary contact email's domain. "languageCode": "A String", # Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "name": "A String", # Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id} "orgDisplayName": "A String", # Required. Name of the organization that the customer entity represents. - "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Address of the organization of the customer entity. Region and zip codes are required to enforce US laws and embargoes. Valid address lines are required for all customers. Language code is discarded. Use the Customer-level language code to set the customer's language. + "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -390,14 +390,14 @@Method Details
"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. }, "primaryContactInfo": { # Contact information for a customer account. # Primary contact info. - "displayName": "A String", # Output only. Display name of the contact in the customer account. Populated by combining customer first name and last name. - "email": "A String", # Email of the contact in the customer account. Email is required for entitlements that need creation of admin.google.com accounts. The email will be the username used in credentials to access the admin.google.com account. - "firstName": "A String", # First name of the contact in the customer account. - "lastName": "A String", # Last name of the contact in the customer account. - "phone": "A String", # Phone number of the contact in the customer account. - "title": "A String", # Optional. Job title of the contact in the customer account. + "displayName": "A String", # Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name. + "email": "A String", # The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. + "firstName": "A String", # The customer account contact's first name. + "lastName": "A String", # The customer account contact's last name. + "phone": "A String", # The customer account's contact phone number. + "title": "A String", # Optional. The customer account contact's job title. }, - "updateTime": "A String", # Output only. The time at which the customer is updated. + "updateTime": "A String", # Output only. Time when the customer was updated. }, ], "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListCustomersRequest.page_token to obtain that page. @@ -702,9 +702,9 @@Method Details
The object takes the form of: { # Entity representing a customer of a reseller or distributor. - "alternateEmail": "A String", # Secondary contact email. Alternate email and primary contact email are required to have different domains if primary contact email is present. When creating admin.google.com accounts, users get notified credentials at this email. This email address is also used as a recovery email. + "alternateEmail": "A String", # Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. "channelPartnerId": "A String", # Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer. - "cloudIdentityId": "A String", # Output only. Customer's cloud_identity_id. Populated only if a Cloud Identity resource exists for this customer. + "cloudIdentityId": "A String", # Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource. "cloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer. "adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard. "alternateEmail": "A String", # The alternate email. @@ -719,12 +719,12 @@Method Details
"phoneNumber": "A String", # Phone number associated with the Cloud Identity. "primaryDomain": "A String", # Output only. The primary domain name. }, - "createTime": "A String", # Output only. The time at which the customer is created. - "domain": "A String", # Required. Primary domain used by the customer. Domain of primary contact email is required to be same as the provided domain. + "createTime": "A String", # Output only. Time when the customer was created. + "domain": "A String", # Required. The customer's primary domain. Must match the primary contact email's domain. "languageCode": "A String", # Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "name": "A String", # Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id} "orgDisplayName": "A String", # Required. Name of the organization that the customer entity represents. - "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Address of the organization of the customer entity. Region and zip codes are required to enforce US laws and embargoes. Valid address lines are required for all customers. Language code is discarded. Use the Customer-level language code to set the customer's language. + "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -742,14 +742,14 @@Method Details
"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. }, "primaryContactInfo": { # Contact information for a customer account. # Primary contact info. - "displayName": "A String", # Output only. Display name of the contact in the customer account. Populated by combining customer first name and last name. - "email": "A String", # Email of the contact in the customer account. Email is required for entitlements that need creation of admin.google.com accounts. The email will be the username used in credentials to access the admin.google.com account. - "firstName": "A String", # First name of the contact in the customer account. - "lastName": "A String", # Last name of the contact in the customer account. - "phone": "A String", # Phone number of the contact in the customer account. - "title": "A String", # Optional. Job title of the contact in the customer account. + "displayName": "A String", # Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name. + "email": "A String", # The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. + "firstName": "A String", # The customer account contact's first name. + "lastName": "A String", # The customer account contact's last name. + "phone": "A String", # The customer account's contact phone number. + "title": "A String", # Optional. The customer account contact's job title. }, - "updateTime": "A String", # Output only. The time at which the customer is updated. + "updateTime": "A String", # Output only. Time when the customer was updated. } updateMask: string, The update mask that applies to the resource. Optional. @@ -762,9 +762,9 @@Method Details
An object of the form: { # Entity representing a customer of a reseller or distributor. - "alternateEmail": "A String", # Secondary contact email. Alternate email and primary contact email are required to have different domains if primary contact email is present. When creating admin.google.com accounts, users get notified credentials at this email. This email address is also used as a recovery email. + "alternateEmail": "A String", # Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. "channelPartnerId": "A String", # Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer. - "cloudIdentityId": "A String", # Output only. Customer's cloud_identity_id. Populated only if a Cloud Identity resource exists for this customer. + "cloudIdentityId": "A String", # Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource. "cloudIdentityInfo": { # Cloud Identity information for the Cloud Channel Customer. # Output only. Cloud Identity information for the customer. Populated only if a Cloud Identity account exists for this customer. "adminConsoleUri": "A String", # Output only. URI of Customer's Admin console dashboard. "alternateEmail": "A String", # The alternate email. @@ -779,12 +779,12 @@Method Details
"phoneNumber": "A String", # Phone number associated with the Cloud Identity. "primaryDomain": "A String", # Output only. The primary domain name. }, - "createTime": "A String", # Output only. The time at which the customer is created. - "domain": "A String", # Required. Primary domain used by the customer. Domain of primary contact email is required to be same as the provided domain. + "createTime": "A String", # Output only. Time when the customer was created. + "domain": "A String", # Required. The customer's primary domain. Must match the primary contact email's domain. "languageCode": "A String", # Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "name": "A String", # Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id} "orgDisplayName": "A String", # Required. Name of the organization that the customer entity represents. - "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. Address of the organization of the customer entity. Region and zip codes are required to enforce US laws and embargoes. Valid address lines are required for all customers. Language code is discarded. Use the Customer-level language code to set the customer's language. + "orgPostalAddress": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Required. The organization address for the customer. To enforce US laws and embargoes, we require a region and zip code. You must provide valid addresses for every customer. To set the customer's language, use the Customer-level language code. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", ], @@ -802,14 +802,14 @@Method Details
"sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. }, "primaryContactInfo": { # Contact information for a customer account. # Primary contact info. - "displayName": "A String", # Output only. Display name of the contact in the customer account. Populated by combining customer first name and last name. - "email": "A String", # Email of the contact in the customer account. Email is required for entitlements that need creation of admin.google.com accounts. The email will be the username used in credentials to access the admin.google.com account. - "firstName": "A String", # First name of the contact in the customer account. - "lastName": "A String", # Last name of the contact in the customer account. - "phone": "A String", # Phone number of the contact in the customer account. - "title": "A String", # Optional. Job title of the contact in the customer account. + "displayName": "A String", # Output only. The customer account contact's display name, formatted as a combination of the customer's first and last name. + "email": "A String", # The customer account's contact email. Required for entitlements that create admin.google.com accounts, and serves as the customer's username for those accounts. + "firstName": "A String", # The customer account contact's first name. + "lastName": "A String", # The customer account contact's last name. + "phone": "A String", # The customer account's contact phone number. + "title": "A String", # Optional. The customer account contact's job title. }, - "updateTime": "A String", # Output only. The time at which the customer is updated. + "updateTime": "A String", # Output only. Time when the customer was updated. }Instance Methods
Retrieves the next page of results.
-
report(projectName, body=None, x__xgafv=None)Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456` **Note:** [Error Reporting](/error-reporting) is a global service built on Cloud Logging and doesn't analyze logs stored in regional log buckets or logs routed to other Google Cloud projects. For more information, see [Using Error Reporting with regionalized logs](/error-reporting/docs/regionalization).
+Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) is a global service built on Cloud Logging and doesn't analyze logs stored in regional log buckets or logs routed to other Google Cloud projects. For more information, see [Using Error Reporting with regionalized logs] (https://cloud.google.com/error-reporting/docs/regionalization).
Method Details
close()@@ -175,7 +175,7 @@Method Details
report(projectName, body=None, x__xgafv=None)-Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456` **Note:** [Error Reporting](/error-reporting) is a global service built on Cloud Logging and doesn't analyze logs stored in regional log buckets or logs routed to other Google Cloud projects. For more information, see [Using Error Reporting with regionalized logs](/error-reporting/docs/regionalization). +Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) is a global service built on Cloud Logging and doesn't analyze logs stored in regional log buckets or logs routed to other Google Cloud projects. For more information, see [Using Error Reporting with regionalized logs] (https://cloud.google.com/error-reporting/docs/regionalization). Args: projectName: string, Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectId}`, where `{projectId}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: // `projects/my-project-123`. (required) diff --git a/docs/dyn/cloudidentity_v1.devices.deviceUsers.html b/docs/dyn/cloudidentity_v1.devices.deviceUsers.html index 9c5ff5321ea..ee70febc707 100644 --- a/docs/dyn/cloudidentity_v1.devices.deviceUsers.html +++ b/docs/dyn/cloudidentity_v1.devices.deviceUsers.html @@ -302,7 +302,7 @@Method Details
"languageCode": "A String", # Output only. Default locale used on device, in IETF BCP-47 format. "lastSyncTime": "A String", # Output only. Last time when user synced with policies. "managementState": "A String", # Output only. Management state of the user on the device. - "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the DeviceUser in format: `devices/{device_id}/deviceUsers/{user_id}`, where user_id is the ID of the user associated with the user session. + "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the DeviceUser in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where `device_user_id` uniquely identifies a user's use of a device. "passwordState": "A String", # Password state of the DeviceUser object "userAgent": "A String", # Output only. User agent on the device for this specific user "userEmail": "A String", # Email address of the user registered on the device. @@ -337,7 +337,7 @@Method Details
"languageCode": "A String", # Output only. Default locale used on device, in IETF BCP-47 format. "lastSyncTime": "A String", # Output only. Last time when user synced with policies. "managementState": "A String", # Output only. Management state of the user on the device. - "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the DeviceUser in format: `devices/{device_id}/deviceUsers/{user_id}`, where user_id is the ID of the user associated with the user session. + "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the DeviceUser in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where `device_user_id` uniquely identifies a user's use of a device. "passwordState": "A String", # Password state of the DeviceUser object "userAgent": "A String", # Output only. User agent on the device for this specific user "userEmail": "A String", # Email address of the user registered on the device. diff --git a/docs/dyn/cloudidentity_v1.groups.html b/docs/dyn/cloudidentity_v1.groups.html index 654316944b8..ef7f8039015 100644 --- a/docs/dyn/cloudidentity_v1.groups.html +++ b/docs/dyn/cloudidentity_v1.groups.html @@ -93,7 +93,7 @@Instance Methods
Retrieves a `Group`.
-
list(pageSize=None, pageToken=None, parent=None, view=None, x__xgafv=None)Lists the `Group`s under a customer or namespace.
+Lists the `Group` resources under a customer or namespace.
list_next(previous_request, previous_response)Retrieves the next page of results.
@@ -105,7 +105,7 @@Instance Methods
Updates a `Group`.
-
search(pageSize=None, pageToken=None, query=None, view=None, x__xgafv=None)Searches for `Group`s matching a specified query.
+Searches for `Group` resources matching a specified query.
search_next(previous_request, previous_response)Retrieves the next page of results.
@@ -143,11 +143,11 @@Method Details
"id": "A String", # The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. "namespace": "A String", # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}. }, - "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. Examples: {"cloudidentity.googleapis.com/groups.discussion_forum": ""} or {"system/groups/external": ""}. + "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. "a_key": "A String", }, "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. - "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. + "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn'). "updateTime": "A String", # Output only. The time when the `Group` was last updated. } @@ -254,23 +254,23 @@Method Details
"id": "A String", # The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. "namespace": "A String", # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}. }, - "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. Examples: {"cloudidentity.googleapis.com/groups.discussion_forum": ""} or {"system/groups/external": ""}. + "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. "a_key": "A String", }, "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. - "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. + "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn'). "updateTime": "A String", # Output only. The time when the `Group` was last updated. }list(pageSize=None, pageToken=None, parent=None, view=None, x__xgafv=None)-Lists the `Group`s under a customer or namespace. +Lists the `Group` resources under a customer or namespace. Args: pageSize: integer, The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `View.BASIC` and to 50 for `View.FULL`. Must not be greater than 1000 for `View.BASIC` or 500 for `View.FULL`. pageToken: string, The `next_page_token` value returned from a previous list request, if any. - parent: string, Required. The parent resource under which to list all `Group`s. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. + parent: string, Required. The parent resource under which to list all `Group` resources. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn'). view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`. Allowed values VIEW_UNSPECIFIED - Default. Should not be used. @@ -306,11 +306,11 @@Method Details
"id": "A String", # The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. "namespace": "A String", # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}. }, - "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. Examples: {"cloudidentity.googleapis.com/groups.discussion_forum": ""} or {"system/groups/external": ""}. + "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. "a_key": "A String", }, "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. - "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. + "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn'). "updateTime": "A String", # Output only. The time when the `Group` was last updated. }, ], @@ -381,11 +381,11 @@Method Details
"id": "A String", # The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. "namespace": "A String", # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}. }, - "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. Examples: {"cloudidentity.googleapis.com/groups.discussion_forum": ""} or {"system/groups/external": ""}. + "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. "a_key": "A String", }, "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. - "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. + "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn'). "updateTime": "A String", # Output only. The time when the `Group` was last updated. } @@ -421,12 +421,12 @@Method Details
search(pageSize=None, pageToken=None, query=None, view=None, x__xgafv=None)-Searches for `Group`s matching a specified query. +Searches for `Group` resources matching a specified query. Args: pageSize: integer, The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `GroupView.BASIC` and 50 for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`. pageToken: string, The `next_page_token` value returned from a previous search request, if any. - query: string, Required. The search query. Must be specified in [Common Expression Language](https://opensource.google/projects/cel). May only contain equality operators on the parent and inclusion operators on labels (e.g., `parent == 'customers/{customer_id}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels`). + query: string, Required. The search query. Must be specified in [Common Expression Language](https://opensource.google/projects/cel). May only contain equality operators on the parent and inclusion operators on labels (e.g., `parent == 'customers/{customer_id}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels`). The `customer_id` must begin with "C" (for example, 'C046psxkn'). view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`. Allowed values VIEW_UNSPECIFIED - Default. Should not be used. @@ -441,7 +441,7 @@Method Details
An object of the form: { # The response message for GroupsService.SearchGroups. - "groups": [ # The `Group`s that match the search query. + "groups": [ # The `Group` resources that match the search query. { # A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user, another group, or a service account. "createTime": "A String", # Output only. The time when the `Group` was created. "description": "A String", # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters. @@ -462,11 +462,11 @@Method Details
"id": "A String", # The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. "namespace": "A String", # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}. }, - "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. Examples: {"cloudidentity.googleapis.com/groups.discussion_forum": ""} or {"system/groups/external": ""}. + "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. "a_key": "A String", }, "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. - "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. + "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn'). "updateTime": "A String", # Output only. The time when the `Group` was last updated. }, ], diff --git a/docs/dyn/cloudidentity_v1.groups.memberships.html b/docs/dyn/cloudidentity_v1.groups.memberships.html index aaa8398e4cf..31cf220f5ee 100644 --- a/docs/dyn/cloudidentity_v1.groups.memberships.html +++ b/docs/dyn/cloudidentity_v1.groups.memberships.html @@ -408,7 +408,7 @@Method Details
], "updateRolesParams": [ # The `MembershipRole`s to be updated. Updating roles in the same request as adding or removing roles is not supported. Must not be set if either `add_roles` or `remove_roles` is set. { # The details of an update to a `MembershipRole`. - "fieldMask": "A String", # The fully-qualified names of fields to update. May only contain the field `expiry_detail`. + "fieldMask": "A String", # The fully-qualified names of fields to update. May only contain the field `expiry_detail.expire_time`. "membershipRole": { # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`. # The `MembershipRole`s to be updated. Only `MEMBER` `MembershipRole` can currently be updated. "expiryDetail": { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. Expiry details are only supported for `MEMBER` `MembershipRoles`. May be set if `name` is `MEMBER`. Must not be set if `name` is any other value. "expireTime": "A String", # The time at which the `MembershipRole` will expire. @@ -457,7 +457,7 @@Method Details
parent: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search transitive memberships in. Format: `groups/{group_id}`, where `group_id` is always '-' as this API will search across all groups for a given member. (required) pageSize: integer, The default page size is 200 (max 1000). pageToken: string, The next_page_token value returned from a previous list request, if any. - query: string, Required. A CEL expression that MUST include member specification AND label(s). This is a `required` field. Users can search on label attributes of groups. CONTAINS match ('in') is supported on labels. Certain groups are uniquely identified by both a 'member_key_id' and a 'member_key_namespace', which requires an additional query input: 'member_key_namespace'. Example query: `member_key_id == 'member_key_id_value' && in labels` + query: string, Required. A CEL expression that MUST include member specification AND label(s). This is a `required` field. Users can search on label attributes of groups. CONTAINS match ('in') is supported on labels. Identity-mapped groups are uniquely identified by both a `member_key_id` and a `member_key_namespace`, which requires an additional query input: `member_key_namespace`. Example query: `member_key_id == 'member_key_id_value' && in labels` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -523,7 +523,7 @@Method Details
{ # The response message for MembershipsService.SearchTransitiveMemberships. "memberships": [ # List of transitive members satisfying the query. { # Message representing a transitive membership of a group. - "member": "A String", # Resource name for this member if member is a GROUP, otherwise it is empty. + "member": "A String", # Resource name for this member. "preferredMemberKey": [ # Entity key has an id and a namespace. In case of discussion forums, the id will be an email address without a namespace. { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. "id": "A String", # The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. diff --git a/docs/dyn/cloudidentity_v1beta1.customers.userinvitations.html b/docs/dyn/cloudidentity_v1beta1.customers.userinvitations.html index 24e60db627e..1e26f6b8302 100644 --- a/docs/dyn/cloudidentity_v1beta1.customers.userinvitations.html +++ b/docs/dyn/cloudidentity_v1beta1.customers.userinvitations.html @@ -82,13 +82,13 @@Instance Methods
Close httplib2 connections.
-Retrieves a UserInvitation resource. **Note:** New consumer accounts with the customer’s verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.
+Retrieves a UserInvitation resource. **Note:** New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.
-
isInvitableUser(name, x__xgafv=None)Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account). Eligibility is based on the following criteria: * the email address is a consumer account and it’s the primary email address of the account, and * the domain of the email address matches an existing verified Google Workspace or Cloud Identity domain If both conditions are met, the user is eligible. **Note:** This method is not supported for Workspace Essentials customers.
+Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account). Eligibility is based on the following criteria: * the email address is a consumer account and it's the primary email address of the account, and * the domain of the email address matches an existing verified Google Workspace or Cloud Identity domain If both conditions are met, the user is eligible. **Note:** This method is not supported for Workspace Essentials customers.
-
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)Retrieves a list of UserInvitation resources. **Note:** New consumer accounts with the customer’s verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.
+Retrieves a list of UserInvitation resources. **Note:** New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.
list_next(previous_request, previous_response)Retrieves the next page of results.
@@ -144,7 +144,7 @@Method Details
get(name, x__xgafv=None)-Retrieves a UserInvitation resource. **Note:** New consumer accounts with the customer’s verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains. +Retrieves a UserInvitation resource. **Note:** New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains. Args: name: string, Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}` (required) @@ -166,7 +166,7 @@Method Details
isInvitableUser(name, x__xgafv=None)-Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account). Eligibility is based on the following criteria: * the email address is a consumer account and it’s the primary email address of the account, and * the domain of the email address matches an existing verified Google Workspace or Cloud Identity domain If both conditions are met, the user is eligible. **Note:** This method is not supported for Workspace Essentials customers. +Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account). Eligibility is based on the following criteria: * the email address is a consumer account and it's the primary email address of the account, and * the domain of the email address matches an existing verified Google Workspace or Cloud Identity domain If both conditions are met, the user is eligible. **Note:** This method is not supported for Workspace Essentials customers. Args: name: string, Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}` (required) @@ -185,7 +185,7 @@Method Details
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)-Retrieves a list of UserInvitation resources. **Note:** New consumer accounts with the customer’s verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains. +Retrieves a list of UserInvitation resources. **Note:** New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains. Args: parent: string, Required. The customer ID of the Google Workspace or Cloud Identity account the UserInvitation resources are associated with. (required) diff --git a/docs/dyn/cloudidentity_v1beta1.devices.deviceUsers.html b/docs/dyn/cloudidentity_v1beta1.devices.deviceUsers.html index 2c6a9e49be1..0198314de86 100644 --- a/docs/dyn/cloudidentity_v1beta1.devices.deviceUsers.html +++ b/docs/dyn/cloudidentity_v1beta1.devices.deviceUsers.html @@ -297,7 +297,7 @@Method Details
"languageCode": "A String", # Output only. Default locale used on device, in IETF BCP-47 format. "lastSyncTime": "A String", # Output only. Last time when user synced with policies. "managementState": "A String", # Output only. Management state of the user on the device. - "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the DeviceUser in format: `devices/{device_id}/deviceUsers/{user_id}`, where user_id is the ID of the user associated with the user session. + "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the DeviceUser in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where `device_user_id` uniquely identifies a user's use of a device. "passwordState": "A String", # Password state of the DeviceUser object "userAgent": "A String", # Output only. User agent on the device for this specific user "userEmail": "A String", # Email address of the user registered on the device. @@ -331,7 +331,7 @@Method Details
"languageCode": "A String", # Output only. Default locale used on device, in IETF BCP-47 format. "lastSyncTime": "A String", # Output only. Last time when user synced with policies. "managementState": "A String", # Output only. Management state of the user on the device. - "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the DeviceUser in format: `devices/{device_id}/deviceUsers/{user_id}`, where user_id is the ID of the user associated with the user session. + "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the DeviceUser in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where `device_user_id` uniquely identifies a user's use of a device. "passwordState": "A String", # Password state of the DeviceUser object "userAgent": "A String", # Output only. User agent on the device for this specific user "userEmail": "A String", # Email address of the user registered on the device. diff --git a/docs/dyn/cloudidentity_v1beta1.groups.html b/docs/dyn/cloudidentity_v1beta1.groups.html index 66d949a709b..b03faa6511d 100644 --- a/docs/dyn/cloudidentity_v1beta1.groups.html +++ b/docs/dyn/cloudidentity_v1beta1.groups.html @@ -93,7 +93,7 @@Instance Methods
Retrieves a `Group`.
-
list(pageSize=None, pageToken=None, parent=None, view=None, x__xgafv=None)Lists the `Group`s under a customer or namespace.
+Lists the `Group` resources under a customer or namespace.
list_next(previous_request, previous_response)Retrieves the next page of results.
@@ -105,7 +105,7 @@Instance Methods
Updates a `Group`.
-
search(pageSize=None, pageToken=None, query=None, view=None, x__xgafv=None)Searches for `Group`s matching a specified query.
+Searches for `Group` resources matching a specified query.
search_next(previous_request, previous_response)Retrieves the next page of results.
@@ -149,11 +149,11 @@Method Details
"id": "A String", # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. "namespace": "A String", # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}. }, - "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. Examples: {"cloudidentity.googleapis.com/groups.discussion_forum": ""} or {"system/groups/external": ""}. + "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. "a_key": "A String", }, "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. - "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. + "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn'). "updateTime": "A String", # Output only. The time when the `Group` was last updated. } @@ -266,23 +266,23 @@Method Details
"id": "A String", # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. "namespace": "A String", # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}. }, - "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. Examples: {"cloudidentity.googleapis.com/groups.discussion_forum": ""} or {"system/groups/external": ""}. + "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. "a_key": "A String", }, "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. - "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. + "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn'). "updateTime": "A String", # Output only. The time when the `Group` was last updated. }list(pageSize=None, pageToken=None, parent=None, view=None, x__xgafv=None)-Lists the `Group`s under a customer or namespace. +Lists the `Group` resources under a customer or namespace. Args: pageSize: integer, The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `View.BASIC` and to 50 for `View.FULL`. Must not be greater than 1000 for `View.BASIC` or 500 for `View.FULL`. pageToken: string, The `next_page_token` value returned from a previous list request, if any. - parent: string, Required. The parent resource under which to list all `Group`s. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. + parent: string, Required. The parent resource under which to list all `Group` resources. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn'). view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`. Allowed values VIEW_UNSPECIFIED - Default. Should not be used. @@ -297,7 +297,7 @@Method Details
An object of the form: { # The response message for GroupsService.ListGroups. - "groups": [ # The `Group`s under the specified `parent`. + "groups": [ # The `Group` resources under the specified `parent`. { # A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user, another group, or a service account. "additionalGroupKeys": [ # Additional entity key aliases for a Group. { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. @@ -324,11 +324,11 @@Method Details
"id": "A String", # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. "namespace": "A String", # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}. }, - "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. Examples: {"cloudidentity.googleapis.com/groups.discussion_forum": ""} or {"system/groups/external": ""}. + "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. "a_key": "A String", }, "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. - "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. + "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn'). "updateTime": "A String", # Output only. The time when the `Group` was last updated. }, ], @@ -405,11 +405,11 @@Method Details
"id": "A String", # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. "namespace": "A String", # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}. }, - "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. Examples: {"cloudidentity.googleapis.com/groups.discussion_forum": ""} or {"system/groups/external": ""}. + "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. "a_key": "A String", }, "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. - "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. + "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn'). "updateTime": "A String", # Output only. The time when the `Group` was last updated. } @@ -445,12 +445,12 @@Method Details
search(pageSize=None, pageToken=None, query=None, view=None, x__xgafv=None)-Searches for `Group`s matching a specified query. +Searches for `Group` resources matching a specified query. Args: pageSize: integer, The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`. pageToken: string, The `next_page_token` value returned from a previous search request, if any. - query: string, Required. The search query. Must be specified in [Common Expression Language](https://opensource.google/projects/cel). May only contain equality operators on the parent and inclusion operators on labels (e.g., `parent == 'customers/{customer_id}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels`). + query: string, Required. The search query. Must be specified in [Common Expression Language](https://opensource.google/projects/cel). May only contain equality operators on the parent and inclusion operators on labels (e.g., `parent == 'customers/{customer_id}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels`). The `customer_id` must begin with "C" (for example, 'C046psxkn'). view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`. Allowed values BASIC - Default. Only basic resource information is returned. @@ -464,7 +464,7 @@Method Details
An object of the form: { # The response message for GroupsService.SearchGroups. - "groups": [ # The `Group`s that match the search query. + "groups": [ # The `Group` resources that match the search query. { # A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user, another group, or a service account. "additionalGroupKeys": [ # Additional entity key aliases for a Group. { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. @@ -491,11 +491,11 @@Method Details
"id": "A String", # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. "namespace": "A String", # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}. }, - "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. Examples: {"cloudidentity.googleapis.com/groups.discussion_forum": ""} or {"system/groups/external": ""}. + "labels": { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. "a_key": "A String", }, "name": "A String", # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. - "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. + "parent": "A String", # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn'). "updateTime": "A String", # Output only. The time when the `Group` was last updated. }, ], diff --git a/docs/dyn/cloudidentity_v1beta1.groups.memberships.html b/docs/dyn/cloudidentity_v1beta1.groups.memberships.html index 83819f0974c..e683082e202 100644 --- a/docs/dyn/cloudidentity_v1beta1.groups.memberships.html +++ b/docs/dyn/cloudidentity_v1beta1.groups.memberships.html @@ -419,7 +419,7 @@Method Details
], "updateRolesParams": [ # The `MembershipRole`s to be updated. Updating roles in the same request as adding or removing roles is not supported. Must not be set if either `add_roles` or `remove_roles` is set. { # The details of an update to a `MembershipRole`. - "fieldMask": "A String", # The fully-qualified names of fields to update. May only contain the field `expiry_detail`. + "fieldMask": "A String", # The fully-qualified names of fields to update. May only contain the field `expiry_detail.expire_time`. "membershipRole": { # A membership role within the Cloud Identity Groups API. A `MembershipRole` defines the privileges granted to a `Membership`. # The `MembershipRole`s to be updated. Only `MEMBER` `MembershipRoles` can currently be updated. May only contain a `MembershipRole` with `name` `MEMBER`. "expiryDetail": { # The `MembershipRole` expiry details. # The expiry details of the `MembershipRole`. Expiry details are only supported for `MEMBER` `MembershipRoles`. May be set if `name` is `MEMBER`. Must not be set if `name` is any other value. "expireTime": "A String", # The time at which the `MembershipRole` will expire. @@ -472,7 +472,7 @@Method Details
parent: string, [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search transitive memberships in. Format: `groups/{group_id}`, where `group_id` is always '-' as this API will search across all groups for a given member. (required) pageSize: integer, The default page size is 200 (max 1000). pageToken: string, The next_page_token value returned from a previous list request, if any. - query: string, Required. A CEL expression that MUST include member specification AND label(s). This is a `required` field. Users can search on label attributes of groups. CONTAINS match ('in') is supported on labels. Certain groups are uniquely identified by both a 'member_key_id' and a 'member_key_namespace', which requires an additional query input: 'member_key_namespace'. Example query: `member_key_id == 'member_key_id_value' && in labels` + query: string, Required. A CEL expression that MUST include member specification AND label(s). This is a `required` field. Users can search on label attributes of groups. CONTAINS match ('in') is supported on labels. Identity-mapped groups are uniquely identified by both a `member_key_id` and a `member_key_namespace`, which requires an additional query input: `member_key_namespace`. Example query: `member_key_id == 'member_key_id_value' && in labels` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -538,7 +538,7 @@Method Details
{ # The response message for MembershipsService.SearchTransitiveMemberships. "memberships": [ # List of transitive members satisfying the query. { # Message representing a transitive membership of a group. - "member": "A String", # Resource name for this member if member is a GROUP, otherwise it is empty. + "member": "A String", # Resource name for this member. "preferredMemberKey": [ # Entity key has an id and a namespace. In case of discussion forums, the id will be an email address without a namespace. { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. "id": "A String", # The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. diff --git a/docs/dyn/datastore_v1.projects.html b/docs/dyn/datastore_v1.projects.html index 4f71a3fd441..96acf9cb890 100644 --- a/docs/dyn/datastore_v1.projects.html +++ b/docs/dyn/datastore_v1.projects.html @@ -248,7 +248,40 @@Method Details
], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": # Object with schema name: Value + "a_key": { # A message that can hold any of the supported value types and associated metadata. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, }, }, "update": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The entity to update. The entity must already exist. Must have a complete key path. @@ -266,7 +299,40 @@Method Details
], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": # Object with schema name: Value + "a_key": { # A message that can hold any of the supported value types and associated metadata. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, }, }, "upsert": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The entity to upsert. The entity may or may not already exist. The entity key's final path element may be incomplete. @@ -284,7 +350,40 @@Method Details
], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": # Object with schema name: Value + "a_key": { # A message that can hold any of the supported value types and associated metadata. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, }, }, }, @@ -503,7 +602,40 @@Method Details
], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": # Object with schema name: Value + "a_key": { # A message that can hold any of the supported value types and associated metadata. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, }, }, "version": "A String", # The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads. @@ -527,7 +659,40 @@Method Details
], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": # Object with schema name: Value + "a_key": { # A message that can hold any of the supported value types and associated metadata. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, }, }, "version": "A String", # The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads. @@ -625,24 +790,7 @@Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. - }, - ], - }, - "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": # Object with schema name: Value - }, - }, + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -681,24 +829,7 @@Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. - }, - ], - }, - "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": # Object with schema name: Value - }, - }, + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -759,24 +890,7 @@Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. - }, - ], - }, - "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": # Object with schema name: Value - }, - }, + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -863,7 +977,40 @@Method Details
], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": # Object with schema name: Value + "a_key": { # A message that can hold any of the supported value types and associated metadata. + "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. + "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. + # Object with schema name: Value + ], + }, + "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. + "booleanValue": True or False, # A boolean value. + "doubleValue": 3.14, # A double value. + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. + "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + "integerValue": "A String", # An integer value. + "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. + }, + ], + }, + "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. + "nullValue": "A String", # A null value. + "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. + "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. + }, }, }, "version": "A String", # The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads. @@ -902,24 +1049,7 @@Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. - }, - ], - }, - "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": # Object with schema name: Value - }, - }, + "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html b/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html index 8f47a909c04..b33ee7c162b 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html @@ -164,7 +164,7 @@Method Details
"parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value "a_key": "", # Properties of the object. }, - "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { "telephony": { "caller_id": "+18558363987" } } + "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ``` "a_key": "", # Properties of the object. }, "sessionEntityTypes": [ # Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. @@ -1041,7 +1041,7 @@Method Details
"parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value "a_key": "", # Properties of the object. }, - "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { "telephony": { "caller_id": "+18558363987" } } + "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ``` "a_key": "", # Properties of the object. }, "sessionEntityTypes": [ # Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. @@ -1895,7 +1895,7 @@Method Details
"parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value "a_key": "", # Properties of the object. }, - "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { "telephony": { "caller_id": "+18558363987" } } + "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ``` "a_key": "", # Properties of the object. }, "sessionEntityTypes": [ # Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html b/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html index a536cf2a608..82d4421d971 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html @@ -164,7 +164,7 @@Method Details
"parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value "a_key": "", # Properties of the object. }, - "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { "telephony": { "caller_id": "+18558363987" } } + "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ``` "a_key": "", # Properties of the object. }, "sessionEntityTypes": [ # Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. @@ -1041,7 +1041,7 @@Method Details
"parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value "a_key": "", # Properties of the object. }, - "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { "telephony": { "caller_id": "+18558363987" } } + "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ``` "a_key": "", # Properties of the object. }, "sessionEntityTypes": [ # Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. @@ -1895,7 +1895,7 @@Method Details
"parameters": { # Additional parameters to be put into session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: depending on parameter value type, could be one of string, number, boolean, null, list or map - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value "a_key": "", # Properties of the object. }, - "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: { "telephony": { "caller_id": "+18558363987" } } + "payload": { # This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular, for the Dialogflow Phone Gateway integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ``` "a_key": "", # Properties of the object. }, "sessionEntityTypes": [ # Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. diff --git a/docs/dyn/dlp_v2.organizations.deidentifyTemplates.html b/docs/dyn/dlp_v2.organizations.deidentifyTemplates.html index e1ea0b088ad..94bc0e0bbda 100644 --- a/docs/dyn/dlp_v2.organizations.deidentifyTemplates.html +++ b/docs/dyn/dlp_v2.organizations.deidentifyTemplates.html @@ -383,7 +383,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -1178,7 +1178,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -1995,7 +1995,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -2800,7 +2800,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -3612,7 +3612,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -4406,7 +4406,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, diff --git a/docs/dyn/dlp_v2.organizations.locations.deidentifyTemplates.html b/docs/dyn/dlp_v2.organizations.locations.deidentifyTemplates.html index b56c99ef83a..421af29bc44 100644 --- a/docs/dyn/dlp_v2.organizations.locations.deidentifyTemplates.html +++ b/docs/dyn/dlp_v2.organizations.locations.deidentifyTemplates.html @@ -383,7 +383,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -1178,7 +1178,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -1995,7 +1995,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -2800,7 +2800,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -3612,7 +3612,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -4406,7 +4406,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, diff --git a/docs/dyn/dlp_v2.projects.content.html b/docs/dyn/dlp_v2.projects.content.html index 3eff83cbe51..c43ec43daea 100644 --- a/docs/dyn/dlp_v2.projects.content.html +++ b/docs/dyn/dlp_v2.projects.content.html @@ -372,7 +372,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -1143,7 +1143,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -2648,7 +2648,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -3247,7 +3247,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, diff --git a/docs/dyn/dlp_v2.projects.deidentifyTemplates.html b/docs/dyn/dlp_v2.projects.deidentifyTemplates.html index 8d4a938e402..dbd7294c354 100644 --- a/docs/dyn/dlp_v2.projects.deidentifyTemplates.html +++ b/docs/dyn/dlp_v2.projects.deidentifyTemplates.html @@ -383,7 +383,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -1178,7 +1178,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -1995,7 +1995,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -2800,7 +2800,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -3612,7 +3612,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -4406,7 +4406,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, diff --git a/docs/dyn/dlp_v2.projects.locations.content.html b/docs/dyn/dlp_v2.projects.locations.content.html index 5e4b96fa3f5..bc47f7b5659 100644 --- a/docs/dyn/dlp_v2.projects.locations.content.html +++ b/docs/dyn/dlp_v2.projects.locations.content.html @@ -372,7 +372,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -1143,7 +1143,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -2648,7 +2648,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -3247,7 +3247,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, diff --git a/docs/dyn/dlp_v2.projects.locations.deidentifyTemplates.html b/docs/dyn/dlp_v2.projects.locations.deidentifyTemplates.html index 2667dc14e20..20937c9e4e6 100644 --- a/docs/dyn/dlp_v2.projects.locations.deidentifyTemplates.html +++ b/docs/dyn/dlp_v2.projects.locations.deidentifyTemplates.html @@ -383,7 +383,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -1178,7 +1178,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -1995,7 +1995,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -2800,7 +2800,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -3612,7 +3612,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, @@ -4406,7 +4406,7 @@Method Details
"logicalOperator": "A String", # The operator to apply to the result of conditions. Default and currently only supported value is `AND`. }, }, - "fields": [ # Required. Input field(s) to apply the transformation to. + "fields": [ # Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type". { # General identifier of a data field in a storage service. "name": "A String", # Name describing the field. }, diff --git a/docs/dyn/documentai_v1.projects.locations.processors.html b/docs/dyn/documentai_v1.projects.locations.processors.html index ebe79f8f48e..ada58e44ee2 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.html @@ -239,6 +239,7 @@Method Details
}, ], }, + "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range [0, 1]. "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead. "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any. "page": "A String", # Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. @@ -941,6 +942,7 @@Method Details
}, ], }, + "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range [0, 1]. "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead. "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any. "page": "A String", # Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. diff --git a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html index 8c352199820..29336393fb2 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html @@ -166,6 +166,7 @@Method Details
}, ], }, + "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range [0, 1]. "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead. "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any. "page": "A String", # Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. diff --git a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html index dc869cc6b4b..92a0402d921 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html @@ -229,6 +229,7 @@Method Details
}, ], }, + "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range [0, 1]. "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead. "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any. "page": "A String", # Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. @@ -931,6 +932,7 @@Method Details
}, ], }, + "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range [0, 1]. "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead. "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any. "page": "A String", # Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. diff --git a/docs/dyn/documentai_v1beta2.projects.documents.html b/docs/dyn/documentai_v1beta2.projects.documents.html index b6211580941..5d0c183655d 100644 --- a/docs/dyn/documentai_v1beta2.projects.documents.html +++ b/docs/dyn/documentai_v1beta2.projects.documents.html @@ -354,6 +354,7 @@Method Details
}, ], }, + "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range [0, 1]. "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead. "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any. "page": "A String", # Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. diff --git a/docs/dyn/documentai_v1beta2.projects.locations.documents.html b/docs/dyn/documentai_v1beta2.projects.locations.documents.html index 36685a1f7df..115c276270d 100644 --- a/docs/dyn/documentai_v1beta2.projects.locations.documents.html +++ b/docs/dyn/documentai_v1beta2.projects.locations.documents.html @@ -354,6 +354,7 @@Method Details
}, ], }, + "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range [0, 1]. "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead. "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any. "page": "A String", # Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.html index 703a0bb2849..78f680d1b17 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.html @@ -470,6 +470,7 @@Method Details
}, ], }, + "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range [0, 1]. "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead. "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any. "page": "A String", # Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. @@ -1156,6 +1157,7 @@Method Details
}, ], }, + "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range [0, 1]. "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead. "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any. "page": "A String", # Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. @@ -1858,6 +1860,7 @@Method Details
}, ], }, + "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range [0, 1]. "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead. "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any. "page": "A String", # Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html index 569fbb9ef4d..ea67f455d2e 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html @@ -166,6 +166,7 @@Method Details
}, ], }, + "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range [0, 1]. "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead. "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any. "page": "A String", # Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. @@ -852,6 +853,7 @@Method Details
}, ], }, + "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range [0, 1]. "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead. "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any. "page": "A String", # Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html index 1afb368e9fc..c853f759614 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html @@ -238,6 +238,7 @@Method Details
}, ], }, + "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range [0, 1]. "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead. "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any. "page": "A String", # Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. @@ -924,6 +925,7 @@Method Details
}, ], }, + "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range [0, 1]. "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead. "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any. "page": "A String", # Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. @@ -1626,6 +1628,7 @@Method Details
}, ], }, + "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range [0, 1]. "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead. "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any. "page": "A String", # Required. Index into the Document.pages element, for example using Document.pages to locate the related page element. diff --git a/docs/dyn/gameservices_v1beta.projects.locations.realms.gameServerClusters.html b/docs/dyn/gameservices_v1beta.projects.locations.realms.gameServerClusters.html index 227493cd107..26e3337893b 100644 --- a/docs/dyn/gameservices_v1beta.projects.locations.realms.gameServerClusters.html +++ b/docs/dyn/gameservices_v1beta.projects.locations.realms.gameServerClusters.html @@ -84,10 +84,10 @@Instance Methods
delete(name, x__xgafv=None)Deletes a single game server cluster.
+get(name, view=None, x__xgafv=None)Gets details of a single game server cluster.
-
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)Lists game server clusters in a given project and location.
@@ -96,7 +96,7 @@
list_next(previous_request, previous_response)Instance Methods
patch(name, body=None, updateMask=None, x__xgafv=None)Patches a single game server cluster.
-
+previewCreate(parent, body=None, gameServerClusterId=None, previewTime=None, x__xgafv=None)previewCreate(parent, body=None, gameServerClusterId=None, previewTime=None, view=None, x__xgafv=None)Previews creation of a new game server cluster in a given project and location.
@@ -121,6 +121,14 @@
previewDelete(name, previewTime=None, x__xgafv=None)Method Details
{ # A game server cluster resource. "allocationPriority": "A String", # Optional. The allocation priority assigned to the game server cluster. Game server clusters receive new game server allocations based on the relative allocation priorites set for each cluster, if the realm is configured for multicluster allocation. + "clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster, this will be available if 'view' is set to `FULL` in the relevant List/Get/Preview request. + "agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster. + "agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster. + "installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes. + "kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service). + "provider": "A String", # Output only. The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty. + "versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes. + }, "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters. "gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed. "cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster. @@ -206,11 +214,16 @@Method Details
-get(name, x__xgafv=None)+get(name, view=None, x__xgafv=None)Gets details of a single game server cluster. Args: name: string, Required. The name of the game server cluster to retrieve, in the following form: `projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`. (required) + view: string, Optional. View for the returned GameServerCluster objects. When `FULL` is specified, the `cluster_state` field is also returned in the GameServerCluster object, which includes the state of the referenced Kubernetes cluster such as versions and provider info. The default/unset value is GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED, same as BASIC, which does not return the `cluster_state` field. + Allowed values + GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view. + BASIC - Include basic information of a GameServerCluster resource and omit `cluster_state`. This is the default value (for ListGameServerClusters, GetGameServerCluster and PreviewCreateGameServerCluster). + FULL - Include everything. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -221,6 +234,14 @@Method Details
{ # A game server cluster resource. "allocationPriority": "A String", # Optional. The allocation priority assigned to the game server cluster. Game server clusters receive new game server allocations based on the relative allocation priorites set for each cluster, if the realm is configured for multicluster allocation. + "clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster, this will be available if 'view' is set to `FULL` in the relevant List/Get/Preview request. + "agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster. + "agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster. + "installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes. + "kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service). + "provider": "A String", # Output only. The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty. + "versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes. + }, "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters. "gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed. "cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster. @@ -242,7 +263,7 @@Method Details
-list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)Lists game server clusters in a given project and location. Args: @@ -251,6 +272,11 @@Method Details
orderBy: string, Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order. pageSize: integer, Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerClusters left to be queried. pageToken: string, Optional. The next_page_token value returned from a previous List request, if any. + view: string, Optional. View for the returned GameServerCluster objects. When `FULL` is specified, the `cluster_state` field is also returned in the GameServerCluster object, which includes the state of the referenced Kubernetes cluster such as versions and provider info. The default/unset value is GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED, same as BASIC, which does not return the `cluster_state` field. + Allowed values + GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view. + BASIC - Include basic information of a GameServerCluster resource and omit `cluster_state`. This is the default value (for ListGameServerClusters, GetGameServerCluster and PreviewCreateGameServerCluster). + FULL - Include everything. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -263,6 +289,14 @@Method Details
"gameServerClusters": [ # The list of game server clusters. { # A game server cluster resource. "allocationPriority": "A String", # Optional. The allocation priority assigned to the game server cluster. Game server clusters receive new game server allocations based on the relative allocation priorites set for each cluster, if the realm is configured for multicluster allocation. + "clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster, this will be available if 'view' is set to `FULL` in the relevant List/Get/Preview request. + "agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster. + "agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster. + "installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes. + "kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service). + "provider": "A String", # Output only. The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty. + "versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes. + }, "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters. "gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed. "cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster. @@ -314,6 +348,14 @@Method Details
{ # A game server cluster resource. "allocationPriority": "A String", # Optional. The allocation priority assigned to the game server cluster. Game server clusters receive new game server allocations based on the relative allocation priorites set for each cluster, if the realm is configured for multicluster allocation. + "clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster, this will be available if 'view' is set to `FULL` in the relevant List/Get/Preview request. + "agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster. + "agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster. + "installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes. + "kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service). + "provider": "A String", # Output only. The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty. + "versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes. + }, "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters. "gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed. "cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster. @@ -364,7 +406,7 @@Method Details
-previewCreate(parent, body=None, gameServerClusterId=None, previewTime=None, x__xgafv=None)+previewCreate(parent, body=None, gameServerClusterId=None, previewTime=None, view=None, x__xgafv=None)Previews creation of a new game server cluster in a given project and location. Args: @@ -374,6 +416,14 @@Method Details
{ # A game server cluster resource. "allocationPriority": "A String", # Optional. The allocation priority assigned to the game server cluster. Game server clusters receive new game server allocations based on the relative allocation priorites set for each cluster, if the realm is configured for multicluster allocation. + "clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster, this will be available if 'view' is set to `FULL` in the relevant List/Get/Preview request. + "agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster. + "agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster. + "installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes. + "kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service). + "provider": "A String", # Output only. The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty. + "versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes. + }, "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters. "gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed. "cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster. @@ -395,6 +445,11 @@Method Details
gameServerClusterId: string, Required. The ID of the game server cluster resource to be created. previewTime: string, Optional. The target timestamp to compute the preview. + view: string, Optional. This field is deprecated, preview will always return KubernetesClusterState. + Allowed values + GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view. + BASIC - Include basic information of a GameServerCluster resource and omit `cluster_state`. This is the default value (for ListGameServerClusters, GetGameServerCluster and PreviewCreateGameServerCluster). + FULL - Include everything. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -404,6 +459,14 @@Method Details
An object of the form: { # Response message for GameServerClustersService.PreviewCreateGameServerCluster. + "clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster in preview, this will be available if 'view' is set to `FULL` in the relevant List/Get/Preview request. + "agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster. + "agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster. + "installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes. + "kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service). + "provider": "A String", # Output only. The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty. + "versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes. + }, "etag": "A String", # The ETag of the game server cluster. "targetState": { # Encapsulates the Target state. # The target state. "details": [ # Details about Agones fleets. @@ -491,6 +554,14 @@Method Details
{ # A game server cluster resource. "allocationPriority": "A String", # Optional. The allocation priority assigned to the game server cluster. Game server clusters receive new game server allocations based on the relative allocation priorites set for each cluster, if the realm is configured for multicluster allocation. + "clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster, this will be available if 'view' is set to `FULL` in the relevant List/Get/Preview request. + "agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster. + "agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster. + "installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes. + "kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service). + "provider": "A String", # Output only. The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty. + "versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes. + }, "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters. "gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed. "cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster. diff --git a/docs/dyn/index.md b/docs/dyn/index.md index 733d22cb339..e9c5b04c47d 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -118,6 +118,10 @@ * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/assuredworkloads_v1.html) +## baremetalsolution +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/baremetalsolution_v1.html) + + ## bigquery * [v2](http://googleapis.github.io/google-api-python-client/docs/dyn/bigquery_v2.html) diff --git a/docs/dyn/logging_v2.billingAccounts.logs.html b/docs/dyn/logging_v2.billingAccounts.logs.html index 540a62ccaca..447deb5cfcc 100644 --- a/docs/dyn/logging_v2.billingAccounts.logs.html +++ b/docs/dyn/logging_v2.billingAccounts.logs.html @@ -97,7 +97,7 @@Method Details
Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. Args: - logName: string, Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/123/logs/cloudaudit.googleapis.com%2Factivity".For more information about log names, see LogEntry. (required) + logName: string, Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog".For more information about log names, see LogEntry. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/logging_v2.folders.logs.html b/docs/dyn/logging_v2.folders.logs.html index 268bee8ce4f..a390b12ed43 100644 --- a/docs/dyn/logging_v2.folders.logs.html +++ b/docs/dyn/logging_v2.folders.logs.html @@ -97,7 +97,7 @@Method Details
Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. Args: - logName: string, Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/123/logs/cloudaudit.googleapis.com%2Factivity".For more information about log names, see LogEntry. (required) + logName: string, Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog".For more information about log names, see LogEntry. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/logging_v2.logs.html b/docs/dyn/logging_v2.logs.html index 83cab718894..b68eb2e3e88 100644 --- a/docs/dyn/logging_v2.logs.html +++ b/docs/dyn/logging_v2.logs.html @@ -97,7 +97,7 @@Method Details
Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. Args: - logName: string, Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/123/logs/cloudaudit.googleapis.com%2Factivity".For more information about log names, see LogEntry. (required) + logName: string, Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog".For more information about log names, see LogEntry. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/logging_v2.organizations.logs.html b/docs/dyn/logging_v2.organizations.logs.html index dc7612edb93..878a3598633 100644 --- a/docs/dyn/logging_v2.organizations.logs.html +++ b/docs/dyn/logging_v2.organizations.logs.html @@ -97,7 +97,7 @@Method Details
Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. Args: - logName: string, Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/123/logs/cloudaudit.googleapis.com%2Factivity".For more information about log names, see LogEntry. (required) + logName: string, Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog".For more information about log names, see LogEntry. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/logging_v2.projects.logs.html b/docs/dyn/logging_v2.projects.logs.html index 7b0ad27e839..da288b4fcb8 100644 --- a/docs/dyn/logging_v2.projects.logs.html +++ b/docs/dyn/logging_v2.projects.logs.html @@ -97,7 +97,7 @@Method Details
Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. Args: - logName: string, Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/123/logs/cloudaudit.googleapis.com%2Factivity".For more information about log names, see LogEntry. (required) + logName: string, Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog".For more information about log names, see LogEntry. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/memcache_v1.projects.locations.html b/docs/dyn/memcache_v1.projects.locations.html index 78873b14ea3..f0b8ad54c60 100644 --- a/docs/dyn/memcache_v1.projects.locations.html +++ b/docs/dyn/memcache_v1.projects.locations.html @@ -136,7 +136,7 @@Method Details
Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/memcache_v1beta2.projects.locations.html b/docs/dyn/memcache_v1beta2.projects.locations.html index 02467838105..abb66e08338 100644 --- a/docs/dyn/memcache_v1beta2.projects.locations.html +++ b/docs/dyn/memcache_v1beta2.projects.locations.html @@ -136,7 +136,7 @@Method Details
Args: name: string, The resource that owns the locations collection, if applicable. (required) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). - pageSize: integer, The maximum number of results to return. If not set, the service will select a default. + pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/metastore_v1beta.projects.locations.services.metadataImports.html b/docs/dyn/metastore_v1beta.projects.locations.services.metadataImports.html index ccdffdb01e0..a7d3c4b1d03 100644 --- a/docs/dyn/metastore_v1beta.projects.locations.services.metadataImports.html +++ b/docs/dyn/metastore_v1beta.projects.locations.services.metadataImports.html @@ -108,7 +108,7 @@Method Details
The object takes the form of: { # A metastore resource that imports metadata. - "createTime": "A String", # Output only. The time when the metadata import was created. + "createTime": "A String", # Output only. The time when the metadata import was started. "databaseDump": { # A specification of the location of and metadata about a database dump from a relational database management system. # Immutable. A database dump from a pre-existing metastore's database. "databaseType": "A String", # The type of the database. "gcsUri": "A String", # A Cloud Storage object or folder URI that specifies the source from which to import metadata. It must begin with gs://. @@ -167,7 +167,7 @@Method Details
An object of the form: { # A metastore resource that imports metadata. - "createTime": "A String", # Output only. The time when the metadata import was created. + "createTime": "A String", # Output only. The time when the metadata import was started. "databaseDump": { # A specification of the location of and metadata about a database dump from a relational database management system. # Immutable. A database dump from a pre-existing metastore's database. "databaseType": "A String", # The type of the database. "gcsUri": "A String", # A Cloud Storage object or folder URI that specifies the source from which to import metadata. It must begin with gs://. @@ -202,7 +202,7 @@Method Details
{ # Response message for DataprocMetastore.ListMetadataImports. "metadataImports": [ # The imports in the specified service. { # A metastore resource that imports metadata. - "createTime": "A String", # Output only. The time when the metadata import was created. + "createTime": "A String", # Output only. The time when the metadata import was started. "databaseDump": { # A specification of the location of and metadata about a database dump from a relational database management system. # Immutable. A database dump from a pre-existing metastore's database. "databaseType": "A String", # The type of the database. "gcsUri": "A String", # A Cloud Storage object or folder URI that specifies the source from which to import metadata. It must begin with gs://. @@ -246,7 +246,7 @@Method Details
The object takes the form of: { # A metastore resource that imports metadata. - "createTime": "A String", # Output only. The time when the metadata import was created. + "createTime": "A String", # Output only. The time when the metadata import was started. "databaseDump": { # A specification of the location of and metadata about a database dump from a relational database management system. # Immutable. A database dump from a pre-existing metastore's database. "databaseType": "A String", # The type of the database. "gcsUri": "A String", # A Cloud Storage object or folder URI that specifies the source from which to import metadata. It must begin with gs://. diff --git a/docs/dyn/monitoring_v1.projects.dashboards.html b/docs/dyn/monitoring_v1.projects.dashboards.html index 6034c73a2e3..7146c53c1fe 100644 --- a/docs/dyn/monitoring_v1.projects.dashboards.html +++ b/docs/dyn/monitoring_v1.projects.dashboards.html @@ -78,7 +78,7 @@Instance Methods
close()Close httplib2 connections.
-
+create(parent, body=None, x__xgafv=None)create(parent, body=None, validateOnly=None, x__xgafv=None)Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see Managing dashboards by API. This method requires the monitoring.dashboards.create permission on the specified project. For more information about permissions, see Cloud Identity and Access Management.
@@ -93,7 +93,7 @@Instance Methods
list_next(previous_request, previous_response)Retrieves the next page of results.
-
+patch(name, body=None, x__xgafv=None)patch(name, body=None, validateOnly=None, x__xgafv=None)Replaces an existing custom dashboard with a new definition.This method requires the monitoring.dashboards.update permission on the specified dashboard. For more information, see Cloud Identity and Access Management (https://cloud.google.com/iam).
Method Details
@@ -102,7 +102,7 @@Method Details
-create(parent, body=None, x__xgafv=None)+create(parent, body=None, validateOnly=None, x__xgafv=None)Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see Managing dashboards by API. This method requires the monitoring.dashboards.create permission on the specified project. For more information about permissions, see Cloud Identity and Access Management. Args: @@ -958,6 +958,7 @@Method Details
}, } + validateOnly: boolean, If set, validate the request and preview the review, but do not actually save it. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -3581,7 +3582,7 @@Method Details
-patch(name, body=None, x__xgafv=None)+patch(name, body=None, validateOnly=None, x__xgafv=None)Replaces an existing custom dashboard with a new definition.This method requires the monitoring.dashboards.update permission on the specified dashboard. For more information, see Cloud Identity and Access Management (https://cloud.google.com/iam). Args: @@ -4437,6 +4438,7 @@Method Details
}, } + validateOnly: boolean, If set, validate the request and preview the review, but do not actually save it. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/mybusinessaccountmanagement_v1.locations.html b/docs/dyn/mybusinessaccountmanagement_v1.locations.html index 00b2ab97aab..5095990312e 100644 --- a/docs/dyn/mybusinessaccountmanagement_v1.locations.html +++ b/docs/dyn/mybusinessaccountmanagement_v1.locations.html @@ -83,7 +83,7 @@Instance Methods
close()Close httplib2 connections.
-
+transferLocation(locationsId, body=None, x__xgafv=None)transfer(name, body=None, x__xgafv=None)Moves a location from an account that the user owns to another account that the same user administers. The user must be an owner of the account the location is currently associated with and must also be at least a manager of the destination account.
Method Details
@@ -92,17 +92,16 @@Method Details
-transferLocation(locationsId, body=None, x__xgafv=None)+transfer(name, body=None, x__xgafv=None)Moves a location from an account that the user owns to another account that the same user administers. The user must be an owner of the account the location is currently associated with and must also be at least a manager of the destination account. Args: - locationsId: string, A parameter (required) + name: string, Required. The name of the location to transfer. `locations/{location_id}`. (required) body: object, The request body. The object takes the form of: { # Request message for AccessControl.TransferLocation. "destinationAccount": "A String", # Required. Name of the account resource to transfer the location to (for example, "accounts/{account}"). - "name": "A String", # Required. The name of the location to transfer. `locations/{location_id}`. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html index 83a8670417e..d7c4f748f8c 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html @@ -126,6 +126,8 @@Method Details
"createTime": "A String", # Output only. The time the test was created. "description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters. "destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test. + "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. + "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). "instance": "A String", # A Compute Engine instance URI. "ipAddress": "A String", # The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test's destination is a [global load balancer VIP](/load-balancing/docs/load-balancing-overview). "network": "A String", # A Compute Engine network URI. @@ -163,29 +165,29 @@Method Details
}, "steps": [ # A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted). The steps are ordered by the processing sequence within the simulated network state machine. It is critical to preserve the order of the steps and avoid reordering or sorting them. { # A simulated forwarding path is composed of multiple steps. Each step has a well-defined state and an associated configuration. - "abort": { # Details of the final state "abort" and associated resource. # Display info of the final state "abort" and reason. + "abort": { # Details of the final state "abort" and associated resource. # Display information of the final state "abort" and reason. "cause": "A String", # Causes that the analysis is aborted. "resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. - "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display info of a Cloud SQL instance. + "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. - "externalIp": "A String", # External IP address of Cloud SQL instance. - "internalIp": "A String", # Internal IP address of Cloud SQL instance. - "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if instance does not have one. + "externalIp": "A String", # External IP address of a Cloud SQL instance. + "internalIp": "A String", # Internal IP address of a Cloud SQL instance. + "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if the instance does not have one. "region": "A String", # Region in which the Cloud SQL instance is running. "uri": "A String", # URI of a Cloud SQL instance. }, - "deliver": { # Details of the final state "deliver" and associated resource. # Display info of the final state "deliver" and reason. + "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "resourceUri": "A String", # URI of the resource that the packet is delivered to. "target": "A String", # Target type where the packet is delivered to. }, "description": "A String", # A description of the step. Usually this is a summary of the state. - "drop": { # Details of the final state "drop" and associated resource. # Display info of the final state "drop" and reason. + "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "resourceUri": "A String", # URI of the resource that caused the drop. }, - "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display info of the source and destination under analysis. The endpoint info in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. + "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. @@ -194,7 +196,7 @@Method Details
"sourceNetworkUri": "A String", # URI of the network where this packet originates from. "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, - "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display info of a Compute Engine firewall rule. + "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display information of a Compute Engine firewall rule. "action": "A String", # Possible values: ALLOW, DENY "direction": "A String", # Possible values: INGRESS, EGRESS "displayName": "A String", # The display name of the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules. @@ -210,11 +212,11 @@Method Details
], "uri": "A String", # The URI of the VPC firewall rule. This field is not applicable to implied firewall rules or hierarchical firewall policy rules. }, - "forward": { # Details of the final state "forward" and associated resource. # Display info of the final state "forward" and reason. + "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "resourceUri": "A String", # URI of the resource that the packet is forwarded to. "target": "A String", # Target type where this packet is forwarded to. }, - "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display info of a Compute Engine forwarding rule. + "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of a Compute Engine forwarding rule. "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the test. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the test. @@ -223,13 +225,13 @@Method Details
"uri": "A String", # URI of a Compute Engine forwarding rule. "vip": "A String", # VIP of the forwarding rule. }, - "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine cluster master. # Display info of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of a Google Kubernetes Engine cluster network. - "clusterUri": "A String", # URI of a Google Kubernetes Engine cluster. - "externalIp": "A String", # External IP address of a Google Kubernetes Engine cluster master. - "internalIp": "A String", # Internal IP address of a Google Kubernetes Engine cluster master. + "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. + "clusterNetworkUri": "A String", # URI of a GKE cluster network. + "clusterUri": "A String", # URI of a GKE cluster. + "externalIp": "A String", # External IP address of a GKE cluster master. + "internalIp": "A String", # Internal IP address of a GKE cluster master. }, - "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display info of a Compute Engine instance. + "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. "interface": "A String", # Name of the network interface of a Compute Engine instance. @@ -241,7 +243,7 @@Method Details
"serviceAccount": "A String", # Service account authorized for the instance. "uri": "A String", # URI of a Compute Engine instance. }, - "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display info of the load balancers. + "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. "backendType": "A String", # Type of load balancer's backend configuration. "backendUri": "A String", # Backend configuration URI. "backends": [ # Information for the loadbalancer backends. @@ -260,13 +262,13 @@Method Details
"healthCheckUri": "A String", # URI of the health check for the load balancer. "loadBalancerType": "A String", # Type of the load balancer. }, - "network": { # For display only. Metadata associated with a Compute Engine network. # Display info of a GCP network. + "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. "displayName": "A String", # Name of a Compute Engine network. "matchedIpRange": "A String", # The IP range that matches the test. "uri": "A String", # URI of a Compute Engine network. }, "projectId": "A String", # Project ID that contains the configuration this step is validating. - "route": { # For display only. Metadata associated with a Compute Engine route. # Display info of a Compute Engine route. + "route": { # For display only. Metadata associated with a Compute Engine route. # Display information of a Compute Engine route. "destIpRange": "A String", # Destination IP range of the route. "displayName": "A String", # Name of a Compute Engine route. "instanceTags": [ # Instance tags of the route. @@ -280,18 +282,18 @@Method Details
"uri": "A String", # URI of a Compute Engine route. Dynamic route from cloud router does not have a URI. Advertised route from Google Cloud VPC to on-premises network also does not have a URI. }, "state": "A String", # Each step is in one of the pre-defined states. - "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display info of a Compute Engine VPN gateway. + "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. "networkUri": "A String", # URI of a Compute Engine network where the VPN gateway is configured. - "region": "A String", # Name of a GCP region where this VPN gateway is configured. + "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. "uri": "A String", # URI of a VPN gateway. "vpnTunnelUri": "A String", # A VPN tunnel that is associated with this VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. }, - "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display info of a Compute Engine VPN tunnel. + "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. "networkUri": "A String", # URI of a Compute Engine network where the VPN tunnel is configured. - "region": "A String", # Name of a GCP region where this VPN tunnel is configured. + "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. @@ -309,6 +311,8 @@Method Details
"A String", ], "source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test. + "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. + "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). "instance": "A String", # A Compute Engine instance URI. "ipAddress": "A String", # The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test's destination is a [global load balancer VIP](/load-balancing/docs/load-balancing-overview). "network": "A String", # A Compute Engine network URI. @@ -402,6 +406,8 @@Method Details
"createTime": "A String", # Output only. The time the test was created. "description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters. "destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test. + "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. + "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). "instance": "A String", # A Compute Engine instance URI. "ipAddress": "A String", # The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test's destination is a [global load balancer VIP](/load-balancing/docs/load-balancing-overview). "network": "A String", # A Compute Engine network URI. @@ -439,29 +445,29 @@Method Details
}, "steps": [ # A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted). The steps are ordered by the processing sequence within the simulated network state machine. It is critical to preserve the order of the steps and avoid reordering or sorting them. { # A simulated forwarding path is composed of multiple steps. Each step has a well-defined state and an associated configuration. - "abort": { # Details of the final state "abort" and associated resource. # Display info of the final state "abort" and reason. + "abort": { # Details of the final state "abort" and associated resource. # Display information of the final state "abort" and reason. "cause": "A String", # Causes that the analysis is aborted. "resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. - "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display info of a Cloud SQL instance. + "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. - "externalIp": "A String", # External IP address of Cloud SQL instance. - "internalIp": "A String", # Internal IP address of Cloud SQL instance. - "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if instance does not have one. + "externalIp": "A String", # External IP address of a Cloud SQL instance. + "internalIp": "A String", # Internal IP address of a Cloud SQL instance. + "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if the instance does not have one. "region": "A String", # Region in which the Cloud SQL instance is running. "uri": "A String", # URI of a Cloud SQL instance. }, - "deliver": { # Details of the final state "deliver" and associated resource. # Display info of the final state "deliver" and reason. + "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "resourceUri": "A String", # URI of the resource that the packet is delivered to. "target": "A String", # Target type where the packet is delivered to. }, "description": "A String", # A description of the step. Usually this is a summary of the state. - "drop": { # Details of the final state "drop" and associated resource. # Display info of the final state "drop" and reason. + "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "resourceUri": "A String", # URI of the resource that caused the drop. }, - "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display info of the source and destination under analysis. The endpoint info in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. + "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. @@ -470,7 +476,7 @@Method Details
"sourceNetworkUri": "A String", # URI of the network where this packet originates from. "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, - "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display info of a Compute Engine firewall rule. + "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display information of a Compute Engine firewall rule. "action": "A String", # Possible values: ALLOW, DENY "direction": "A String", # Possible values: INGRESS, EGRESS "displayName": "A String", # The display name of the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules. @@ -486,11 +492,11 @@Method Details
], "uri": "A String", # The URI of the VPC firewall rule. This field is not applicable to implied firewall rules or hierarchical firewall policy rules. }, - "forward": { # Details of the final state "forward" and associated resource. # Display info of the final state "forward" and reason. + "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "resourceUri": "A String", # URI of the resource that the packet is forwarded to. "target": "A String", # Target type where this packet is forwarded to. }, - "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display info of a Compute Engine forwarding rule. + "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of a Compute Engine forwarding rule. "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the test. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the test. @@ -499,13 +505,13 @@Method Details
"uri": "A String", # URI of a Compute Engine forwarding rule. "vip": "A String", # VIP of the forwarding rule. }, - "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine cluster master. # Display info of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of a Google Kubernetes Engine cluster network. - "clusterUri": "A String", # URI of a Google Kubernetes Engine cluster. - "externalIp": "A String", # External IP address of a Google Kubernetes Engine cluster master. - "internalIp": "A String", # Internal IP address of a Google Kubernetes Engine cluster master. + "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. + "clusterNetworkUri": "A String", # URI of a GKE cluster network. + "clusterUri": "A String", # URI of a GKE cluster. + "externalIp": "A String", # External IP address of a GKE cluster master. + "internalIp": "A String", # Internal IP address of a GKE cluster master. }, - "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display info of a Compute Engine instance. + "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. "interface": "A String", # Name of the network interface of a Compute Engine instance. @@ -517,7 +523,7 @@Method Details
"serviceAccount": "A String", # Service account authorized for the instance. "uri": "A String", # URI of a Compute Engine instance. }, - "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display info of the load balancers. + "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. "backendType": "A String", # Type of load balancer's backend configuration. "backendUri": "A String", # Backend configuration URI. "backends": [ # Information for the loadbalancer backends. @@ -536,13 +542,13 @@Method Details
"healthCheckUri": "A String", # URI of the health check for the load balancer. "loadBalancerType": "A String", # Type of the load balancer. }, - "network": { # For display only. Metadata associated with a Compute Engine network. # Display info of a GCP network. + "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. "displayName": "A String", # Name of a Compute Engine network. "matchedIpRange": "A String", # The IP range that matches the test. "uri": "A String", # URI of a Compute Engine network. }, "projectId": "A String", # Project ID that contains the configuration this step is validating. - "route": { # For display only. Metadata associated with a Compute Engine route. # Display info of a Compute Engine route. + "route": { # For display only. Metadata associated with a Compute Engine route. # Display information of a Compute Engine route. "destIpRange": "A String", # Destination IP range of the route. "displayName": "A String", # Name of a Compute Engine route. "instanceTags": [ # Instance tags of the route. @@ -556,18 +562,18 @@Method Details
"uri": "A String", # URI of a Compute Engine route. Dynamic route from cloud router does not have a URI. Advertised route from Google Cloud VPC to on-premises network also does not have a URI. }, "state": "A String", # Each step is in one of the pre-defined states. - "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display info of a Compute Engine VPN gateway. + "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. "networkUri": "A String", # URI of a Compute Engine network where the VPN gateway is configured. - "region": "A String", # Name of a GCP region where this VPN gateway is configured. + "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. "uri": "A String", # URI of a VPN gateway. "vpnTunnelUri": "A String", # A VPN tunnel that is associated with this VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. }, - "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display info of a Compute Engine VPN tunnel. + "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. "networkUri": "A String", # URI of a Compute Engine network where the VPN tunnel is configured. - "region": "A String", # Name of a GCP region where this VPN tunnel is configured. + "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. @@ -585,6 +591,8 @@Method Details
"A String", ], "source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test. + "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. + "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). "instance": "A String", # A Compute Engine instance URI. "ipAddress": "A String", # The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test's destination is a [global load balancer VIP](/load-balancing/docs/load-balancing-overview). "network": "A String", # A Compute Engine network URI. @@ -669,6 +677,8 @@Method Details
"createTime": "A String", # Output only. The time the test was created. "description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters. "destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test. + "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. + "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). "instance": "A String", # A Compute Engine instance URI. "ipAddress": "A String", # The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test's destination is a [global load balancer VIP](/load-balancing/docs/load-balancing-overview). "network": "A String", # A Compute Engine network URI. @@ -706,29 +716,29 @@Method Details
}, "steps": [ # A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted). The steps are ordered by the processing sequence within the simulated network state machine. It is critical to preserve the order of the steps and avoid reordering or sorting them. { # A simulated forwarding path is composed of multiple steps. Each step has a well-defined state and an associated configuration. - "abort": { # Details of the final state "abort" and associated resource. # Display info of the final state "abort" and reason. + "abort": { # Details of the final state "abort" and associated resource. # Display information of the final state "abort" and reason. "cause": "A String", # Causes that the analysis is aborted. "resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. - "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display info of a Cloud SQL instance. + "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. - "externalIp": "A String", # External IP address of Cloud SQL instance. - "internalIp": "A String", # Internal IP address of Cloud SQL instance. - "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if instance does not have one. + "externalIp": "A String", # External IP address of a Cloud SQL instance. + "internalIp": "A String", # Internal IP address of a Cloud SQL instance. + "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if the instance does not have one. "region": "A String", # Region in which the Cloud SQL instance is running. "uri": "A String", # URI of a Cloud SQL instance. }, - "deliver": { # Details of the final state "deliver" and associated resource. # Display info of the final state "deliver" and reason. + "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "resourceUri": "A String", # URI of the resource that the packet is delivered to. "target": "A String", # Target type where the packet is delivered to. }, "description": "A String", # A description of the step. Usually this is a summary of the state. - "drop": { # Details of the final state "drop" and associated resource. # Display info of the final state "drop" and reason. + "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "resourceUri": "A String", # URI of the resource that caused the drop. }, - "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display info of the source and destination under analysis. The endpoint info in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. + "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. @@ -737,7 +747,7 @@Method Details
"sourceNetworkUri": "A String", # URI of the network where this packet originates from. "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, - "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display info of a Compute Engine firewall rule. + "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display information of a Compute Engine firewall rule. "action": "A String", # Possible values: ALLOW, DENY "direction": "A String", # Possible values: INGRESS, EGRESS "displayName": "A String", # The display name of the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules. @@ -753,11 +763,11 @@Method Details
], "uri": "A String", # The URI of the VPC firewall rule. This field is not applicable to implied firewall rules or hierarchical firewall policy rules. }, - "forward": { # Details of the final state "forward" and associated resource. # Display info of the final state "forward" and reason. + "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "resourceUri": "A String", # URI of the resource that the packet is forwarded to. "target": "A String", # Target type where this packet is forwarded to. }, - "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display info of a Compute Engine forwarding rule. + "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of a Compute Engine forwarding rule. "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the test. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the test. @@ -766,13 +776,13 @@Method Details
"uri": "A String", # URI of a Compute Engine forwarding rule. "vip": "A String", # VIP of the forwarding rule. }, - "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine cluster master. # Display info of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of a Google Kubernetes Engine cluster network. - "clusterUri": "A String", # URI of a Google Kubernetes Engine cluster. - "externalIp": "A String", # External IP address of a Google Kubernetes Engine cluster master. - "internalIp": "A String", # Internal IP address of a Google Kubernetes Engine cluster master. + "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. + "clusterNetworkUri": "A String", # URI of a GKE cluster network. + "clusterUri": "A String", # URI of a GKE cluster. + "externalIp": "A String", # External IP address of a GKE cluster master. + "internalIp": "A String", # Internal IP address of a GKE cluster master. }, - "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display info of a Compute Engine instance. + "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. "interface": "A String", # Name of the network interface of a Compute Engine instance. @@ -784,7 +794,7 @@Method Details
"serviceAccount": "A String", # Service account authorized for the instance. "uri": "A String", # URI of a Compute Engine instance. }, - "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display info of the load balancers. + "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. "backendType": "A String", # Type of load balancer's backend configuration. "backendUri": "A String", # Backend configuration URI. "backends": [ # Information for the loadbalancer backends. @@ -803,13 +813,13 @@Method Details
"healthCheckUri": "A String", # URI of the health check for the load balancer. "loadBalancerType": "A String", # Type of the load balancer. }, - "network": { # For display only. Metadata associated with a Compute Engine network. # Display info of a GCP network. + "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. "displayName": "A String", # Name of a Compute Engine network. "matchedIpRange": "A String", # The IP range that matches the test. "uri": "A String", # URI of a Compute Engine network. }, "projectId": "A String", # Project ID that contains the configuration this step is validating. - "route": { # For display only. Metadata associated with a Compute Engine route. # Display info of a Compute Engine route. + "route": { # For display only. Metadata associated with a Compute Engine route. # Display information of a Compute Engine route. "destIpRange": "A String", # Destination IP range of the route. "displayName": "A String", # Name of a Compute Engine route. "instanceTags": [ # Instance tags of the route. @@ -823,18 +833,18 @@Method Details
"uri": "A String", # URI of a Compute Engine route. Dynamic route from cloud router does not have a URI. Advertised route from Google Cloud VPC to on-premises network also does not have a URI. }, "state": "A String", # Each step is in one of the pre-defined states. - "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display info of a Compute Engine VPN gateway. + "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. "networkUri": "A String", # URI of a Compute Engine network where the VPN gateway is configured. - "region": "A String", # Name of a GCP region where this VPN gateway is configured. + "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. "uri": "A String", # URI of a VPN gateway. "vpnTunnelUri": "A String", # A VPN tunnel that is associated with this VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. }, - "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display info of a Compute Engine VPN tunnel. + "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. "networkUri": "A String", # URI of a Compute Engine network where the VPN tunnel is configured. - "region": "A String", # Name of a GCP region where this VPN tunnel is configured. + "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. @@ -852,6 +862,8 @@Method Details
"A String", ], "source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test. + "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. + "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). "instance": "A String", # A Compute Engine instance URI. "ipAddress": "A String", # The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test's destination is a [global load balancer VIP](/load-balancing/docs/load-balancing-overview). "network": "A String", # A Compute Engine network URI. @@ -895,6 +907,8 @@Method Details
"createTime": "A String", # Output only. The time the test was created. "description": "A String", # The user-supplied description of the Connectivity Test. Maximum of 512 characters. "destination": { # Source or destination of the Connectivity Test. # Required. Destination specification of the Connectivity Test. You can use a combination of destination IP address, Compute Engine VM instance, or VPC network to uniquely identify the destination location. Even if the destination IP address is not unique, the source IP location is unique. Usually, the analysis can infer the destination endpoint from route information. If the destination you specify is a VM instance and the instance has multiple network interfaces, then you must also specify either a destination IP address or VPC network to identify the destination interface. A reachability analysis proceeds even if the destination location is ambiguous. However, the result can include endpoints that you don't intend to test. + "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. + "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). "instance": "A String", # A Compute Engine instance URI. "ipAddress": "A String", # The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test's destination is a [global load balancer VIP](/load-balancing/docs/load-balancing-overview). "network": "A String", # A Compute Engine network URI. @@ -932,29 +946,29 @@Method Details
}, "steps": [ # A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted). The steps are ordered by the processing sequence within the simulated network state machine. It is critical to preserve the order of the steps and avoid reordering or sorting them. { # A simulated forwarding path is composed of multiple steps. Each step has a well-defined state and an associated configuration. - "abort": { # Details of the final state "abort" and associated resource. # Display info of the final state "abort" and reason. + "abort": { # Details of the final state "abort" and associated resource. # Display information of the final state "abort" and reason. "cause": "A String", # Causes that the analysis is aborted. "resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. - "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display info of a Cloud SQL instance. + "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. - "externalIp": "A String", # External IP address of Cloud SQL instance. - "internalIp": "A String", # Internal IP address of Cloud SQL instance. - "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if instance does not have one. + "externalIp": "A String", # External IP address of a Cloud SQL instance. + "internalIp": "A String", # Internal IP address of a Cloud SQL instance. + "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if the instance does not have one. "region": "A String", # Region in which the Cloud SQL instance is running. "uri": "A String", # URI of a Cloud SQL instance. }, - "deliver": { # Details of the final state "deliver" and associated resource. # Display info of the final state "deliver" and reason. + "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "resourceUri": "A String", # URI of the resource that the packet is delivered to. "target": "A String", # Target type where the packet is delivered to. }, "description": "A String", # A description of the step. Usually this is a summary of the state. - "drop": { # Details of the final state "drop" and associated resource. # Display info of the final state "drop" and reason. + "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "resourceUri": "A String", # URI of the resource that caused the drop. }, - "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display info of the source and destination under analysis. The endpoint info in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. + "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. @@ -963,7 +977,7 @@Method Details
"sourceNetworkUri": "A String", # URI of the network where this packet originates from. "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, - "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display info of a Compute Engine firewall rule. + "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display information of a Compute Engine firewall rule. "action": "A String", # Possible values: ALLOW, DENY "direction": "A String", # Possible values: INGRESS, EGRESS "displayName": "A String", # The display name of the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules. @@ -979,11 +993,11 @@Method Details
], "uri": "A String", # The URI of the VPC firewall rule. This field is not applicable to implied firewall rules or hierarchical firewall policy rules. }, - "forward": { # Details of the final state "forward" and associated resource. # Display info of the final state "forward" and reason. + "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "resourceUri": "A String", # URI of the resource that the packet is forwarded to. "target": "A String", # Target type where this packet is forwarded to. }, - "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display info of a Compute Engine forwarding rule. + "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of a Compute Engine forwarding rule. "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the test. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the test. @@ -992,13 +1006,13 @@Method Details
"uri": "A String", # URI of a Compute Engine forwarding rule. "vip": "A String", # VIP of the forwarding rule. }, - "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine cluster master. # Display info of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of a Google Kubernetes Engine cluster network. - "clusterUri": "A String", # URI of a Google Kubernetes Engine cluster. - "externalIp": "A String", # External IP address of a Google Kubernetes Engine cluster master. - "internalIp": "A String", # Internal IP address of a Google Kubernetes Engine cluster master. + "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. + "clusterNetworkUri": "A String", # URI of a GKE cluster network. + "clusterUri": "A String", # URI of a GKE cluster. + "externalIp": "A String", # External IP address of a GKE cluster master. + "internalIp": "A String", # Internal IP address of a GKE cluster master. }, - "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display info of a Compute Engine instance. + "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. "interface": "A String", # Name of the network interface of a Compute Engine instance. @@ -1010,7 +1024,7 @@Method Details
"serviceAccount": "A String", # Service account authorized for the instance. "uri": "A String", # URI of a Compute Engine instance. }, - "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display info of the load balancers. + "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. "backendType": "A String", # Type of load balancer's backend configuration. "backendUri": "A String", # Backend configuration URI. "backends": [ # Information for the loadbalancer backends. @@ -1029,13 +1043,13 @@Method Details
"healthCheckUri": "A String", # URI of the health check for the load balancer. "loadBalancerType": "A String", # Type of the load balancer. }, - "network": { # For display only. Metadata associated with a Compute Engine network. # Display info of a GCP network. + "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. "displayName": "A String", # Name of a Compute Engine network. "matchedIpRange": "A String", # The IP range that matches the test. "uri": "A String", # URI of a Compute Engine network. }, "projectId": "A String", # Project ID that contains the configuration this step is validating. - "route": { # For display only. Metadata associated with a Compute Engine route. # Display info of a Compute Engine route. + "route": { # For display only. Metadata associated with a Compute Engine route. # Display information of a Compute Engine route. "destIpRange": "A String", # Destination IP range of the route. "displayName": "A String", # Name of a Compute Engine route. "instanceTags": [ # Instance tags of the route. @@ -1049,18 +1063,18 @@Method Details
"uri": "A String", # URI of a Compute Engine route. Dynamic route from cloud router does not have a URI. Advertised route from Google Cloud VPC to on-premises network also does not have a URI. }, "state": "A String", # Each step is in one of the pre-defined states. - "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display info of a Compute Engine VPN gateway. + "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. "networkUri": "A String", # URI of a Compute Engine network where the VPN gateway is configured. - "region": "A String", # Name of a GCP region where this VPN gateway is configured. + "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. "uri": "A String", # URI of a VPN gateway. "vpnTunnelUri": "A String", # A VPN tunnel that is associated with this VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. }, - "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display info of a Compute Engine VPN tunnel. + "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. "networkUri": "A String", # URI of a Compute Engine network where the VPN tunnel is configured. - "region": "A String", # Name of a GCP region where this VPN tunnel is configured. + "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. @@ -1078,6 +1092,8 @@Method Details
"A String", ], "source": { # Source or destination of the Connectivity Test. # Required. Source specification of the Connectivity Test. You can use a combination of source IP address, virtual machine (VM) instance, or Compute Engine network to uniquely identify the source location. Examples: If the source IP address is an internal IP address within a Google Cloud Virtual Private Cloud (VPC) network, then you must also specify the VPC network. Otherwise, specify the VM instance, which already contains its internal IP address and VPC network information. If the source of the test is within an on-premises network, then you must provide the destination VPC network. If the source endpoint is a Compute Engine VM instance with multiple network interfaces, the instance itself is not sufficient to identify the endpoint. So, you must also specify the source IP address or VPC network. A reachability analysis proceeds even if the source location is ambiguous. However, the test result may include endpoints that you don't intend to test. + "cloudSqlInstance": "A String", # A [Cloud SQL](https://cloud.google.com/sql) instance URI. + "gkeMasterCluster": "A String", # A cluster URI for [Google Kubernetes Engine master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture). "instance": "A String", # A Compute Engine instance URI. "ipAddress": "A String", # The IP address of the endpoint, which can be an external or internal IP. An IPv6 address is only allowed when the test's destination is a [global load balancer VIP](/load-balancing/docs/load-balancing-overview). "network": "A String", # A Compute Engine network URI. diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html index be3f628f16a..e31ee639203 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html @@ -198,29 +198,29 @@Method Details
}, "steps": [ # A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted). The steps are ordered by the processing sequence within the simulated network state machine. It is critical to preserve the order of the steps and avoid reordering or sorting them. { # A simulated forwarding path is composed of multiple steps. Each step has a well-defined state and an associated configuration. - "abort": { # Details of the final state "abort" and associated resource. # Display info of the final state "abort" and reason. + "abort": { # Details of the final state "abort" and associated resource. # Display information of the final state "abort" and reason. "cause": "A String", # Causes that the analysis is aborted. "resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. - "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display info of a Cloud SQL instance. + "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. - "externalIp": "A String", # External IP address of Cloud SQL instance. - "internalIp": "A String", # Internal IP address of Cloud SQL instance. - "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if instance does not have one. + "externalIp": "A String", # External IP address of a Cloud SQL instance. + "internalIp": "A String", # Internal IP address of a Cloud SQL instance. + "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if the instance does not have one. "region": "A String", # Region in which the Cloud SQL instance is running. "uri": "A String", # URI of a Cloud SQL instance. }, - "deliver": { # Details of the final state "deliver" and associated resource. # Display info of the final state "deliver" and reason. + "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "resourceUri": "A String", # URI of the resource that the packet is delivered to. "target": "A String", # Target type where the packet is delivered to. }, "description": "A String", # A description of the step. Usually this is a summary of the state. - "drop": { # Details of the final state "drop" and associated resource. # Display info of the final state "drop" and reason. + "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "resourceUri": "A String", # URI of the resource that caused the drop. }, - "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display info of the source and destination under analysis. The endpoint info in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. + "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. @@ -229,7 +229,7 @@Method Details
"sourceNetworkUri": "A String", # URI of the network where this packet originates from. "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, - "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display info of a Compute Engine firewall rule. + "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display information of a Compute Engine firewall rule. "action": "A String", # Possible values: ALLOW, DENY "direction": "A String", # Possible values: INGRESS, EGRESS "displayName": "A String", # The display name of the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules. @@ -245,11 +245,11 @@Method Details
], "uri": "A String", # The URI of the VPC firewall rule. This field is not applicable to implied firewall rules or hierarchical firewall policy rules. }, - "forward": { # Details of the final state "forward" and associated resource. # Display info of the final state "forward" and reason. + "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "resourceUri": "A String", # URI of the resource that the packet is forwarded to. "target": "A String", # Target type where this packet is forwarded to. }, - "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display info of a Compute Engine forwarding rule. + "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of a Compute Engine forwarding rule. "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the test. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the test. @@ -258,13 +258,13 @@Method Details
"uri": "A String", # URI of a Compute Engine forwarding rule. "vip": "A String", # VIP of the forwarding rule. }, - "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine cluster master. # Display info of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of a Google Kubernetes Engine cluster network. - "clusterUri": "A String", # URI of a Google Kubernetes Engine cluster. - "externalIp": "A String", # External IP address of a Google Kubernetes Engine cluster master. - "internalIp": "A String", # Internal IP address of a Google Kubernetes Engine cluster master. + "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. + "clusterNetworkUri": "A String", # URI of a GKE cluster network. + "clusterUri": "A String", # URI of a GKE cluster. + "externalIp": "A String", # External IP address of a GKE cluster master. + "internalIp": "A String", # Internal IP address of a GKE cluster master. }, - "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display info of a Compute Engine instance. + "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. "interface": "A String", # Name of the network interface of a Compute Engine instance. @@ -276,7 +276,7 @@Method Details
"serviceAccount": "A String", # Service account authorized for the instance. "uri": "A String", # URI of a Compute Engine instance. }, - "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display info of the load balancers. + "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. "backendType": "A String", # Type of load balancer's backend configuration. "backendUri": "A String", # Backend configuration URI. "backends": [ # Information for the loadbalancer backends. @@ -295,13 +295,13 @@Method Details
"healthCheckUri": "A String", # URI of the health check for the load balancer. "loadBalancerType": "A String", # Type of the load balancer. }, - "network": { # For display only. Metadata associated with a Compute Engine network. # Display info of a GCP network. + "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. "displayName": "A String", # Name of a Compute Engine network. "matchedIpRange": "A String", # The IP range that matches the test. "uri": "A String", # URI of a Compute Engine network. }, "projectId": "A String", # Project ID that contains the configuration this step is validating. - "route": { # For display only. Metadata associated with a Compute Engine route. # Display info of a Compute Engine route. + "route": { # For display only. Metadata associated with a Compute Engine route. # Display information of a Compute Engine route. "destIpRange": "A String", # Destination IP range of the route. "displayName": "A String", # Name of a Compute Engine route. "instanceTags": [ # Instance tags of the route. @@ -315,18 +315,18 @@Method Details
"uri": "A String", # URI of a Compute Engine route. Dynamic route from cloud router does not have a URI. Advertised route from Google Cloud VPC to on-premises network also does not have a URI. }, "state": "A String", # Each step is in one of the pre-defined states. - "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display info of a Compute Engine VPN gateway. + "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. "networkUri": "A String", # URI of a Compute Engine network where the VPN gateway is configured. - "region": "A String", # Name of a GCP region where this VPN gateway is configured. + "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. "uri": "A String", # URI of a VPN gateway. "vpnTunnelUri": "A String", # A VPN tunnel that is associated with this VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. }, - "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display info of a Compute Engine VPN tunnel. + "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. "networkUri": "A String", # URI of a Compute Engine network where the VPN tunnel is configured. - "region": "A String", # Name of a GCP region where this VPN tunnel is configured. + "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. @@ -511,29 +511,29 @@Method Details
}, "steps": [ # A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted). The steps are ordered by the processing sequence within the simulated network state machine. It is critical to preserve the order of the steps and avoid reordering or sorting them. { # A simulated forwarding path is composed of multiple steps. Each step has a well-defined state and an associated configuration. - "abort": { # Details of the final state "abort" and associated resource. # Display info of the final state "abort" and reason. + "abort": { # Details of the final state "abort" and associated resource. # Display information of the final state "abort" and reason. "cause": "A String", # Causes that the analysis is aborted. "resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. - "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display info of a Cloud SQL instance. + "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. - "externalIp": "A String", # External IP address of Cloud SQL instance. - "internalIp": "A String", # Internal IP address of Cloud SQL instance. - "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if instance does not have one. + "externalIp": "A String", # External IP address of a Cloud SQL instance. + "internalIp": "A String", # Internal IP address of a Cloud SQL instance. + "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if the instance does not have one. "region": "A String", # Region in which the Cloud SQL instance is running. "uri": "A String", # URI of a Cloud SQL instance. }, - "deliver": { # Details of the final state "deliver" and associated resource. # Display info of the final state "deliver" and reason. + "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "resourceUri": "A String", # URI of the resource that the packet is delivered to. "target": "A String", # Target type where the packet is delivered to. }, "description": "A String", # A description of the step. Usually this is a summary of the state. - "drop": { # Details of the final state "drop" and associated resource. # Display info of the final state "drop" and reason. + "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "resourceUri": "A String", # URI of the resource that caused the drop. }, - "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display info of the source and destination under analysis. The endpoint info in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. + "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. @@ -542,7 +542,7 @@Method Details
"sourceNetworkUri": "A String", # URI of the network where this packet originates from. "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, - "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display info of a Compute Engine firewall rule. + "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display information of a Compute Engine firewall rule. "action": "A String", # Possible values: ALLOW, DENY "direction": "A String", # Possible values: INGRESS, EGRESS "displayName": "A String", # The display name of the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules. @@ -558,11 +558,11 @@Method Details
], "uri": "A String", # The URI of the VPC firewall rule. This field is not applicable to implied firewall rules or hierarchical firewall policy rules. }, - "forward": { # Details of the final state "forward" and associated resource. # Display info of the final state "forward" and reason. + "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "resourceUri": "A String", # URI of the resource that the packet is forwarded to. "target": "A String", # Target type where this packet is forwarded to. }, - "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display info of a Compute Engine forwarding rule. + "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of a Compute Engine forwarding rule. "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the test. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the test. @@ -571,13 +571,13 @@Method Details
"uri": "A String", # URI of a Compute Engine forwarding rule. "vip": "A String", # VIP of the forwarding rule. }, - "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine cluster master. # Display info of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of a Google Kubernetes Engine cluster network. - "clusterUri": "A String", # URI of a Google Kubernetes Engine cluster. - "externalIp": "A String", # External IP address of a Google Kubernetes Engine cluster master. - "internalIp": "A String", # Internal IP address of a Google Kubernetes Engine cluster master. + "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. + "clusterNetworkUri": "A String", # URI of a GKE cluster network. + "clusterUri": "A String", # URI of a GKE cluster. + "externalIp": "A String", # External IP address of a GKE cluster master. + "internalIp": "A String", # Internal IP address of a GKE cluster master. }, - "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display info of a Compute Engine instance. + "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. "interface": "A String", # Name of the network interface of a Compute Engine instance. @@ -589,7 +589,7 @@Method Details
"serviceAccount": "A String", # Service account authorized for the instance. "uri": "A String", # URI of a Compute Engine instance. }, - "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display info of the load balancers. + "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. "backendType": "A String", # Type of load balancer's backend configuration. "backendUri": "A String", # Backend configuration URI. "backends": [ # Information for the loadbalancer backends. @@ -608,13 +608,13 @@Method Details
"healthCheckUri": "A String", # URI of the health check for the load balancer. "loadBalancerType": "A String", # Type of the load balancer. }, - "network": { # For display only. Metadata associated with a Compute Engine network. # Display info of a GCP network. + "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. "displayName": "A String", # Name of a Compute Engine network. "matchedIpRange": "A String", # The IP range that matches the test. "uri": "A String", # URI of a Compute Engine network. }, "projectId": "A String", # Project ID that contains the configuration this step is validating. - "route": { # For display only. Metadata associated with a Compute Engine route. # Display info of a Compute Engine route. + "route": { # For display only. Metadata associated with a Compute Engine route. # Display information of a Compute Engine route. "destIpRange": "A String", # Destination IP range of the route. "displayName": "A String", # Name of a Compute Engine route. "instanceTags": [ # Instance tags of the route. @@ -628,18 +628,18 @@Method Details
"uri": "A String", # URI of a Compute Engine route. Dynamic route from cloud router does not have a URI. Advertised route from Google Cloud VPC to on-premises network also does not have a URI. }, "state": "A String", # Each step is in one of the pre-defined states. - "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display info of a Compute Engine VPN gateway. + "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. "networkUri": "A String", # URI of a Compute Engine network where the VPN gateway is configured. - "region": "A String", # Name of a GCP region where this VPN gateway is configured. + "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. "uri": "A String", # URI of a VPN gateway. "vpnTunnelUri": "A String", # A VPN tunnel that is associated with this VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. }, - "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display info of a Compute Engine VPN tunnel. + "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. "networkUri": "A String", # URI of a Compute Engine network where the VPN tunnel is configured. - "region": "A String", # Name of a GCP region where this VPN tunnel is configured. + "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. @@ -815,29 +815,29 @@Method Details
}, "steps": [ # A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted). The steps are ordered by the processing sequence within the simulated network state machine. It is critical to preserve the order of the steps and avoid reordering or sorting them. { # A simulated forwarding path is composed of multiple steps. Each step has a well-defined state and an associated configuration. - "abort": { # Details of the final state "abort" and associated resource. # Display info of the final state "abort" and reason. + "abort": { # Details of the final state "abort" and associated resource. # Display information of the final state "abort" and reason. "cause": "A String", # Causes that the analysis is aborted. "resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. - "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display info of a Cloud SQL instance. + "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. - "externalIp": "A String", # External IP address of Cloud SQL instance. - "internalIp": "A String", # Internal IP address of Cloud SQL instance. - "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if instance does not have one. + "externalIp": "A String", # External IP address of a Cloud SQL instance. + "internalIp": "A String", # Internal IP address of a Cloud SQL instance. + "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if the instance does not have one. "region": "A String", # Region in which the Cloud SQL instance is running. "uri": "A String", # URI of a Cloud SQL instance. }, - "deliver": { # Details of the final state "deliver" and associated resource. # Display info of the final state "deliver" and reason. + "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "resourceUri": "A String", # URI of the resource that the packet is delivered to. "target": "A String", # Target type where the packet is delivered to. }, "description": "A String", # A description of the step. Usually this is a summary of the state. - "drop": { # Details of the final state "drop" and associated resource. # Display info of the final state "drop" and reason. + "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "resourceUri": "A String", # URI of the resource that caused the drop. }, - "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display info of the source and destination under analysis. The endpoint info in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. + "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. @@ -846,7 +846,7 @@Method Details
"sourceNetworkUri": "A String", # URI of the network where this packet originates from. "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, - "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display info of a Compute Engine firewall rule. + "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display information of a Compute Engine firewall rule. "action": "A String", # Possible values: ALLOW, DENY "direction": "A String", # Possible values: INGRESS, EGRESS "displayName": "A String", # The display name of the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules. @@ -862,11 +862,11 @@Method Details
], "uri": "A String", # The URI of the VPC firewall rule. This field is not applicable to implied firewall rules or hierarchical firewall policy rules. }, - "forward": { # Details of the final state "forward" and associated resource. # Display info of the final state "forward" and reason. + "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "resourceUri": "A String", # URI of the resource that the packet is forwarded to. "target": "A String", # Target type where this packet is forwarded to. }, - "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display info of a Compute Engine forwarding rule. + "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of a Compute Engine forwarding rule. "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the test. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the test. @@ -875,13 +875,13 @@Method Details
"uri": "A String", # URI of a Compute Engine forwarding rule. "vip": "A String", # VIP of the forwarding rule. }, - "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine cluster master. # Display info of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of a Google Kubernetes Engine cluster network. - "clusterUri": "A String", # URI of a Google Kubernetes Engine cluster. - "externalIp": "A String", # External IP address of a Google Kubernetes Engine cluster master. - "internalIp": "A String", # Internal IP address of a Google Kubernetes Engine cluster master. + "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. + "clusterNetworkUri": "A String", # URI of a GKE cluster network. + "clusterUri": "A String", # URI of a GKE cluster. + "externalIp": "A String", # External IP address of a GKE cluster master. + "internalIp": "A String", # Internal IP address of a GKE cluster master. }, - "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display info of a Compute Engine instance. + "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. "interface": "A String", # Name of the network interface of a Compute Engine instance. @@ -893,7 +893,7 @@Method Details
"serviceAccount": "A String", # Service account authorized for the instance. "uri": "A String", # URI of a Compute Engine instance. }, - "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display info of the load balancers. + "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. "backendType": "A String", # Type of load balancer's backend configuration. "backendUri": "A String", # Backend configuration URI. "backends": [ # Information for the loadbalancer backends. @@ -912,13 +912,13 @@Method Details
"healthCheckUri": "A String", # URI of the health check for the load balancer. "loadBalancerType": "A String", # Type of the load balancer. }, - "network": { # For display only. Metadata associated with a Compute Engine network. # Display info of a GCP network. + "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. "displayName": "A String", # Name of a Compute Engine network. "matchedIpRange": "A String", # The IP range that matches the test. "uri": "A String", # URI of a Compute Engine network. }, "projectId": "A String", # Project ID that contains the configuration this step is validating. - "route": { # For display only. Metadata associated with a Compute Engine route. # Display info of a Compute Engine route. + "route": { # For display only. Metadata associated with a Compute Engine route. # Display information of a Compute Engine route. "destIpRange": "A String", # Destination IP range of the route. "displayName": "A String", # Name of a Compute Engine route. "instanceTags": [ # Instance tags of the route. @@ -932,18 +932,18 @@Method Details
"uri": "A String", # URI of a Compute Engine route. Dynamic route from cloud router does not have a URI. Advertised route from Google Cloud VPC to on-premises network also does not have a URI. }, "state": "A String", # Each step is in one of the pre-defined states. - "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display info of a Compute Engine VPN gateway. + "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. "networkUri": "A String", # URI of a Compute Engine network where the VPN gateway is configured. - "region": "A String", # Name of a GCP region where this VPN gateway is configured. + "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. "uri": "A String", # URI of a VPN gateway. "vpnTunnelUri": "A String", # A VPN tunnel that is associated with this VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. }, - "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display info of a Compute Engine VPN tunnel. + "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. "networkUri": "A String", # URI of a Compute Engine network where the VPN tunnel is configured. - "region": "A String", # Name of a GCP region where this VPN tunnel is configured. + "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. @@ -1078,29 +1078,29 @@Method Details
}, "steps": [ # A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted). The steps are ordered by the processing sequence within the simulated network state machine. It is critical to preserve the order of the steps and avoid reordering or sorting them. { # A simulated forwarding path is composed of multiple steps. Each step has a well-defined state and an associated configuration. - "abort": { # Details of the final state "abort" and associated resource. # Display info of the final state "abort" and reason. + "abort": { # Details of the final state "abort" and associated resource. # Display information of the final state "abort" and reason. "cause": "A String", # Causes that the analysis is aborted. "resourceUri": "A String", # URI of the resource that caused the abort. }, "causesDrop": True or False, # This is a step that leads to the final state Drop. - "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display info of a Cloud SQL instance. + "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. - "externalIp": "A String", # External IP address of Cloud SQL instance. - "internalIp": "A String", # Internal IP address of Cloud SQL instance. - "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if instance does not have one. + "externalIp": "A String", # External IP address of a Cloud SQL instance. + "internalIp": "A String", # Internal IP address of a Cloud SQL instance. + "networkUri": "A String", # URI of a Cloud SQL instance network or empty string if the instance does not have one. "region": "A String", # Region in which the Cloud SQL instance is running. "uri": "A String", # URI of a Cloud SQL instance. }, - "deliver": { # Details of the final state "deliver" and associated resource. # Display info of the final state "deliver" and reason. + "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "resourceUri": "A String", # URI of the resource that the packet is delivered to. "target": "A String", # Target type where the packet is delivered to. }, "description": "A String", # A description of the step. Usually this is a summary of the state. - "drop": { # Details of the final state "drop" and associated resource. # Display info of the final state "drop" and reason. + "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "resourceUri": "A String", # URI of the resource that caused the drop. }, - "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display info of the source and destination under analysis. The endpoint info in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. + "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. @@ -1109,7 +1109,7 @@Method Details
"sourceNetworkUri": "A String", # URI of the network where this packet originates from. "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, - "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display info of a Compute Engine firewall rule. + "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. # Display information of a Compute Engine firewall rule. "action": "A String", # Possible values: ALLOW, DENY "direction": "A String", # Possible values: INGRESS, EGRESS "displayName": "A String", # The display name of the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules. @@ -1125,11 +1125,11 @@Method Details
], "uri": "A String", # The URI of the VPC firewall rule. This field is not applicable to implied firewall rules or hierarchical firewall policy rules. }, - "forward": { # Details of the final state "forward" and associated resource. # Display info of the final state "forward" and reason. + "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "resourceUri": "A String", # URI of the resource that the packet is forwarded to. "target": "A String", # Target type where this packet is forwarded to. }, - "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display info of a Compute Engine forwarding rule. + "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. "displayName": "A String", # Name of a Compute Engine forwarding rule. "matchedPortRange": "A String", # Port range defined in the forwarding rule that matches the test. "matchedProtocol": "A String", # Protocol defined in the forwarding rule that matches the test. @@ -1138,13 +1138,13 @@Method Details
"uri": "A String", # URI of a Compute Engine forwarding rule. "vip": "A String", # VIP of the forwarding rule. }, - "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine cluster master. # Display info of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of a Google Kubernetes Engine cluster network. - "clusterUri": "A String", # URI of a Google Kubernetes Engine cluster. - "externalIp": "A String", # External IP address of a Google Kubernetes Engine cluster master. - "internalIp": "A String", # Internal IP address of a Google Kubernetes Engine cluster master. + "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. + "clusterNetworkUri": "A String", # URI of a GKE cluster network. + "clusterUri": "A String", # URI of a GKE cluster. + "externalIp": "A String", # External IP address of a GKE cluster master. + "internalIp": "A String", # Internal IP address of a GKE cluster master. }, - "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display info of a Compute Engine instance. + "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. "externalIp": "A String", # External IP address of the network interface. "interface": "A String", # Name of the network interface of a Compute Engine instance. @@ -1156,7 +1156,7 @@Method Details
"serviceAccount": "A String", # Service account authorized for the instance. "uri": "A String", # URI of a Compute Engine instance. }, - "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display info of the load balancers. + "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. "backendType": "A String", # Type of load balancer's backend configuration. "backendUri": "A String", # Backend configuration URI. "backends": [ # Information for the loadbalancer backends. @@ -1175,13 +1175,13 @@Method Details
"healthCheckUri": "A String", # URI of the health check for the load balancer. "loadBalancerType": "A String", # Type of the load balancer. }, - "network": { # For display only. Metadata associated with a Compute Engine network. # Display info of a GCP network. + "network": { # For display only. Metadata associated with a Compute Engine network. # Display information of a Google Cloud network. "displayName": "A String", # Name of a Compute Engine network. "matchedIpRange": "A String", # The IP range that matches the test. "uri": "A String", # URI of a Compute Engine network. }, "projectId": "A String", # Project ID that contains the configuration this step is validating. - "route": { # For display only. Metadata associated with a Compute Engine route. # Display info of a Compute Engine route. + "route": { # For display only. Metadata associated with a Compute Engine route. # Display information of a Compute Engine route. "destIpRange": "A String", # Destination IP range of the route. "displayName": "A String", # Name of a Compute Engine route. "instanceTags": [ # Instance tags of the route. @@ -1195,18 +1195,18 @@Method Details
"uri": "A String", # URI of a Compute Engine route. Dynamic route from cloud router does not have a URI. Advertised route from Google Cloud VPC to on-premises network also does not have a URI. }, "state": "A String", # Each step is in one of the pre-defined states. - "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display info of a Compute Engine VPN gateway. + "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. "networkUri": "A String", # URI of a Compute Engine network where the VPN gateway is configured. - "region": "A String", # Name of a GCP region where this VPN gateway is configured. + "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. "uri": "A String", # URI of a VPN gateway. "vpnTunnelUri": "A String", # A VPN tunnel that is associated with this VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. }, - "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display info of a Compute Engine VPN tunnel. + "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. "networkUri": "A String", # URI of a Compute Engine network where the VPN tunnel is configured. - "region": "A String", # Name of a GCP region where this VPN tunnel is configured. + "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. diff --git a/docs/dyn/oslogin_v1beta.users.html b/docs/dyn/oslogin_v1beta.users.html index 7161152092e..98a426d02d5 100644 --- a/docs/dyn/oslogin_v1beta.users.html +++ b/docs/dyn/oslogin_v1beta.users.html @@ -88,10 +88,10 @@Instance Methods
close()Close httplib2 connections.
-
+getLoginProfile(name, projectId=None, systemId=None, x__xgafv=None)getLoginProfile(name, projectId=None, systemId=None, view=None, x__xgafv=None)Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.
-
+importSshPublicKey(parent, body=None, projectId=None, x__xgafv=None)importSshPublicKey(parent, body=None, projectId=None, view=None, x__xgafv=None)Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.
Method Details
@@ -100,13 +100,18 @@Method Details
-getLoginProfile(name, projectId=None, systemId=None, x__xgafv=None)+getLoginProfile(name, projectId=None, systemId=None, view=None, x__xgafv=None)Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine. Args: name: string, Required. The unique ID for the user in format `users/{user}`. (required) projectId: string, The project ID of the Google Cloud Platform project. systemId: string, A system ID for filtering the results of the request. + view: string, The view configures whether to retrieve security keys information. + Allowed values + LOGIN_PROFILE_VIEW_UNSPECIFIED - The default login profile view. The API defaults to the BASIC view. + BASIC - Includes POSIX and SSH key information. + SECURITY_KEY - Include security key information for the user. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -144,7 +149,7 @@Method Details
-importSshPublicKey(parent, body=None, projectId=None, x__xgafv=None)+importSshPublicKey(parent, body=None, projectId=None, view=None, x__xgafv=None)Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile. Args: @@ -160,6 +165,11 @@Method Details
} projectId: string, The project ID of the Google Cloud Platform project. + view: string, The view configures whether to retrieve security keys information. + Allowed values + LOGIN_PROFILE_VIEW_UNSPECIFIED - The default login profile view. The API defaults to the BASIC view. + BASIC - Includes POSIX and SSH key information. + SECURITY_KEY - Include security key information for the user. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html b/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html index 8cf440162fc..7deb96634c6 100644 --- a/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html +++ b/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html @@ -131,7 +131,7 @@Method Details
"endUserEntitled": True or False, # Output only. Indicates if the subscription is entitled to the end user. "freeTrialEndTime": "A String", # Output only. End of the free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified. "name": "A String", # Output only. Response only. Resource name of the subscription. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" - "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. + "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum. "products": [ # Required. Resource name that identifies one or more subscription products. The format will be 'partners/{partner_id}/products/{product_id}'. "A String", ], @@ -172,7 +172,7 @@Method Details
"endUserEntitled": True or False, # Output only. Indicates if the subscription is entitled to the end user. "freeTrialEndTime": "A String", # Output only. End of the free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified. "name": "A String", # Output only. Response only. Resource name of the subscription. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" - "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. + "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum. "products": [ # Required. Resource name that identifies one or more subscription products. The format will be 'partners/{partner_id}/products/{product_id}'. "A String", ], @@ -188,7 +188,7 @@Method Details
"updateTime": "A String", # Output only. System generated timestamp when the subscription is most recently updated. UTC timezone. } - subscriptionId: string, Required. Identifies the subscription resource on the Partner side. If a subscription was previously created with the same subscription_id, we will directly return that one. + subscriptionId: string, Required. Identifies the subscription resource on the Partner side. The value is restricted to 63 ASCII characters at the maximum. If a subscription was previously created with the same subscription_id, we will directly return that one. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -206,7 +206,7 @@Method Details
"endUserEntitled": True or False, # Output only. Indicates if the subscription is entitled to the end user. "freeTrialEndTime": "A String", # Output only. End of the free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified. "name": "A String", # Output only. Response only. Resource name of the subscription. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" - "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. + "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum. "products": [ # Required. Resource name that identifies one or more subscription products. The format will be 'partners/{partner_id}/products/{product_id}'. "A String", ], @@ -253,7 +253,7 @@Method Details
"endUserEntitled": True or False, # Output only. Indicates if the subscription is entitled to the end user. "freeTrialEndTime": "A String", # Output only. End of the free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified. "name": "A String", # Output only. Response only. Resource name of the subscription. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" - "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. + "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum. "products": [ # Required. Resource name that identifies one or more subscription products. The format will be 'partners/{partner_id}/products/{product_id}'. "A String", ], @@ -328,7 +328,7 @@Method Details
"endUserEntitled": True or False, # Output only. Indicates if the subscription is entitled to the end user. "freeTrialEndTime": "A String", # Output only. End of the free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified. "name": "A String", # Output only. Response only. Resource name of the subscription. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" - "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. + "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum. "products": [ # Required. Resource name that identifies one or more subscription products. The format will be 'partners/{partner_id}/products/{product_id}'. "A String", ], @@ -363,7 +363,7 @@Method Details
"endUserEntitled": True or False, # Output only. Indicates if the subscription is entitled to the end user. "freeTrialEndTime": "A String", # Output only. End of the free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified. "name": "A String", # Output only. Response only. Resource name of the subscription. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" - "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. + "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum. "products": [ # Required. Resource name that identifies one or more subscription products. The format will be 'partners/{partner_id}/products/{product_id}'. "A String", ], @@ -379,7 +379,7 @@Method Details
"updateTime": "A String", # Output only. System generated timestamp when the subscription is most recently updated. UTC timezone. } - subscriptionId: string, Required. Identifies the subscription resource on the Partner side. If a subscription was previously created with the same subscription_id, we will directly return that one. + subscriptionId: string, Required. Identifies the subscription resource on the Partner side. The value is restricted to 63 ASCII characters at the maximum. If a subscription was previously created with the same subscription_id, we will directly return that one. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -397,7 +397,7 @@Method Details
"endUserEntitled": True or False, # Output only. Indicates if the subscription is entitled to the end user. "freeTrialEndTime": "A String", # Output only. End of the free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified. "name": "A String", # Output only. Response only. Resource name of the subscription. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" - "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. + "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum. "products": [ # Required. Resource name that identifies one or more subscription products. The format will be 'partners/{partner_id}/products/{product_id}'. "A String", ], @@ -444,7 +444,7 @@Method Details
"endUserEntitled": True or False, # Output only. Indicates if the subscription is entitled to the end user. "freeTrialEndTime": "A String", # Output only. End of the free trial period, in ISO 8061 format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free trial promotion is specified. "name": "A String", # Output only. Response only. Resource name of the subscription. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}" - "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. + "partnerUserToken": "A String", # Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum. "products": [ # Required. Resource name that identifies one or more subscription products. The format will be 'partners/{partner_id}/products/{product_id}'. "A String", ], diff --git a/docs/dyn/pubsublite_v1.cursor.projects.locations.subscriptions.html b/docs/dyn/pubsublite_v1.cursor.projects.locations.subscriptions.html index b7a3eda7157..f2ac87b6a3a 100644 --- a/docs/dyn/pubsublite_v1.cursor.projects.locations.subscriptions.html +++ b/docs/dyn/pubsublite_v1.cursor.projects.locations.subscriptions.html @@ -82,10 +82,41 @@Instance Methods
Close httplib2 connections.
++
+commitCursor(subscription, body=None, x__xgafv=None)Updates the committed cursor.
Method Details
+close()Close httplib2 connections.++commitCursor(subscription, body=None, x__xgafv=None)+Updates the committed cursor. + +Args: + subscription: string, The subscription for which to update the cursor. (required) + body: object, The request body. + The object takes the form of: + +{ # Request for CommitCursor. + "cursor": { # A cursor that describes the position of a message within a topic partition. # The new value for the committed cursor. + "offset": "A String", # The offset of a message within a topic partition. Must be greater than or equal 0. + }, + "partition": "A String", # The partition for which to update the cursor. Partitions are zero indexed, so `partition` must be in the range [0, topic.num_partitions). +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response for CommitCursor. +}+