Skip to content

Commit

Permalink
search-core: add cloudChoice enum and config support (#277)
Browse files Browse the repository at this point in the history
This PR adds the new cloudChoice config property, to allow
choosing either all consumer serving regions, or just the ones
backed by GCP. By default the Multi option will be used, so
default behavior is unchanged.

J=WAT-4374
TEST=auto

Added new test class

---------

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
Fondryext and github-actions[bot] committed Dec 9, 2024
1 parent 689f94e commit 8e699a5
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/search-core.cloudchoice.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,19 @@

Defines the cloud choice of the API domains.

<<<<<<< HEAD
**Signature:**
=======
<b>Signature:</b>
>>>>>>> 7a02721 (search-core: add cloudChoice enum and config support (#277))
```typescript
export declare enum CloudChoice
```

## Enumeration Members

<<<<<<< HEAD
<table><thead><tr><th>

Member
Expand Down Expand Up @@ -59,3 +64,10 @@ GLOBAL\_MULTI

</td></tr>
</tbody></table>
=======
| Member | Value | Description |
| --- | --- | --- |
| GLOBAL\_GCP | <code>&quot;GLOBAL-GCP&quot;</code> | |
| GLOBAL\_MULTI | <code>&quot;GLOBAL-MULTI&quot;</code> | |

>>>>>>> 7a02721 (search-core: add cloudChoice enum and config support (#277))
22 changes: 22 additions & 0 deletions docs/search-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Represents an error

## Enumerations

<<<<<<< HEAD
<table><thead><tr><th>

Enumeration
Expand Down Expand Up @@ -242,6 +243,27 @@ Represents the type of spell check performed.

</td></tr>
</tbody></table>
=======
| Enumeration | Description |
| --- | --- |
| [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md) | Represents the type of [AppliedQueryFilter](./search-core.appliedqueryfilter.md) applied to a search. |
| [BuiltInFieldType](./search-core.builtinfieldtype.md) | Possible built-in field types for [DirectAnswer.fieldType](./search-core.directanswer.fieldtype.md)<!-- -->. |
| [CloudChoice](./search-core.cloudchoice.md) | Defines the cloud choice of the API domains. |
| [CloudRegion](./search-core.cloudregion.md) | Defines the cloud region of the API domains. |
| [DirectAnswerType](./search-core.directanswertype.md) | Represents the type of direct answer. |
| [Direction](./search-core.direction.md) | The direction of a sort. |
| [Environment](./search-core.environment.md) | Defines the environment of the API domains. |
| [ErrorType](./search-core.errortype.md) | Identifier for the type of error causing the failure. |
| [FilterCombinator](./search-core.filtercombinator.md) | Indicates how child filters in a [StaticFilter](./search-core.staticfilter.md) should be combined. |
| [LocationBiasMethod](./search-core.locationbiasmethod.md) | The method used to determine the location. |
| [Matcher](./search-core.matcher.md) | A Matcher is a filtering operation. |
| [QuerySource](./search-core.querysource.md) | The source of the search request. |
| [QueryTrigger](./search-core.querytrigger.md) | Describes the ways a search can be executed besides user input. |
| [SearchIntent](./search-core.searchintent.md) | Represents intents from the Search API. |
| [SortType](./search-core.sorttype.md) | The method of sorting. |
| [Source](./search-core.source.md) | Represents the source of a [Result](./search-core.result.md)<!-- -->. |
| [SpellCheckType](./search-core.spellchecktype.md) | Represents the type of spell check performed. |
>>>>>>> 7a02721 (search-core: add cloudChoice enum and config support (#277))
## Functions

Expand Down
4 changes: 4 additions & 0 deletions docs/search-core.servingconfig.cloudchoice.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@

Defines the cloud choice of the API domains.

<<<<<<< HEAD
**Signature:**
=======
<b>Signature:</b>
>>>>>>> 7a02721 (search-core: add cloudChoice enum and config support (#277))
```typescript
cloudChoice?: CloudChoice;
Expand Down
8 changes: 8 additions & 0 deletions docs/search-core.servingconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,15 @@ export interface ServingConfig

## Properties

<<<<<<< HEAD
<table><thead><tr><th>
=======
| Property | Type | Description |
| --- | --- | --- |
| [cloudChoice?](./search-core.servingconfig.cloudchoice.md) | [CloudChoice](./search-core.cloudchoice.md) | <i>(Optional)</i> Defines the cloud choice of the API domains. |
| [cloudRegion?](./search-core.servingconfig.cloudregion.md) | [CloudRegion](./search-core.cloudregion.md) | <i>(Optional)</i> Defines the cloud region of the API domains. |
| [environment?](./search-core.servingconfig.environment.md) | [Environment](./search-core.environment.md) | <i>(Optional)</i> Defines the environment of the API domains. |
>>>>>>> 7a02721 (search-core: add cloudChoice enum and config support (#277))

Property

Expand Down

0 comments on commit 8e699a5

Please sign in to comment.