You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pclass="firstline">Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.</p>
name: string, Required. The resource name of the CmekConfig to delete, such as `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`. (required)
104
+
x__xgafv: string, V1 error format.
105
+
Allowed values
106
+
1 - v1 error format
107
+
2 - v2 error format
108
+
109
+
Returns:
110
+
An object of the form:
111
+
112
+
{ # This resource represents a long-running operation that is the result of a network API call.
113
+
"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.
114
+
"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.
115
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
116
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
117
+
{
118
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
119
+
},
120
+
],
121
+
"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.
122
+
},
123
+
"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.
124
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
125
+
},
126
+
"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}`.
127
+
"response": { # The normal, successful response of the operation. 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`.
128
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
name: string, Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. (required)
139
+
x__xgafv: string, V1 error format.
140
+
Allowed values
141
+
1 - v1 error format
142
+
2 - v2 error format
143
+
144
+
Returns:
145
+
An object of the form:
146
+
147
+
{ # Configurations used to enable CMEK data encryption with Cloud KMS keys.
148
+
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
149
+
"kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
150
+
"kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
151
+
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
152
+
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.
153
+
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
154
+
"singleRegionKeys": [ # Optional. Single-regional CMEKs that are required for some VAIS features.
155
+
{ # Metadata for single-regional CMEKs.
156
+
"kmsKey": "A String", # Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
157
+
},
158
+
],
159
+
"state": "A String", # Output only. The states of the CmekConfig.
parent: string, Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned. (required)
169
+
x__xgafv: string, V1 error format.
170
+
Allowed values
171
+
1 - v1 error format
172
+
2 - v2 error format
173
+
174
+
Returns:
175
+
An object of the form:
176
+
177
+
{ # Response message for CmekConfigService.ListCmekConfigs method.
178
+
"cmekConfigs": [ # All the customer's CmekConfigs.
179
+
{ # Configurations used to enable CMEK data encryption with Cloud KMS keys.
180
+
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
181
+
"kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
182
+
"kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
183
+
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
184
+
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.
185
+
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
186
+
"singleRegionKeys": [ # Optional. Single-regional CMEKs that are required for some VAIS features.
187
+
{ # Metadata for single-regional CMEKs.
188
+
"kmsKey": "A String", # Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
189
+
},
190
+
],
191
+
"state": "A String", # Output only. The states of the CmekConfig.
<pre>Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.
200
+
201
+
Args:
202
+
name: string, Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`. (required)
203
+
body: object, The request body.
204
+
The object takes the form of:
205
+
206
+
{ # Configurations used to enable CMEK data encryption with Cloud KMS keys.
207
+
"isDefault": True or False, # Output only. The default CmekConfig for the Customer.
208
+
"kmsKey": "A String", # KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
209
+
"kmsKeyVersion": "A String", # KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.
210
+
"lastRotationTimestampMicros": "A String", # Output only. The timestamp of the last key rotation.
211
+
"name": "A String", # Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.
212
+
"notebooklmState": "A String", # Output only. Whether the NotebookLM Corpus is ready to be used.
213
+
"singleRegionKeys": [ # Optional. Single-regional CMEKs that are required for some VAIS features.
214
+
{ # Metadata for single-regional CMEKs.
215
+
"kmsKey": "A String", # Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
216
+
},
217
+
],
218
+
"state": "A String", # Output only. The states of the CmekConfig.
219
+
}
220
+
221
+
setDefault: boolean, Set the following CmekConfig as the default to be used for child resources if one is not specified.
222
+
x__xgafv: string, V1 error format.
223
+
Allowed values
224
+
1 - v1 error format
225
+
2 - v2 error format
226
+
227
+
Returns:
228
+
An object of the form:
229
+
230
+
{ # This resource represents a long-running operation that is the result of a network API call.
231
+
"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.
232
+
"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.
233
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
234
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
235
+
{
236
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
237
+
},
238
+
],
239
+
"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.
240
+
},
241
+
"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.
242
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
243
+
},
244
+
"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}`.
245
+
"response": { # The normal, successful response of the operation. 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`.
246
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html
+1-1
Original file line number
Diff line number
Diff line change
@@ -115,7 +115,7 @@ <h3>Method Details</h3>
115
115
116
116
{ # Request message for ConversationalSearchService.ConverseConversation method.
117
117
"boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
118
-
"conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
118
+
"conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
119
119
{ # Boost applies to documents which match a condition.
120
120
"boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
121
121
"boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
0 commit comments