All URIs are relative to /v3
| Method | HTTP request | Description |
|---|---|---|
| CreateAlgorithm | Post /algorithms | Create a new algorithm. |
| DeleteAlgorithm | Delete /algorithms/{algorithmId} | Delete an algorithm. |
| GetAlgorithmById | Get /algorithms/{algorithmId} | Get an algorithm by ID. |
| GetAlgorithms | Get /algorithms | Retrieve the list of algorithms. |
| SearchAlgorithms | Post /algorithms/search | Search for algorithms. |
CreateAlgorithmResponse CreateAlgorithm(ctx).AlgorithmCreateParameters(algorithmCreateParameters).Execute()
Create a new algorithm.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/delphix/dct-sdk-go"
)
func main() {
algorithmCreateParameters := *openapiclient.NewAlgorithmCreateParameters("Address", "1", map[string]interface{}{"key": interface{}(123)}, int32(123)) // AlgorithmCreateParameters | The parameters to create an algorithm.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AlgorithmsApi.CreateAlgorithm(context.Background()).AlgorithmCreateParameters(algorithmCreateParameters).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AlgorithmsApi.CreateAlgorithm``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateAlgorithm`: CreateAlgorithmResponse
fmt.Fprintf(os.Stdout, "Response from `AlgorithmsApi.CreateAlgorithm`: %v\n", resp)
}Other parameters are passed through a pointer to a apiCreateAlgorithmRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| algorithmCreateParameters | AlgorithmCreateParameters | The parameters to create an algorithm. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteAlgorithm(ctx, algorithmId).Execute()
Delete an algorithm.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/delphix/dct-sdk-go"
)
func main() {
algorithmId := "algorithmId_example" // string | The ID of the Algorithm.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
r, err := apiClient.AlgorithmsApi.DeleteAlgorithm(context.Background(), algorithmId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AlgorithmsApi.DeleteAlgorithm``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| algorithmId | string | The ID of the Algorithm. |
Other parameters are passed through a pointer to a apiDeleteAlgorithmRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Algorithm GetAlgorithmById(ctx, algorithmId).Execute()
Get an algorithm by ID.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/delphix/dct-sdk-go"
)
func main() {
algorithmId := "algorithmId_example" // string | The ID of the Algorithm.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AlgorithmsApi.GetAlgorithmById(context.Background(), algorithmId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AlgorithmsApi.GetAlgorithmById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetAlgorithmById`: Algorithm
fmt.Fprintf(os.Stdout, "Response from `AlgorithmsApi.GetAlgorithmById`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| algorithmId | string | The ID of the Algorithm. |
Other parameters are passed through a pointer to a apiGetAlgorithmByIdRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListAlgorithmsResponse GetAlgorithms(ctx).Limit(limit).Cursor(cursor).Sort(sort).Execute()
Retrieve the list of algorithms.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/delphix/dct-sdk-go"
)
func main() {
limit := int32(50) // int32 | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. (optional) (default to 100)
cursor := "cursor_example" // string | Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. (optional)
sort := "id" // string | The field to sort results by. A property name with a prepended '-' signifies a descending order. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AlgorithmsApi.GetAlgorithms(context.Background()).Limit(limit).Cursor(cursor).Sort(sort).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AlgorithmsApi.GetAlgorithms``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetAlgorithms`: ListAlgorithmsResponse
fmt.Fprintf(os.Stdout, "Response from `AlgorithmsApi.GetAlgorithms`: %v\n", resp)
}Other parameters are passed through a pointer to a apiGetAlgorithmsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | int32 | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. | [default to 100] |
| cursor | string | Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. | |
| sort | string | The field to sort results by. A property name with a prepended '-' signifies a descending order. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SearchAlgorithmsResponse SearchAlgorithms(ctx).Limit(limit).Cursor(cursor).Sort(sort).SearchBody(searchBody).Execute()
Search for algorithms.
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/delphix/dct-sdk-go"
)
func main() {
limit := int32(50) // int32 | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. (optional) (default to 100)
cursor := "cursor_example" // string | Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. (optional)
sort := "id" // string | The field to sort results by. A property name with a prepended '-' signifies a descending order. (optional)
searchBody := *openapiclient.NewSearchBody() // SearchBody | A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview **Note: All keywords are case-insensitive** ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 | ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`. ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' | ## Grouping Parenthesis `()` can be used to override operator precedence. For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo') ## Literal Values | Literal | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | \"foo\", \"bar\", \"foo bar\", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', \"bar\"] | ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AlgorithmsApi.SearchAlgorithms(context.Background()).Limit(limit).Cursor(cursor).Sort(sort).SearchBody(searchBody).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AlgorithmsApi.SearchAlgorithms``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `SearchAlgorithms`: SearchAlgorithmsResponse
fmt.Fprintf(os.Stdout, "Response from `AlgorithmsApi.SearchAlgorithms`: %v\n", resp)
}Other parameters are passed through a pointer to a apiSearchAlgorithmsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | int32 | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. | [default to 100] |
| cursor | string | Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. | |
| sort | string | The field to sort results by. A property name with a prepended '-' signifies a descending order. | |
| searchBody | SearchBody | A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview Note: All keywords are case-insensitive ## Comparison Operators | Operator |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]