chore: update generated docs (#1115)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/2ed9ab0e-55b4-4ab2-aede-c95e765f7376/targets
- [x] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/discovery-artifact-manager/commit/0bed8bdae25d545e796cfcdd7a9bfffff11e69da
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/cloudidentity_v1.devices.deviceUsers.clientStates.html b/docs/dyn/cloudidentity_v1.devices.deviceUsers.clientStates.html
index 71bf6e4..597bdcd 100644
--- a/docs/dyn/cloudidentity_v1.devices.deviceUsers.clientStates.html
+++ b/docs/dyn/cloudidentity_v1.devices.deviceUsers.clientStates.html
@@ -81,13 +81,13 @@
<code><a href="#get">get(name, customer=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the client state for the device user</p>
<p class="toc_element">
- <code><a href="#list">list(parent, orderBy=None, customer=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, orderBy=None, filter=None, customer=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the client states for the given search query.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#patch">patch(name, body=None, customer=None, updateMask=None, x__xgafv=None)</a></code></p>
+ <code><a href="#patch">patch(name, body=None, updateMask=None, customer=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the client state for the device user</p>
<h3>Method Details</h3>
<div class="method">
@@ -111,38 +111,38 @@
An object of the form:
{ # Represents the state associated with an API client calling the Devices API. Resource representing ClientState and supports updates from API users
- "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState in format: `devices/{device_id}/deviceUsers/{device_user_id}/clientState/{partner_id}`, where partner_id corresponds to the partner storing the data. For partners belonging to the "BeyondCorp Alliance", this is the partner ID specified to you by Google. For all other callers, this is a string of the form: `{customer_id}-suffix`, where `customer_id` is your customer ID. The *suffix* is any string the caller specifies. This string will be displayed verbatim in the administration console. This suffix is used in setting up Custom Access Levels in Context-Aware Access. Your organization's customer ID can be obtained from the URL: `GET https://www.googleapis.com/admin/directory/v1/customers/my_customer` The `id` field in the response contains the customer ID starting with the letter 'C'. The customer ID to be used in this API is the string after the letter 'C' (not including 'C')
- "healthScore": "A String", # The Health score of the resource. The Health score is the callers specification of the condition of the device from a usability point of view. For example, a third-party device management provider may specify a health score based on its compliance with organizational policies.
- "managed": "A String", # The management state of the resource as specified by the API client.
- "etag": "A String", # The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest
- "lastUpdateTime": "A String", # Output only. The time the client state data was last updated.
- "customId": "A String", # This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
- "complianceState": "A String", # The compliance state of the resource as specified by the API client.
- "keyValuePairs": { # The map of key-value attributes stored by callers specific to a device. The total serialized length of this map may not exceed 10KB. No limit is placed on the number of attributes in a map.
- "a_key": { # Additional custom attribute values may be one of these types
- "numberValue": 3.14, # Represents a double value.
- "stringValue": "A String", # Represents a string value.
- "boolValue": True or False, # Represents a boolean value.
- },
+ "assetTags": [ # The caller can specify asset tags for this resource
+ "A String",
+ ],
+ "etag": "A String", # The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest
+ "managed": "A String", # The management state of the resource as specified by the API client.
+ "keyValuePairs": { # The map of key-value attributes stored by callers specific to a device. The total serialized length of this map may not exceed 10KB. No limit is placed on the number of attributes in a map.
+ "a_key": { # Additional custom attribute values may be one of these types
+ "stringValue": "A String", # Represents a string value.
+ "numberValue": 3.14, # Represents a double value.
+ "boolValue": True or False, # Represents a boolean value.
},
- "createTime": "A String", # Output only. The time the client state data was created.
- "assetTags": [ # The caller can specify asset tags for this resource
- "A String",
- ],
- "ownerType": "A String", # Output only. The owner of the ClientState
- "scoreReason": "A String", # A descriptive cause of the health score.
- }</pre>
+ },
+ "createTime": "A String", # Output only. The time the client state data was created.
+ "ownerType": "A String", # Output only. The owner of the ClientState
+ "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState in format: `devices/{device_id}/deviceUsers/{device_user_id}/clientState/{partner_id}`, where partner_id corresponds to the partner storing the data. For partners belonging to the "BeyondCorp Alliance", this is the partner ID specified to you by Google. For all other callers, this is a string of the form: `{customer_id}-suffix`, where `customer_id` is your customer ID. The *suffix* is any string the caller specifies. This string will be displayed verbatim in the administration console. This suffix is used in setting up Custom Access Levels in Context-Aware Access. Your organization's customer ID can be obtained from the URL: `GET https://www.googleapis.com/admin/directory/v1/customers/my_customer` The `id` field in the response contains the customer ID starting with the letter 'C'. The customer ID to be used in this API is the string after the letter 'C' (not including 'C')
+ "customId": "A String", # This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
+ "complianceState": "A String", # The compliance state of the resource as specified by the API client.
+ "scoreReason": "A String", # A descriptive cause of the health score.
+ "healthScore": "A String", # The Health score of the resource. The Health score is the callers specification of the condition of the device from a usability point of view. For example, a third-party device management provider may specify a health score based on its compliance with organizational policies.
+ "lastUpdateTime": "A String", # Output only. The time the client state data was last updated.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, orderBy=None, customer=None, filter=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, orderBy=None, filter=None, customer=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the client states for the given search query.
Args:
parent: string, Required. To list all ClientStates, set this to "devices/-/deviceUsers/-". To list all ClientStates owned by a DeviceUser, set this to the resource name of the DeviceUser. Format: devices/{device}/deviceUsers/{deviceUser} (required)
orderBy: string, Optional. Order specification for client states in the response.
- customer: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
filter: string, Optional. Additional restrictions when fetching list of client states.
+ customer: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
pageToken: string, Optional. A page token, received from a previous `ListClientStates` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListClientStates` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
@@ -156,27 +156,27 @@
"nextPageToken": "A String", # Token to retrieve the next page of results. Empty if there are no more results.
"clientStates": [ # Client states meeting the list restrictions.
{ # Represents the state associated with an API client calling the Devices API. Resource representing ClientState and supports updates from API users
- "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState in format: `devices/{device_id}/deviceUsers/{device_user_id}/clientState/{partner_id}`, where partner_id corresponds to the partner storing the data. For partners belonging to the "BeyondCorp Alliance", this is the partner ID specified to you by Google. For all other callers, this is a string of the form: `{customer_id}-suffix`, where `customer_id` is your customer ID. The *suffix* is any string the caller specifies. This string will be displayed verbatim in the administration console. This suffix is used in setting up Custom Access Levels in Context-Aware Access. Your organization's customer ID can be obtained from the URL: `GET https://www.googleapis.com/admin/directory/v1/customers/my_customer` The `id` field in the response contains the customer ID starting with the letter 'C'. The customer ID to be used in this API is the string after the letter 'C' (not including 'C')
- "healthScore": "A String", # The Health score of the resource. The Health score is the callers specification of the condition of the device from a usability point of view. For example, a third-party device management provider may specify a health score based on its compliance with organizational policies.
- "managed": "A String", # The management state of the resource as specified by the API client.
- "etag": "A String", # The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest
- "lastUpdateTime": "A String", # Output only. The time the client state data was last updated.
- "customId": "A String", # This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
- "complianceState": "A String", # The compliance state of the resource as specified by the API client.
- "keyValuePairs": { # The map of key-value attributes stored by callers specific to a device. The total serialized length of this map may not exceed 10KB. No limit is placed on the number of attributes in a map.
- "a_key": { # Additional custom attribute values may be one of these types
- "numberValue": 3.14, # Represents a double value.
- "stringValue": "A String", # Represents a string value.
- "boolValue": True or False, # Represents a boolean value.
- },
+ "assetTags": [ # The caller can specify asset tags for this resource
+ "A String",
+ ],
+ "etag": "A String", # The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest
+ "managed": "A String", # The management state of the resource as specified by the API client.
+ "keyValuePairs": { # The map of key-value attributes stored by callers specific to a device. The total serialized length of this map may not exceed 10KB. No limit is placed on the number of attributes in a map.
+ "a_key": { # Additional custom attribute values may be one of these types
+ "stringValue": "A String", # Represents a string value.
+ "numberValue": 3.14, # Represents a double value.
+ "boolValue": True or False, # Represents a boolean value.
},
- "createTime": "A String", # Output only. The time the client state data was created.
- "assetTags": [ # The caller can specify asset tags for this resource
- "A String",
- ],
- "ownerType": "A String", # Output only. The owner of the ClientState
- "scoreReason": "A String", # A descriptive cause of the health score.
},
+ "createTime": "A String", # Output only. The time the client state data was created.
+ "ownerType": "A String", # Output only. The owner of the ClientState
+ "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState in format: `devices/{device_id}/deviceUsers/{device_user_id}/clientState/{partner_id}`, where partner_id corresponds to the partner storing the data. For partners belonging to the "BeyondCorp Alliance", this is the partner ID specified to you by Google. For all other callers, this is a string of the form: `{customer_id}-suffix`, where `customer_id` is your customer ID. The *suffix* is any string the caller specifies. This string will be displayed verbatim in the administration console. This suffix is used in setting up Custom Access Levels in Context-Aware Access. Your organization's customer ID can be obtained from the URL: `GET https://www.googleapis.com/admin/directory/v1/customers/my_customer` The `id` field in the response contains the customer ID starting with the letter 'C'. The customer ID to be used in this API is the string after the letter 'C' (not including 'C')
+ "customId": "A String", # This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
+ "complianceState": "A String", # The compliance state of the resource as specified by the API client.
+ "scoreReason": "A String", # A descriptive cause of the health score.
+ "healthScore": "A String", # The Health score of the resource. The Health score is the callers specification of the condition of the device from a usability point of view. For example, a third-party device management provider may specify a health score based on its compliance with organizational policies.
+ "lastUpdateTime": "A String", # Output only. The time the client state data was last updated.
+ },
],
}</pre>
</div>
@@ -196,7 +196,7 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(name, body=None, customer=None, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(name, body=None, updateMask=None, customer=None, x__xgafv=None)</code>
<pre>Updates the client state for the device user
Args:
@@ -205,30 +205,30 @@
The object takes the form of:
{ # Represents the state associated with an API client calling the Devices API. Resource representing ClientState and supports updates from API users
- "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState in format: `devices/{device_id}/deviceUsers/{device_user_id}/clientState/{partner_id}`, where partner_id corresponds to the partner storing the data. For partners belonging to the "BeyondCorp Alliance", this is the partner ID specified to you by Google. For all other callers, this is a string of the form: `{customer_id}-suffix`, where `customer_id` is your customer ID. The *suffix* is any string the caller specifies. This string will be displayed verbatim in the administration console. This suffix is used in setting up Custom Access Levels in Context-Aware Access. Your organization's customer ID can be obtained from the URL: `GET https://www.googleapis.com/admin/directory/v1/customers/my_customer` The `id` field in the response contains the customer ID starting with the letter 'C'. The customer ID to be used in this API is the string after the letter 'C' (not including 'C')
- "healthScore": "A String", # The Health score of the resource. The Health score is the callers specification of the condition of the device from a usability point of view. For example, a third-party device management provider may specify a health score based on its compliance with organizational policies.
- "managed": "A String", # The management state of the resource as specified by the API client.
- "etag": "A String", # The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest
- "lastUpdateTime": "A String", # Output only. The time the client state data was last updated.
- "customId": "A String", # This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
- "complianceState": "A String", # The compliance state of the resource as specified by the API client.
- "keyValuePairs": { # The map of key-value attributes stored by callers specific to a device. The total serialized length of this map may not exceed 10KB. No limit is placed on the number of attributes in a map.
- "a_key": { # Additional custom attribute values may be one of these types
- "numberValue": 3.14, # Represents a double value.
- "stringValue": "A String", # Represents a string value.
- "boolValue": True or False, # Represents a boolean value.
- },
+ "assetTags": [ # The caller can specify asset tags for this resource
+ "A String",
+ ],
+ "etag": "A String", # The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest
+ "managed": "A String", # The management state of the resource as specified by the API client.
+ "keyValuePairs": { # The map of key-value attributes stored by callers specific to a device. The total serialized length of this map may not exceed 10KB. No limit is placed on the number of attributes in a map.
+ "a_key": { # Additional custom attribute values may be one of these types
+ "stringValue": "A String", # Represents a string value.
+ "numberValue": 3.14, # Represents a double value.
+ "boolValue": True or False, # Represents a boolean value.
},
- "createTime": "A String", # Output only. The time the client state data was created.
- "assetTags": [ # The caller can specify asset tags for this resource
- "A String",
- ],
- "ownerType": "A String", # Output only. The owner of the ClientState
- "scoreReason": "A String", # A descriptive cause of the health score.
- }
+ },
+ "createTime": "A String", # Output only. The time the client state data was created.
+ "ownerType": "A String", # Output only. The owner of the ClientState
+ "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState in format: `devices/{device_id}/deviceUsers/{device_user_id}/clientState/{partner_id}`, where partner_id corresponds to the partner storing the data. For partners belonging to the "BeyondCorp Alliance", this is the partner ID specified to you by Google. For all other callers, this is a string of the form: `{customer_id}-suffix`, where `customer_id` is your customer ID. The *suffix* is any string the caller specifies. This string will be displayed verbatim in the administration console. This suffix is used in setting up Custom Access Levels in Context-Aware Access. Your organization's customer ID can be obtained from the URL: `GET https://www.googleapis.com/admin/directory/v1/customers/my_customer` The `id` field in the response contains the customer ID starting with the letter 'C'. The customer ID to be used in this API is the string after the letter 'C' (not including 'C')
+ "customId": "A String", # This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
+ "complianceState": "A String", # The compliance state of the resource as specified by the API client.
+ "scoreReason": "A String", # A descriptive cause of the health score.
+ "healthScore": "A String", # The Health score of the resource. The Health score is the callers specification of the condition of the device from a usability point of view. For example, a third-party device management provider may specify a health score based on its compliance with organizational policies.
+ "lastUpdateTime": "A String", # Output only. The time the client state data was last updated.
+}
- customer: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
updateMask: string, Optional. Comma-separated list of fully qualified names of fields to be updated. If not specified, all updatable fields in ClientState are updated.
+ customer: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer` If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -241,19 +241,19 @@
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
- "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>