Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4c9ccb08aa866b5402c5e63c70306b5a3c121ba1 / . / docs / dyn / cloudsearch_v1.settings.html
blob: 5a49ad342760a2810825edc392ef5dbe7f795990 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.settings.html">settings</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="cloudsearch_v1.settings.datasources.html">datasources()</a></code>
79</p>
80<p class="firstline">Returns the datasources Resource.</p>
81
82<p class="toc_element">
83 <code><a href="cloudsearch_v1.settings.searchapplications.html">searchapplications()</a></code>
84</p>
85<p class="firstline">Returns the searchapplications Resource.</p>
86
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]87<p class="toc_element">
88 <code><a href="#close">close()</a></code></p>
89<p class="firstline">Close httplib2 connections.</p>
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]90<p class="toc_element">
91 <code><a href="#getCustomer">getCustomer(x__xgafv=None)</a></code></p>
92<p class="firstline">Get customer settings. **Note:** This API requires an admin account to execute.</p>
93<p class="toc_element">
94 <code><a href="#updateCustomer">updateCustomer(body=None, updateMask=None, x__xgafv=None)</a></code></p>
95<p class="firstline">Update customer settings. **Note:** This API requires an admin account to execute.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]96<h3>Method Details</h3>
97<div class="method">
98 <code class="details" id="close">close()</code>
99 <pre>Close httplib2 connections.</pre>
100</div>
101
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]102<div class="method">
103 <code class="details" id="getCustomer">getCustomer(x__xgafv=None)</code>
104 <pre>Get customer settings. **Note:** This API requires an admin account to execute.
105
106Args:
107 x__xgafv: string, V1 error format.
108 Allowed values
109 1 - v1 error format
110 2 - v2 error format
111
112Returns:
113 An object of the form:
114
115 { # Represents settings at a customer level.
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700[diff] [blame]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 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]122 &quot;vpcSettings&quot;: { # VPC SC settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request.
123 &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}
124 },
125}</pre>
126</div>
127
128<div class="method">
129 <code class="details" id="updateCustomer">updateCustomer(body=None, updateMask=None, x__xgafv=None)</code>
130 <pre>Update customer settings. **Note:** This API requires an admin account to execute.
131
132Args:
133 body: object, The request body.
134 The object takes the form of:
135
136{ # Represents settings at a customer level.
yoshi-code-bot3dd15272021-04-21 15:07:48 -0700[diff] [blame]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 },
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]143 &quot;vpcSettings&quot;: { # VPC SC settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request.
144 &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}
145 },
146}
147
148 updateMask: string, Update mask to control which fields get updated. If you specify a field in the update_mask but don&#x27;t specify its value here, that field will be cleared. If the mask is not present or empty, all fields will be updated. Currently supported field paths: vpc_settings and audit_logging_settings
149 x__xgafv: string, V1 error format.
150 Allowed values
151 1 - v1 error format
152 2 - v2 error format
153
154Returns:
155 An object of the form:
156
157 { # This resource represents a long-running operation that is the result of a network API call.
158 &quot;done&quot;: 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.
159 &quot;error&quot;: { # 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.
160 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
161 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
162 {
163 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
164 },
165 ],
166 &quot;message&quot;: &quot;A String&quot;, # 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.
167 },
168 &quot;metadata&quot;: { # 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.
169 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
170 },
171 &quot;name&quot;: &quot;A String&quot;, # 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}`.
172 &quot;response&quot;: { # 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`.
173 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
174 },
175}</pre>
176</div>
177
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]178</body></html>