chore: update docs/dyn (#1162)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/b5e48daa-1759-436b-9fe7-ffce1482b520/targets
- [ ] To automatically regenerate this PR, check this box.
diff --git a/docs/dyn/analyticsadmin_v1alpha.accounts.userLinks.html b/docs/dyn/analyticsadmin_v1alpha.accounts.userLinks.html
index b18e39b..fb85eb2 100644
--- a/docs/dyn/analyticsadmin_v1alpha.accounts.userLinks.html
+++ b/docs/dyn/analyticsadmin_v1alpha.accounts.userLinks.html
@@ -105,7 +105,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about a user's link to an account or property.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all user links on an account or property.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -124,9 +124,9 @@
The object takes the form of:
{ # Request message for AuditUserLinks RPC.
- "pageSize": 42, # The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 1000 user links will be returned. The maximum value is 5000; values above 5000 will be coerced to 5000.
- "pageToken": "A String", # A page token, received from a previous `AuditUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `AuditUserLinks` must match the call that provided the page token.
- }
+ "pageSize": 42, # The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 1000 user links will be returned. The maximum value is 5000; values above 5000 will be coerced to 5000.
+ "pageToken": "A String", # A page token, received from a previous `AuditUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `AuditUserLinks` must match the call that provided the page token.
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -137,20 +137,20 @@
An object of the form:
{ # Response message for AuditUserLinks RPC.
- "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
- "userLinks": [ # List of AuditUserLinks. These will be ordered stably, but in an arbitrary order.
- { # Read-only resource used to summarize a principal's effective roles.
- "name": "A String", # Example format: properties/1234/userLinks/5678
- "effectiveRoles": [ # Union of all permissions a user has at this account or property (includes direct permissions, group-inherited permissions, etc.). Format: predefinedRoles/read
- "A String",
- ],
- "directRoles": [ # Roles directly assigned to this user for this entity. Format: predefinedRoles/read Excludes roles that are inherited from an account (if this is for a property), group, or organization admin role.
- "A String",
- ],
- "emailAddress": "A String", # Email address of the linked user
- },
- ],
- }</pre>
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "userLinks": [ # List of AuditUserLinks. These will be ordered stably, but in an arbitrary order.
+ { # Read-only resource used to summarize a principal's effective roles.
+ "directRoles": [ # Roles directly assigned to this user for this entity. Format: predefinedRoles/read Excludes roles that are inherited from an account (if this is for a property), group, or organization admin role.
+ "A String",
+ ],
+ "effectiveRoles": [ # Union of all permissions a user has at this account or property (includes direct permissions, group-inherited permissions, etc.). Format: predefinedRoles/read
+ "A String",
+ ],
+ "emailAddress": "A String", # Email address of the linked user
+ "name": "A String", # Example format: properties/1234/userLinks/5678
+ },
+ ],
+}</pre>
</div>
<div class="method">
@@ -177,21 +177,21 @@
The object takes the form of:
{ # Request message for BatchCreateUserLinks RPC.
- "notifyNewUsers": True or False, # Optional. If set, then email the new users notifying them that they've been granted permissions to the resource. Regardless of whether this is set or not, notify_new_user field inside each individual request is ignored.
- "requests": [ # Required. The requests specifying the user links to create. A maximum of 1000 user links can be created in a batch.
- { # Request message for CreateUserLink RPC. Users can have multiple email addresses associated with their Google account, and one of these email addresses is the "primary" email address. Any of the email addresses associated with a Google account may be used for a new UserLink, but the returned UserLink will always contain the "primary" email address. As a result, the input and output email address for this request may differ.
- "parent": "A String", # Required. Example format: accounts/1234
- "userLink": { # A resource message representing a user's permissions on an Account or Property resource. # Required. The user link to create.
- "name": "A String", # Example format: properties/1234/userLinks/5678
- "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
- },
- "notifyNewUser": True or False, # Optional. If set, then email the new user notifying them that they've been granted permissions to the resource.
+ "notifyNewUsers": True or False, # Optional. If set, then email the new users notifying them that they've been granted permissions to the resource. Regardless of whether this is set or not, notify_new_user field inside each individual request is ignored.
+ "requests": [ # Required. The requests specifying the user links to create. A maximum of 1000 user links can be created in a batch.
+ { # Request message for CreateUserLink RPC. Users can have multiple email addresses associated with their Google account, and one of these email addresses is the "primary" email address. Any of the email addresses associated with a Google account may be used for a new UserLink, but the returned UserLink will always contain the "primary" email address. As a result, the input and output email address for this request may differ.
+ "notifyNewUser": True or False, # Optional. If set, then email the new user notifying them that they've been granted permissions to the resource.
+ "parent": "A String", # Required. Example format: accounts/1234
+ "userLink": { # A resource message representing a user's permissions on an Account or Property resource. # Required. The user link to create.
+ "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
},
- ],
- }
+ },
+ ],
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -202,16 +202,16 @@
An object of the form:
{ # Response message for BatchCreateUserLinks RPC.
- "userLinks": [ # The user links created.
- { # A resource message representing a user's permissions on an Account or Property resource.
- "name": "A String", # Example format: properties/1234/userLinks/5678
- "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
- },
- ],
- }</pre>
+ "userLinks": [ # The user links created.
+ { # A resource message representing a user's permissions on an Account or Property resource.
+ "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
+ },
+ ],
+}</pre>
</div>
<div class="method">
@@ -224,12 +224,12 @@
The object takes the form of:
{ # Request message for BatchDeleteUserLinks RPC.
- "requests": [ # Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch.
- { # Request message for DeleteUserLink RPC.
- "name": "A String", # Required. Example format: accounts/1234/userLinks/5678
- },
- ],
- }
+ "requests": [ # Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch.
+ { # Request message for DeleteUserLink RPC.
+ "name": "A String", # Required. Example format: accounts/1234/userLinks/5678
+ },
+ ],
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -240,7 +240,7 @@
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
- }</pre>
+}</pre>
</div>
<div class="method">
@@ -259,16 +259,16 @@
An object of the form:
{ # Response message for BatchGetUserLinks RPC.
- "userLinks": [ # The requested user links.
- { # A resource message representing a user's permissions on an Account or Property resource.
- "name": "A String", # Example format: properties/1234/userLinks/5678
- "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
- },
- ],
- }</pre>
+ "userLinks": [ # The requested user links.
+ { # A resource message representing a user's permissions on an Account or Property resource.
+ "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
+ },
+ ],
+}</pre>
</div>
<div class="method">
@@ -281,18 +281,18 @@
The object takes the form of:
{ # Request message for BatchUpdateUserLinks RPC.
- "requests": [ # Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch.
- { # Request message for UpdateUserLink RPC.
- "userLink": { # A resource message representing a user's permissions on an Account or Property resource. # Required. The user link to update.
- "name": "A String", # Example format: properties/1234/userLinks/5678
- "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
- },
+ "requests": [ # Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch.
+ { # Request message for UpdateUserLink RPC.
+ "userLink": { # A resource message representing a user's permissions on an Account or Property resource. # Required. The user link to update.
+ "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
},
- ],
- }
+ },
+ ],
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -303,16 +303,16 @@
An object of the form:
{ # Response message for BatchUpdateUserLinks RPC.
- "userLinks": [ # The user links updated.
- { # A resource message representing a user's permissions on an Account or Property resource.
- "name": "A String", # Example format: properties/1234/userLinks/5678
- "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
- },
- ],
- }</pre>
+ "userLinks": [ # The user links updated.
+ { # A resource message representing a user's permissions on an Account or Property resource.
+ "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
+ },
+ ],
+}</pre>
</div>
<div class="method">
@@ -330,11 +330,11 @@
The object takes the form of:
{ # A resource message representing a user's permissions on an Account or Property resource.
- "name": "A String", # Example format: properties/1234/userLinks/5678
"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
}
notifyNewUser: boolean, Optional. If set, then email the new user notifying them that they've been granted permissions to the resource.
@@ -347,12 +347,12 @@
An object of the form:
{ # A resource message representing a user's permissions on an Account or Property resource.
- "name": "A String", # Example format: properties/1234/userLinks/5678
- "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
- }</pre>
+ "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
+}</pre>
</div>
<div class="method">
@@ -370,7 +370,7 @@
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
- }</pre>
+}</pre>
</div>
<div class="method">
@@ -388,22 +388,22 @@
An object of the form:
{ # A resource message representing a user's permissions on an Account or Property resource.
- "name": "A String", # Example format: properties/1234/userLinks/5678
- "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
- }</pre>
+ "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
+}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all user links on an account or property.
Args:
parent: string, Required. Example format: accounts/1234 (required)
- pageToken: string, A page token, received from a previous `ListUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLinks` must match the call that provided the page token.
pageSize: integer, The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 200 user links will be returned. The maximum value is 500; values above 500 will be coerced to 500.
+ pageToken: string, A page token, received from a previous `ListUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLinks` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -413,17 +413,17 @@
An object of the form:
{ # Response message for ListUserLinks RPC.
- "userLinks": [ # List of UserLinks. These will be ordered stably, but in an arbitrary order.
- { # A resource message representing a user's permissions on an Account or Property resource.
- "name": "A String", # Example format: properties/1234/userLinks/5678
- "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
- },
- ],
- "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
- }</pre>
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "userLinks": [ # List of UserLinks. These will be ordered stably, but in an arbitrary order.
+ { # A resource message representing a user's permissions on an Account or Property resource.
+ "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
+ },
+ ],
+}</pre>
</div>
<div class="method">
@@ -450,11 +450,11 @@
The object takes the form of:
{ # A resource message representing a user's permissions on an Account or Property resource.
- "name": "A String", # Example format: properties/1234/userLinks/5678
"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
}
x__xgafv: string, V1 error format.
@@ -466,12 +466,12 @@
An object of the form:
{ # A resource message representing a user's permissions on an Account or Property resource.
- "name": "A String", # Example format: properties/1234/userLinks/5678
- "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
- }</pre>
+ "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
+}</pre>
</div>
</body></html>
\ No newline at end of file