178 lines
8.7 KiB
HTML
178 lines
8.7 KiB
HTML
<html><body>
|
|
<style>
|
|
|
|
body, h1, h2, h3, div, span, p, pre, a {
|
|
margin: 0;
|
|
padding: 0;
|
|
border: 0;
|
|
font-weight: inherit;
|
|
font-style: inherit;
|
|
font-size: 100%;
|
|
font-family: inherit;
|
|
vertical-align: baseline;
|
|
}
|
|
|
|
body {
|
|
font-size: 13px;
|
|
padding: 1em;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 26px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h2 {
|
|
font-size: 24px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h3 {
|
|
font-size: 20px;
|
|
margin-bottom: 1em;
|
|
margin-top: 1em;
|
|
}
|
|
|
|
pre, code {
|
|
line-height: 1.5;
|
|
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
|
|
}
|
|
|
|
pre {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
h1, h2, h3, p {
|
|
font-family: Arial, sans serif;
|
|
}
|
|
|
|
h1, h2, h3 {
|
|
border-bottom: solid #CCC 1px;
|
|
}
|
|
|
|
.toc_element {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
.firstline {
|
|
margin-left: 2 em;
|
|
}
|
|
|
|
.method {
|
|
margin-top: 1em;
|
|
border: solid 1px #CCC;
|
|
padding: 1em;
|
|
background: #EEE;
|
|
}
|
|
|
|
.details {
|
|
font-weight: bold;
|
|
font-size: 14px;
|
|
}
|
|
|
|
</style>
|
|
|
|
<h1><a href="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.settings.html">settings</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="cloudsearch_v1.settings.datasources.html">datasources()</a></code>
|
|
</p>
|
|
<p class="firstline">Returns the datasources Resource.</p>
|
|
|
|
<p class="toc_element">
|
|
<code><a href="cloudsearch_v1.settings.searchapplications.html">searchapplications()</a></code>
|
|
</p>
|
|
<p class="firstline">Returns the searchapplications Resource.</p>
|
|
|
|
<p class="toc_element">
|
|
<code><a href="#close">close()</a></code></p>
|
|
<p class="firstline">Close httplib2 connections.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#getCustomer">getCustomer(x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Get customer settings. **Note:** This API requires an admin account to execute.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#updateCustomer">updateCustomer(body=None, updateMask=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Update customer settings. **Note:** This API requires an admin account to execute.</p>
|
|
<h3>Method Details</h3>
|
|
<div class="method">
|
|
<code class="details" id="close">close()</code>
|
|
<pre>Close httplib2 connections.</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="getCustomer">getCustomer(x__xgafv=None)</code>
|
|
<pre>Get customer settings. **Note:** This API requires an admin account to execute.
|
|
|
|
Args:
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Represents settings at a customer level.
|
|
"auditLoggingSettings": { # 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.
|
|
"logAdminReadActions": True or False, # Indicates whether audit logging is on/off for admin activity read APIs i.e. Get/List DataSources, Get/List SearchApplications etc.
|
|
"logDataReadActions": True or False, # Indicates whether audit logging is on/off for data access read APIs i.e. ListItems, GetItem etc.
|
|
"logDataWriteActions": True or False, # Indicates whether audit logging is on/off for data access write APIs i.e. IndexItem etc.
|
|
"project": "A String", # 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}
|
|
},
|
|
"vpcSettings": { # VPC SC settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request.
|
|
"project": "A String", # 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}
|
|
},
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="updateCustomer">updateCustomer(body=None, updateMask=None, x__xgafv=None)</code>
|
|
<pre>Update customer settings. **Note:** This API requires an admin account to execute.
|
|
|
|
Args:
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{ # Represents settings at a customer level.
|
|
"auditLoggingSettings": { # 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.
|
|
"logAdminReadActions": True or False, # Indicates whether audit logging is on/off for admin activity read APIs i.e. Get/List DataSources, Get/List SearchApplications etc.
|
|
"logDataReadActions": True or False, # Indicates whether audit logging is on/off for data access read APIs i.e. ListItems, GetItem etc.
|
|
"logDataWriteActions": True or False, # Indicates whether audit logging is on/off for data access write APIs i.e. IndexItem etc.
|
|
"project": "A String", # 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}
|
|
},
|
|
"vpcSettings": { # VPC SC settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request.
|
|
"project": "A String", # 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}
|
|
},
|
|
}
|
|
|
|
updateMask: string, Update mask to control which fields get updated. If you specify a field in the update_mask but don'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
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # This resource represents a long-running operation that is the result of a network API call.
|
|
"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.
|
|
"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.
|
|
"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.
|
|
},
|
|
],
|
|
"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.
|
|
},
|
|
"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.
|
|
},
|
|
"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}`.
|
|
"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.
|
|
},
|
|
}</pre>
|
|
</div>
|
|
|
|
</body></html> |