...

Package nosql

import "github.com/oracle/oci-go-sdk/nosql"
Overview
Index

Overview ▾

Index ▾

type ChangeTableCompartmentDetails
    func (m ChangeTableCompartmentDetails) String() string
type ChangeTableCompartmentRequest
    func (request ChangeTableCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ChangeTableCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeTableCompartmentRequest) String() string
type ChangeTableCompartmentResponse
    func (response ChangeTableCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeTableCompartmentResponse) String() string
type Column
    func (m Column) String() string
type CreateIndexDetails
    func (m CreateIndexDetails) String() string
type CreateIndexRequest
    func (request CreateIndexRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateIndexRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateIndexRequest) String() string
type CreateIndexResponse
    func (response CreateIndexResponse) HTTPResponse() *http.Response
    func (response CreateIndexResponse) String() string
type CreateTableDetails
    func (m CreateTableDetails) String() string
type CreateTableRequest
    func (request CreateTableRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateTableRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateTableRequest) String() string
type CreateTableResponse
    func (response CreateTableResponse) HTTPResponse() *http.Response
    func (response CreateTableResponse) String() string
type DeleteIndexRequest
    func (request DeleteIndexRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteIndexRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteIndexRequest) String() string
type DeleteIndexResponse
    func (response DeleteIndexResponse) HTTPResponse() *http.Response
    func (response DeleteIndexResponse) String() string
type DeleteRowRequest
    func (request DeleteRowRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteRowRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteRowRequest) String() string
type DeleteRowResponse
    func (response DeleteRowResponse) HTTPResponse() *http.Response
    func (response DeleteRowResponse) String() string
type DeleteRowResult
    func (m DeleteRowResult) String() string
type DeleteTableRequest
    func (request DeleteTableRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteTableRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteTableRequest) String() string
type DeleteTableResponse
    func (response DeleteTableResponse) HTTPResponse() *http.Response
    func (response DeleteTableResponse) String() string
type DeleteWorkRequestRequest
    func (request DeleteWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteWorkRequestRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteWorkRequestRequest) String() string
type DeleteWorkRequestResponse
    func (response DeleteWorkRequestResponse) HTTPResponse() *http.Response
    func (response DeleteWorkRequestResponse) String() string
type GetIndexRequest
    func (request GetIndexRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetIndexRequest) RetryPolicy() *common.RetryPolicy
    func (request GetIndexRequest) String() string
type GetIndexResponse
    func (response GetIndexResponse) HTTPResponse() *http.Response
    func (response GetIndexResponse) String() string
type GetRowConsistencyEnum
    func GetGetRowConsistencyEnumValues() []GetRowConsistencyEnum
type GetRowRequest
    func (request GetRowRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetRowRequest) RetryPolicy() *common.RetryPolicy
    func (request GetRowRequest) String() string
type GetRowResponse
    func (response GetRowResponse) HTTPResponse() *http.Response
    func (response GetRowResponse) String() string
type GetTableRequest
    func (request GetTableRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetTableRequest) RetryPolicy() *common.RetryPolicy
    func (request GetTableRequest) String() string
type GetTableResponse
    func (response GetTableResponse) HTTPResponse() *http.Response
    func (response GetTableResponse) String() string
type GetWorkRequestRequest
    func (request GetWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
    func (request GetWorkRequestRequest) String() string
type GetWorkRequestResponse
    func (response GetWorkRequestResponse) HTTPResponse() *http.Response
    func (response GetWorkRequestResponse) String() string
type Index
    func (m Index) String() string
type IndexCollection
    func (m IndexCollection) String() string
type IndexKey
    func (m IndexKey) String() string
type IndexLifecycleStateEnum
    func GetIndexLifecycleStateEnumValues() []IndexLifecycleStateEnum
type IndexSummary
    func (m IndexSummary) String() string
type ListIndexesLifecycleStateEnum
    func GetListIndexesLifecycleStateEnumValues() []ListIndexesLifecycleStateEnum
type ListIndexesRequest
    func (request ListIndexesRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListIndexesRequest) RetryPolicy() *common.RetryPolicy
    func (request ListIndexesRequest) String() string
type ListIndexesResponse
    func (response ListIndexesResponse) HTTPResponse() *http.Response
    func (response ListIndexesResponse) String() string
type ListIndexesSortByEnum
    func GetListIndexesSortByEnumValues() []ListIndexesSortByEnum
type ListIndexesSortOrderEnum
    func GetListIndexesSortOrderEnumValues() []ListIndexesSortOrderEnum
type ListTableUsageRequest
    func (request ListTableUsageRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListTableUsageRequest) RetryPolicy() *common.RetryPolicy
    func (request ListTableUsageRequest) String() string
type ListTableUsageResponse
    func (response ListTableUsageResponse) HTTPResponse() *http.Response
    func (response ListTableUsageResponse) String() string
type ListTablesLifecycleStateEnum
    func GetListTablesLifecycleStateEnumValues() []ListTablesLifecycleStateEnum
type ListTablesRequest
    func (request ListTablesRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListTablesRequest) RetryPolicy() *common.RetryPolicy
    func (request ListTablesRequest) String() string
type ListTablesResponse
    func (response ListTablesResponse) HTTPResponse() *http.Response
    func (response ListTablesResponse) String() string
type ListTablesSortByEnum
    func GetListTablesSortByEnumValues() []ListTablesSortByEnum
type ListTablesSortOrderEnum
    func GetListTablesSortOrderEnumValues() []ListTablesSortOrderEnum
type ListWorkRequestErrorsRequest
    func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestErrorsRequest) String() string
type ListWorkRequestErrorsResponse
    func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestErrorsResponse) String() string
type ListWorkRequestLogsRequest
    func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestLogsRequest) String() string
type ListWorkRequestLogsResponse
    func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestLogsResponse) String() string
type ListWorkRequestsRequest
    func (request ListWorkRequestsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestsRequest) String() string
type ListWorkRequestsResponse
    func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestsResponse) String() string
type NosqlClient
    func NewNosqlClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client NosqlClient, err error)
    func NewNosqlClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client NosqlClient, err error)
    func (client NosqlClient) ChangeTableCompartment(ctx context.Context, request ChangeTableCompartmentRequest) (response ChangeTableCompartmentResponse, err error)
    func (client *NosqlClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client NosqlClient) CreateIndex(ctx context.Context, request CreateIndexRequest) (response CreateIndexResponse, err error)
    func (client NosqlClient) CreateTable(ctx context.Context, request CreateTableRequest) (response CreateTableResponse, err error)
    func (client NosqlClient) DeleteIndex(ctx context.Context, request DeleteIndexRequest) (response DeleteIndexResponse, err error)
    func (client NosqlClient) DeleteRow(ctx context.Context, request DeleteRowRequest) (response DeleteRowResponse, err error)
    func (client NosqlClient) DeleteTable(ctx context.Context, request DeleteTableRequest) (response DeleteTableResponse, err error)
    func (client NosqlClient) DeleteWorkRequest(ctx context.Context, request DeleteWorkRequestRequest) (response DeleteWorkRequestResponse, err error)
    func (client NosqlClient) GetIndex(ctx context.Context, request GetIndexRequest) (response GetIndexResponse, err error)
    func (client NosqlClient) GetRow(ctx context.Context, request GetRowRequest) (response GetRowResponse, err error)
    func (client NosqlClient) GetTable(ctx context.Context, request GetTableRequest) (response GetTableResponse, err error)
    func (client NosqlClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
    func (client NosqlClient) ListIndexes(ctx context.Context, request ListIndexesRequest) (response ListIndexesResponse, err error)
    func (client NosqlClient) ListTableUsage(ctx context.Context, request ListTableUsageRequest) (response ListTableUsageResponse, err error)
    func (client NosqlClient) ListTables(ctx context.Context, request ListTablesRequest) (response ListTablesResponse, err error)
    func (client NosqlClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
    func (client NosqlClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
    func (client NosqlClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
    func (client NosqlClient) PrepareStatement(ctx context.Context, request PrepareStatementRequest) (response PrepareStatementResponse, err error)
    func (client NosqlClient) Query(ctx context.Context, request QueryRequest) (response QueryResponse, err error)
    func (client *NosqlClient) SetRegion(region string)
    func (client NosqlClient) SummarizeStatement(ctx context.Context, request SummarizeStatementRequest) (response SummarizeStatementResponse, err error)
    func (client NosqlClient) UpdateRow(ctx context.Context, request UpdateRowRequest) (response UpdateRowResponse, err error)
    func (client NosqlClient) UpdateTable(ctx context.Context, request UpdateTableRequest) (response UpdateTableResponse, err error)
type PrepareStatementRequest
    func (request PrepareStatementRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request PrepareStatementRequest) RetryPolicy() *common.RetryPolicy
    func (request PrepareStatementRequest) String() string
type PrepareStatementResponse
    func (response PrepareStatementResponse) HTTPResponse() *http.Response
    func (response PrepareStatementResponse) String() string
type PreparedStatement
    func (m PreparedStatement) String() string
type QueryDetails
    func (m QueryDetails) String() string
type QueryDetailsConsistencyEnum
    func GetQueryDetailsConsistencyEnumValues() []QueryDetailsConsistencyEnum
type QueryRequest
    func (request QueryRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request QueryRequest) RetryPolicy() *common.RetryPolicy
    func (request QueryRequest) String() string
type QueryResponse
    func (response QueryResponse) HTTPResponse() *http.Response
    func (response QueryResponse) String() string
type QueryResultCollection
    func (m QueryResultCollection) String() string
type RequestUsage
    func (m RequestUsage) String() string
type Row
    func (m Row) String() string
type Schema
    func (m Schema) String() string
type StatementSummary
    func (m StatementSummary) String() string
type StatementSummaryOperationEnum
    func GetStatementSummaryOperationEnumValues() []StatementSummaryOperationEnum
type SummarizeStatementRequest
    func (request SummarizeStatementRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request SummarizeStatementRequest) RetryPolicy() *common.RetryPolicy
    func (request SummarizeStatementRequest) String() string
type SummarizeStatementResponse
    func (response SummarizeStatementResponse) HTTPResponse() *http.Response
    func (response SummarizeStatementResponse) String() string
type Table
    func (m Table) String() string
type TableCollection
    func (m TableCollection) String() string
type TableLifecycleStateEnum
    func GetTableLifecycleStateEnumValues() []TableLifecycleStateEnum
type TableLimits
    func (m TableLimits) String() string
type TableSummary
    func (m TableSummary) String() string
type TableUsageCollection
    func (m TableUsageCollection) String() string
type TableUsageSummary
    func (m TableUsageSummary) String() string
type UpdateRowDetails
    func (m UpdateRowDetails) String() string
type UpdateRowDetailsOptionEnum
    func GetUpdateRowDetailsOptionEnumValues() []UpdateRowDetailsOptionEnum
type UpdateRowRequest
    func (request UpdateRowRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateRowRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateRowRequest) String() string
type UpdateRowResponse
    func (response UpdateRowResponse) HTTPResponse() *http.Response
    func (response UpdateRowResponse) String() string
type UpdateRowResult
    func (m UpdateRowResult) String() string
type UpdateTableDetails
    func (m UpdateTableDetails) String() string
type UpdateTableRequest
    func (request UpdateTableRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateTableRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateTableRequest) String() string
type UpdateTableResponse
    func (response UpdateTableResponse) HTTPResponse() *http.Response
    func (response UpdateTableResponse) String() string
type WorkRequest
    func (m WorkRequest) String() string
type WorkRequestCollection
    func (m WorkRequestCollection) String() string
type WorkRequestError
    func (m WorkRequestError) String() string
type WorkRequestErrorCollection
    func (m WorkRequestErrorCollection) String() string
type WorkRequestLogEntry
    func (m WorkRequestLogEntry) String() string
type WorkRequestLogEntryCollection
    func (m WorkRequestLogEntryCollection) String() string
type WorkRequestOperationTypeEnum
    func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum
type WorkRequestResource
    func (m WorkRequestResource) String() string
type WorkRequestResourceActionTypeEnum
    func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum
type WorkRequestStatusEnum
    func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum
type WorkRequestSummary
    func (m WorkRequestSummary) String() string
type WorkRequestSummaryOperationTypeEnum
    func GetWorkRequestSummaryOperationTypeEnumValues() []WorkRequestSummaryOperationTypeEnum
type WorkRequestSummaryStatusEnum
    func GetWorkRequestSummaryStatusEnumValues() []WorkRequestSummaryStatusEnum

Package files

change_table_compartment_details.go change_table_compartment_request_response.go column.go create_index_details.go create_index_request_response.go create_table_details.go create_table_request_response.go delete_index_request_response.go delete_row_request_response.go delete_row_result.go delete_table_request_response.go delete_work_request_request_response.go get_index_request_response.go get_row_request_response.go get_table_request_response.go get_work_request_request_response.go index.go index_collection.go index_key.go index_summary.go list_indexes_request_response.go list_table_usage_request_response.go list_tables_request_response.go list_work_request_errors_request_response.go list_work_request_logs_request_response.go list_work_requests_request_response.go nosql_client.go prepare_statement_request_response.go prepared_statement.go query_details.go query_request_response.go query_result_collection.go request_usage.go row.go schema.go statement_summary.go summarize_statement_request_response.go table.go table_collection.go table_limits.go table_summary.go table_usage_collection.go table_usage_summary.go update_row_details.go update_row_request_response.go update_row_result.go update_table_details.go update_table_request_response.go work_request.go work_request_collection.go work_request_error.go work_request_error_collection.go work_request_log_entry.go work_request_log_entry_collection.go work_request_resource.go work_request_summary.go

type ChangeTableCompartmentDetails

ChangeTableCompartmentDetails Specification of both from and to compartments.

type ChangeTableCompartmentDetails struct {

    // The OCID of the table's new compartment.
    ToCompartmentId *string `mandatory:"true" json:"toCompartmentId"`

    // The OCID of the table's current compartment.  Required
    // if the tableNameOrId path parameter is a table name.
    // Optional if tableNameOrId is an OCID.  If tableNameOrId
    // is an OCID, and fromCompartmentId is supplied, the latter
    // must match the identified table's current compartmentId.
    FromCompartmentId *string `mandatory:"false" json:"fromCompartmentId"`
}

func (ChangeTableCompartmentDetails) String

func (m ChangeTableCompartmentDetails) String() string

type ChangeTableCompartmentRequest

ChangeTableCompartmentRequest wrapper for the ChangeTableCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/ChangeTableCompartment.go.html to see an example of how to use ChangeTableCompartmentRequest.

type ChangeTableCompartmentRequest struct {

    // A table name within the compartment, or a table OCID.
    TableNameOrId *string `mandatory:"true" contributesTo:"path" name:"tableNameOrId"`

    // Specifications of the source and target compartments.
    ChangeTableCompartmentDetails `contributesTo:"body"`

    // A token that uniquely identifies a request so it can be retried
    // in case of a timeout or server error without risk of executing
    // that same action again. Retry tokens expire after 24 hours, but
    // can be invalidated before then due to conflicting
    // operations. For example, if a resource has been deleted and
    // purged from the system, then a retry of the original creation
    // request might be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // For optimistic concurrency control. In the PUT or DELETE call
    // for a resource, set the `if-match` parameter to the value of the
    // etag from a previous GET or POST response for that resource.
    // The resource will be updated or deleted only if the etag you
    // provide matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ChangeTableCompartmentRequest) HTTPRequest

func (request ChangeTableCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeTableCompartmentRequest) RetryPolicy

func (request ChangeTableCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeTableCompartmentRequest) String

func (request ChangeTableCompartmentRequest) String() string

type ChangeTableCompartmentResponse

ChangeTableCompartmentResponse wrapper for the ChangeTableCompartment operation

type ChangeTableCompartmentResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the asynchronous
    // request. You can use this to query status of the asynchronous
    // operation.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ChangeTableCompartmentResponse) HTTPResponse

func (response ChangeTableCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeTableCompartmentResponse) String

func (response ChangeTableCompartmentResponse) String() string

type Column

Column A column of a table.

type Column struct {

    // The column name.
    Name *string `mandatory:"false" json:"name"`

    // The column type.
    Type *string `mandatory:"false" json:"type"`

    // The column nullable flag.
    IsNullable *bool `mandatory:"false" json:"isNullable"`

    // The column default value.
    DefaultValue *string `mandatory:"false" json:"defaultValue"`
}

func (Column) String

func (m Column) String() string

type CreateIndexDetails

CreateIndexDetails Specifications for the new index.

type CreateIndexDetails struct {

    // Index name.
    Name *string `mandatory:"true" json:"name"`

    // A set of keys for a secondary index.
    Keys []IndexKey `mandatory:"true" json:"keys"`

    // The OCID of the table's compartment.  Required
    // if the tableNameOrId path parameter is a table name.
    // Optional if tableNameOrId is an OCID.  If tableNameOrId
    // is an OCID, and compartmentId is supplied, the latter
    // must match the identified table's compartmentId.
    CompartmentId *string `mandatory:"false" json:"compartmentId"`

    // If true, the operation completes successfully even when the
    // index exists.  Otherwise, an attempt to create an index
    // that already exists will return an error.
    IsIfNotExists *bool `mandatory:"false" json:"isIfNotExists"`
}

func (CreateIndexDetails) String

func (m CreateIndexDetails) String() string

type CreateIndexRequest

CreateIndexRequest wrapper for the CreateIndex operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/CreateIndex.go.html to see an example of how to use CreateIndexRequest.

type CreateIndexRequest struct {

    // A table name within the compartment, or a table OCID.
    TableNameOrId *string `mandatory:"true" contributesTo:"path" name:"tableNameOrId"`

    // Specifications for the new index.
    CreateIndexDetails `contributesTo:"body"`

    // A token that uniquely identifies a request so it can be retried
    // in case of a timeout or server error without risk of executing
    // that same action again. Retry tokens expire after 24 hours, but
    // can be invalidated before then due to conflicting
    // operations. For example, if a resource has been deleted and
    // purged from the system, then a retry of the original creation
    // request might be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (CreateIndexRequest) HTTPRequest

func (request CreateIndexRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateIndexRequest) RetryPolicy

func (request CreateIndexRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateIndexRequest) String

func (request CreateIndexRequest) String() string

type CreateIndexResponse

CreateIndexResponse wrapper for the CreateIndex operation

type CreateIndexResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the asynchronous
    // request. You can use this to query status of the asynchronous
    // operation.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (CreateIndexResponse) HTTPResponse

func (response CreateIndexResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateIndexResponse) String

func (response CreateIndexResponse) String() string

type CreateTableDetails

CreateTableDetails Specifications for the new table.

type CreateTableDetails struct {

    // Table name.
    Name *string `mandatory:"true" json:"name"`

    // Compartment Identifier.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // Complete CREATE TABLE DDL statement.
    DdlStatement *string `mandatory:"true" json:"ddlStatement"`

    TableLimits *TableLimits `mandatory:"true" json:"tableLimits"`

    // True if table can be reclaimed after an idle period.
    IsAutoReclaimable *bool `mandatory:"false" json:"isAutoReclaimable"`

    // Simple key-value pair that is applied without any predefined
    // name, type or scope. Exists for cross-compatibility only.
    // Example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and
    // scoped to a namespace.  Example: `{"foo-namespace":
    // {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (CreateTableDetails) String

func (m CreateTableDetails) String() string

type CreateTableRequest

CreateTableRequest wrapper for the CreateTable operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/CreateTable.go.html to see an example of how to use CreateTableRequest.

type CreateTableRequest struct {

    // Specifications for the new table.
    CreateTableDetails `contributesTo:"body"`

    // A token that uniquely identifies a request so it can be retried
    // in case of a timeout or server error without risk of executing
    // that same action again. Retry tokens expire after 24 hours, but
    // can be invalidated before then due to conflicting
    // operations. For example, if a resource has been deleted and
    // purged from the system, then a retry of the original creation
    // request might be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (CreateTableRequest) HTTPRequest

func (request CreateTableRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateTableRequest) RetryPolicy

func (request CreateTableRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateTableRequest) String

func (request CreateTableRequest) String() string

type CreateTableResponse

CreateTableResponse wrapper for the CreateTable operation

type CreateTableResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the asynchronous
    // request. You can use this to query status of the asynchronous
    // operation.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (CreateTableResponse) HTTPResponse

func (response CreateTableResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateTableResponse) String

func (response CreateTableResponse) String() string

type DeleteIndexRequest

DeleteIndexRequest wrapper for the DeleteIndex operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/DeleteIndex.go.html to see an example of how to use DeleteIndexRequest.

type DeleteIndexRequest struct {

    // A table name within the compartment, or a table OCID.
    TableNameOrId *string `mandatory:"true" contributesTo:"path" name:"tableNameOrId"`

    // The name of a table's index.
    IndexName *string `mandatory:"true" contributesTo:"path" name:"indexName"`

    // The ID of a table's compartment. When a table is identified
    // by name, the compartmentId is often needed to provide
    // context for interpreting the name.
    CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

    // Set as true to select "if exists" behavior.
    IsIfExists *bool `mandatory:"false" contributesTo:"query" name:"isIfExists"`

    // For optimistic concurrency control. In the PUT or DELETE call
    // for a resource, set the `if-match` parameter to the value of the
    // etag from a previous GET or POST response for that resource.
    // The resource will be updated or deleted only if the etag you
    // provide matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (DeleteIndexRequest) HTTPRequest

func (request DeleteIndexRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteIndexRequest) RetryPolicy

func (request DeleteIndexRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteIndexRequest) String

func (request DeleteIndexRequest) String() string

type DeleteIndexResponse

DeleteIndexResponse wrapper for the DeleteIndex operation

type DeleteIndexResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the asynchronous
    // request. You can use this to query status of the asynchronous
    // operation.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (DeleteIndexResponse) HTTPResponse

func (response DeleteIndexResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteIndexResponse) String

func (response DeleteIndexResponse) String() string

type DeleteRowRequest

DeleteRowRequest wrapper for the DeleteRow operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/DeleteRow.go.html to see an example of how to use DeleteRowRequest.

type DeleteRowRequest struct {

    // A table name within the compartment, or a table OCID.
    TableNameOrId *string `mandatory:"true" contributesTo:"path" name:"tableNameOrId"`

    // An array of strings, each of the format "column-name:value",
    // representing the primary key of the row.
    Key []string `contributesTo:"query" name:"key" collectionFormat:"multi"`

    // The ID of a table's compartment. When a table is identified
    // by name, the compartmentId is often needed to provide
    // context for interpreting the name.
    CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

    // If true, and the operation fails due to an option setting
    // (ifVersion et al), then the existing row will be returned.
    IsGetReturnRow *bool `mandatory:"false" contributesTo:"query" name:"isGetReturnRow"`

    // Timeout setting for this operation.
    TimeoutInMs *int `mandatory:"false" contributesTo:"query" name:"timeoutInMs"`

    // For optimistic concurrency control. In the PUT or DELETE call
    // for a resource, set the `if-match` parameter to the value of the
    // etag from a previous GET or POST response for that resource.
    // The resource will be updated or deleted only if the etag you
    // provide matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (DeleteRowRequest) HTTPRequest

func (request DeleteRowRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteRowRequest) RetryPolicy

func (request DeleteRowRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteRowRequest) String

func (request DeleteRowRequest) String() string

type DeleteRowResponse

DeleteRowResponse wrapper for the DeleteRow operation

type DeleteRowResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The DeleteRowResult instance
    DeleteRowResult `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (DeleteRowResponse) HTTPResponse

func (response DeleteRowResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteRowResponse) String

func (response DeleteRowResponse) String() string

type DeleteRowResult

DeleteRowResult The result of a DeleteRow operation.

type DeleteRowResult struct {

    // Convey the success or failure of the operation.
    IsSuccess *bool `mandatory:"false" json:"isSuccess"`

    // The version string associated with the existing row.
    // Returned if the delete fails due to options setting in the
    // request.
    ExistingVersion *string `mandatory:"false" json:"existingVersion"`

    // The map of values from a row.
    ExistingValue map[string]interface{} `mandatory:"false" json:"existingValue"`

    Usage *RequestUsage `mandatory:"false" json:"usage"`
}

func (DeleteRowResult) String

func (m DeleteRowResult) String() string

type DeleteTableRequest

DeleteTableRequest wrapper for the DeleteTable operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/DeleteTable.go.html to see an example of how to use DeleteTableRequest.

type DeleteTableRequest struct {

    // A table name within the compartment, or a table OCID.
    TableNameOrId *string `mandatory:"true" contributesTo:"path" name:"tableNameOrId"`

    // The ID of a table's compartment. When a table is identified
    // by name, the compartmentId is often needed to provide
    // context for interpreting the name.
    CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

    // Set as true to select "if exists" behavior.
    IsIfExists *bool `mandatory:"false" contributesTo:"query" name:"isIfExists"`

    // For optimistic concurrency control. In the PUT or DELETE call
    // for a resource, set the `if-match` parameter to the value of the
    // etag from a previous GET or POST response for that resource.
    // The resource will be updated or deleted only if the etag you
    // provide matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (DeleteTableRequest) HTTPRequest

func (request DeleteTableRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteTableRequest) RetryPolicy

func (request DeleteTableRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteTableRequest) String

func (request DeleteTableRequest) String() string

type DeleteTableResponse

DeleteTableResponse wrapper for the DeleteTable operation

type DeleteTableResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the asynchronous
    // request. You can use this to query status of the asynchronous
    // operation.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (DeleteTableResponse) HTTPResponse

func (response DeleteTableResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteTableResponse) String

func (response DeleteTableResponse) String() string

type DeleteWorkRequestRequest

DeleteWorkRequestRequest wrapper for the DeleteWorkRequest operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/DeleteWorkRequest.go.html to see an example of how to use DeleteWorkRequestRequest.

type DeleteWorkRequestRequest struct {

    // The ID of the asynchronous request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // For optimistic concurrency control. In the PUT or DELETE call
    // for a resource, set the `if-match` parameter to the value of the
    // etag from a previous GET or POST response for that resource.
    // The resource will be updated or deleted only if the etag you
    // provide matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (DeleteWorkRequestRequest) HTTPRequest

func (request DeleteWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteWorkRequestRequest) RetryPolicy

func (request DeleteWorkRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteWorkRequestRequest) String

func (request DeleteWorkRequestRequest) String() string

type DeleteWorkRequestResponse

DeleteWorkRequestResponse wrapper for the DeleteWorkRequest operation

type DeleteWorkRequestResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the asynchronous
    // request. You can use this to query status of the asynchronous
    // operation.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (DeleteWorkRequestResponse) HTTPResponse

func (response DeleteWorkRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteWorkRequestResponse) String

func (response DeleteWorkRequestResponse) String() string

type GetIndexRequest

GetIndexRequest wrapper for the GetIndex operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/GetIndex.go.html to see an example of how to use GetIndexRequest.

type GetIndexRequest struct {

    // A table name within the compartment, or a table OCID.
    TableNameOrId *string `mandatory:"true" contributesTo:"path" name:"tableNameOrId"`

    // The name of a table's index.
    IndexName *string `mandatory:"true" contributesTo:"path" name:"indexName"`

    // The ID of a table's compartment. When a table is identified
    // by name, the compartmentId is often needed to provide
    // context for interpreting the name.
    CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (GetIndexRequest) HTTPRequest

func (request GetIndexRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetIndexRequest) RetryPolicy

func (request GetIndexRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetIndexRequest) String

func (request GetIndexRequest) String() string

type GetIndexResponse

GetIndexResponse wrapper for the GetIndex operation

type GetIndexResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Index instance
    Index `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (GetIndexResponse) HTTPResponse

func (response GetIndexResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetIndexResponse) String

func (response GetIndexResponse) String() string

type GetRowConsistencyEnum

GetRowConsistencyEnum Enum with underlying type: string

type GetRowConsistencyEnum string

Set of constants representing the allowable values for GetRowConsistencyEnum

const (
    GetRowConsistencyEventual GetRowConsistencyEnum = "EVENTUAL"
    GetRowConsistencyAbsolute GetRowConsistencyEnum = "ABSOLUTE"
)

func GetGetRowConsistencyEnumValues

func GetGetRowConsistencyEnumValues() []GetRowConsistencyEnum

GetGetRowConsistencyEnumValues Enumerates the set of values for GetRowConsistencyEnum

type GetRowRequest

GetRowRequest wrapper for the GetRow operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/GetRow.go.html to see an example of how to use GetRowRequest.

type GetRowRequest struct {

    // A table name within the compartment, or a table OCID.
    TableNameOrId *string `mandatory:"true" contributesTo:"path" name:"tableNameOrId"`

    // An array of strings, each of the format "column-name:value",
    // representing the primary key of the row.
    Key []string `contributesTo:"query" name:"key" collectionFormat:"multi"`

    // The ID of a table's compartment. When a table is identified
    // by name, the compartmentId is often needed to provide
    // context for interpreting the name.
    CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

    // Consistency requirement for a read operation.
    Consistency GetRowConsistencyEnum `mandatory:"false" contributesTo:"query" name:"consistency" omitEmpty:"true"`

    // Timeout setting for this operation.
    TimeoutInMs *int `mandatory:"false" contributesTo:"query" name:"timeoutInMs"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (GetRowRequest) HTTPRequest

func (request GetRowRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetRowRequest) RetryPolicy

func (request GetRowRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetRowRequest) String

func (request GetRowRequest) String() string

type GetRowResponse

GetRowResponse wrapper for the GetRow operation

type GetRowResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Row instance
    Row `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (GetRowResponse) HTTPResponse

func (response GetRowResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetRowResponse) String

func (response GetRowResponse) String() string

type GetTableRequest

GetTableRequest wrapper for the GetTable operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/GetTable.go.html to see an example of how to use GetTableRequest.

type GetTableRequest struct {

    // A table name within the compartment, or a table OCID.
    TableNameOrId *string `mandatory:"true" contributesTo:"path" name:"tableNameOrId"`

    // The ID of a table's compartment. When a table is identified
    // by name, the compartmentId is often needed to provide
    // context for interpreting the name.
    CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (GetTableRequest) HTTPRequest

func (request GetTableRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetTableRequest) RetryPolicy

func (request GetTableRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetTableRequest) String

func (request GetTableRequest) String() string

type GetTableResponse

GetTableResponse wrapper for the GetTable operation

type GetTableResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The Table instance
    Table `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (GetTableResponse) HTTPResponse

func (response GetTableResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetTableResponse) String

func (response GetTableResponse) String() string

type GetWorkRequestRequest

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.

type GetWorkRequestRequest struct {

    // The ID of the asynchronous request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (GetWorkRequestRequest) HTTPRequest

func (request GetWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy

func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetWorkRequestRequest) String

func (request GetWorkRequestRequest) String() string

type GetWorkRequestResponse

GetWorkRequestResponse wrapper for the GetWorkRequest operation

type GetWorkRequestResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The WorkRequest instance
    WorkRequest `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

    // A decimal number representing the number of seconds the
    // client should wait before polling this endpoint again.
    RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}

func (GetWorkRequestResponse) HTTPResponse

func (response GetWorkRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type Index

Index Information about an index.

type Index struct {

    // Index name.
    Name *string `mandatory:"false" json:"name"`

    // Compartment Identifier.
    CompartmentId *string `mandatory:"false" json:"compartmentId"`

    // The name of the table to which this index belongs.
    TableName *string `mandatory:"false" json:"tableName"`

    // the OCID of the table to which this index belongs.
    TableId *string `mandatory:"false" json:"tableId"`

    // A set of keys for a secondary index.
    Keys []IndexKey `mandatory:"false" json:"keys"`

    // The state of an index.
    LifecycleState IndexLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // A message describing the current state in more detail.
    LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}

func (Index) String

func (m Index) String() string

type IndexCollection

IndexCollection Results of ListIndexes.

type IndexCollection struct {

    // A page of IndexSummary objects.
    Items []IndexSummary `mandatory:"false" json:"items"`
}

func (IndexCollection) String

func (m IndexCollection) String() string

type IndexKey

IndexKey Specifies a single key in a secondary index.

type IndexKey struct {

    // The name of a column to be included as an index key.
    ColumnName *string `mandatory:"true" json:"columnName"`

    // If the specified column is of type JSON, jsonPath contains
    // a dotted path indicating the field within the JSON object
    // that will be the index key.
    JsonPath *string `mandatory:"false" json:"jsonPath"`

    // If the specified column is of type JSON, jsonFieldType contains
    // the type of the field indicated by jsonPath.
    JsonFieldType *string `mandatory:"false" json:"jsonFieldType"`
}

func (IndexKey) String

func (m IndexKey) String() string

type IndexLifecycleStateEnum

IndexLifecycleStateEnum Enum with underlying type: string

type IndexLifecycleStateEnum string

Set of constants representing the allowable values for IndexLifecycleStateEnum

const (
    IndexLifecycleStateCreating IndexLifecycleStateEnum = "CREATING"
    IndexLifecycleStateUpdating IndexLifecycleStateEnum = "UPDATING"
    IndexLifecycleStateActive   IndexLifecycleStateEnum = "ACTIVE"
    IndexLifecycleStateDeleting IndexLifecycleStateEnum = "DELETING"
    IndexLifecycleStateDeleted  IndexLifecycleStateEnum = "DELETED"
    IndexLifecycleStateFailed   IndexLifecycleStateEnum = "FAILED"
)

func GetIndexLifecycleStateEnumValues

func GetIndexLifecycleStateEnumValues() []IndexLifecycleStateEnum

GetIndexLifecycleStateEnumValues Enumerates the set of values for IndexLifecycleStateEnum

type IndexSummary

IndexSummary Information about an index.

type IndexSummary struct {

    // Index name.
    Name *string `mandatory:"false" json:"name"`

    // A set of keys for a secondary index.
    Keys []IndexKey `mandatory:"false" json:"keys"`

    // The state of an index.
    LifecycleState IndexLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // A message describing the current state in more detail.
    LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}

func (IndexSummary) String

func (m IndexSummary) String() string

type ListIndexesLifecycleStateEnum

ListIndexesLifecycleStateEnum Enum with underlying type: string

type ListIndexesLifecycleStateEnum string

Set of constants representing the allowable values for ListIndexesLifecycleStateEnum

const (
    ListIndexesLifecycleStateAll      ListIndexesLifecycleStateEnum = "ALL"
    ListIndexesLifecycleStateCreating ListIndexesLifecycleStateEnum = "CREATING"
    ListIndexesLifecycleStateUpdating ListIndexesLifecycleStateEnum = "UPDATING"
    ListIndexesLifecycleStateActive   ListIndexesLifecycleStateEnum = "ACTIVE"
    ListIndexesLifecycleStateDeleting ListIndexesLifecycleStateEnum = "DELETING"
    ListIndexesLifecycleStateDeleted  ListIndexesLifecycleStateEnum = "DELETED"
    ListIndexesLifecycleStateFailed   ListIndexesLifecycleStateEnum = "FAILED"
    ListIndexesLifecycleStateInactive ListIndexesLifecycleStateEnum = "INACTIVE"
)

func GetListIndexesLifecycleStateEnumValues

func GetListIndexesLifecycleStateEnumValues() []ListIndexesLifecycleStateEnum

GetListIndexesLifecycleStateEnumValues Enumerates the set of values for ListIndexesLifecycleStateEnum

type ListIndexesRequest

ListIndexesRequest wrapper for the ListIndexes operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/ListIndexes.go.html to see an example of how to use ListIndexesRequest.

type ListIndexesRequest struct {

    // A table name within the compartment, or a table OCID.
    TableNameOrId *string `mandatory:"true" contributesTo:"path" name:"tableNameOrId"`

    // The ID of a table's compartment. When a table is identified
    // by name, the compartmentId is often needed to provide
    // context for interpreting the name.
    CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

    // A shell-globbing-style (*?[]) filter for names.
    Name *string `mandatory:"false" contributesTo:"query" name:"name"`

    // Filter list by the lifecycle state of the item.
    LifecycleState ListIndexesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

    // The maximum number of items to return.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The page token representing the page at which to start
    // retrieving results. This is usually retrieved from a previous
    // list call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The sort order to use, either 'ASC' or 'DESC'.
    SortOrder ListIndexesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // The field to sort by. Only one sort order may be
    // provided. Default order for timeCreated is descending. Default
    // order for name is ascending. If no value is specified
    // timeCreated is default.
    SortBy ListIndexesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ListIndexesRequest) HTTPRequest

func (request ListIndexesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListIndexesRequest) RetryPolicy

func (request ListIndexesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListIndexesRequest) String

func (request ListIndexesRequest) String() string

type ListIndexesResponse

ListIndexesResponse wrapper for the ListIndexes operation

type ListIndexesResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of IndexCollection instances
    IndexCollection `presentIn:"body"`

    // For pagination of a list of items. When paging through a list,
    // if this header appears in the response, then a partial list
    // might have been returned. Include this value as the `page`
    // parameter for the subsequent GET request to get the next batch
    // of items.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListIndexesResponse) HTTPResponse

func (response ListIndexesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListIndexesResponse) String

func (response ListIndexesResponse) String() string

type ListIndexesSortByEnum

ListIndexesSortByEnum Enum with underlying type: string

type ListIndexesSortByEnum string

Set of constants representing the allowable values for ListIndexesSortByEnum

const (
    ListIndexesSortByTimecreated ListIndexesSortByEnum = "timeCreated"
    ListIndexesSortByName        ListIndexesSortByEnum = "name"
)

func GetListIndexesSortByEnumValues

func GetListIndexesSortByEnumValues() []ListIndexesSortByEnum

GetListIndexesSortByEnumValues Enumerates the set of values for ListIndexesSortByEnum

type ListIndexesSortOrderEnum

ListIndexesSortOrderEnum Enum with underlying type: string

type ListIndexesSortOrderEnum string

Set of constants representing the allowable values for ListIndexesSortOrderEnum

const (
    ListIndexesSortOrderAsc  ListIndexesSortOrderEnum = "ASC"
    ListIndexesSortOrderDesc ListIndexesSortOrderEnum = "DESC"
)

func GetListIndexesSortOrderEnumValues

func GetListIndexesSortOrderEnumValues() []ListIndexesSortOrderEnum

GetListIndexesSortOrderEnumValues Enumerates the set of values for ListIndexesSortOrderEnum

type ListTableUsageRequest

ListTableUsageRequest wrapper for the ListTableUsage operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/ListTableUsage.go.html to see an example of how to use ListTableUsageRequest.

type ListTableUsageRequest struct {

    // A table name within the compartment, or a table OCID.
    TableNameOrId *string `mandatory:"true" contributesTo:"path" name:"tableNameOrId"`

    // The ID of a table's compartment. When a table is identified
    // by name, the compartmentId is often needed to provide
    // context for interpreting the name.
    CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The start time to use for the request. If no time range
    // is set for this request, the most recent complete usage
    // record is returned.
    TimeStart *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeStart"`

    // The end time to use for the request.
    TimeEnd *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeEnd"`

    // The maximum number of items to return.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The page token representing the page at which to start
    // retrieving results. This is usually retrieved from a previous
    // list call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ListTableUsageRequest) HTTPRequest

func (request ListTableUsageRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListTableUsageRequest) RetryPolicy

func (request ListTableUsageRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListTableUsageRequest) String

func (request ListTableUsageRequest) String() string

type ListTableUsageResponse

ListTableUsageResponse wrapper for the ListTableUsage operation

type ListTableUsageResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of TableUsageCollection instances
    TableUsageCollection `presentIn:"body"`

    // For pagination of a list of items. When paging through a list,
    // if this header appears in the response, then a partial list
    // might have been returned. Include this value as the `page`
    // parameter for the subsequent GET request to get the next batch
    // of items.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListTableUsageResponse) HTTPResponse

func (response ListTableUsageResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListTableUsageResponse) String

func (response ListTableUsageResponse) String() string

type ListTablesLifecycleStateEnum

ListTablesLifecycleStateEnum Enum with underlying type: string

type ListTablesLifecycleStateEnum string

Set of constants representing the allowable values for ListTablesLifecycleStateEnum

const (
    ListTablesLifecycleStateAll      ListTablesLifecycleStateEnum = "ALL"
    ListTablesLifecycleStateCreating ListTablesLifecycleStateEnum = "CREATING"
    ListTablesLifecycleStateUpdating ListTablesLifecycleStateEnum = "UPDATING"
    ListTablesLifecycleStateActive   ListTablesLifecycleStateEnum = "ACTIVE"
    ListTablesLifecycleStateDeleting ListTablesLifecycleStateEnum = "DELETING"
    ListTablesLifecycleStateDeleted  ListTablesLifecycleStateEnum = "DELETED"
    ListTablesLifecycleStateFailed   ListTablesLifecycleStateEnum = "FAILED"
    ListTablesLifecycleStateInactive ListTablesLifecycleStateEnum = "INACTIVE"
)

func GetListTablesLifecycleStateEnumValues

func GetListTablesLifecycleStateEnumValues() []ListTablesLifecycleStateEnum

GetListTablesLifecycleStateEnumValues Enumerates the set of values for ListTablesLifecycleStateEnum

type ListTablesRequest

ListTablesRequest wrapper for the ListTables operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/ListTables.go.html to see an example of how to use ListTablesRequest.

type ListTablesRequest struct {

    // The ID of a table's compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // A shell-globbing-style (*?[]) filter for names.
    Name *string `mandatory:"false" contributesTo:"query" name:"name"`

    // The maximum number of items to return.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The page token representing the page at which to start
    // retrieving results. This is usually retrieved from a previous
    // list call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The sort order to use, either 'ASC' or 'DESC'.
    SortOrder ListTablesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // The field to sort by. Only one sort order may be
    // provided. Default order for timeCreated is descending. Default
    // order for name is ascending. If no value is specified
    // timeCreated is default.
    SortBy ListTablesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Filter list by the lifecycle state of the item.
    LifecycleState ListTablesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ListTablesRequest) HTTPRequest

func (request ListTablesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListTablesRequest) RetryPolicy

func (request ListTablesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListTablesRequest) String

func (request ListTablesRequest) String() string

type ListTablesResponse

ListTablesResponse wrapper for the ListTables operation

type ListTablesResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of TableCollection instances
    TableCollection `presentIn:"body"`

    // For pagination of a list of items. When paging through a list,
    // if this header appears in the response, then a partial list
    // might have been returned. Include this value as the `page`
    // parameter for the subsequent GET request to get the next batch
    // of items.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListTablesResponse) HTTPResponse

func (response ListTablesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListTablesResponse) String

func (response ListTablesResponse) String() string

type ListTablesSortByEnum

ListTablesSortByEnum Enum with underlying type: string

type ListTablesSortByEnum string

Set of constants representing the allowable values for ListTablesSortByEnum

const (
    ListTablesSortByTimecreated ListTablesSortByEnum = "timeCreated"
    ListTablesSortByName        ListTablesSortByEnum = "name"
)

func GetListTablesSortByEnumValues

func GetListTablesSortByEnumValues() []ListTablesSortByEnum

GetListTablesSortByEnumValues Enumerates the set of values for ListTablesSortByEnum

type ListTablesSortOrderEnum

ListTablesSortOrderEnum Enum with underlying type: string

type ListTablesSortOrderEnum string

Set of constants representing the allowable values for ListTablesSortOrderEnum

const (
    ListTablesSortOrderAsc  ListTablesSortOrderEnum = "ASC"
    ListTablesSortOrderDesc ListTablesSortOrderEnum = "DESC"
)

func GetListTablesSortOrderEnumValues

func GetListTablesSortOrderEnumValues() []ListTablesSortOrderEnum

GetListTablesSortOrderEnumValues Enumerates the set of values for ListTablesSortOrderEnum

type ListWorkRequestErrorsRequest

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.

type ListWorkRequestErrorsRequest struct {

    // The ID of the asynchronous request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The page token representing the page at which to start
    // retrieving results. This is usually retrieved from a previous
    // list call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The maximum number of items to return.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ListWorkRequestErrorsRequest) HTTPRequest

func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy

func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestErrorsRequest) String

func (request ListWorkRequestErrorsRequest) String() string

type ListWorkRequestErrorsResponse

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

type ListWorkRequestErrorsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of WorkRequestErrorCollection instances
    WorkRequestErrorCollection `presentIn:"body"`

    // For pagination of a list of items. When paging through a list,
    // if this header appears in the response, then a partial list
    // might have been returned. Include this value as the `page`
    // parameter for the subsequent GET request to get the next batch
    // of items.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListWorkRequestErrorsResponse) HTTPResponse

func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestLogsRequest

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.

type ListWorkRequestLogsRequest struct {

    // The ID of the asynchronous request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The page token representing the page at which to start
    // retrieving results. This is usually retrieved from a previous
    // list call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The maximum number of items to return.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ListWorkRequestLogsRequest) HTTPRequest

func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy

func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestLogsRequest) String

func (request ListWorkRequestLogsRequest) String() string

type ListWorkRequestLogsResponse

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

type ListWorkRequestLogsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of WorkRequestLogEntryCollection instances
    WorkRequestLogEntryCollection `presentIn:"body"`

    // For pagination of a list of items. When paging through a list,
    // if this header appears in the response, then a partial list
    // might have been returned. Include this value as the `page`
    // parameter for the subsequent GET request to get the next batch
    // of items.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListWorkRequestLogsResponse) HTTPResponse

func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestsRequest

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.

type ListWorkRequestsRequest struct {

    // The ID of a table's compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The page token representing the page at which to start
    // retrieving results. This is usually retrieved from a previous
    // list call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The maximum number of items to return.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (ListWorkRequestsRequest) HTTPRequest

func (request ListWorkRequestsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy

func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestsRequest) String

func (request ListWorkRequestsRequest) String() string

type ListWorkRequestsResponse

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

type ListWorkRequestsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of WorkRequestCollection instances
    WorkRequestCollection `presentIn:"body"`

    // For pagination of a list of items. When paging through a list,
    // if this header appears in the response, then a partial list
    // might have been returned. Include this value as the `page`
    // parameter for the subsequent GET request to get the next batch
    // of items.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListWorkRequestsResponse) HTTPResponse

func (response ListWorkRequestsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type NosqlClient

NosqlClient a client for Nosql

type NosqlClient struct {
    common.BaseClient
    // contains filtered or unexported fields
}

func NewNosqlClientWithConfigurationProvider

func NewNosqlClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client NosqlClient, err error)

NewNosqlClientWithConfigurationProvider Creates a new default Nosql client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewNosqlClientWithOboToken

func NewNosqlClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client NosqlClient, err error)

NewNosqlClientWithOboToken Creates a new default Nosql client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer

as well as reading the region

func (NosqlClient) ChangeTableCompartment

func (client NosqlClient) ChangeTableCompartment(ctx context.Context, request ChangeTableCompartmentRequest) (response ChangeTableCompartmentResponse, err error)

ChangeTableCompartment Change a table's compartment.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/ChangeTableCompartment.go.html to see an example of how to use ChangeTableCompartment API.

func (*NosqlClient) ConfigurationProvider

func (client *NosqlClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (NosqlClient) CreateIndex

func (client NosqlClient) CreateIndex(ctx context.Context, request CreateIndexRequest) (response CreateIndexResponse, err error)

CreateIndex Create a new index on the table identified by tableNameOrId.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/CreateIndex.go.html to see an example of how to use CreateIndex API.

func (NosqlClient) CreateTable

func (client NosqlClient) CreateTable(ctx context.Context, request CreateTableRequest) (response CreateTableResponse, err error)

CreateTable Create a new table.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/CreateTable.go.html to see an example of how to use CreateTable API.

func (NosqlClient) DeleteIndex

func (client NosqlClient) DeleteIndex(ctx context.Context, request DeleteIndexRequest) (response DeleteIndexResponse, err error)

DeleteIndex Delete an index from the table identified by tableNameOrId.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/DeleteIndex.go.html to see an example of how to use DeleteIndex API.

func (NosqlClient) DeleteRow

func (client NosqlClient) DeleteRow(ctx context.Context, request DeleteRowRequest) (response DeleteRowResponse, err error)

DeleteRow Delete a single row from the table, by primary key.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/DeleteRow.go.html to see an example of how to use DeleteRow API.

func (NosqlClient) DeleteTable

func (client NosqlClient) DeleteTable(ctx context.Context, request DeleteTableRequest) (response DeleteTableResponse, err error)

DeleteTable Delete a table by tableNameOrId.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/DeleteTable.go.html to see an example of how to use DeleteTable API.

func (NosqlClient) DeleteWorkRequest

func (client NosqlClient) DeleteWorkRequest(ctx context.Context, request DeleteWorkRequestRequest) (response DeleteWorkRequestResponse, err error)

DeleteWorkRequest Cancel a work request operation with the given ID.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/DeleteWorkRequest.go.html to see an example of how to use DeleteWorkRequest API.

func (NosqlClient) GetIndex

func (client NosqlClient) GetIndex(ctx context.Context, request GetIndexRequest) (response GetIndexResponse, err error)

GetIndex Get information about a single index.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/GetIndex.go.html to see an example of how to use GetIndex API.

func (NosqlClient) GetRow

func (client NosqlClient) GetRow(ctx context.Context, request GetRowRequest) (response GetRowResponse, err error)

GetRow Get a single row from the table by primary key.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/GetRow.go.html to see an example of how to use GetRow API.

func (NosqlClient) GetTable

func (client NosqlClient) GetTable(ctx context.Context, request GetTableRequest) (response GetTableResponse, err error)

GetTable Get table info by identifier.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/GetTable.go.html to see an example of how to use GetTable API.

func (NosqlClient) GetWorkRequest

func (client NosqlClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)

GetWorkRequest Get the status of the work request with the given ID.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API.

func (NosqlClient) ListIndexes

func (client NosqlClient) ListIndexes(ctx context.Context, request ListIndexesRequest) (response ListIndexesResponse, err error)

ListIndexes Get a list of indexes on a table.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/ListIndexes.go.html to see an example of how to use ListIndexes API.

func (NosqlClient) ListTableUsage

func (client NosqlClient) ListTableUsage(ctx context.Context, request ListTableUsageRequest) (response ListTableUsageResponse, err error)

ListTableUsage Get table usage info.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/ListTableUsage.go.html to see an example of how to use ListTableUsage API.

func (NosqlClient) ListTables

func (client NosqlClient) ListTables(ctx context.Context, request ListTablesRequest) (response ListTablesResponse, err error)

ListTables Get a list of tables in a compartment.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/ListTables.go.html to see an example of how to use ListTables API.

func (NosqlClient) ListWorkRequestErrors

func (client NosqlClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)

ListWorkRequestErrors Return a (paginated) list of errors for a given work request.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API.

func (NosqlClient) ListWorkRequestLogs

func (client NosqlClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)

ListWorkRequestLogs Return a (paginated) list of logs for a given work request.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API.

func (NosqlClient) ListWorkRequests

func (client NosqlClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)

ListWorkRequests List the work requests in a compartment.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.

func (NosqlClient) PrepareStatement

func (client NosqlClient) PrepareStatement(ctx context.Context, request PrepareStatementRequest) (response PrepareStatementResponse, err error)

PrepareStatement Prepare a SQL statement for use in a query with variable substitution.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/PrepareStatement.go.html to see an example of how to use PrepareStatement API.

func (NosqlClient) Query

func (client NosqlClient) Query(ctx context.Context, request QueryRequest) (response QueryResponse, err error)

Query Execute a SQL query.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/Query.go.html to see an example of how to use Query API.

func (*NosqlClient) SetRegion

func (client *NosqlClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (NosqlClient) SummarizeStatement

func (client NosqlClient) SummarizeStatement(ctx context.Context, request SummarizeStatementRequest) (response SummarizeStatementResponse, err error)

SummarizeStatement Check the syntax and return a brief summary of a SQL statement.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/SummarizeStatement.go.html to see an example of how to use SummarizeStatement API.

func (NosqlClient) UpdateRow

func (client NosqlClient) UpdateRow(ctx context.Context, request UpdateRowRequest) (response UpdateRowResponse, err error)

UpdateRow Write a single row into the table.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/UpdateRow.go.html to see an example of how to use UpdateRow API.

func (NosqlClient) UpdateTable

func (client NosqlClient) UpdateTable(ctx context.Context, request UpdateTableRequest) (response UpdateTableResponse, err error)

UpdateTable Alter the table identified by tableNameOrId, changing schema, limits, or tags

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/UpdateTable.go.html to see an example of how to use UpdateTable API.

type PrepareStatementRequest

PrepareStatementRequest wrapper for the PrepareStatement operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/PrepareStatement.go.html to see an example of how to use PrepareStatementRequest.

type PrepareStatementRequest struct {

    // The ID of a table's compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // A NoSQL SQL statement.
    Statement *string `mandatory:"true" contributesTo:"query" name:"statement"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (PrepareStatementRequest) HTTPRequest

func (request PrepareStatementRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (PrepareStatementRequest) RetryPolicy

func (request PrepareStatementRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (PrepareStatementRequest) String

func (request PrepareStatementRequest) String() string

type PrepareStatementResponse

PrepareStatementResponse wrapper for the PrepareStatement operation

type PrepareStatementResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The PreparedStatement instance
    PreparedStatement `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (PrepareStatementResponse) HTTPResponse

func (response PrepareStatementResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (PrepareStatementResponse) String

func (response PrepareStatementResponse) String() string

type PreparedStatement

PreparedStatement The result of query preparation.

type PreparedStatement struct {

    // A base64-encoded, compiled and parameterized version of
    // a SQL statement.
    Statement *string `mandatory:"false" json:"statement"`

    Usage *RequestUsage `mandatory:"false" json:"usage"`
}

func (PreparedStatement) String

func (m PreparedStatement) String() string

type QueryDetails

QueryDetails All the information surrounding a query, including the query statement, limits, consistency, and so forth.

type QueryDetails struct {

    // Compartment OCID, to provide context for a table name in
    // the given statement.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // A NoSQL SQL query statement; or a Base64-encoded prepared statement.
    Statement *string `mandatory:"true" json:"statement"`

    // If true, the statement is a prepared statement.
    IsPrepared *bool `mandatory:"false" json:"isPrepared"`

    // Consistency requirement for a read operation.
    Consistency QueryDetailsConsistencyEnum `mandatory:"false" json:"consistency,omitempty"`

    // A limit on the total amount of data read during this operation, in KB.
    MaxReadInKBs *int `mandatory:"false" json:"maxReadInKBs"`

    // A map of prepared statement variables to values.
    Variables map[string]interface{} `mandatory:"false" json:"variables"`

    // Timeout setting for the query.
    TimeoutInMs *int `mandatory:"false" json:"timeoutInMs"`
}

func (QueryDetails) String

func (m QueryDetails) String() string

type QueryDetailsConsistencyEnum

QueryDetailsConsistencyEnum Enum with underlying type: string

type QueryDetailsConsistencyEnum string

Set of constants representing the allowable values for QueryDetailsConsistencyEnum

const (
    QueryDetailsConsistencyEventual QueryDetailsConsistencyEnum = "EVENTUAL"
    QueryDetailsConsistencyAbsolute QueryDetailsConsistencyEnum = "ABSOLUTE"
)

func GetQueryDetailsConsistencyEnumValues

func GetQueryDetailsConsistencyEnumValues() []QueryDetailsConsistencyEnum

GetQueryDetailsConsistencyEnumValues Enumerates the set of values for QueryDetailsConsistencyEnum

type QueryRequest

QueryRequest wrapper for the Query operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/Query.go.html to see an example of how to use QueryRequest.

type QueryRequest struct {

    // SQL query statement and ancillary information.
    QueryDetails `contributesTo:"body"`

    // The maximum number of items to return.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The page token representing the page at which to start
    // retrieving results. This is usually retrieved from a previous
    // list call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (QueryRequest) HTTPRequest

func (request QueryRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (QueryRequest) RetryPolicy

func (request QueryRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (QueryRequest) String

func (request QueryRequest) String() string

type QueryResponse

QueryResponse wrapper for the Query operation

type QueryResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of QueryResultCollection instances
    QueryResultCollection `presentIn:"body"`

    // For pagination of a list of items. When paging through a list,
    // if this header appears in the response, then a partial list
    // might have been returned. Include this value as the `page`
    // parameter for the subsequent GET request to get the next batch
    // of items.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (QueryResponse) HTTPResponse

func (response QueryResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (QueryResponse) String

func (response QueryResponse) String() string

type QueryResultCollection

QueryResultCollection The result of a query.

type QueryResultCollection struct {

    // Array of objects representing query results.
    Items []map[string]interface{} `mandatory:"false" json:"items"`

    Usage *RequestUsage `mandatory:"false" json:"usage"`
}

func (QueryResultCollection) String

func (m QueryResultCollection) String() string

type RequestUsage

RequestUsage The usage metrics for a request.

type RequestUsage struct {

    // Read Units consumed by this operation.
    ReadUnitsConsumed *int `mandatory:"false" json:"readUnitsConsumed"`

    // Write Units consumed by this operation.
    WriteUnitsConsumed *int `mandatory:"false" json:"writeUnitsConsumed"`
}

func (RequestUsage) String

func (m RequestUsage) String() string

type Row

Row The result of GetRow.

type Row struct {

    // The map of values from a row.
    Value map[string]interface{} `mandatory:"false" json:"value"`

    // The expiration time of the row. A zero value indicates that
    // the row does not expire. An RFC3339 formatted datetime
    // string.
    TimeOfExpiration *common.SDKTime `mandatory:"false" json:"timeOfExpiration"`

    Usage *RequestUsage `mandatory:"false" json:"usage"`
}

func (Row) String

func (m Row) String() string

type Schema

Schema The table schema information as a JSON object.

type Schema struct {

    // The columns of a table.
    Columns []Column `mandatory:"true" json:"columns"`

    // A list of column names that make up a key.
    PrimaryKey []string `mandatory:"true" json:"primaryKey"`

    // A list of column names that make up a key.
    ShardKey []string `mandatory:"true" json:"shardKey"`

    // The default Time-to-Live for the table, in days.
    Ttl *int `mandatory:"true" json:"ttl"`
}

func (Schema) String

func (m Schema) String() string

type StatementSummary

StatementSummary Information derived from parsing a NoSQL SQL statement.

type StatementSummary struct {

    // The operation represented in the statement, e.g. CREATE_TABLE.
    Operation StatementSummaryOperationEnum `mandatory:"false" json:"operation,omitempty"`

    // The table name from the SQL statement.
    TableName *string `mandatory:"false" json:"tableName"`

    // The index name from the SQL statement, if present.
    IndexName *string `mandatory:"false" json:"indexName"`

    // True if the statement includes "IF EXISTS."
    IsIfExists *bool `mandatory:"false" json:"isIfExists"`

    // True if the statement includes "IF NOT EXISTS."
    IsIfNotExists *bool `mandatory:"false" json:"isIfNotExists"`

    // If present, indicates a syntax error in the statement.
    SyntaxError *string `mandatory:"false" json:"syntaxError"`
}

func (StatementSummary) String

func (m StatementSummary) String() string

type StatementSummaryOperationEnum

StatementSummaryOperationEnum Enum with underlying type: string

type StatementSummaryOperationEnum string

Set of constants representing the allowable values for StatementSummaryOperationEnum

const (
    StatementSummaryOperationCreateTable StatementSummaryOperationEnum = "CREATE_TABLE"
    StatementSummaryOperationAlterTable  StatementSummaryOperationEnum = "ALTER_TABLE"
    StatementSummaryOperationDropTable   StatementSummaryOperationEnum = "DROP_TABLE"
    StatementSummaryOperationCreateIndex StatementSummaryOperationEnum = "CREATE_INDEX"
    StatementSummaryOperationDropIndex   StatementSummaryOperationEnum = "DROP_INDEX"
    StatementSummaryOperationSelect      StatementSummaryOperationEnum = "SELECT"
    StatementSummaryOperationUpdate      StatementSummaryOperationEnum = "UPDATE"
    StatementSummaryOperationInsert      StatementSummaryOperationEnum = "INSERT"
    StatementSummaryOperationDelete      StatementSummaryOperationEnum = "DELETE"
)

func GetStatementSummaryOperationEnumValues

func GetStatementSummaryOperationEnumValues() []StatementSummaryOperationEnum

GetStatementSummaryOperationEnumValues Enumerates the set of values for StatementSummaryOperationEnum

type SummarizeStatementRequest

SummarizeStatementRequest wrapper for the SummarizeStatement operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/SummarizeStatement.go.html to see an example of how to use SummarizeStatementRequest.

type SummarizeStatementRequest struct {

    // The ID of a table's compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // A NoSQL SQL statement.
    Statement *string `mandatory:"true" contributesTo:"query" name:"statement"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (SummarizeStatementRequest) HTTPRequest

func (request SummarizeStatementRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (SummarizeStatementRequest) RetryPolicy

func (request SummarizeStatementRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (SummarizeStatementRequest) String

func (request SummarizeStatementRequest) String() string

type SummarizeStatementResponse

SummarizeStatementResponse wrapper for the SummarizeStatement operation

type SummarizeStatementResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The StatementSummary instance
    StatementSummary `presentIn:"body"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (SummarizeStatementResponse) HTTPResponse

func (response SummarizeStatementResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (SummarizeStatementResponse) String

func (response SummarizeStatementResponse) String() string

type Table

Table Complete metadata about a table.

type Table struct {

    // Unique identifier that is immutable.
    Id *string `mandatory:"true" json:"id"`

    // Compartment Identifier.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // Human-friendly table name, immutable.
    Name *string `mandatory:"false" json:"name"`

    // The time the the table was created. An RFC3339 formatted
    // datetime string.
    TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

    // The time the the table's metadata was last updated. An
    // RFC3339 formatted datetime string.
    TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

    TableLimits *TableLimits `mandatory:"false" json:"tableLimits"`

    // The state of a table.
    LifecycleState TableLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // True if this table can be reclaimed after an idle period.
    IsAutoReclaimable *bool `mandatory:"false" json:"isAutoReclaimable"`

    // If lifecycleState is INACTIVE, indicates when
    // this table will be automatically removed.
    // An RFC3339 formatted datetime string.
    TimeOfExpiration *common.SDKTime `mandatory:"false" json:"timeOfExpiration"`

    // A message describing the current state in more detail.
    LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

    Schema *Schema `mandatory:"false" json:"schema"`

    // A DDL statement representing the schema.
    DdlStatement *string `mandatory:"false" json:"ddlStatement"`

    // Simple key-value pair that is applied without any predefined
    // name, type or scope. Exists for cross-compatibility only.
    // Example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and
    // scoped to a namespace.  Example: `{"foo-namespace":
    // {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // Read-only system tag. These predefined keys are scoped to
    // namespaces.  At present the only supported namespace is
    // `"orcl-cloud"`; and the only key in that namespace is
    // `"free-tier-retained"`.
    // Example: `{"orcl-cloud"": {"free-tier-retained": "true"}}`
    SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

func (Table) String

func (m Table) String() string

type TableCollection

TableCollection Results of ListTables.

type TableCollection struct {

    // A page of TableSummary objects.
    Items []TableSummary `mandatory:"false" json:"items"`

    // The maximum number of reclaimable tables allowed in the tenancy.
    MaxAutoReclaimableTables *int `mandatory:"false" json:"maxAutoReclaimableTables"`

    // The current number of reclaimable tables in the tenancy.
    AutoReclaimableTables *int `mandatory:"false" json:"autoReclaimableTables"`
}

func (TableCollection) String

func (m TableCollection) String() string

type TableLifecycleStateEnum

TableLifecycleStateEnum Enum with underlying type: string

type TableLifecycleStateEnum string

Set of constants representing the allowable values for TableLifecycleStateEnum

const (
    TableLifecycleStateCreating TableLifecycleStateEnum = "CREATING"
    TableLifecycleStateUpdating TableLifecycleStateEnum = "UPDATING"
    TableLifecycleStateActive   TableLifecycleStateEnum = "ACTIVE"
    TableLifecycleStateDeleting TableLifecycleStateEnum = "DELETING"
    TableLifecycleStateDeleted  TableLifecycleStateEnum = "DELETED"
    TableLifecycleStateFailed   TableLifecycleStateEnum = "FAILED"
    TableLifecycleStateInactive TableLifecycleStateEnum = "INACTIVE"
)

func GetTableLifecycleStateEnumValues

func GetTableLifecycleStateEnumValues() []TableLifecycleStateEnum

GetTableLifecycleStateEnumValues Enumerates the set of values for TableLifecycleStateEnum

type TableLimits

TableLimits Throughput and storage limits configuration of a table.

type TableLimits struct {

    // Maximum sustained read throughput limit for the table.
    MaxReadUnits *int `mandatory:"true" json:"maxReadUnits"`

    // Maximum sustained write throughput limit for the table.
    MaxWriteUnits *int `mandatory:"true" json:"maxWriteUnits"`

    // Maximum size of storage used by the table.
    MaxStorageInGBs *int `mandatory:"true" json:"maxStorageInGBs"`
}

func (TableLimits) String

func (m TableLimits) String() string

type TableSummary

TableSummary Summary of the table.

type TableSummary struct {

    // Unique identifier that is immutable on creation.
    Id *string `mandatory:"true" json:"id"`

    // Compartment Identifier.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // Human-friendly table name, also immutable.
    Name *string `mandatory:"false" json:"name"`

    // The time the the table was created. An RFC3339 formatted
    // datetime string.
    TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

    // The time the the table's metadata was last updated. An
    // RFC3339 formatted datetime string.
    TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

    TableLimits *TableLimits `mandatory:"false" json:"tableLimits"`

    // The state of a table.
    LifecycleState TableLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // A message describing the current state in more detail.
    LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

    // True if this table can be reclaimed after an idle period.
    IsAutoReclaimable *bool `mandatory:"false" json:"isAutoReclaimable"`

    // If lifecycleState is INACTIVE, indicates when
    // this table will be automatically removed.
    // An RFC3339 formatted datetime string.
    TimeOfExpiration *common.SDKTime `mandatory:"false" json:"timeOfExpiration"`

    // Simple key-value pair that is applied without any predefined
    // name, type or scope. Exists for cross-compatibility only.
    // Example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and
    // scoped to a namespace.  Example: `{"foo-namespace":
    // {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // Read-only system tag. These predefined keys are scoped to
    // namespaces.  At present the only supported namespace is
    // `"orcl-cloud"`; and the only key in that namespace is
    // `"free-tier-retained"`.
    // Example: `{"orcl-cloud"": {"free-tier-retained": "true"}}`
    SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

func (TableSummary) String

func (m TableSummary) String() string

type TableUsageCollection

TableUsageCollection Result of GetTableUsage.

type TableUsageCollection struct {

    // A page of TableUsageSummary objects.
    Items []TableUsageSummary `mandatory:"false" json:"items"`
}

func (TableUsageCollection) String

func (m TableUsageCollection) String() string

type TableUsageSummary

TableUsageSummary TableUsageSummary represents a single usage record, or slice, that includes information about read and write throughput consumed during that period as well as the current information regarding storage capacity. In addition the count of throttling exceptions for the period is reported.

type TableUsageSummary struct {

    // The length of the sampling period.
    SecondsInPeriod *int `mandatory:"false" json:"secondsInPeriod"`

    // Read throughput during the sampling period.
    ReadUnits *int `mandatory:"false" json:"readUnits"`

    // Write throughput during the sampling period.
    WriteUnits *int `mandatory:"false" json:"writeUnits"`

    // The size of the table, in GB.
    StorageInGBs *int `mandatory:"false" json:"storageInGBs"`

    // The number of times reads were throttled due to exceeding
    // the read throughput limit.
    ReadThrottleCount *int `mandatory:"false" json:"readThrottleCount"`

    // The number of times writes were throttled due to exceeding
    // the write throughput limit.
    WriteThrottleCount *int `mandatory:"false" json:"writeThrottleCount"`

    // The number of times writes were throttled because the table
    // exceeded its size limit.
    StorageThrottleCount *int `mandatory:"false" json:"storageThrottleCount"`
}

func (TableUsageSummary) String

func (m TableUsageSummary) String() string

type UpdateRowDetails

UpdateRowDetails Specifications for the putting of a table row.

type UpdateRowDetails struct {

    // The map of values from a row.
    Value map[string]interface{} `mandatory:"true" json:"value"`

    // The OCID of the table's compartment.  Required
    // if the tableNameOrId path parameter is a table name.
    // Optional if tableNameOrId is an OCID.  If tableNameOrId
    // is an OCID, and compartmentId is supplied, the latter
    // must match the identified table's compartmentId.
    CompartmentId *string `mandatory:"false" json:"compartmentId"`

    // Specifies a condition for the put operation.
    Option UpdateRowDetailsOptionEnum `mandatory:"false" json:"option,omitempty"`

    // If true, and the put fails due to an option setting, then
    // the existing row will be returned.
    IsGetReturnRow *bool `mandatory:"false" json:"isGetReturnRow"`

    // Timeout setting for the put.
    TimeoutInMs *int `mandatory:"false" json:"timeoutInMs"`

    // Time-to-live for the row, in days.
    Ttl *int `mandatory:"false" json:"ttl"`

    // If true, set time-to-live for this row to the table's default.
    IsTtlUseTableDefault *bool `mandatory:"false" json:"isTtlUseTableDefault"`

    // Sets the number of generated identity values that are
    // requested from the server during a put. If present and greater than 0,
    // this value takes precedence over a default value for the table.
    IdentityCacheSize *int `mandatory:"false" json:"identityCacheSize"`

    // If present and true, the presented row value must exactly
    // match the table's schema.  Otherwise, rows with missing
    // non-key fields or extra fields can be written successfully.
    IsExactMatch *bool `mandatory:"false" json:"isExactMatch"`
}

func (UpdateRowDetails) String

func (m UpdateRowDetails) String() string

type UpdateRowDetailsOptionEnum

UpdateRowDetailsOptionEnum Enum with underlying type: string

type UpdateRowDetailsOptionEnum string

Set of constants representing the allowable values for UpdateRowDetailsOptionEnum

const (
    UpdateRowDetailsOptionAbsent  UpdateRowDetailsOptionEnum = "IF_ABSENT"
    UpdateRowDetailsOptionPresent UpdateRowDetailsOptionEnum = "IF_PRESENT"
)

func GetUpdateRowDetailsOptionEnumValues

func GetUpdateRowDetailsOptionEnumValues() []UpdateRowDetailsOptionEnum

GetUpdateRowDetailsOptionEnumValues Enumerates the set of values for UpdateRowDetailsOptionEnum

type UpdateRowRequest

UpdateRowRequest wrapper for the UpdateRow operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/UpdateRow.go.html to see an example of how to use UpdateRowRequest.

type UpdateRowRequest struct {

    // A table name within the compartment, or a table OCID.
    TableNameOrId *string `mandatory:"true" contributesTo:"path" name:"tableNameOrId"`

    // Specifications for the putting of a table row.
    UpdateRowDetails `contributesTo:"body"`

    // For optimistic concurrency control. In the PUT or DELETE call
    // for a resource, set the `if-match` parameter to the value of the
    // etag from a previous GET or POST response for that resource.
    // The resource will be updated or deleted only if the etag you
    // provide matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (UpdateRowRequest) HTTPRequest

func (request UpdateRowRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateRowRequest) RetryPolicy

func (request UpdateRowRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateRowRequest) String

func (request UpdateRowRequest) String() string

type UpdateRowResponse

UpdateRowResponse wrapper for the UpdateRow operation

type UpdateRowResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The UpdateRowResult instance
    UpdateRowResult `presentIn:"body"`

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (UpdateRowResponse) HTTPResponse

func (response UpdateRowResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateRowResponse) String

func (response UpdateRowResponse) String() string

type UpdateRowResult

UpdateRowResult The result of an UpdateRow operation.

type UpdateRowResult struct {

    // An opaque version string associated with the row.
    Version *string `mandatory:"false" json:"version"`

    // The version string associated with the existing row.
    // Returned if the put fails due to options setting in the
    // request.
    ExistingVersion *string `mandatory:"false" json:"existingVersion"`

    // The map of values from a row.
    ExistingValue map[string]interface{} `mandatory:"false" json:"existingValue"`

    // The value generated if the operation created a new value for
    // an identity column. If the table has no identity column, this value
    // is null. If it has an identity column, and a value was generated for
    // that column, it is non-null.
    GeneratedValue *string `mandatory:"false" json:"generatedValue"`

    Usage *RequestUsage `mandatory:"false" json:"usage"`
}

func (UpdateRowResult) String

func (m UpdateRowResult) String() string

type UpdateTableDetails

UpdateTableDetails The information to be updated.

type UpdateTableDetails struct {

    // The OCID of the table's current compartment.  Required
    // if the tableNameOrId path parameter is a table name.
    // Optional if tableNameOrId is an OCID.  If tableNameOrId
    // is an OCID, and compartmentId is supplied, the latter
    // must match the identified table's compartmentId.
    CompartmentId *string `mandatory:"false" json:"compartmentId"`

    // Complete ALTER TABLE DDL statement.
    DdlStatement *string `mandatory:"false" json:"ddlStatement"`

    TableLimits *TableLimits `mandatory:"false" json:"tableLimits"`

    // Simple key-value pair that is applied without any predefined
    // name, type or scope. Exists for cross-compatibility only.
    // Example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Defined tags for this resource. Each key is predefined and
    // scoped to a namespace.  Example: `{"foo-namespace":
    // {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

func (UpdateTableDetails) String

func (m UpdateTableDetails) String() string

type UpdateTableRequest

UpdateTableRequest wrapper for the UpdateTable operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/nosql/UpdateTable.go.html to see an example of how to use UpdateTableRequest.

type UpdateTableRequest struct {

    // A table name within the compartment, or a table OCID.
    TableNameOrId *string `mandatory:"true" contributesTo:"path" name:"tableNameOrId"`

    // Specifications for the alteration.
    UpdateTableDetails `contributesTo:"body"`

    // For optimistic concurrency control. In the PUT or DELETE call
    // for a resource, set the `if-match` parameter to the value of the
    // etag from a previous GET or POST response for that resource.
    // The resource will be updated or deleted only if the etag you
    // provide matches the resource's current etag value.
    IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // Metadata about the request. This information will not be transmitted to the service, but
    // represents information that the SDK will consume to drive retry behavior.
    RequestMetadata common.RequestMetadata
}

func (UpdateTableRequest) HTTPRequest

func (request UpdateTableRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateTableRequest) RetryPolicy

func (request UpdateTableRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateTableRequest) String

func (request UpdateTableRequest) String() string

type UpdateTableResponse

UpdateTableResponse wrapper for the UpdateTable operation

type UpdateTableResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the asynchronous
    // request. You can use this to query status of the asynchronous
    // operation.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Unique Oracle-assigned identifier for the request. If you need
    // to contact Oracle about a particular request, please provide
    // the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (UpdateTableResponse) HTTPResponse

func (response UpdateTableResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateTableResponse) String

func (response UpdateTableResponse) String() string

type WorkRequest

WorkRequest A description of workrequest status.

type WorkRequest struct {

    // Type of the work request.
    OperationType WorkRequestOperationTypeEnum `mandatory:"true" json:"operationType"`

    // Status of current work request.
    Status WorkRequestStatusEnum `mandatory:"true" json:"status"`

    // The id of the work request.
    Id *string `mandatory:"true" json:"id"`

    // The ocid of the compartment that contains the work request.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The resources affected by this work request.
    Resources []WorkRequestResource `mandatory:"true" json:"resources"`

    // Percentage of the request completed.
    PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

    // The date and time the request was created, as described in
    // RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
    TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

    // The date and time the request was started, as described in
    // RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section
    // 14.29.
    TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

    // The date and time the object was finished, as described in
    // RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
    TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

func (WorkRequest) String

func (m WorkRequest) String() string

type WorkRequestCollection

WorkRequestCollection Results of ListWorkRequests

type WorkRequestCollection struct {

    // A page of WorkRequestSummary objects.
    Items []WorkRequestSummary `mandatory:"false" json:"items"`
}

func (WorkRequestCollection) String

func (m WorkRequestCollection) String() string

type WorkRequestError

WorkRequestError An error encountered while executing a work request.

type WorkRequestError struct {

    // A machine-usable code for the error that occured. Error
    // codes are listed on
    // (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)
    Code *string `mandatory:"true" json:"code"`

    // A human readable description of the issue encountered.
    Message *string `mandatory:"true" json:"message"`

    // The time the error occured. An RFC3339 formatted datetime string.
    Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

func (WorkRequestError) String

func (m WorkRequestError) String() string

type WorkRequestErrorCollection

WorkRequestErrorCollection Results of ListWorkRequestErrors

type WorkRequestErrorCollection struct {

    // A page of WorkRequestError objects.
    Items []WorkRequestError `mandatory:"false" json:"items"`
}

func (WorkRequestErrorCollection) String

func (m WorkRequestErrorCollection) String() string

type WorkRequestLogEntry

WorkRequestLogEntry A log message from the execution of a work request.

type WorkRequestLogEntry struct {

    // Human-readable log message.
    Message *string `mandatory:"true" json:"message"`

    // The time the log message was written. An RFC3339 formatted datetime string.
    Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

func (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

type WorkRequestLogEntryCollection

WorkRequestLogEntryCollection Results of ListWorkRequestLogs

type WorkRequestLogEntryCollection struct {

    // A page of WorkRequestLogEntry objects.
    Items []WorkRequestLogEntry `mandatory:"false" json:"items"`
}

func (WorkRequestLogEntryCollection) String

func (m WorkRequestLogEntryCollection) String() string

type WorkRequestOperationTypeEnum

WorkRequestOperationTypeEnum Enum with underlying type: string

type WorkRequestOperationTypeEnum string

Set of constants representing the allowable values for WorkRequestOperationTypeEnum

const (
    WorkRequestOperationTypeCreateTable WorkRequestOperationTypeEnum = "CREATE_TABLE"
    WorkRequestOperationTypeUpdateTable WorkRequestOperationTypeEnum = "UPDATE_TABLE"
    WorkRequestOperationTypeDeleteTable WorkRequestOperationTypeEnum = "DELETE_TABLE"
)

func GetWorkRequestOperationTypeEnumValues

func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum

GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum

type WorkRequestResource

WorkRequestResource A resource created or operated on by a work request.

type WorkRequestResource struct {

    // The resource type the work request affects.
    EntityType *string `mandatory:"true" json:"entityType"`

    // The way in which this resource is affected by the work
    // tracked in the work request.  A resource being created,
    // updated, or deleted will remain in the IN_PROGRESS state
    // until work is complete for that resource at which point it
    // will transition to CREATED, UPDATED, or DELETED,
    // respectively.
    ActionType WorkRequestResourceActionTypeEnum `mandatory:"true" json:"actionType"`

    // The identifier of the resource the work request affects.
    Identifier *string `mandatory:"true" json:"identifier"`

    // The URI path to access the resource metadata.
    EntityUri *string `mandatory:"false" json:"entityUri"`
}

func (WorkRequestResource) String

func (m WorkRequestResource) String() string

type WorkRequestResourceActionTypeEnum

WorkRequestResourceActionTypeEnum Enum with underlying type: string

type WorkRequestResourceActionTypeEnum string

Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum

const (
    WorkRequestResourceActionTypeCreated    WorkRequestResourceActionTypeEnum = "CREATED"
    WorkRequestResourceActionTypeUpdated    WorkRequestResourceActionTypeEnum = "UPDATED"
    WorkRequestResourceActionTypeDeleted    WorkRequestResourceActionTypeEnum = "DELETED"
    WorkRequestResourceActionTypeInProgress WorkRequestResourceActionTypeEnum = "IN_PROGRESS"
)

func GetWorkRequestResourceActionTypeEnumValues

func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum

GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum

type WorkRequestStatusEnum

WorkRequestStatusEnum Enum with underlying type: string

type WorkRequestStatusEnum string

Set of constants representing the allowable values for WorkRequestStatusEnum

const (
    WorkRequestStatusAccepted   WorkRequestStatusEnum = "ACCEPTED"
    WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
    WorkRequestStatusFailed     WorkRequestStatusEnum = "FAILED"
    WorkRequestStatusSucceeded  WorkRequestStatusEnum = "SUCCEEDED"
    WorkRequestStatusCanceling  WorkRequestStatusEnum = "CANCELING"
    WorkRequestStatusCanceled   WorkRequestStatusEnum = "CANCELED"
)

func GetWorkRequestStatusEnumValues

func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum

GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum

type WorkRequestSummary

WorkRequestSummary A description of workrequest status.

type WorkRequestSummary struct {

    // Type of the work request.
    OperationType WorkRequestSummaryOperationTypeEnum `mandatory:"true" json:"operationType"`

    // Status of current work request.
    Status WorkRequestSummaryStatusEnum `mandatory:"true" json:"status"`

    // The id of the work request.
    Id *string `mandatory:"true" json:"id"`

    // The ocid of the compartment that contains the work request.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The resources affected by this work request.
    Resources []WorkRequestResource `mandatory:"true" json:"resources"`

    // Percentage of the request completed.
    PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

    // The date and time the request was created, as described in
    // RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
    TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

    // The date and time the request was started, as described in
    // RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section
    // 14.29.
    TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

    // The date and time the object was finished, as described in
    // RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
    TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

func (WorkRequestSummary) String

func (m WorkRequestSummary) String() string

type WorkRequestSummaryOperationTypeEnum

WorkRequestSummaryOperationTypeEnum Enum with underlying type: string

type WorkRequestSummaryOperationTypeEnum string

Set of constants representing the allowable values for WorkRequestSummaryOperationTypeEnum

const (
    WorkRequestSummaryOperationTypeCreateTable WorkRequestSummaryOperationTypeEnum = "CREATE_TABLE"
    WorkRequestSummaryOperationTypeUpdateTable WorkRequestSummaryOperationTypeEnum = "UPDATE_TABLE"
    WorkRequestSummaryOperationTypeDeleteTable WorkRequestSummaryOperationTypeEnum = "DELETE_TABLE"
)

func GetWorkRequestSummaryOperationTypeEnumValues

func GetWorkRequestSummaryOperationTypeEnumValues() []WorkRequestSummaryOperationTypeEnum

GetWorkRequestSummaryOperationTypeEnumValues Enumerates the set of values for WorkRequestSummaryOperationTypeEnum

type WorkRequestSummaryStatusEnum

WorkRequestSummaryStatusEnum Enum with underlying type: string

type WorkRequestSummaryStatusEnum string

Set of constants representing the allowable values for WorkRequestSummaryStatusEnum

const (
    WorkRequestSummaryStatusAccepted   WorkRequestSummaryStatusEnum = "ACCEPTED"
    WorkRequestSummaryStatusInProgress WorkRequestSummaryStatusEnum = "IN_PROGRESS"
    WorkRequestSummaryStatusFailed     WorkRequestSummaryStatusEnum = "FAILED"
    WorkRequestSummaryStatusSucceeded  WorkRequestSummaryStatusEnum = "SUCCEEDED"
    WorkRequestSummaryStatusCanceling  WorkRequestSummaryStatusEnum = "CANCELING"
    WorkRequestSummaryStatusCanceled   WorkRequestSummaryStatusEnum = "CANCELED"
)

func GetWorkRequestSummaryStatusEnumValues

func GetWorkRequestSummaryStatusEnumValues() []WorkRequestSummaryStatusEnum

GetWorkRequestSummaryStatusEnumValues Enumerates the set of values for WorkRequestSummaryStatusEnum