|
| 1 | +# DbtApi |
| 2 | + |
| 3 | +All URIs are relative to *https://api.segmentapis.com* |
| 4 | + |
| 5 | +| Method | HTTP request | Description | |
| 6 | +|------------- | ------------- | -------------| |
| 7 | +| [**createDbtModelSyncTrigger**](DbtApi.md#createDbtModelSyncTrigger) | **POST** /dbt-model-syncs/trigger | Create Dbt Model Sync Trigger | |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | +## Operation: createDbtModelSyncTrigger |
| 12 | + |
| 13 | +> CreateDbtModelSyncTrigger200Response createDbtModelSyncTrigger(createDbtModelSyncTriggerInput) |
| 14 | +
|
| 15 | +Create Dbt Model Sync Trigger |
| 16 | + |
| 17 | +Creates a trigger for a new dbt model sync for a Source. The rate limit for this endpoint is 10 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information. |
| 18 | + |
| 19 | +### Example |
| 20 | + |
| 21 | +```java |
| 22 | +// Import classes: |
| 23 | +import com.segment.publicapi.ApiClient; |
| 24 | +import com.segment.publicapi.ApiException; |
| 25 | +import com.segment.publicapi.Configuration; |
| 26 | +import com.segment.publicapi.auth.*; |
| 27 | +import com.segment.publicapi.models.*; |
| 28 | +import com.segment.publicapi.api.DbtApi; |
| 29 | + |
| 30 | +public class Example { |
| 31 | + public static void main(String[] args) { |
| 32 | + ApiClient defaultClient = Configuration.getDefaultApiClient(); |
| 33 | + |
| 34 | + // Configure HTTP bearer authorization: token |
| 35 | + HttpBearerAuth token = (HttpBearerAuth) defaultClient.getAuthentication("token"); |
| 36 | + token.setBearerToken("BEARER TOKEN"); |
| 37 | + |
| 38 | + DbtApi apiInstance = new DbtApi(defaultClient); |
| 39 | + CreateDbtModelSyncTriggerInput createDbtModelSyncTriggerInput = new CreateDbtModelSyncTriggerInput(); // CreateDbtModelSyncTriggerInput | |
| 40 | + try { |
| 41 | + CreateDbtModelSyncTrigger200Response result = apiInstance.createDbtModelSyncTrigger(createDbtModelSyncTriggerInput); |
| 42 | + System.out.println(result); |
| 43 | + } catch (ApiException e) { |
| 44 | + System.err.println("Exception when calling DbtApi#createDbtModelSyncTrigger"); |
| 45 | + System.err.println("Status code: " + e.getCode()); |
| 46 | + System.err.println("Reason: " + e.getResponseBody()); |
| 47 | + System.err.println("Response headers: " + e.getResponseHeaders()); |
| 48 | + e.printStackTrace(); |
| 49 | + } |
| 50 | + } |
| 51 | +} |
| 52 | +``` |
| 53 | + |
| 54 | +### Parameters |
| 55 | + |
| 56 | + |
| 57 | +| Name | Type | Description | Notes | |
| 58 | +|------------- | ------------- | ------------- | -------------| |
| 59 | +| **createDbtModelSyncTriggerInput** | [**CreateDbtModelSyncTriggerInput**](CreateDbtModelSyncTriggerInput.md)| | | |
| 60 | + |
| 61 | +### Return type |
| 62 | + |
| 63 | +[**CreateDbtModelSyncTrigger200Response**](CreateDbtModelSyncTrigger200Response.md) |
| 64 | + |
| 65 | +### Authorization |
| 66 | + |
| 67 | +[token](../README.md#token) |
| 68 | + |
| 69 | +### HTTP request headers |
| 70 | + |
| 71 | +- **Content-Type**: application/vnd.segment.v1beta+json |
| 72 | +- **Accept**: application/vnd.segment.v1beta+json, application/json |
| 73 | + |
| 74 | + |
| 75 | +### HTTP response details |
| 76 | +| Status code | Description | Response headers | |
| 77 | +|-------------|-------------|------------------| |
| 78 | +| **200** | OK | - | |
| 79 | +| **404** | Resource not found | - | |
| 80 | +| **422** | Validation failure | - | |
| 81 | +| **429** | Too many requests | - | |
| 82 | + |
0 commit comments