\VCDBsApi

All URIs are relative to /v3

Method	HTTP request	Description
CreateVcdbTags	Post /vcdbs/{vcdbId}/tags	Create tags for a vCDB.
DeleteVcdbTags	Post /vcdbs/{vcdbId}/tags/delete	Delete tags for a vCDB.
GetTagsVcdb	Get /vcdbs/{vcdbId}/tags	Get tags for a vCDB.
GetVcdbById	Get /vcdbs/{vcdbId}	Get a CDB by ID (Oracle only).
GetVcdbs	Get /vcdbs	List all vCDBs (Oracle only).
SearchVcdbs	Post /vcdbs/search	Search for vCDBs (Oracle only).

CreateVcdbTags

TagsResponse CreateVcdbTags(ctx, vcdbId).TagsRequest(tagsRequest).Execute()

Create tags for a vCDB.

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

tagsRequest | TagsRequest | Tags information for vCDB. |

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]

DeleteVcdbTags

DeleteVcdbTags(ctx, vcdbId).DeleteTag(deleteTag).Execute()

Delete tags for a vCDB.

Example

package main

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

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.VCDBsApi.DeleteVcdbTags(context.Background(), vcdbId).DeleteTag(deleteTag).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VCDBsApi.DeleteVcdbTags``: %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.
vcdbId	string	The ID of the vCDB.

Other Parameters

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

GetTagsVcdb

TagsResponse GetTagsVcdb(ctx, vcdbId).Execute()

Get tags for a vCDB.

Example

package main

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

func main() {
    vcdbId := "vcdbId_example" // string | The ID of the vCDB.

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

Path Parameters

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

Other Parameters

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

GetVcdbById

VCDB GetVcdbById(ctx, vcdbId).Execute()

Get a CDB by ID (Oracle only).

Example

package main

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

func main() {
    vcdbId := "vcdbId_example" // string | The ID of the vCDB.

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

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

VCDB

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]

GetVcdbs

ListVCDBsResponse GetVcdbs(ctx).Limit(limit).Cursor(cursor).Sort(sort).Execute()

List all vCDBs (Oracle only).

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

Path Parameters

Other Parameters

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

ListVCDBsResponse

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]

SearchVcdbs

SearchVCDBsResponse SearchVcdbs(ctx).Limit(limit).Cursor(cursor).Sort(sort).SearchBody(searchBody).Execute()

Search for vCDBs (Oracle only).

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

Path Parameters

Other Parameters

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

SearchVCDBsResponse

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

VCDBsApi.md

Latest commit

History

VCDBsApi.md

File metadata and controls

\VCDBsApi

CreateVcdbTags

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteVcdbTags

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetTagsVcdb

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetVcdbById

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetVcdbs

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SearchVcdbs

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers