\TimeflowsApi

All URIs are relative to /v3

Method	HTTP request	Description
CreateTimeflowTags	Post /timeflows/{timeflowId}/tags	Create tags for a Timeflow.
DeleteTimeflow	Delete /timeflows/{timeflowId}	Delete a timeflow.
DeleteTimeflowTags	Post /timeflows/{timeflowId}/tags/delete	Delete tags for a Timeflow.
GetTimeflowById	Get /timeflows/{timeflowId}	Get a Timeflow by ID.
GetTimeflowSnapshotDayRange	Get /timeflows/{timeflowId}/timeflowSnapshotDayRange	Returns the count of TimeFlow snapshots of the Timeflow aggregated by day.
GetTimeflowTags	Get /timeflows/{timeflowId}/tags	Get tags for a Timeflow.
GetTimeflows	Get /timeflows	Retrieve the list of timeflows.
SearchTimeflows	Post /timeflows/search	Search timeflows.
UpdateTimeflow	Patch /timeflows/{timeflowId}	Update values of a timeflow.

CreateTimeflowTags

TagsResponse CreateTimeflowTags(ctx, timeflowId).TagsRequest(tagsRequest).Execute()

Create tags for a Timeflow.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/delphix/dct-sdk-go"
)

func main() {
    timeflowId := "timeflowId_example" // string | The ID of the timeflow.
    tagsRequest := *openapiclient.NewTagsRequest([]openapiclient.Tag{*openapiclient.NewTag("key-1", "value-1")}) // TagsRequest | Tags information for Timeflow.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TimeflowsApi.CreateTimeflowTags(context.Background(), timeflowId).TagsRequest(tagsRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TimeflowsApi.CreateTimeflowTags``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateTimeflowTags`: TagsResponse
    fmt.Fprintf(os.Stdout, "Response from `TimeflowsApi.CreateTimeflowTags`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
timeflowId	string	The ID of the timeflow.

Other Parameters

Other parameters are passed through a pointer to a apiCreateTimeflowTagsRequest struct via the builder pattern

Name	Type	Description	Notes

tagsRequest | TagsRequest | Tags information for Timeflow. |

Return type

TagsResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteTimeflow

DeleteTimeflowResponse DeleteTimeflow(ctx, timeflowId).Execute()

Delete a timeflow.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/delphix/dct-sdk-go"
)

func main() {
    timeflowId := "timeflowId_example" // string | The ID of the timeflow.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TimeflowsApi.DeleteTimeflow(context.Background(), timeflowId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TimeflowsApi.DeleteTimeflow``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteTimeflow`: DeleteTimeflowResponse
    fmt.Fprintf(os.Stdout, "Response from `TimeflowsApi.DeleteTimeflow`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
timeflowId	string	The ID of the timeflow.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteTimeflowRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

DeleteTimeflowResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteTimeflowTags

DeleteTimeflowTags(ctx, timeflowId).DeleteTag(deleteTag).Execute()

Delete tags for a Timeflow.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/delphix/dct-sdk-go"
)

func main() {
    timeflowId := "timeflowId_example" // string | The ID of the timeflow.
    deleteTag := *openapiclient.NewDeleteTag() // DeleteTag | The parameters to delete tags (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.TimeflowsApi.DeleteTimeflowTags(context.Background(), timeflowId).DeleteTag(deleteTag).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TimeflowsApi.DeleteTimeflowTags``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
timeflowId	string	The ID of the timeflow.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteTimeflowTagsRequest struct via the builder pattern

Name	Type	Description	Notes

deleteTag | DeleteTag | The parameters to delete tags |

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTimeflowById

Timeflow GetTimeflowById(ctx, timeflowId).Execute()

Get a Timeflow by ID.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/delphix/dct-sdk-go"
)

func main() {
    timeflowId := "timeflowId_example" // string | The ID of the timeflow.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TimeflowsApi.GetTimeflowById(context.Background(), timeflowId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TimeflowsApi.GetTimeflowById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetTimeflowById`: Timeflow
    fmt.Fprintf(os.Stdout, "Response from `TimeflowsApi.GetTimeflowById`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
timeflowId	string	The ID of the timeflow.

Other Parameters

Other parameters are passed through a pointer to a apiGetTimeflowByIdRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Timeflow

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTimeflowSnapshotDayRange

SnapshotsDayRangesResponse GetTimeflowSnapshotDayRange(ctx, timeflowId).Execute()

Returns the count of TimeFlow snapshots of the Timeflow aggregated by day.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/delphix/dct-sdk-go"
)

func main() {
    timeflowId := "timeflowId_example" // string | The ID of the timeflow.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TimeflowsApi.GetTimeflowSnapshotDayRange(context.Background(), timeflowId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TimeflowsApi.GetTimeflowSnapshotDayRange``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetTimeflowSnapshotDayRange`: SnapshotsDayRangesResponse
    fmt.Fprintf(os.Stdout, "Response from `TimeflowsApi.GetTimeflowSnapshotDayRange`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
timeflowId	string	The ID of the timeflow.

Other Parameters

Other parameters are passed through a pointer to a apiGetTimeflowSnapshotDayRangeRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

SnapshotsDayRangesResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTimeflowTags

TagsResponse GetTimeflowTags(ctx, timeflowId).Execute()

Get tags for a Timeflow.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/delphix/dct-sdk-go"
)

func main() {
    timeflowId := "timeflowId_example" // string | The ID of the timeflow.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TimeflowsApi.GetTimeflowTags(context.Background(), timeflowId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TimeflowsApi.GetTimeflowTags``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetTimeflowTags`: TagsResponse
    fmt.Fprintf(os.Stdout, "Response from `TimeflowsApi.GetTimeflowTags`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
timeflowId	string	The ID of the timeflow.

Other Parameters

Other parameters are passed through a pointer to a apiGetTimeflowTagsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

TagsResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTimeflows

ListTimeflowsResponse GetTimeflows(ctx).Limit(limit).Cursor(cursor).Sort(sort).Execute()

Retrieve the list of timeflows.

Example

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 descending order. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TimeflowsApi.GetTimeflows(context.Background()).Limit(limit).Cursor(cursor).Sort(sort).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TimeflowsApi.GetTimeflows``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetTimeflows`: ListTimeflowsResponse
    fmt.Fprintf(os.Stdout, "Response from `TimeflowsApi.GetTimeflows`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiGetTimeflowsRequest 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 descending order.

Return type

ListTimeflowsResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SearchTimeflows

SearchTimeflowsResponse SearchTimeflows(ctx).Limit(limit).Cursor(cursor).Sort(sort).SearchBody(searchBody).Execute()

Search timeflows.

Example

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 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.TimeflowsApi.SearchTimeflows(context.Background()).Limit(limit).Cursor(cursor).Sort(sort).SearchBody(searchBody).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TimeflowsApi.SearchTimeflows``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SearchTimeflows`: SearchTimeflowsResponse
    fmt.Fprintf(os.Stdout, "Response from `TimeflowsApi.SearchTimeflows`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSearchTimeflowsRequest 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 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

Return type

SearchTimeflowsResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTimeflow

UpdateTimeflowResponse UpdateTimeflow(ctx, timeflowId).UpdateTimeflowParameters(updateTimeflowParameters).Execute()

Update values of a timeflow.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/delphix/dct-sdk-go"
)

func main() {
    timeflowId := "timeflowId_example" // string | The ID of the timeflow.
    updateTimeflowParameters := *openapiclient.NewUpdateTimeflowParameters() // UpdateTimeflowParameters | The new data to update a timeflow. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.TimeflowsApi.UpdateTimeflow(context.Background(), timeflowId).UpdateTimeflowParameters(updateTimeflowParameters).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TimeflowsApi.UpdateTimeflow``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateTimeflow`: UpdateTimeflowResponse
    fmt.Fprintf(os.Stdout, "Response from `TimeflowsApi.UpdateTimeflow`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
timeflowId	string	The ID of the timeflow.

Other Parameters

Other parameters are passed through a pointer to a apiUpdateTimeflowRequest struct via the builder pattern

Name	Type	Description	Notes

updateTimeflowParameters | UpdateTimeflowParameters | The new data to update a timeflow. |

Return type

UpdateTimeflowResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

TimeflowsApi.md

Latest commit

History

TimeflowsApi.md

File metadata and controls

\TimeflowsApi

CreateTimeflowTags

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteTimeflow

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteTimeflowTags

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetTimeflowById

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetTimeflowSnapshotDayRange

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetTimeflowTags

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetTimeflows

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SearchTimeflows

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateTimeflow

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers