Skip to content

Commit e3610c2

Browse files
feat(cloudsearch): update the api
#### cloudsearch:v1 The following keys were added: - schemas.AuditLoggingSettings (Total Keys: 6) - schemas.ContextAttribute (Total Keys: 5) - schemas.CustomerSettings.properties.auditLoggingSettings (Total Keys: 1) - schemas.ItemMetadata.properties.contextAttributes (Total Keys: 2) - schemas.SearchApplication.properties.enableAuditLog (Total Keys: 1) - schemas.SearchRequest.properties.contextAttributes (Total Keys: 2)
1 parent 60f30e1 commit e3610c2

File tree

6 files changed

+136
-1
lines changed

6 files changed

+136
-1
lines changed

docs/dyn/cloudsearch_v1.debug.datasources.items.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,14 @@ <h3>Method Details</h3>
207207
&quot;metadata&quot;: { # Available metadata fields for the item. # Metadata information.
208208
&quot;containerName&quot;: &quot;A String&quot;, # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
209209
&quot;contentLanguage&quot;: &quot;A String&quot;, # The BCP-47 language code for the item, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
210+
&quot;contextAttributes&quot;: [ # A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10.
211+
{ # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.
212+
&quot;name&quot;: &quot;A String&quot;, # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched.
213+
&quot;values&quot;: [ # Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched.
214+
&quot;A String&quot;,
215+
],
216+
},
217+
],
210218
&quot;createTime&quot;: &quot;A String&quot;, # The time when the item was created in the source repository.
211219
&quot;hash&quot;: &quot;A String&quot;, # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
212220
&quot;interactions&quot;: [ # A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.

docs/dyn/cloudsearch_v1.indexing.datasources.items.html

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,14 @@ <h3>Method Details</h3>
268268
&quot;metadata&quot;: { # Available metadata fields for the item. # Metadata information.
269269
&quot;containerName&quot;: &quot;A String&quot;, # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
270270
&quot;contentLanguage&quot;: &quot;A String&quot;, # The BCP-47 language code for the item, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
271+
&quot;contextAttributes&quot;: [ # A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10.
272+
{ # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.
273+
&quot;name&quot;: &quot;A String&quot;, # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched.
274+
&quot;values&quot;: [ # Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched.
275+
&quot;A String&quot;,
276+
],
277+
},
278+
],
271279
&quot;createTime&quot;: &quot;A String&quot;, # The time when the item was created in the source repository.
272280
&quot;hash&quot;: &quot;A String&quot;, # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
273281
&quot;interactions&quot;: [ # A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.
@@ -448,6 +456,14 @@ <h3>Method Details</h3>
448456
&quot;metadata&quot;: { # Available metadata fields for the item. # Metadata information.
449457
&quot;containerName&quot;: &quot;A String&quot;, # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
450458
&quot;contentLanguage&quot;: &quot;A String&quot;, # The BCP-47 language code for the item, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
459+
&quot;contextAttributes&quot;: [ # A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10.
460+
{ # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.
461+
&quot;name&quot;: &quot;A String&quot;, # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched.
462+
&quot;values&quot;: [ # Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched.
463+
&quot;A String&quot;,
464+
],
465+
},
466+
],
451467
&quot;createTime&quot;: &quot;A String&quot;, # The time when the item was created in the source repository.
452468
&quot;hash&quot;: &quot;A String&quot;, # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
453469
&quot;interactions&quot;: [ # A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.
@@ -662,6 +678,14 @@ <h3>Method Details</h3>
662678
&quot;metadata&quot;: { # Available metadata fields for the item. # Metadata information.
663679
&quot;containerName&quot;: &quot;A String&quot;, # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
664680
&quot;contentLanguage&quot;: &quot;A String&quot;, # The BCP-47 language code for the item, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
681+
&quot;contextAttributes&quot;: [ # A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10.
682+
{ # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.
683+
&quot;name&quot;: &quot;A String&quot;, # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched.
684+
&quot;values&quot;: [ # Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched.
685+
&quot;A String&quot;,
686+
],
687+
},
688+
],
665689
&quot;createTime&quot;: &quot;A String&quot;, # The time when the item was created in the source repository.
666690
&quot;hash&quot;: &quot;A String&quot;, # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
667691
&quot;interactions&quot;: [ # A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.
@@ -873,6 +897,14 @@ <h3>Method Details</h3>
873897
&quot;metadata&quot;: { # Available metadata fields for the item. # Metadata information.
874898
&quot;containerName&quot;: &quot;A String&quot;, # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
875899
&quot;contentLanguage&quot;: &quot;A String&quot;, # The BCP-47 language code for the item, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
900+
&quot;contextAttributes&quot;: [ # A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10.
901+
{ # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.
902+
&quot;name&quot;: &quot;A String&quot;, # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched.
903+
&quot;values&quot;: [ # Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched.
904+
&quot;A String&quot;,
905+
],
906+
},
907+
],
876908
&quot;createTime&quot;: &quot;A String&quot;, # The time when the item was created in the source repository.
877909
&quot;hash&quot;: &quot;A String&quot;, # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
878910
&quot;interactions&quot;: [ # A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.
@@ -1075,6 +1107,14 @@ <h3>Method Details</h3>
10751107
&quot;metadata&quot;: { # Available metadata fields for the item. # Metadata information.
10761108
&quot;containerName&quot;: &quot;A String&quot;, # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
10771109
&quot;contentLanguage&quot;: &quot;A String&quot;, # The BCP-47 language code for the item, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
1110+
&quot;contextAttributes&quot;: [ # A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10.
1111+
{ # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.
1112+
&quot;name&quot;: &quot;A String&quot;, # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched.
1113+
&quot;values&quot;: [ # Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched.
1114+
&quot;A String&quot;,
1115+
],
1116+
},
1117+
],
10781118
&quot;createTime&quot;: &quot;A String&quot;, # The time when the item was created in the source repository.
10791119
&quot;hash&quot;: &quot;A String&quot;, # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
10801120
&quot;interactions&quot;: [ # A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.

docs/dyn/cloudsearch_v1.query.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,14 @@ <h3>Method Details</h3>
103103
The object takes the form of:
104104

105105
{ # The search API request.
106+
&quot;contextAttributes&quot;: [ # Context attributes for the request which will be used to adjust ranking of search results. The maximum number of elements is 10.
107+
{ # A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.
108+
&quot;name&quot;: &quot;A String&quot;, # The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched.
109+
&quot;values&quot;: [ # Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched.
110+
&quot;A String&quot;,
111+
],
112+
},
113+
],
106114
&quot;dataSourceRestrictions&quot;: [ # The sources to use for querying. If not specified, all data sources from the current search application are used.
107115
{ # Restriction on Datasource.
108116
&quot;filterOptions&quot;: [ # Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: &quot;objecttype&quot;, &quot;type&quot; and &quot;mimetype&quot;. For now, schema specific filters cannot be used to filter suggestions.

docs/dyn/cloudsearch_v1.settings.html

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,12 @@ <h3>Method Details</h3>
113113
An object of the form:
114114

115115
{ # Represents settings at a customer level.
116+
&quot;auditLoggingSettings&quot;: { # Represents the settings for Cloud audit logging # Audit Logging settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request.
117+
&quot;logAdminReadActions&quot;: True or False, # Indicates whether audit logging is on/off for admin activity read APIs i.e. Get/List DataSources, Get/List SearchApplications etc.
118+
&quot;logDataReadActions&quot;: True or False, # Indicates whether audit logging is on/off for data access read APIs i.e. ListItems, GetItem etc.
119+
&quot;logDataWriteActions&quot;: True or False, # Indicates whether audit logging is on/off for data access write APIs i.e. IndexItem etc.
120+
&quot;project&quot;: &quot;A String&quot;, # The resource name of the GCP Project to store audit logs. Cloud audit logging will be enabled after project_name has been updated through CustomerService. Format: projects/{project_id}
121+
},
116122
&quot;vpcSettings&quot;: { # VPC SC settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request.
117123
&quot;project&quot;: &quot;A String&quot;, # The resource name of the GCP Project to be used for VPC SC policy check. VPC security settings on this project will be honored for Cloud Search APIs after project_name has been updated through CustomerService. Format: projects/{project_id}
118124
},
@@ -128,6 +134,12 @@ <h3>Method Details</h3>
128134
The object takes the form of:
129135

130136
{ # Represents settings at a customer level.
137+
&quot;auditLoggingSettings&quot;: { # Represents the settings for Cloud audit logging # Audit Logging settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request.
138+
&quot;logAdminReadActions&quot;: True or False, # Indicates whether audit logging is on/off for admin activity read APIs i.e. Get/List DataSources, Get/List SearchApplications etc.
139+
&quot;logDataReadActions&quot;: True or False, # Indicates whether audit logging is on/off for data access read APIs i.e. ListItems, GetItem etc.
140+
&quot;logDataWriteActions&quot;: True or False, # Indicates whether audit logging is on/off for data access write APIs i.e. IndexItem etc.
141+
&quot;project&quot;: &quot;A String&quot;, # The resource name of the GCP Project to store audit logs. Cloud audit logging will be enabled after project_name has been updated through CustomerService. Format: projects/{project_id}
142+
},
131143
&quot;vpcSettings&quot;: { # VPC SC settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request.
132144
&quot;project&quot;: &quot;A String&quot;, # The resource name of the GCP Project to be used for VPC SC policy check. VPC security settings on this project will be honored for Cloud Search APIs after project_name has been updated through CustomerService. Format: projects/{project_id}
133145
},

0 commit comments

Comments
 (0)