Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Port #282 to 3-dev #307

Merged
merged 2 commits into from
May 29, 2019
Merged

Port #282 to 3-dev #307

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01d20d6
fix arguments list
berthieresteban May 29, 2019
90ee594
Merge branch '3-dev' into 282-fix-index-refreshInternal-JS6-GO1-JAVA1
Aschen May 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 11 additions & 12 deletions src/sdk/go/1/controllers/index/refresh-internal/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,26 +18,25 @@ From [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch
"While a refresh is much lighter than a commit, it still has a performance cost. A manual refresh can be useful when writing tests, but don’t do a manual refresh every time you index a document in production; it will hurt your performance. Instead, your application needs to be aware of the near real-time nature of Elasticsearch and make allowances for it."
:::

## Signature
## Arguments

```go
RefreshInternal(index string, options types.QueryOptions) error
RefreshInternal(options types.QueryOptions) error
```

## Arguments
<br/>

| Arguments | Type | Description | Required |
| --------- | ------------ | ------------- | -------- |
| `index` | string | Index name | yes |
| `options` | QueryOptions | Query options | no |
| Arguments | Type | Description |
| --------- | ------------ | ------------- |
| `options` | <pre>QueryOptions</pre> | Query options |

### **Options**
### Options

Additional query options
The `options` arguments can contain the following option properties:

| Option | Type | Description | Default |
| ---------- | ---- | --------------------------------- | ------- |
| `queuable` | bool | Make this request queuable or not | `true` |
| Option | Type (default) | Description |
| ---------- | -------------- | --------------------------------- |
| `queuable` | <pre>bool (true)</pre> | If true, queues the request during downtime, until connected to Kuzzle again |

## Return

Expand Down
25 changes: 12 additions & 13 deletions src/sdk/java/1/controllers/index/refresh-internal/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,27 +19,26 @@ From [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch

</div>

## Signature
## Arguments

```java
void refreshInternal() throws io.kuzzle.sdk.BadRequestException, io.kuzzle.sdk.ForbiddenException, io.kuzzle.sdk.GatewayTimeoutException, io.kuzzle.sdk.InternalException, io.kuzzle.sdk.ServiceUnavailableException;
void refreshInternal(io.kuzzle.sdk.QueryOptions options) throws io.kuzzle.sdk.BadRequestException, io.kuzzle.sdk.ForbiddenException, io.kuzzle.sdk.GatewayTimeoutException, io.kuzzle.sdk.InternalException, io.kuzzle.sdk.ServiceUnavailableException;
void refreshInternal() throws io.kuzzle.sdk.KuzzleException;
void refreshInternal(io.kuzzle.sdk.QueryOptions options) throws io.kuzzle.sdk.KuzzleException;
```

## Arguments
<br/>

| Arguments | Type | Description | Required |
| --------- | -------------------------- | ----------------- | -------- |
| `index` | String | Index name | yes |
| `options` | io.kuzzle.sdk.QueryOptions | The query options | no |
| Arguments | Type | Description |
| --------- | ------------ | ----------------- |
| `options` | <pre>io.kuzzle.sdk.QueryOptions</pre> | Query options |

### **Options**
### Options

Additional query options
The `options` arguments can contain the following option properties:

| Option | Type | Description | Default |
| ---------- | ------- | --------------------------------- | ------- |
| `queuable` | boolean | Make this request queuable or not | `true` |
| Property | Type (default) | Description |
| ---------- | ------- | --------------------------------- |
| `queuable` | <pre>boolean (true)</pre> | If true, queues the request during downtime, until connected to Kuzzle again |

## Exceptions

Expand Down
7 changes: 3 additions & 4 deletions src/sdk/js/6/controllers/index/refresh-internal/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,21 @@ From [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch

</div>

<br/>
## Arguments

```javascript
refreshInternal(index, [options]);
refreshInternal([options]);
```

<br/>

| Arguments | Type | Description |
| --------- | ----------------- | ------------- |
| `index` | <pre>string</pre> | Index name |
| `options` | <pre>object</pre> | Query options |

### options

Additional query options
The `options` arguments can contain the following option properties:

| Property | Type<br/>(default) | Description |
| ---------- | ------------------------------- | ---------------------------------------------------------------------------- |
Expand Down