Blame - docs/dyn/cloudsearch_v1.settings.searchapplications.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

78

<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

79

<p class="firstline">Creates a search application.</p>

80

81

<code><a href="#delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Deletes a search application.</p>

83

84

<code><a href="#get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>

85

<p class="firstline">Gets the specified search application.</p>

86

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

87

<code><a href="#list">list(debugOptions_enableDebugging=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

88

<p class="firstline">Lists all search applications.</p>

89

90

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

91

<p class="firstline">Retrieves the next page of results.</p>

92

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

93

<code><a href="#reset">reset(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

94

<p class="firstline">Resets a search application to default settings. This will return an empty</p>

95

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

96

<code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

97

<p class="firstline">Updates a search application.</p>

98

<h3>Method Details</h3>

99

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

100

<code class="details" id="create">create(body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

101

<pre>Creates a search application.

102

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

103

**Note:** This API requires an admin account to execute.

104

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

105

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

106

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

107

The object takes the form of:

108

109

{ # SearchApplication

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

110

"dataSourceRestrictions": [ # Retrictions applied to the configurations.

111

# The maximum number of elements is 10.

112

{ # Restriction on Datasource.

113

"filterOptions": [ # Filter options restricting the results. If multiple filters

114

# are present, they are grouped by object type before joining.

115

# Filters with the same object type are joined conjunctively, then

116

# the resulting expressions are joined disjunctively.

117

#

118

# The maximum number of elements is 20.

119

#

120

# NOTE: Suggest API supports only few filters at the moment:

121

# "objecttype", "type" and "mimetype".

122

# For now, schema specific filters cannot be used to filter suggestions.

123

{ # Filter options to be applied on query.

124

"filter": { # A generic way of expressing filters in a query, which supports two # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.

125

# approaches: <br/><br/>

126

# **1. Setting a ValueFilter.** The name must match an operator_name defined in

127

# the schema for your data source.

128

# <br/>

129

# **2. Setting a CompositeFilter.** The filters are evaluated

130

# using the logical operator. The top-level operators can only be either an AND

131

# or a NOT. AND can appear only at the top-most level. OR can appear only under

132

# a top-level AND.

133

"compositeFilter": {

134

"logicOperator": "A String", # The logic operator of the sub filter.

135

"subFilters": [ # Sub filters.

136

# Object with schema name: Filter

],

},

"valueFilter": {

"operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*.

141

# The filter can work against both types of filters defined in the schema

142

# for your data source:

143

# <br/><br/>

144

# 1. `operator_name`, where the query filters results by the property

145

# that matches the value.

146

# <br/>

147

# 2. `greater_than_operator_name` or `less_than_operator_name` in your

148

# schema. The query filters the results for the property values that are

149

# greater than or less than the supplied value in the query.

150

"value": { # Definition of a single value with generic type. # The value to be compared with.

151

"integerValue": "A String",

152

"stringValue": "A String",

153

"dateValue": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.

154

"month": 42, # Month of date. Must be from 1 to 12.

155

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.

156

"year": 42, # Year of date. Must be from 1 to 9999.

157

},

158

"doubleValue": 3.14,

159

"timestampValue": "A String",

160

"booleanValue": True or False,

},

},

},

"objectType": "A String", # If object_type is set, only objects of that type are returned. This should

165

# correspond to the name of the object that was registered within the

166

# definition of schema. The maximum length is 256 characters.

167

},

168

],

169

"source": { # Defines sources for the suggest/search APIs. # The source of restriction.

170

"name": "A String", # Source name for content indexed by the

171

# Indexing API.

172

"predefinedSource": "A String", # Predefined content source for Google Apps.

},

},

],

"sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.

177

{ # Configurations for a source while processing a

178

# Search or

179

# Suggest request.

180

"source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.

181

"name": "A String", # Source name for content indexed by the

182

# Indexing API.

183

"predefinedSource": "A String", # Predefined content source for Google Apps.

184

},

185

"scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.

186

# for a source.

187

"sourceImportance": "A String", # Importance of the source.

188

},

189

"crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.

190

# multiple results from the same source or host "crowd out" other results,

191

# diminishing the quality of search for users. To foster better search quality

192

# and source diversity in search results, you can set a condition to reduce

193

# repetitive results by source.

194

"numSuggestions": 42, # Maximum number of suggestions allowed from a source.

195

# No limits will be set on results if this value is less than or equal to 0.

196

"numResults": 42, # Maximum number of results allowed from a source.

197

# No limits will be set on results if this value is less than or equal to 0.

},

},

],

"defaultSortOptions": { # The default options for sorting the search results

202

"sortOrder": "A String", # Ascending is the default sort order

203

"operatorName": "A String", # Name of the operator corresponding to the field to sort on.

204

# The corresponding property must be marked as

205

# sortable.

206

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

207

"displayName": "A String", # Display name of the Search Application.

208

# The maximum length is 300 characters.

209

"defaultFacetOptions": [ # The default fields for returning facet results.

210

# The sources specified here also have been included in

211

# data_source_restrictions

212

# above.

213

{ # Specifies operators to return facet results for. There will be one

214

# FacetResult for every source_name/object_type/operator_name combination.

215

"numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet.

216

# Defaults to 10.

217

# Maximum value is 100.

218

"sourceName": "A String", # Source name to facet on. Format: datasources/{source_id}

219

# If empty, all data sources will be used.

220

"operatorName": "A String", # Name of the operator chosen for faceting. @see

221

# cloudsearch.SchemaPropertyOptions

222

"objectType": "A String", # If object_type is set, only those objects of that type will be used to

223

# compute facets. If empty, then all objects will be used to compute facets.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

224

},

225

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

226

"scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

227

# Search or

228

# Suggest request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

229

"disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will

230

# be used to boost results.

231

"disableFreshness": True or False, # Whether to use freshness as a ranking signal. By default, freshness is used

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

232

# as a ranking signal. Note that this setting is not available in the Admin

233

# UI.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

234

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

235

"name": "A String", # Name of the Search Application.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

236

# <br />Format: searchapplications/{application_id}.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

237

"operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this

238

# schema. Output only field.

239

"A String",

240

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

241

}

242

243

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

250

251

{ # This resource represents a long-running operation that is the result of a

252

# network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

253

"response": { # The normal response of the operation in case of success. If the original

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

254

# method returns no data on success, such as `Delete`, the response is

255

# `google.protobuf.Empty`. If the original method is standard

256

# `Get`/`Create`/`Update`, the response should be the resource. For other

257

# methods, the response should have the type `XxxResponse`, where `Xxx`

258

# is the original method name. For example, if the original method name

259

# is `TakeSnapshot()`, the inferred response type is

260

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

261

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

262

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

263

"name": "A String", # The server-assigned name, which is only unique within the same service that

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

264

# originally returns it. If you use the default HTTP mapping, the

265

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

266

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

267

# different programming environments, including REST APIs and RPC APIs. It is

268

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

269

# three pieces of data: error code, error message, and error details.

270

#

271

# You can find out more about this error model and how to work with it in the

272

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

273

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

274

# message types for APIs to use.

275

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

276

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

277

},

278

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

279

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

280

"message": "A String", # A developer-facing error message, which should be in English. Any

281

# user-facing error message should be localized and sent in the

282

# google.rpc.Status.details field, or localized by the client.

283

},

284

"metadata": { # Service-specific metadata associated with the operation. It typically

285

# contains progress information and common metadata such as create time.

286

# Some services might not provide such metadata. Any method that returns a

287

# long-running operation should document the metadata type, if any.

288

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

289

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

290

"done": True or False, # If the value is `false`, it means the operation is still in progress.

291

# If `true`, the operation is completed, and either `error` or `response` is

292

# available.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>

298

<pre>Deletes a search application.

299

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

300

**Note:** This API requires an admin account to execute.

301

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

302

Args:

303

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

304

<br />Format: applications/{application_id}. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

305

debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.

306

Otherwise, ignore this field.

307

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

314

315

{ # This resource represents a long-running operation that is the result of a

316

# network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

317

"response": { # The normal response of the operation in case of success. If the original

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

318

# method returns no data on success, such as `Delete`, the response is

319

# `google.protobuf.Empty`. If the original method is standard

320

# `Get`/`Create`/`Update`, the response should be the resource. For other

321

# methods, the response should have the type `XxxResponse`, where `Xxx`

322

# is the original method name. For example, if the original method name

323

# is `TakeSnapshot()`, the inferred response type is

324

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

325

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

326

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

327

"name": "A String", # The server-assigned name, which is only unique within the same service that

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

328

# originally returns it. If you use the default HTTP mapping, the

329

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

330

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

331

# different programming environments, including REST APIs and RPC APIs. It is

332

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

333

# three pieces of data: error code, error message, and error details.

334

#

335

# You can find out more about this error model and how to work with it in the

336

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

337

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

338

# message types for APIs to use.

339

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

340

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

341

},

342

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

343

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

344

"message": "A String", # A developer-facing error message, which should be in English. Any

345

# user-facing error message should be localized and sent in the

346

# google.rpc.Status.details field, or localized by the client.

347

},

348

"metadata": { # Service-specific metadata associated with the operation. It typically

349

# contains progress information and common metadata such as create time.

350

# Some services might not provide such metadata. Any method that returns a

351

# long-running operation should document the metadata type, if any.

352

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

353

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

354

"done": True or False, # If the value is `false`, it means the operation is still in progress.

355

# If `true`, the operation is completed, and either `error` or `response` is

356

# available.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>

362

<pre>Gets the specified search application.

363

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

364

**Note:** This API requires an admin account to execute.

365

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

366

Args:

367

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

368

<br />Format: applications/{application_id}. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

369

debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.

370

Otherwise, ignore this field.

371

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

378

379

{ # SearchApplication

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

380

"dataSourceRestrictions": [ # Retrictions applied to the configurations.

381

# The maximum number of elements is 10.

382

{ # Restriction on Datasource.

383

"filterOptions": [ # Filter options restricting the results. If multiple filters

384

# are present, they are grouped by object type before joining.

385

# Filters with the same object type are joined conjunctively, then

386

# the resulting expressions are joined disjunctively.

387

#

388

# The maximum number of elements is 20.

389

#

390

# NOTE: Suggest API supports only few filters at the moment:

391

# "objecttype", "type" and "mimetype".

392

# For now, schema specific filters cannot be used to filter suggestions.

393

{ # Filter options to be applied on query.

394

"filter": { # A generic way of expressing filters in a query, which supports two # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.

395

# approaches: <br/><br/>

396

# **1. Setting a ValueFilter.** The name must match an operator_name defined in

397

# the schema for your data source.

398

# <br/>

399

# **2. Setting a CompositeFilter.** The filters are evaluated

400

# using the logical operator. The top-level operators can only be either an AND

401

# or a NOT. AND can appear only at the top-most level. OR can appear only under

402

# a top-level AND.

403

"compositeFilter": {

404

"logicOperator": "A String", # The logic operator of the sub filter.

405

"subFilters": [ # Sub filters.

406

# Object with schema name: Filter

],

},

"valueFilter": {

"operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*.

411

# The filter can work against both types of filters defined in the schema

412

# for your data source:

413

# <br/><br/>

414

# 1. `operator_name`, where the query filters results by the property

415

# that matches the value.

416

# <br/>

417

# 2. `greater_than_operator_name` or `less_than_operator_name` in your

418

# schema. The query filters the results for the property values that are

419

# greater than or less than the supplied value in the query.

420

"value": { # Definition of a single value with generic type. # The value to be compared with.

421

"integerValue": "A String",

422

"stringValue": "A String",

423

"dateValue": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.

424

"month": 42, # Month of date. Must be from 1 to 12.

425

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.

426

"year": 42, # Year of date. Must be from 1 to 9999.

427

},

428

"doubleValue": 3.14,

429

"timestampValue": "A String",

430

"booleanValue": True or False,

},

},

},

"objectType": "A String", # If object_type is set, only objects of that type are returned. This should

435

# correspond to the name of the object that was registered within the

436

# definition of schema. The maximum length is 256 characters.

437

},

438

],

439

"source": { # Defines sources for the suggest/search APIs. # The source of restriction.

440

"name": "A String", # Source name for content indexed by the

441

# Indexing API.

442

"predefinedSource": "A String", # Predefined content source for Google Apps.

},

},

],

"sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.

447

{ # Configurations for a source while processing a

448

# Search or

449

# Suggest request.

450

"source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.

451

"name": "A String", # Source name for content indexed by the

452

# Indexing API.

453

"predefinedSource": "A String", # Predefined content source for Google Apps.

454

},

455

"scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.

456

# for a source.

457

"sourceImportance": "A String", # Importance of the source.

458

},

459

"crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.

460

# multiple results from the same source or host "crowd out" other results,

461

# diminishing the quality of search for users. To foster better search quality

462

# and source diversity in search results, you can set a condition to reduce

463

# repetitive results by source.

464

"numSuggestions": 42, # Maximum number of suggestions allowed from a source.

465

# No limits will be set on results if this value is less than or equal to 0.

466

"numResults": 42, # Maximum number of results allowed from a source.

467

# No limits will be set on results if this value is less than or equal to 0.

},

},

],

"defaultSortOptions": { # The default options for sorting the search results

472

"sortOrder": "A String", # Ascending is the default sort order

473

"operatorName": "A String", # Name of the operator corresponding to the field to sort on.

474

# The corresponding property must be marked as

475

# sortable.

476

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

477

"displayName": "A String", # Display name of the Search Application.

478

# The maximum length is 300 characters.

479

"defaultFacetOptions": [ # The default fields for returning facet results.

480

# The sources specified here also have been included in

481

# data_source_restrictions

482

# above.

483

{ # Specifies operators to return facet results for. There will be one

484

# FacetResult for every source_name/object_type/operator_name combination.

485

"numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet.

486

# Defaults to 10.

487

# Maximum value is 100.

488

"sourceName": "A String", # Source name to facet on. Format: datasources/{source_id}

489

# If empty, all data sources will be used.

490

"operatorName": "A String", # Name of the operator chosen for faceting. @see

491

# cloudsearch.SchemaPropertyOptions

492

"objectType": "A String", # If object_type is set, only those objects of that type will be used to

493

# compute facets. If empty, then all objects will be used to compute facets.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

494

},

495

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

496

"scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

497

# Search or

498

# Suggest request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

499

"disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will

500

# be used to boost results.

501

"disableFreshness": True or False, # Whether to use freshness as a ranking signal. By default, freshness is used

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

502

# as a ranking signal. Note that this setting is not available in the Admin

503

# UI.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

504

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

505

"name": "A String", # Name of the Search Application.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

506

# <br />Format: searchapplications/{application_id}.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

507

"operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this

508

# schema. Output only field.

509

"A String",

510

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

515

<code class="details" id="list">list(debugOptions_enableDebugging=None, pageToken=None, pageSize=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

516

<pre>Lists all search applications.

517

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

518

**Note:** This API requires an admin account to execute.

519

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

520

Args:

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

521

debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.

522

Otherwise, ignore this field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

523

pageToken: string, The next_page_token value returned from a previous List request, if any.

524

<br/> The default value is 10

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

525

pageSize: integer, The maximum number of items to return.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

526

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

533

534

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

535

"searchApplications": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

536

{ # SearchApplication

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

537

"dataSourceRestrictions": [ # Retrictions applied to the configurations.

538

# The maximum number of elements is 10.

539

{ # Restriction on Datasource.

540

"filterOptions": [ # Filter options restricting the results. If multiple filters

541

# are present, they are grouped by object type before joining.

542

# Filters with the same object type are joined conjunctively, then

543

# the resulting expressions are joined disjunctively.

544

#

545

# The maximum number of elements is 20.

546

#

547

# NOTE: Suggest API supports only few filters at the moment:

548

# "objecttype", "type" and "mimetype".

549

# For now, schema specific filters cannot be used to filter suggestions.

550

{ # Filter options to be applied on query.

551

"filter": { # A generic way of expressing filters in a query, which supports two # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.

552

# approaches: <br/><br/>

553

# **1. Setting a ValueFilter.** The name must match an operator_name defined in

554

# the schema for your data source.

555

# <br/>

556

# **2. Setting a CompositeFilter.** The filters are evaluated

557

# using the logical operator. The top-level operators can only be either an AND

558

# or a NOT. AND can appear only at the top-most level. OR can appear only under

559

# a top-level AND.

560

"compositeFilter": {

561

"logicOperator": "A String", # The logic operator of the sub filter.

562

"subFilters": [ # Sub filters.

563

# Object with schema name: Filter

],

},

"valueFilter": {

"operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*.

568

# The filter can work against both types of filters defined in the schema

569

# for your data source:

570

# <br/><br/>

571

# 1. `operator_name`, where the query filters results by the property

572

# that matches the value.

573

# <br/>

574

# 2. `greater_than_operator_name` or `less_than_operator_name` in your

575

# schema. The query filters the results for the property values that are

576

# greater than or less than the supplied value in the query.

577

"value": { # Definition of a single value with generic type. # The value to be compared with.

578

"integerValue": "A String",

579

"stringValue": "A String",

580

"dateValue": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.

581

"month": 42, # Month of date. Must be from 1 to 12.

582

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.

583

"year": 42, # Year of date. Must be from 1 to 9999.

584

},

585

"doubleValue": 3.14,

586

"timestampValue": "A String",

587

"booleanValue": True or False,

},

},

},

"objectType": "A String", # If object_type is set, only objects of that type are returned. This should

592

# correspond to the name of the object that was registered within the

593

# definition of schema. The maximum length is 256 characters.

594

},

595

],

596

"source": { # Defines sources for the suggest/search APIs. # The source of restriction.

597

"name": "A String", # Source name for content indexed by the

598

# Indexing API.

599

"predefinedSource": "A String", # Predefined content source for Google Apps.

},

},

],

"sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.

604

{ # Configurations for a source while processing a

605

# Search or

606

# Suggest request.

607

"source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.

608

"name": "A String", # Source name for content indexed by the

609

# Indexing API.

610

"predefinedSource": "A String", # Predefined content source for Google Apps.

611

},

612

"scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.

613

# for a source.

614

"sourceImportance": "A String", # Importance of the source.

615

},

616

"crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.

617

# multiple results from the same source or host "crowd out" other results,

618

# diminishing the quality of search for users. To foster better search quality

619

# and source diversity in search results, you can set a condition to reduce

620

# repetitive results by source.

621

"numSuggestions": 42, # Maximum number of suggestions allowed from a source.

622

# No limits will be set on results if this value is less than or equal to 0.

623

"numResults": 42, # Maximum number of results allowed from a source.

624

# No limits will be set on results if this value is less than or equal to 0.

},

},

],

"defaultSortOptions": { # The default options for sorting the search results

629

"sortOrder": "A String", # Ascending is the default sort order

630

"operatorName": "A String", # Name of the operator corresponding to the field to sort on.

631

# The corresponding property must be marked as

632

# sortable.

633

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

634

"displayName": "A String", # Display name of the Search Application.

635

# The maximum length is 300 characters.

636

"defaultFacetOptions": [ # The default fields for returning facet results.

637

# The sources specified here also have been included in

638

# data_source_restrictions

639

# above.

640

{ # Specifies operators to return facet results for. There will be one

641

# FacetResult for every source_name/object_type/operator_name combination.

642

"numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet.

643

# Defaults to 10.

644

# Maximum value is 100.

645

"sourceName": "A String", # Source name to facet on. Format: datasources/{source_id}

646

# If empty, all data sources will be used.

647

"operatorName": "A String", # Name of the operator chosen for faceting. @see

648

# cloudsearch.SchemaPropertyOptions

649

"objectType": "A String", # If object_type is set, only those objects of that type will be used to

650

# compute facets. If empty, then all objects will be used to compute facets.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

651

},

652

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

653

"scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

654

# Search or

655

# Suggest request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

656

"disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will

657

# be used to boost results.

658

"disableFreshness": True or False, # Whether to use freshness as a ranking signal. By default, freshness is used

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

659

# as a ranking signal. Note that this setting is not available in the Admin

660

# UI.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

661

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

662

"name": "A String", # Name of the Search Application.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

663

# <br />Format: searchapplications/{application_id}.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

664

"operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this

665

# schema. Output only field.

666

"A String",

667

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

668

},

669

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

670

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no

671

# more results in the list.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

677

<pre>Retrieves the next page of results.

678

679

Args:

680

previous_request: The request for the previous page. (required)

681

previous_response: The response from the request for the previous page. (required)

682

683

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

684

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

685

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

690

<code class="details" id="reset">reset(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

691

<pre>Resets a search application to default settings. This will return an empty

692

response.

693

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

694

**Note:** This API requires an admin account to execute.

695

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

696

Args:

697

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

698

<br />Format: applications/{application_id}. (required)

699

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

700

The object takes the form of:

701

702

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

703

"debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.

704

"enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

705

# Otherwise, ignore this field.

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

716

717

{ # This resource represents a long-running operation that is the result of a

718

# network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

719

"response": { # The normal response of the operation in case of success. If the original

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

720

# method returns no data on success, such as `Delete`, the response is

721

# `google.protobuf.Empty`. If the original method is standard

722

# `Get`/`Create`/`Update`, the response should be the resource. For other

723

# methods, the response should have the type `XxxResponse`, where `Xxx`

724

# is the original method name. For example, if the original method name

725

# is `TakeSnapshot()`, the inferred response type is

726

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

727

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

728

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

729

"name": "A String", # The server-assigned name, which is only unique within the same service that

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

730

# originally returns it. If you use the default HTTP mapping, the

731

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

732

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

733

# different programming environments, including REST APIs and RPC APIs. It is

734

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

735

# three pieces of data: error code, error message, and error details.

736

#

737

# You can find out more about this error model and how to work with it in the

738

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

739

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

740

# message types for APIs to use.

741

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

742

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

743

},

744

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

745

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

746

"message": "A String", # A developer-facing error message, which should be in English. Any

747

# user-facing error message should be localized and sent in the

748

# google.rpc.Status.details field, or localized by the client.

749

},

750

"metadata": { # Service-specific metadata associated with the operation. It typically

751

# contains progress information and common metadata such as create time.

752

# Some services might not provide such metadata. Any method that returns a

753

# long-running operation should document the metadata type, if any.

754

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

755

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

756

"done": True or False, # If the value is `false`, it means the operation is still in progress.

757

# If `true`, the operation is completed, and either `error` or `response` is

758

# available.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

763

<code class="details" id="update">update(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

764

<pre>Updates a search application.

765

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

766

**Note:** This API requires an admin account to execute.

767

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

768

Args:

769

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

770

<br />Format: searchapplications/{application_id}. (required)

771

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

772

The object takes the form of:

773

774

{ # SearchApplication

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

775

"dataSourceRestrictions": [ # Retrictions applied to the configurations.

776

# The maximum number of elements is 10.

777

{ # Restriction on Datasource.

778

"filterOptions": [ # Filter options restricting the results. If multiple filters

779

# are present, they are grouped by object type before joining.

780

# Filters with the same object type are joined conjunctively, then

781

# the resulting expressions are joined disjunctively.

782

#

783

# The maximum number of elements is 20.

784

#

785

# NOTE: Suggest API supports only few filters at the moment:

786

# "objecttype", "type" and "mimetype".

787

# For now, schema specific filters cannot be used to filter suggestions.

788

{ # Filter options to be applied on query.

789

"filter": { # A generic way of expressing filters in a query, which supports two # Generic filter to restrict the search, such as `lang:en`, `site:xyz`.

790

# approaches: <br/><br/>

791

# **1. Setting a ValueFilter.** The name must match an operator_name defined in

792

# the schema for your data source.

793

# <br/>

794

# **2. Setting a CompositeFilter.** The filters are evaluated

795

# using the logical operator. The top-level operators can only be either an AND

796

# or a NOT. AND can appear only at the top-most level. OR can appear only under

797

# a top-level AND.

798

"compositeFilter": {

799

"logicOperator": "A String", # The logic operator of the sub filter.

800

"subFilters": [ # Sub filters.

801

# Object with schema name: Filter

],

},

"valueFilter": {

"operatorName": "A String", # The `operator_name` applied to the query, such as *price_greater_than*.

806

# The filter can work against both types of filters defined in the schema

807

# for your data source:

808

# <br/><br/>

809

# 1. `operator_name`, where the query filters results by the property

810

# that matches the value.

811

# <br/>

812

# 2. `greater_than_operator_name` or `less_than_operator_name` in your

813

# schema. The query filters the results for the property values that are

814

# greater than or less than the supplied value in the query.

815

"value": { # Definition of a single value with generic type. # The value to be compared with.

816

"integerValue": "A String",

817

"stringValue": "A String",

818

"dateValue": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.

819

"month": 42, # Month of date. Must be from 1 to 12.

820

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.

821

"year": 42, # Year of date. Must be from 1 to 9999.

822

},

823

"doubleValue": 3.14,

824

"timestampValue": "A String",

825

"booleanValue": True or False,

},

},

},

"objectType": "A String", # If object_type is set, only objects of that type are returned. This should

830

# correspond to the name of the object that was registered within the

831

# definition of schema. The maximum length is 256 characters.

832

},

833

],

834

"source": { # Defines sources for the suggest/search APIs. # The source of restriction.

835

"name": "A String", # Source name for content indexed by the

836

# Indexing API.

837

"predefinedSource": "A String", # Predefined content source for Google Apps.

},

},

],

"sourceConfig": [ # Configuration for a sources specified in data_source_restrictions.

842

{ # Configurations for a source while processing a

843

# Search or

844

# Suggest request.

845

"source": { # Defines sources for the suggest/search APIs. # The source for which this configuration is to be used.

846

"name": "A String", # Source name for content indexed by the

847

# Indexing API.

848

"predefinedSource": "A String", # Predefined content source for Google Apps.

849

},

850

"scoringConfig": { # Set the scoring configuration. This allows modifying the ranking of results # The scoring configuration for the source.

851

# for a source.

852

"sourceImportance": "A String", # Importance of the source.

853

},

854

"crowdingConfig": { # Set search results crowding limits. Crowding is a situation in which # The crowding configuration for the source.

855

# multiple results from the same source or host "crowd out" other results,

856

# diminishing the quality of search for users. To foster better search quality

857

# and source diversity in search results, you can set a condition to reduce

858

# repetitive results by source.

859

"numSuggestions": 42, # Maximum number of suggestions allowed from a source.

860

# No limits will be set on results if this value is less than or equal to 0.

861

"numResults": 42, # Maximum number of results allowed from a source.

862

# No limits will be set on results if this value is less than or equal to 0.

},

},

],

"defaultSortOptions": { # The default options for sorting the search results

867

"sortOrder": "A String", # Ascending is the default sort order

868

"operatorName": "A String", # Name of the operator corresponding to the field to sort on.

869

# The corresponding property must be marked as

870

# sortable.

871

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

872

"displayName": "A String", # Display name of the Search Application.

873

# The maximum length is 300 characters.

874

"defaultFacetOptions": [ # The default fields for returning facet results.

875

# The sources specified here also have been included in

876

# data_source_restrictions

877

# above.

878

{ # Specifies operators to return facet results for. There will be one

879

# FacetResult for every source_name/object_type/operator_name combination.

880

"numFacetBuckets": 42, # Maximum number of facet buckets that should be returned for this facet.

881

# Defaults to 10.

882

# Maximum value is 100.

883

"sourceName": "A String", # Source name to facet on. Format: datasources/{source_id}

884

# If empty, all data sources will be used.

885

"operatorName": "A String", # Name of the operator chosen for faceting. @see

886

# cloudsearch.SchemaPropertyOptions

887

"objectType": "A String", # If object_type is set, only those objects of that type will be used to

888

# compute facets. If empty, then all objects will be used to compute facets.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

889

},

890

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

891

"scoringConfig": { # Scoring configurations for a source while processing a # Configuration for ranking results.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

892

# Search or

893

# Suggest request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

894

"disablePersonalization": True or False, # Whether to personalize the results. By default, personal signals will

895

# be used to boost results.

896

"disableFreshness": True or False, # Whether to use freshness as a ranking signal. By default, freshness is used

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

897

# as a ranking signal. Note that this setting is not available in the Admin

898

# UI.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

899

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

900

"name": "A String", # Name of the Search Application.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

901

# <br />Format: searchapplications/{application_id}.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

902

"operationIds": [ # Output only. IDs of the Long Running Operations (LROs) currently running for this

903

# schema. Output only field.

904

"A String",

905

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

906

}

907

908

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

915

916

{ # This resource represents a long-running operation that is the result of a

917

# network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

918

"response": { # The normal response of the operation in case of success. If the original

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

919

# method returns no data on success, such as `Delete`, the response is

920

# `google.protobuf.Empty`. If the original method is standard

921

# `Get`/`Create`/`Update`, the response should be the resource. For other

922

# methods, the response should have the type `XxxResponse`, where `Xxx`

923

# is the original method name. For example, if the original method name

924

# is `TakeSnapshot()`, the inferred response type is

925

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

926

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

927

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

928

"name": "A String", # The server-assigned name, which is only unique within the same service that

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

929

# originally returns it. If you use the default HTTP mapping, the

930

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

931

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

Bu Sun Kim