...

Package dataflow

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

Overview ▾

Index ▾

type Application
    func (m Application) String() string
type ApplicationLanguageEnum
    func GetApplicationLanguageEnumValues() []ApplicationLanguageEnum
type ApplicationLifecycleStateEnum
    func GetApplicationLifecycleStateEnumValues() []ApplicationLifecycleStateEnum
type ApplicationParameter
    func (m ApplicationParameter) String() string
type ApplicationSummary
    func (m ApplicationSummary) String() string
type ChangeApplicationCompartmentDetails
    func (m ChangeApplicationCompartmentDetails) String() string
type ChangeApplicationCompartmentRequest
    func (request ChangeApplicationCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ChangeApplicationCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeApplicationCompartmentRequest) String() string
type ChangeApplicationCompartmentResponse
    func (response ChangeApplicationCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeApplicationCompartmentResponse) String() string
type ChangePrivateEndpointCompartmentDetails
    func (m ChangePrivateEndpointCompartmentDetails) String() string
type ChangePrivateEndpointCompartmentRequest
    func (request ChangePrivateEndpointCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ChangePrivateEndpointCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangePrivateEndpointCompartmentRequest) String() string
type ChangePrivateEndpointCompartmentResponse
    func (response ChangePrivateEndpointCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangePrivateEndpointCompartmentResponse) String() string
type ChangeRunCompartmentDetails
    func (m ChangeRunCompartmentDetails) String() string
type ChangeRunCompartmentRequest
    func (request ChangeRunCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ChangeRunCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeRunCompartmentRequest) String() string
type ChangeRunCompartmentResponse
    func (response ChangeRunCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeRunCompartmentResponse) String() string
type CreateApplicationDetails
    func (m CreateApplicationDetails) String() string
type CreateApplicationRequest
    func (request CreateApplicationRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateApplicationRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateApplicationRequest) String() string
type CreateApplicationResponse
    func (response CreateApplicationResponse) HTTPResponse() *http.Response
    func (response CreateApplicationResponse) String() string
type CreatePrivateEndpointDetails
    func (m CreatePrivateEndpointDetails) String() string
type CreatePrivateEndpointRequest
    func (request CreatePrivateEndpointRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreatePrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
    func (request CreatePrivateEndpointRequest) String() string
type CreatePrivateEndpointResponse
    func (response CreatePrivateEndpointResponse) HTTPResponse() *http.Response
    func (response CreatePrivateEndpointResponse) String() string
type CreateRunDetails
    func (m CreateRunDetails) String() string
type CreateRunRequest
    func (request CreateRunRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateRunRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateRunRequest) String() string
type CreateRunResponse
    func (response CreateRunResponse) HTTPResponse() *http.Response
    func (response CreateRunResponse) String() string
type DataFlowClient
    func NewDataFlowClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DataFlowClient, err error)
    func NewDataFlowClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DataFlowClient, err error)
    func (client DataFlowClient) ChangeApplicationCompartment(ctx context.Context, request ChangeApplicationCompartmentRequest) (response ChangeApplicationCompartmentResponse, err error)
    func (client DataFlowClient) ChangePrivateEndpointCompartment(ctx context.Context, request ChangePrivateEndpointCompartmentRequest) (response ChangePrivateEndpointCompartmentResponse, err error)
    func (client DataFlowClient) ChangeRunCompartment(ctx context.Context, request ChangeRunCompartmentRequest) (response ChangeRunCompartmentResponse, err error)
    func (client *DataFlowClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client DataFlowClient) CreateApplication(ctx context.Context, request CreateApplicationRequest) (response CreateApplicationResponse, err error)
    func (client DataFlowClient) CreatePrivateEndpoint(ctx context.Context, request CreatePrivateEndpointRequest) (response CreatePrivateEndpointResponse, err error)
    func (client DataFlowClient) CreateRun(ctx context.Context, request CreateRunRequest) (response CreateRunResponse, err error)
    func (client DataFlowClient) DeleteApplication(ctx context.Context, request DeleteApplicationRequest) (response DeleteApplicationResponse, err error)
    func (client DataFlowClient) DeletePrivateEndpoint(ctx context.Context, request DeletePrivateEndpointRequest) (response DeletePrivateEndpointResponse, err error)
    func (client DataFlowClient) DeleteRun(ctx context.Context, request DeleteRunRequest) (response DeleteRunResponse, err error)
    func (client DataFlowClient) GetApplication(ctx context.Context, request GetApplicationRequest) (response GetApplicationResponse, err error)
    func (client DataFlowClient) GetPrivateEndpoint(ctx context.Context, request GetPrivateEndpointRequest) (response GetPrivateEndpointResponse, err error)
    func (client DataFlowClient) GetRun(ctx context.Context, request GetRunRequest) (response GetRunResponse, err error)
    func (client DataFlowClient) GetRunLog(ctx context.Context, request GetRunLogRequest) (response GetRunLogResponse, err error)
    func (client DataFlowClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
    func (client DataFlowClient) ListApplications(ctx context.Context, request ListApplicationsRequest) (response ListApplicationsResponse, err error)
    func (client DataFlowClient) ListPrivateEndpoints(ctx context.Context, request ListPrivateEndpointsRequest) (response ListPrivateEndpointsResponse, err error)
    func (client DataFlowClient) ListRunLogs(ctx context.Context, request ListRunLogsRequest) (response ListRunLogsResponse, err error)
    func (client DataFlowClient) ListRuns(ctx context.Context, request ListRunsRequest) (response ListRunsResponse, err error)
    func (client DataFlowClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
    func (client DataFlowClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
    func (client DataFlowClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
    func (client *DataFlowClient) SetRegion(region string)
    func (client DataFlowClient) UpdateApplication(ctx context.Context, request UpdateApplicationRequest) (response UpdateApplicationResponse, err error)
    func (client DataFlowClient) UpdatePrivateEndpoint(ctx context.Context, request UpdatePrivateEndpointRequest) (response UpdatePrivateEndpointResponse, err error)
    func (client DataFlowClient) UpdateRun(ctx context.Context, request UpdateRunRequest) (response UpdateRunResponse, err error)
type DeleteApplicationRequest
    func (request DeleteApplicationRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteApplicationRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteApplicationRequest) String() string
type DeleteApplicationResponse
    func (response DeleteApplicationResponse) HTTPResponse() *http.Response
    func (response DeleteApplicationResponse) String() string
type DeletePrivateEndpointRequest
    func (request DeletePrivateEndpointRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeletePrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
    func (request DeletePrivateEndpointRequest) String() string
type DeletePrivateEndpointResponse
    func (response DeletePrivateEndpointResponse) HTTPResponse() *http.Response
    func (response DeletePrivateEndpointResponse) String() string
type DeleteRunRequest
    func (request DeleteRunRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteRunRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteRunRequest) String() string
type DeleteRunResponse
    func (response DeleteRunResponse) HTTPResponse() *http.Response
    func (response DeleteRunResponse) String() string
type GetApplicationRequest
    func (request GetApplicationRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetApplicationRequest) RetryPolicy() *common.RetryPolicy
    func (request GetApplicationRequest) String() string
type GetApplicationResponse
    func (response GetApplicationResponse) HTTPResponse() *http.Response
    func (response GetApplicationResponse) String() string
type GetPrivateEndpointRequest
    func (request GetPrivateEndpointRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
    func (request GetPrivateEndpointRequest) String() string
type GetPrivateEndpointResponse
    func (response GetPrivateEndpointResponse) HTTPResponse() *http.Response
    func (response GetPrivateEndpointResponse) String() string
type GetRunLogRequest
    func (request GetRunLogRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetRunLogRequest) RetryPolicy() *common.RetryPolicy
    func (request GetRunLogRequest) String() string
type GetRunLogResponse
    func (response GetRunLogResponse) HTTPResponse() *http.Response
    func (response GetRunLogResponse) String() string
type GetRunRequest
    func (request GetRunRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetRunRequest) RetryPolicy() *common.RetryPolicy
    func (request GetRunRequest) String() string
type GetRunResponse
    func (response GetRunResponse) HTTPResponse() *http.Response
    func (response GetRunResponse) 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 ListApplicationsRequest
    func (request ListApplicationsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListApplicationsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListApplicationsRequest) String() string
type ListApplicationsResponse
    func (response ListApplicationsResponse) HTTPResponse() *http.Response
    func (response ListApplicationsResponse) String() string
type ListApplicationsSortByEnum
    func GetListApplicationsSortByEnumValues() []ListApplicationsSortByEnum
type ListApplicationsSortOrderEnum
    func GetListApplicationsSortOrderEnumValues() []ListApplicationsSortOrderEnum
type ListPrivateEndpointsLifecycleStateEnum
    func GetListPrivateEndpointsLifecycleStateEnumValues() []ListPrivateEndpointsLifecycleStateEnum
type ListPrivateEndpointsRequest
    func (request ListPrivateEndpointsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListPrivateEndpointsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListPrivateEndpointsRequest) String() string
type ListPrivateEndpointsResponse
    func (response ListPrivateEndpointsResponse) HTTPResponse() *http.Response
    func (response ListPrivateEndpointsResponse) String() string
type ListPrivateEndpointsSortByEnum
    func GetListPrivateEndpointsSortByEnumValues() []ListPrivateEndpointsSortByEnum
type ListPrivateEndpointsSortOrderEnum
    func GetListPrivateEndpointsSortOrderEnumValues() []ListPrivateEndpointsSortOrderEnum
type ListRunLogsRequest
    func (request ListRunLogsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListRunLogsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListRunLogsRequest) String() string
type ListRunLogsResponse
    func (response ListRunLogsResponse) HTTPResponse() *http.Response
    func (response ListRunLogsResponse) String() string
type ListRunsLifecycleStateEnum
    func GetListRunsLifecycleStateEnumValues() []ListRunsLifecycleStateEnum
type ListRunsRequest
    func (request ListRunsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListRunsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListRunsRequest) String() string
type ListRunsResponse
    func (response ListRunsResponse) HTTPResponse() *http.Response
    func (response ListRunsResponse) String() string
type ListRunsSortByEnum
    func GetListRunsSortByEnumValues() []ListRunsSortByEnum
type ListRunsSortOrderEnum
    func GetListRunsSortOrderEnumValues() []ListRunsSortOrderEnum
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 PrivateEndpoint
    func (m PrivateEndpoint) String() string
type PrivateEndpointCollection
    func (m PrivateEndpointCollection) String() string
type PrivateEndpointLifecycleStateEnum
    func GetPrivateEndpointLifecycleStateEnumValues() []PrivateEndpointLifecycleStateEnum
type PrivateEndpointSummary
    func (m PrivateEndpointSummary) String() string
type Run
    func (m Run) String() string
type RunLifecycleStateEnum
    func GetRunLifecycleStateEnumValues() []RunLifecycleStateEnum
type RunLogSummary
    func (m RunLogSummary) String() string
type RunLogSummarySourceEnum
    func GetRunLogSummarySourceEnumValues() []RunLogSummarySourceEnum
type RunLogSummaryTypeEnum
    func GetRunLogSummaryTypeEnumValues() []RunLogSummaryTypeEnum
type RunSummary
    func (m RunSummary) String() string
type UpdateApplicationDetails
    func (m UpdateApplicationDetails) String() string
type UpdateApplicationRequest
    func (request UpdateApplicationRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateApplicationRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateApplicationRequest) String() string
type UpdateApplicationResponse
    func (response UpdateApplicationResponse) HTTPResponse() *http.Response
    func (response UpdateApplicationResponse) String() string
type UpdatePrivateEndpointDetails
    func (m UpdatePrivateEndpointDetails) String() string
type UpdatePrivateEndpointRequest
    func (request UpdatePrivateEndpointRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdatePrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdatePrivateEndpointRequest) String() string
type UpdatePrivateEndpointResponse
    func (response UpdatePrivateEndpointResponse) HTTPResponse() *http.Response
    func (response UpdatePrivateEndpointResponse) String() string
type UpdateRunDetails
    func (m UpdateRunDetails) String() string
type UpdateRunRequest
    func (request UpdateRunRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateRunRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateRunRequest) String() string
type UpdateRunResponse
    func (response UpdateRunResponse) HTTPResponse() *http.Response
    func (response UpdateRunResponse) 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 WorkRequestLog
    func (m WorkRequestLog) String() string
type WorkRequestLogCollection
    func (m WorkRequestLogCollection) String() string
type WorkRequestOperationEnum
    func GetWorkRequestOperationEnumValues() []WorkRequestOperationEnum
type WorkRequestResource
    func (m WorkRequestResource) String() string
type WorkRequestResourceActionTypeEnum
    func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum
type WorkRequestStatusEnum
    func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum
type WorkRequestSummary
    func (m WorkRequestSummary) String() string

Package files

application.go application_language.go application_lifecycle_state.go application_parameter.go application_summary.go change_application_compartment_details.go change_application_compartment_request_response.go change_private_endpoint_compartment_details.go change_private_endpoint_compartment_request_response.go change_run_compartment_details.go change_run_compartment_request_response.go create_application_details.go create_application_request_response.go create_private_endpoint_details.go create_private_endpoint_request_response.go create_run_details.go create_run_request_response.go dataflow_client.go delete_application_request_response.go delete_private_endpoint_request_response.go delete_run_request_response.go get_application_request_response.go get_private_endpoint_request_response.go get_run_log_request_response.go get_run_request_response.go get_work_request_request_response.go list_applications_request_response.go list_private_endpoints_request_response.go list_run_logs_request_response.go list_runs_request_response.go list_work_request_errors_request_response.go list_work_request_logs_request_response.go list_work_requests_request_response.go private_endpoint.go private_endpoint_collection.go private_endpoint_lifecycle_state.go private_endpoint_summary.go run.go run_lifecycle_state.go run_log_summary.go run_summary.go update_application_details.go update_application_request_response.go update_private_endpoint_details.go update_private_endpoint_request_response.go update_run_details.go update_run_request_response.go work_request.go work_request_collection.go work_request_error.go work_request_error_collection.go work_request_log.go work_request_log_collection.go work_request_operation.go work_request_resource.go work_request_status.go work_request_summary.go

type Application

Application A Data Flow application object.

type Application struct {

    // The OCID of a compartment.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // A user-friendly name. This name is not necessarily unique.
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The VM shape for the driver. Sets the driver cores and memory.
    DriverShape *string `mandatory:"true" json:"driverShape"`

    // The VM shape for the executors. Sets the executor cores and memory.
    ExecutorShape *string `mandatory:"true" json:"executorShape"`

    // An Oracle Cloud Infrastructure URI of the file containing the application to execute.
    // See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    FileUri *string `mandatory:"true" json:"fileUri"`

    // The application ID.
    Id *string `mandatory:"true" json:"id"`

    // The Spark language.
    Language ApplicationLanguageEnum `mandatory:"true" json:"language"`

    // The current state of this application.
    LifecycleState ApplicationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The number of executor VMs requested.
    NumExecutors *int `mandatory:"true" json:"numExecutors"`

    // The OCID of the user who created the resource.
    OwnerPrincipalId *string `mandatory:"true" json:"ownerPrincipalId"`

    // The Spark version utilized to run the application.
    SparkVersion *string `mandatory:"true" json:"sparkVersion"`

    // The date and time a application was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The date and time a application was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

    // An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application.
    // See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    ArchiveUri *string `mandatory:"false" json:"archiveUri"`

    // The arguments passed to the running application as command line arguments.  An argument is
    // either a plain text or a placeholder. Placeholders are replaced using values from the parameters
    // map.  Each placeholder specified must be represented in the parameters map else the request
    // (POST or PUT) will fail with a HTTP 400 status code.  Placeholders are specified as
    // `Service Api Spec`, where `name` is the name of the parameter.
    // Example:  `[ "--input", "${input_file}", "--name", "John Doe" ]`
    // If "input_file" has a value of "mydata.xml", then the value above will be translated to
    // `--input mydata.xml --name "John Doe"`
    Arguments []string `mandatory:"false" json:"arguments"`

    // The class for the application.
    ClassName *string `mandatory:"false" json:"className"`

    // The Spark configuration passed to the running process.
    // See https://spark.apache.org/docs/latest/configuration.html#available-properties.
    // Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" }
    // Note: Not all Spark properties are permitted to be set.  Attempting to set a property that is
    // not allowed to be overwritten will cause a 400 status to be returned.
    Configuration map[string]string `mandatory:"false" json:"configuration"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // A user-friendly description.
    Description *string `mandatory:"false" json:"description"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded.
    // See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    LogsBucketUri *string `mandatory:"false" json:"logsBucketUri"`

    // The username of the user who created the resource.  If the username of the owner does not exist,
    // `null` will be returned and the caller should refer to the ownerPrincipalId value instead.
    OwnerUserName *string `mandatory:"false" json:"ownerUserName"`

    // An array of name/value pairs used to fill placeholders found in properties like
    // `Application.arguments`.  The name must be a string of one or more word characters
    // (a-z, A-Z, 0-9, _).  The value can be a string of 0 or more characters of any kind.
    // Example:  [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ]
    Parameters []ApplicationParameter `mandatory:"false" json:"parameters"`

    // The OCID of a private endpoint.
    PrivateEndpointId *string `mandatory:"false" json:"privateEndpointId"`

    // An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory
    // for BATCH SQL runs.
    // See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    WarehouseBucketUri *string `mandatory:"false" json:"warehouseBucketUri"`
}

func (Application) String

func (m Application) String() string

type ApplicationLanguageEnum

ApplicationLanguageEnum Enum with underlying type: string

type ApplicationLanguageEnum string

Set of constants representing the allowable values for ApplicationLanguageEnum

const (
    ApplicationLanguageScala  ApplicationLanguageEnum = "SCALA"
    ApplicationLanguageJava   ApplicationLanguageEnum = "JAVA"
    ApplicationLanguagePython ApplicationLanguageEnum = "PYTHON"
    ApplicationLanguageSql    ApplicationLanguageEnum = "SQL"
)

func GetApplicationLanguageEnumValues

func GetApplicationLanguageEnumValues() []ApplicationLanguageEnum

GetApplicationLanguageEnumValues Enumerates the set of values for ApplicationLanguageEnum

type ApplicationLifecycleStateEnum

ApplicationLifecycleStateEnum Enum with underlying type: string

type ApplicationLifecycleStateEnum string

Set of constants representing the allowable values for ApplicationLifecycleStateEnum

const (
    ApplicationLifecycleStateActive   ApplicationLifecycleStateEnum = "ACTIVE"
    ApplicationLifecycleStateDeleted  ApplicationLifecycleStateEnum = "DELETED"
    ApplicationLifecycleStateInactive ApplicationLifecycleStateEnum = "INACTIVE"
)

func GetApplicationLifecycleStateEnumValues

func GetApplicationLifecycleStateEnumValues() []ApplicationLifecycleStateEnum

GetApplicationLifecycleStateEnumValues Enumerates the set of values for ApplicationLifecycleStateEnum

type ApplicationParameter

ApplicationParameter The parameter of an application.

type ApplicationParameter struct {

    // The name of the parameter.  It must be a string of one or more word characters
    // (a-z, A-Z, 0-9, _).
    // Examples: "iterations", "input_file"
    Name *string `mandatory:"true" json:"name"`

    // The value of the parameter. It must be a string of 0 or more characters of any kind.
    // Examples: "" (empty string), "10", "mydata.xml", "${x}"
    Value *string `mandatory:"true" json:"value"`
}

func (ApplicationParameter) String

func (m ApplicationParameter) String() string

type ApplicationSummary

ApplicationSummary A Data Flow application object used in bulk listings.

type ApplicationSummary struct {

    // The OCID of a compartment.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

    // A user-friendly name. This name is not necessarily unique.
    DisplayName *string `mandatory:"true" json:"displayName"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

    // The application ID.
    Id *string `mandatory:"true" json:"id"`

    // The Spark language.
    Language ApplicationLanguageEnum `mandatory:"true" json:"language"`

    // The current state of this application.
    LifecycleState ApplicationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The OCID of the user who created the resource.
    OwnerPrincipalId *string `mandatory:"true" json:"ownerPrincipalId"`

    // The date and time a application was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The date and time a application was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

    // The username of the user who created the resource.  If the username of the owner does not exist,
    // `null` will be returned and the caller should refer to the ownerPrincipalId value instead.
    OwnerUserName *string `mandatory:"false" json:"ownerUserName"`
}

func (ApplicationSummary) String

func (m ApplicationSummary) String() string

type ChangeApplicationCompartmentDetails

ChangeApplicationCompartmentDetails The change application compartment details.

type ChangeApplicationCompartmentDetails struct {

    // The OCID of a compartment.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

func (ChangeApplicationCompartmentDetails) String

func (m ChangeApplicationCompartmentDetails) String() string

type ChangeApplicationCompartmentRequest

ChangeApplicationCompartmentRequest wrapper for the ChangeApplicationCompartment operation

See also

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

type ChangeApplicationCompartmentRequest struct {

    // The unique ID for an application.
    ApplicationId *string `mandatory:"true" contributesTo:"path" name:"applicationId"`

    // Details for changing an application's compartment.
    ChangeApplicationCompartmentDetails `contributesTo:"body"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // 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"`

    // 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 may be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // 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 (ChangeApplicationCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeApplicationCompartmentRequest) RetryPolicy

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

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

func (ChangeApplicationCompartmentRequest) String

func (request ChangeApplicationCompartmentRequest) String() string

type ChangeApplicationCompartmentResponse

ChangeApplicationCompartmentResponse wrapper for the ChangeApplicationCompartment operation

type ChangeApplicationCompartmentResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // 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 (ChangeApplicationCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeApplicationCompartmentResponse) String

func (response ChangeApplicationCompartmentResponse) String() string

type ChangePrivateEndpointCompartmentDetails

ChangePrivateEndpointCompartmentDetails The change private endpoint compartment details.

type ChangePrivateEndpointCompartmentDetails struct {

    // The OCID of a compartment.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

func (ChangePrivateEndpointCompartmentDetails) String

func (m ChangePrivateEndpointCompartmentDetails) String() string

type ChangePrivateEndpointCompartmentRequest

ChangePrivateEndpointCompartmentRequest wrapper for the ChangePrivateEndpointCompartment operation

See also

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

type ChangePrivateEndpointCompartmentRequest struct {

    // The unique ID for a private endpoint.
    PrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"privateEndpointId"`

    // Details for changing a private endpoint's compartment.
    ChangePrivateEndpointCompartmentDetails `contributesTo:"body"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // 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"`

    // 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 (ChangePrivateEndpointCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangePrivateEndpointCompartmentRequest) RetryPolicy

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

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

func (ChangePrivateEndpointCompartmentRequest) String

func (request ChangePrivateEndpointCompartmentRequest) String() string

type ChangePrivateEndpointCompartmentResponse

ChangePrivateEndpointCompartmentResponse wrapper for the ChangePrivateEndpointCompartment operation

type ChangePrivateEndpointCompartmentResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // 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"`

    // Unique Oracle assigned identifier for a work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

func (ChangePrivateEndpointCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangePrivateEndpointCompartmentResponse) String

func (response ChangePrivateEndpointCompartmentResponse) String() string

type ChangeRunCompartmentDetails

ChangeRunCompartmentDetails The change run compartment details.

type ChangeRunCompartmentDetails struct {

    // The OCID of a compartment.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

func (ChangeRunCompartmentDetails) String

func (m ChangeRunCompartmentDetails) String() string

type ChangeRunCompartmentRequest

ChangeRunCompartmentRequest wrapper for the ChangeRunCompartment operation

See also

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

type ChangeRunCompartmentRequest struct {

    // The unique ID for the run
    RunId *string `mandatory:"true" contributesTo:"path" name:"runId"`

    // Details for changing a run's compartment.
    ChangeRunCompartmentDetails `contributesTo:"body"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // 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"`

    // 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 may be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // 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 (ChangeRunCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeRunCompartmentRequest) RetryPolicy

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

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

func (ChangeRunCompartmentRequest) String

func (request ChangeRunCompartmentRequest) String() string

type ChangeRunCompartmentResponse

ChangeRunCompartmentResponse wrapper for the ChangeRunCompartment operation

type ChangeRunCompartmentResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // 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 (ChangeRunCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeRunCompartmentResponse) String

func (response ChangeRunCompartmentResponse) String() string

type CreateApplicationDetails

CreateApplicationDetails The create application details.

type CreateApplicationDetails struct {

    // The OCID of a compartment.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The VM shape for the driver. Sets the driver cores and memory.
    DriverShape *string `mandatory:"true" json:"driverShape"`

    // The VM shape for the executors. Sets the executor cores and memory.
    ExecutorShape *string `mandatory:"true" json:"executorShape"`

    // An Oracle Cloud Infrastructure URI of the file containing the application to execute.
    // See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    FileUri *string `mandatory:"true" json:"fileUri"`

    // The Spark language.
    Language ApplicationLanguageEnum `mandatory:"true" json:"language"`

    // The number of executor VMs requested.
    NumExecutors *int `mandatory:"true" json:"numExecutors"`

    // The Spark version utilized to run the application.
    SparkVersion *string `mandatory:"true" json:"sparkVersion"`

    // An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application.
    // See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    ArchiveUri *string `mandatory:"false" json:"archiveUri"`

    // The arguments passed to the running application as command line arguments.  An argument is
    // either a plain text or a placeholder. Placeholders are replaced using values from the parameters
    // map.  Each placeholder specified must be represented in the parameters map else the request
    // (POST or PUT) will fail with a HTTP 400 status code.  Placeholders are specified as
    // `Service Api Spec`, where `name` is the name of the parameter.
    // Example:  `[ "--input", "${input_file}", "--name", "John Doe" ]`
    // If "input_file" has a value of "mydata.xml", then the value above will be translated to
    // `--input mydata.xml --name "John Doe"`
    Arguments []string `mandatory:"false" json:"arguments"`

    // The class for the application.
    ClassName *string `mandatory:"false" json:"className"`

    // The Spark configuration passed to the running process.
    // See https://spark.apache.org/docs/latest/configuration.html#available-properties.
    // Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" }
    // Note: Not all Spark properties are permitted to be set.  Attempting to set a property that is
    // not allowed to be overwritten will cause a 400 status to be returned.
    Configuration map[string]string `mandatory:"false" json:"configuration"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // A user-friendly description. Avoid entering confidential information.
    Description *string `mandatory:"false" json:"description"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded.
    // See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    LogsBucketUri *string `mandatory:"false" json:"logsBucketUri"`

    // An array of name/value pairs used to fill placeholders found in properties like
    // `Application.arguments`.  The name must be a string of one or more word characters
    // (a-z, A-Z, 0-9, _).  The value can be a string of 0 or more characters of any kind.
    // Example:  [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ]
    Parameters []ApplicationParameter `mandatory:"false" json:"parameters"`

    // The OCID of a private endpoint.
    PrivateEndpointId *string `mandatory:"false" json:"privateEndpointId"`

    // An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory
    // for BATCH SQL runs.
    // See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    WarehouseBucketUri *string `mandatory:"false" json:"warehouseBucketUri"`
}

func (CreateApplicationDetails) String

func (m CreateApplicationDetails) String() string

type CreateApplicationRequest

CreateApplicationRequest wrapper for the CreateApplication operation

See also

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

type CreateApplicationRequest struct {

    // Details to create an application.
    CreateApplicationDetails `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 may be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    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 (CreateApplicationRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateApplicationRequest) RetryPolicy

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

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

func (CreateApplicationRequest) String

func (request CreateApplicationRequest) String() string

type CreateApplicationResponse

CreateApplicationResponse wrapper for the CreateApplication operation

type CreateApplicationResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For optimistic concurrency control.
    // See ETags for Optimistic Concurrency Control (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
    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 (CreateApplicationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateApplicationResponse) String

func (response CreateApplicationResponse) String() string

type CreatePrivateEndpointDetails

CreatePrivateEndpointDetails The create private endpoint details.

type CreatePrivateEndpointDetails struct {

    // The OCID of a compartment.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // An array of DNS zone names.
    // Example: `[ "app.examplecorp.com", "app.examplecorp2.com" ]`
    DnsZones []string `mandatory:"true" json:"dnsZones"`

    // The OCID of a subnet.
    SubnetId *string `mandatory:"true" json:"subnetId"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // A user-friendly description. Avoid entering confidential information.
    Description *string `mandatory:"false" json:"description"`

    // A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    DisplayName *string `mandatory:"false" json:"displayName"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // The maximum number of hosts to be accessed through the private endpoint. This value is used
    // to calculate the relevant CIDR block and should be a multiple of 256.  If the value is not a
    // multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up
    // to 512.
    MaxHostCount *int `mandatory:"false" json:"maxHostCount"`

    // An array of network security group OCIDs.
    NsgIds []string `mandatory:"false" json:"nsgIds"`
}

func (CreatePrivateEndpointDetails) String

func (m CreatePrivateEndpointDetails) String() string

type CreatePrivateEndpointRequest

CreatePrivateEndpointRequest wrapper for the CreatePrivateEndpoint operation

See also

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

type CreatePrivateEndpointRequest struct {

    // Details to create a private endpoint.
    CreatePrivateEndpointDetails `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 may be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    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 (CreatePrivateEndpointRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreatePrivateEndpointRequest) RetryPolicy

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

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

func (CreatePrivateEndpointRequest) String

func (request CreatePrivateEndpointRequest) String() string

type CreatePrivateEndpointResponse

CreatePrivateEndpointResponse wrapper for the CreatePrivateEndpoint operation

type CreatePrivateEndpointResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For optimistic concurrency control.
    // See ETags for Optimistic Concurrency Control (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
    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"`

    // Unique Oracle assigned identifier for a work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

    // Provides information about the location of a newly created resource.
    Location *string `presentIn:"header" name:"location"`
}

func (CreatePrivateEndpointResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreatePrivateEndpointResponse) String

func (response CreatePrivateEndpointResponse) String() string

type CreateRunDetails

CreateRunDetails The create run details. The following properties are optional and override the default values set in the associated application:

- arguments
- configuration
- definedTags
- driverShape
- executorShape
- freeformTags
- logsBucketUri
- numExecutors
- parameters
- warehouseBucketUri

If the optional properties are not specified, they are copied over from the parent application. Once a run is created, its properties (except for definedTags and freeformTags) cannot be changed. If the parent application's properties (including definedTags and freeformTags) are updated, the corresponding properties of the run will not update.

type CreateRunDetails struct {

    // The application ID.
    ApplicationId *string `mandatory:"true" json:"applicationId"`

    // The OCID of a compartment.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    DisplayName *string `mandatory:"true" json:"displayName"`

    // The arguments passed to the running application as command line arguments.  An argument is
    // either a plain text or a placeholder. Placeholders are replaced using values from the parameters
    // map.  Each placeholder specified must be represented in the parameters map else the request
    // (POST or PUT) will fail with a HTTP 400 status code.  Placeholders are specified as
    // `Service Api Spec`, where `name` is the name of the parameter.
    // Example:  `[ "--input", "${input_file}", "--name", "John Doe" ]`
    // If "input_file" has a value of "mydata.xml", then the value above will be translated to
    // `--input mydata.xml --name "John Doe"`
    Arguments []string `mandatory:"false" json:"arguments"`

    // The Spark configuration passed to the running process.
    // See https://spark.apache.org/docs/latest/configuration.html#available-properties.
    // Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" }
    // Note: Not all Spark properties are permitted to be set.  Attempting to set a property that is
    // not allowed to be overwritten will cause a 400 status to be returned.
    Configuration map[string]string `mandatory:"false" json:"configuration"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // The VM shape for the driver. Sets the driver cores and memory.
    DriverShape *string `mandatory:"false" json:"driverShape"`

    // The VM shape for the executors. Sets the executor cores and memory.
    ExecutorShape *string `mandatory:"false" json:"executorShape"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded.
    // See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    LogsBucketUri *string `mandatory:"false" json:"logsBucketUri"`

    // The number of executor VMs requested.
    NumExecutors *int `mandatory:"false" json:"numExecutors"`

    // An array of name/value pairs used to fill placeholders found in properties like
    // `Application.arguments`.  The name must be a string of one or more word characters
    // (a-z, A-Z, 0-9, _).  The value can be a string of 0 or more characters of any kind.
    // Example:  [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ]
    Parameters []ApplicationParameter `mandatory:"false" json:"parameters"`

    // An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory
    // for BATCH SQL runs.
    // See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    WarehouseBucketUri *string `mandatory:"false" json:"warehouseBucketUri"`
}

func (CreateRunDetails) String

func (m CreateRunDetails) String() string

type CreateRunRequest

CreateRunRequest wrapper for the CreateRun operation

See also

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

type CreateRunRequest struct {

    // Details for creating a run of an application.
    CreateRunDetails `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 may be rejected.
    OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    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 (CreateRunRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateRunRequest) RetryPolicy

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

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

func (CreateRunRequest) String

func (request CreateRunRequest) String() string

type CreateRunResponse

CreateRunResponse wrapper for the CreateRun operation

type CreateRunResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For optimistic concurrency control.
    // See ETags for Optimistic Concurrency Control (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
    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 (CreateRunResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateRunResponse) String

func (response CreateRunResponse) String() string

type DataFlowClient

DataFlowClient a client for DataFlow

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

func NewDataFlowClientWithConfigurationProvider

func NewDataFlowClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DataFlowClient, err error)

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

func NewDataFlowClientWithOboToken

func NewDataFlowClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DataFlowClient, err error)

NewDataFlowClientWithOboToken Creates a new default DataFlow 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 (DataFlowClient) ChangeApplicationCompartment

func (client DataFlowClient) ChangeApplicationCompartment(ctx context.Context, request ChangeApplicationCompartmentRequest) (response ChangeApplicationCompartmentResponse, err error)

ChangeApplicationCompartment Moves an application into a different compartment. When provided, If-Match is checked against ETag values of the resource. Associated resources, like runs, will not be automatically moved.

See also

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

func (DataFlowClient) ChangePrivateEndpointCompartment

func (client DataFlowClient) ChangePrivateEndpointCompartment(ctx context.Context, request ChangePrivateEndpointCompartmentRequest) (response ChangePrivateEndpointCompartmentResponse, err error)

ChangePrivateEndpointCompartment Moves a private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.

See also

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

func (DataFlowClient) ChangeRunCompartment

func (client DataFlowClient) ChangeRunCompartment(ctx context.Context, request ChangeRunCompartmentRequest) (response ChangeRunCompartmentResponse, err error)

ChangeRunCompartment Moves a run into a different compartment. When provided, If-Match is checked against ETag values of the resource. Associated resources, like historical metrics, will not be automatically moved. The run must be in a terminal state (CANCELED, FAILED, SUCCEEDED) in order for it to be moved to a different compartment

See also

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

func (*DataFlowClient) ConfigurationProvider

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

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

func (DataFlowClient) CreateApplication

func (client DataFlowClient) CreateApplication(ctx context.Context, request CreateApplicationRequest) (response CreateApplicationResponse, err error)

CreateApplication Creates an application.

See also

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

func (DataFlowClient) CreatePrivateEndpoint

func (client DataFlowClient) CreatePrivateEndpoint(ctx context.Context, request CreatePrivateEndpointRequest) (response CreatePrivateEndpointResponse, err error)

CreatePrivateEndpoint Creates a private endpoint to be used by an application.

See also

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

func (DataFlowClient) CreateRun

func (client DataFlowClient) CreateRun(ctx context.Context, request CreateRunRequest) (response CreateRunResponse, err error)

CreateRun Creates a run for an application.

See also

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

func (DataFlowClient) DeleteApplication

func (client DataFlowClient) DeleteApplication(ctx context.Context, request DeleteApplicationRequest) (response DeleteApplicationResponse, err error)

DeleteApplication Deletes an application using an `applicationId`.

See also

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

func (DataFlowClient) DeletePrivateEndpoint

func (client DataFlowClient) DeletePrivateEndpoint(ctx context.Context, request DeletePrivateEndpointRequest) (response DeletePrivateEndpointResponse, err error)

DeletePrivateEndpoint Deletes a private endpoint using a `privateEndpointId`.

See also

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

func (DataFlowClient) DeleteRun

func (client DataFlowClient) DeleteRun(ctx context.Context, request DeleteRunRequest) (response DeleteRunResponse, err error)

DeleteRun Cancels the specified run if it has not already completed or was previously cancelled. If a run is in progress, the executing job will be killed.

See also

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

func (DataFlowClient) GetApplication

func (client DataFlowClient) GetApplication(ctx context.Context, request GetApplicationRequest) (response GetApplicationResponse, err error)

GetApplication Retrieves an application using an `applicationId`.

See also

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

func (DataFlowClient) GetPrivateEndpoint

func (client DataFlowClient) GetPrivateEndpoint(ctx context.Context, request GetPrivateEndpointRequest) (response GetPrivateEndpointResponse, err error)

GetPrivateEndpoint Retrieves an private endpoint using a `privateEndpointId`.

See also

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

func (DataFlowClient) GetRun

func (client DataFlowClient) GetRun(ctx context.Context, request GetRunRequest) (response GetRunResponse, err error)

GetRun Retrieves the run for the specified `runId`.

See also

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

func (DataFlowClient) GetRunLog

func (client DataFlowClient) GetRunLog(ctx context.Context, request GetRunLogRequest) (response GetRunLogResponse, err error)

GetRunLog Retrieves the content of an run log.

See also

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

func (DataFlowClient) GetWorkRequest

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

GetWorkRequest Gets the status of the work request with the given OCID.

See also

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

func (DataFlowClient) ListApplications

func (client DataFlowClient) ListApplications(ctx context.Context, request ListApplicationsRequest) (response ListApplicationsResponse, err error)

ListApplications Lists all applications in the specified compartment.

See also

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

func (DataFlowClient) ListPrivateEndpoints

func (client DataFlowClient) ListPrivateEndpoints(ctx context.Context, request ListPrivateEndpointsRequest) (response ListPrivateEndpointsResponse, err error)

ListPrivateEndpoints Lists all private endpoints in the specified compartment.

See also

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

func (DataFlowClient) ListRunLogs

func (client DataFlowClient) ListRunLogs(ctx context.Context, request ListRunLogsRequest) (response ListRunLogsResponse, err error)

ListRunLogs Retrieves summaries of the run's logs.

See also

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

func (DataFlowClient) ListRuns

func (client DataFlowClient) ListRuns(ctx context.Context, request ListRunsRequest) (response ListRunsResponse, err error)

ListRuns Lists all runs of an application in the specified compartment.

See also

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

func (DataFlowClient) ListWorkRequestErrors

func (client DataFlowClient) 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/dataflow/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API.

func (DataFlowClient) ListWorkRequestLogs

func (client DataFlowClient) 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/dataflow/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API.

func (DataFlowClient) ListWorkRequests

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

ListWorkRequests Lists the work requests in a compartment.

See also

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

func (*DataFlowClient) SetRegion

func (client *DataFlowClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (DataFlowClient) UpdateApplication

func (client DataFlowClient) UpdateApplication(ctx context.Context, request UpdateApplicationRequest) (response UpdateApplicationResponse, err error)

UpdateApplication Updates an application using an `applicationId`.

See also

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

func (DataFlowClient) UpdatePrivateEndpoint

func (client DataFlowClient) UpdatePrivateEndpoint(ctx context.Context, request UpdatePrivateEndpointRequest) (response UpdatePrivateEndpointResponse, err error)

UpdatePrivateEndpoint Updates a private endpoint using a `privateEndpointId`. If changes to a private endpoint match a previously defined private endpoint, then a 409 status code will be returned. This indicates that a conflict has been detected.

See also

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

func (DataFlowClient) UpdateRun

func (client DataFlowClient) UpdateRun(ctx context.Context, request UpdateRunRequest) (response UpdateRunResponse, err error)

UpdateRun Updates a run using a `runId`.

See also

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

type DeleteApplicationRequest

DeleteApplicationRequest wrapper for the DeleteApplication operation

See also

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

type DeleteApplicationRequest struct {

    // The unique ID for an application.
    ApplicationId *string `mandatory:"true" contributesTo:"path" name:"applicationId"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // 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"`

    // 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 (DeleteApplicationRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteApplicationRequest) RetryPolicy

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

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

func (DeleteApplicationRequest) String

func (request DeleteApplicationRequest) String() string

type DeleteApplicationResponse

DeleteApplicationResponse wrapper for the DeleteApplication operation

type DeleteApplicationResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // 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 (DeleteApplicationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteApplicationResponse) String

func (response DeleteApplicationResponse) String() string

type DeletePrivateEndpointRequest

DeletePrivateEndpointRequest wrapper for the DeletePrivateEndpoint operation

See also

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

type DeletePrivateEndpointRequest struct {

    // The unique ID for a private endpoint.
    PrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"privateEndpointId"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // 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"`

    // 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 (DeletePrivateEndpointRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeletePrivateEndpointRequest) RetryPolicy

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

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

func (DeletePrivateEndpointRequest) String

func (request DeletePrivateEndpointRequest) String() string

type DeletePrivateEndpointResponse

DeletePrivateEndpointResponse wrapper for the DeletePrivateEndpoint operation

type DeletePrivateEndpointResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // 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"`

    // Unique Oracle assigned identifier for a work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

func (DeletePrivateEndpointResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeletePrivateEndpointResponse) String

func (response DeletePrivateEndpointResponse) String() string

type DeleteRunRequest

DeleteRunRequest wrapper for the DeleteRun operation

See also

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

type DeleteRunRequest struct {

    // The unique ID for the run
    RunId *string `mandatory:"true" contributesTo:"path" name:"runId"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // 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"`

    // 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 (DeleteRunRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteRunRequest) RetryPolicy

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

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

func (DeleteRunRequest) String

func (request DeleteRunRequest) String() string

type DeleteRunResponse

DeleteRunResponse wrapper for the DeleteRun operation

type DeleteRunResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // 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 (DeleteRunResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteRunResponse) String

func (response DeleteRunResponse) String() string

type GetApplicationRequest

GetApplicationRequest wrapper for the GetApplication operation

See also

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

type GetApplicationRequest struct {

    // The unique ID for an application.
    ApplicationId *string `mandatory:"true" contributesTo:"path" name:"applicationId"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    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 (GetApplicationRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetApplicationRequest) RetryPolicy

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

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

func (GetApplicationRequest) String

func (request GetApplicationRequest) String() string

type GetApplicationResponse

GetApplicationResponse wrapper for the GetApplication operation

type GetApplicationResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For optimistic concurrency control.
    // See ETags for Optimistic Concurrency Control (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
    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 (GetApplicationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetApplicationResponse) String

func (response GetApplicationResponse) String() string

type GetPrivateEndpointRequest

GetPrivateEndpointRequest wrapper for the GetPrivateEndpoint operation

See also

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

type GetPrivateEndpointRequest struct {

    // The unique ID for a private endpoint.
    PrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"privateEndpointId"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    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 (GetPrivateEndpointRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetPrivateEndpointRequest) RetryPolicy

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

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

func (GetPrivateEndpointRequest) String

func (request GetPrivateEndpointRequest) String() string

type GetPrivateEndpointResponse

GetPrivateEndpointResponse wrapper for the GetPrivateEndpoint operation

type GetPrivateEndpointResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For optimistic concurrency control.
    // See ETags for Optimistic Concurrency Control (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
    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 (GetPrivateEndpointResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetPrivateEndpointResponse) String

func (response GetPrivateEndpointResponse) String() string

type GetRunLogRequest

GetRunLogRequest wrapper for the GetRunLog operation

See also

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

type GetRunLogRequest struct {

    // The unique ID for the run
    RunId *string `mandatory:"true" contributesTo:"path" name:"runId"`

    // The name of the log. Avoid entering confidential information.
    Name *string `mandatory:"true" contributesTo:"path" name:"name"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    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 (GetRunLogRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetRunLogRequest) RetryPolicy

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

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

func (GetRunLogRequest) String

func (request GetRunLogRequest) String() string

type GetRunLogResponse

GetRunLogResponse wrapper for the GetRunLog operation

type GetRunLogResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The io.ReadCloser instance
    Content io.ReadCloser `presentIn:"body" encoding:"binary"`

    // 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"`

    // For optimistic concurrency control.
    // See ETags for Optimistic Concurrency Control (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
    Etag *string `presentIn:"header" name:"etag"`

    // Indicates the size of the data as described in RFC 2616, section 14.13.
    ContentLength *int64 `presentIn:"header" name:"content-length"`

    // Specifies the media type of the underlying data as described in RFC 2616, section 14.17.
    ContentType *string `presentIn:"header" name:"content-type"`

    // Indicates the encoding of the data, as described in RFC 2616, section 14.11.
    ContentEncoding *string `presentIn:"header" name:"content-encoding"`

    // The user-defined metadata for the log.
    OpcMeta map[string]string `presentIn:"header-collection" prefix:"opc-meta-"`
}

func (GetRunLogResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetRunLogResponse) String

func (response GetRunLogResponse) String() string

type GetRunRequest

GetRunRequest wrapper for the GetRun operation

See also

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

type GetRunRequest struct {

    // The unique ID for the run
    RunId *string `mandatory:"true" contributesTo:"path" name:"runId"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    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 (GetRunRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetRunRequest) RetryPolicy

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

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

func (GetRunRequest) String

func (request GetRunRequest) String() string

type GetRunResponse

GetRunResponse wrapper for the GetRun operation

type GetRunResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For optimistic concurrency control.
    // See ETags for Optimistic Concurrency Control (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
    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 (GetRunResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetRunResponse) String

func (response GetRunResponse) 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/dataflow/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.

type GetWorkRequestRequest struct {

    // The unique ID for a work request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    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"`

    // 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 (GetWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type ListApplicationsRequest

ListApplicationsRequest wrapper for the ListApplications operation

See also

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

type ListApplicationsRequest struct {

    // The OCID of the compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The maximum number of results to return in a paginated `List` call.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call
    // to sent back to server for getting the next page of results.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The field used to sort the results. Multiple fields are not supported.
    SortBy ListApplicationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The ordering of results in ascending or descending order.
    SortOrder ListApplicationsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // The query parameter for the Spark application name.
    DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

    // The OCID of the user who created the resource.
    OwnerPrincipalId *string `mandatory:"false" contributesTo:"query" name:"ownerPrincipalId"`

    // The displayName prefix.
    DisplayNameStartsWith *string `mandatory:"false" contributesTo:"query" name:"displayNameStartsWith"`

    // 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 (ListApplicationsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListApplicationsRequest) RetryPolicy

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

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

func (ListApplicationsRequest) String

func (request ListApplicationsRequest) String() string

type ListApplicationsResponse

ListApplicationsResponse wrapper for the ListApplications operation

type ListApplicationsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []ApplicationSummary instances
    Items []ApplicationSummary `presentIn:"body"`

    // Retrieves the previous page of results.
    // When this header appears in the response, previous pages of results exist.
    // See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`

    // Retrieves the next page of results. When this header appears in the response,
    // additional pages of results remain. See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    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 (ListApplicationsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListApplicationsResponse) String

func (response ListApplicationsResponse) String() string

type ListApplicationsSortByEnum

ListApplicationsSortByEnum Enum with underlying type: string

type ListApplicationsSortByEnum string

Set of constants representing the allowable values for ListApplicationsSortByEnum

const (
    ListApplicationsSortByTimecreated ListApplicationsSortByEnum = "timeCreated"
    ListApplicationsSortByDisplayname ListApplicationsSortByEnum = "displayName"
    ListApplicationsSortByLanguage    ListApplicationsSortByEnum = "language"
)

func GetListApplicationsSortByEnumValues

func GetListApplicationsSortByEnumValues() []ListApplicationsSortByEnum

GetListApplicationsSortByEnumValues Enumerates the set of values for ListApplicationsSortByEnum

type ListApplicationsSortOrderEnum

ListApplicationsSortOrderEnum Enum with underlying type: string

type ListApplicationsSortOrderEnum string

Set of constants representing the allowable values for ListApplicationsSortOrderEnum

const (
    ListApplicationsSortOrderAsc  ListApplicationsSortOrderEnum = "ASC"
    ListApplicationsSortOrderDesc ListApplicationsSortOrderEnum = "DESC"
)

func GetListApplicationsSortOrderEnumValues

func GetListApplicationsSortOrderEnumValues() []ListApplicationsSortOrderEnum

GetListApplicationsSortOrderEnumValues Enumerates the set of values for ListApplicationsSortOrderEnum

type ListPrivateEndpointsLifecycleStateEnum

ListPrivateEndpointsLifecycleStateEnum Enum with underlying type: string

type ListPrivateEndpointsLifecycleStateEnum string

Set of constants representing the allowable values for ListPrivateEndpointsLifecycleStateEnum

const (
    ListPrivateEndpointsLifecycleStateCreating ListPrivateEndpointsLifecycleStateEnum = "CREATING"
    ListPrivateEndpointsLifecycleStateActive   ListPrivateEndpointsLifecycleStateEnum = "ACTIVE"
    ListPrivateEndpointsLifecycleStateInactive ListPrivateEndpointsLifecycleStateEnum = "INACTIVE"
    ListPrivateEndpointsLifecycleStateUpdating ListPrivateEndpointsLifecycleStateEnum = "UPDATING"
    ListPrivateEndpointsLifecycleStateDeleting ListPrivateEndpointsLifecycleStateEnum = "DELETING"
    ListPrivateEndpointsLifecycleStateDeleted  ListPrivateEndpointsLifecycleStateEnum = "DELETED"
    ListPrivateEndpointsLifecycleStateFailed   ListPrivateEndpointsLifecycleStateEnum = "FAILED"
)

func GetListPrivateEndpointsLifecycleStateEnumValues

func GetListPrivateEndpointsLifecycleStateEnumValues() []ListPrivateEndpointsLifecycleStateEnum

GetListPrivateEndpointsLifecycleStateEnumValues Enumerates the set of values for ListPrivateEndpointsLifecycleStateEnum

type ListPrivateEndpointsRequest

ListPrivateEndpointsRequest wrapper for the ListPrivateEndpoints operation

See also

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

type ListPrivateEndpointsRequest struct {

    // The OCID of the compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The maximum number of results to return in a paginated `List` call.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call
    // to sent back to server for getting the next page of results.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The LifecycleState of the private endpoint.
    LifecycleState ListPrivateEndpointsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

    // The field used to sort the results. Multiple fields are not supported.
    SortBy ListPrivateEndpointsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The ordering of results in ascending or descending order.
    SortOrder ListPrivateEndpointsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // The query parameter for the Spark application name.
    DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

    // The OCID of the user who created the resource.
    OwnerPrincipalId *string `mandatory:"false" contributesTo:"query" name:"ownerPrincipalId"`

    // The displayName prefix.
    DisplayNameStartsWith *string `mandatory:"false" contributesTo:"query" name:"displayNameStartsWith"`

    // 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 (ListPrivateEndpointsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListPrivateEndpointsRequest) RetryPolicy

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

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

func (ListPrivateEndpointsRequest) String

func (request ListPrivateEndpointsRequest) String() string

type ListPrivateEndpointsResponse

ListPrivateEndpointsResponse wrapper for the ListPrivateEndpoints operation

type ListPrivateEndpointsResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // Retrieves the previous page of results.
    // When this header appears in the response, previous pages of results exist.
    // See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`

    // Retrieves the next page of results. When this header appears in the response,
    // additional pages of results remain. See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    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 (ListPrivateEndpointsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListPrivateEndpointsResponse) String

func (response ListPrivateEndpointsResponse) String() string

type ListPrivateEndpointsSortByEnum

ListPrivateEndpointsSortByEnum Enum with underlying type: string

type ListPrivateEndpointsSortByEnum string

Set of constants representing the allowable values for ListPrivateEndpointsSortByEnum

const (
    ListPrivateEndpointsSortByTimecreated ListPrivateEndpointsSortByEnum = "timeCreated"
)

func GetListPrivateEndpointsSortByEnumValues

func GetListPrivateEndpointsSortByEnumValues() []ListPrivateEndpointsSortByEnum

GetListPrivateEndpointsSortByEnumValues Enumerates the set of values for ListPrivateEndpointsSortByEnum

type ListPrivateEndpointsSortOrderEnum

ListPrivateEndpointsSortOrderEnum Enum with underlying type: string

type ListPrivateEndpointsSortOrderEnum string

Set of constants representing the allowable values for ListPrivateEndpointsSortOrderEnum

const (
    ListPrivateEndpointsSortOrderAsc  ListPrivateEndpointsSortOrderEnum = "ASC"
    ListPrivateEndpointsSortOrderDesc ListPrivateEndpointsSortOrderEnum = "DESC"
)

func GetListPrivateEndpointsSortOrderEnumValues

func GetListPrivateEndpointsSortOrderEnumValues() []ListPrivateEndpointsSortOrderEnum

GetListPrivateEndpointsSortOrderEnumValues Enumerates the set of values for ListPrivateEndpointsSortOrderEnum

type ListRunLogsRequest

ListRunLogsRequest wrapper for the ListRunLogs operation

See also

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

type ListRunLogsRequest struct {

    // The unique ID for the run
    RunId *string `mandatory:"true" contributesTo:"path" name:"runId"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The maximum number of results to return in a paginated "List" call.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call
    // to sent back to server for getting the next page of results.
    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 (ListRunLogsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListRunLogsRequest) RetryPolicy

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

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

func (ListRunLogsRequest) String

func (request ListRunLogsRequest) String() string

type ListRunLogsResponse

ListRunLogsResponse wrapper for the ListRunLogs operation

type ListRunLogsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []RunLogSummary instances
    Items []RunLogSummary `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"`

    // Retrieves the previous page of results.
    // When this header appears in the response, previous pages of results exist.
    // See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`

    // Retrieves the next page of results. When this header appears in the response,
    // additional pages of results remain. See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

func (ListRunLogsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListRunLogsResponse) String

func (response ListRunLogsResponse) String() string

type ListRunsLifecycleStateEnum

ListRunsLifecycleStateEnum Enum with underlying type: string

type ListRunsLifecycleStateEnum string

Set of constants representing the allowable values for ListRunsLifecycleStateEnum

const (
    ListRunsLifecycleStateAccepted   ListRunsLifecycleStateEnum = "ACCEPTED"
    ListRunsLifecycleStateInProgress ListRunsLifecycleStateEnum = "IN_PROGRESS"
    ListRunsLifecycleStateCanceling  ListRunsLifecycleStateEnum = "CANCELING"
    ListRunsLifecycleStateCanceled   ListRunsLifecycleStateEnum = "CANCELED"
    ListRunsLifecycleStateFailed     ListRunsLifecycleStateEnum = "FAILED"
    ListRunsLifecycleStateSucceeded  ListRunsLifecycleStateEnum = "SUCCEEDED"
)

func GetListRunsLifecycleStateEnumValues

func GetListRunsLifecycleStateEnumValues() []ListRunsLifecycleStateEnum

GetListRunsLifecycleStateEnumValues Enumerates the set of values for ListRunsLifecycleStateEnum

type ListRunsRequest

ListRunsRequest wrapper for the ListRuns operation

See also

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

type ListRunsRequest struct {

    // The OCID of the compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The ID of the application.
    ApplicationId *string `mandatory:"false" contributesTo:"query" name:"applicationId"`

    // The OCID of the user who created the resource.
    OwnerPrincipalId *string `mandatory:"false" contributesTo:"query" name:"ownerPrincipalId"`

    // The displayName prefix.
    DisplayNameStartsWith *string `mandatory:"false" contributesTo:"query" name:"displayNameStartsWith"`

    // The LifecycleState of the run.
    LifecycleState ListRunsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

    // The epoch time that the resource was created.
    TimeCreatedGreaterThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedGreaterThan"`

    // The maximum number of results to return in a paginated `List` call.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call
    // to sent back to server for getting the next page of results.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The field used to sort the results. Multiple fields are not supported.
    SortBy ListRunsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // The ordering of results in ascending or descending order.
    SortOrder ListRunsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // The query parameter for the Spark application name.
    DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

    // 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 (ListRunsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListRunsRequest) RetryPolicy

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

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

func (ListRunsRequest) String

func (request ListRunsRequest) String() string

type ListRunsResponse

ListRunsResponse wrapper for the ListRuns operation

type ListRunsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []RunSummary instances
    Items []RunSummary `presentIn:"body"`

    // Retrieves the previous page of results.
    // When this header appears in the response, previous pages of results exist.
    // See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`

    // Retrieves the next page of results. When this header appears in the response,
    // additional pages of results remain. See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    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 (ListRunsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListRunsResponse) String

func (response ListRunsResponse) String() string

type ListRunsSortByEnum

ListRunsSortByEnum Enum with underlying type: string

type ListRunsSortByEnum string

Set of constants representing the allowable values for ListRunsSortByEnum

const (
    ListRunsSortByTimecreated               ListRunsSortByEnum = "timeCreated"
    ListRunsSortByDisplayname               ListRunsSortByEnum = "displayName"
    ListRunsSortByLanguage                  ListRunsSortByEnum = "language"
    ListRunsSortByRundurationinmilliseconds ListRunsSortByEnum = "runDurationInMilliseconds"
    ListRunsSortByLifecyclestate            ListRunsSortByEnum = "lifecycleState"
    ListRunsSortByTotalocpu                 ListRunsSortByEnum = "totalOCpu"
    ListRunsSortByDatareadinbytes           ListRunsSortByEnum = "dataReadInBytes"
    ListRunsSortByDatawritteninbytes        ListRunsSortByEnum = "dataWrittenInBytes"
)

func GetListRunsSortByEnumValues

func GetListRunsSortByEnumValues() []ListRunsSortByEnum

GetListRunsSortByEnumValues Enumerates the set of values for ListRunsSortByEnum

type ListRunsSortOrderEnum

ListRunsSortOrderEnum Enum with underlying type: string

type ListRunsSortOrderEnum string

Set of constants representing the allowable values for ListRunsSortOrderEnum

const (
    ListRunsSortOrderAsc  ListRunsSortOrderEnum = "ASC"
    ListRunsSortOrderDesc ListRunsSortOrderEnum = "DESC"
)

func GetListRunsSortOrderEnumValues

func GetListRunsSortOrderEnumValues() []ListRunsSortOrderEnum

GetListRunsSortOrderEnumValues Enumerates the set of values for ListRunsSortOrderEnum

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/dataflow/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.

type ListWorkRequestErrorsRequest struct {

    // The unique ID for a work request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // The maximum number of results to return in a paginated `List` call.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call
    // to sent back to server for getting the next page of results.
    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 (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"`

    // Retrieves the previous page of results.
    // When this header appears in the response, previous pages of results exist.
    // See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`

    // Retrieves the next page of results. When this header appears in the response,
    // additional pages of results remain. See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    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/dataflow/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.

type ListWorkRequestLogsRequest struct {

    // The unique ID for a work request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // The maximum number of results to return in a paginated `List` call.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call
    // to sent back to server for getting the next page of results.
    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 (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 WorkRequestLogCollection instances
    WorkRequestLogCollection `presentIn:"body"`

    // Retrieves the previous page of results.
    // When this header appears in the response, previous pages of results exist.
    // See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`

    // Retrieves the next page of results. When this header appears in the response,
    // additional pages of results remain. See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    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/dataflow/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.

type ListWorkRequestsRequest struct {

    // The OCID of the compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The maximum number of results to return in a paginated `List` call.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call
    // to sent back to server for getting the next page of results.
    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 (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"`

    // Retrieves the previous page of results.
    // When this header appears in the response, previous pages of results exist.
    // See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`

    // Retrieves the next page of results. When this header appears in the response,
    // additional pages of results remain. See List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    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 PrivateEndpoint

PrivateEndpoint A Data Flow private endpoint object.

type PrivateEndpoint struct {

    // The OCID of a compartment.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

    // A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    DisplayName *string `mandatory:"true" json:"displayName"`

    // An array of DNS zone names.
    // Example: `[ "app.examplecorp.com", "app.examplecorp2.com" ]`
    DnsZones []string `mandatory:"true" json:"dnsZones"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

    // The OCID of a private endpoint.
    Id *string `mandatory:"true" json:"id"`

    // The current state of this private endpoint.
    LifecycleState PrivateEndpointLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The OCID of the user who created the resource.
    OwnerPrincipalId *string `mandatory:"true" json:"ownerPrincipalId"`

    // The OCID of a subnet.
    SubnetId *string `mandatory:"true" json:"subnetId"`

    // The date and time a application was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The date and time a application was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

    // A user-friendly description. Avoid entering confidential information.
    Description *string `mandatory:"false" json:"description"`

    // The detailed messages about the lifecycle state.
    LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

    // The maximum number of hosts to be accessed through the private endpoint. This value is used
    // to calculate the relevant CIDR block and should be a multiple of 256.  If the value is not a
    // multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up
    // to 512.
    MaxHostCount *int `mandatory:"false" json:"maxHostCount"`

    // An array of network security group OCIDs.
    NsgIds []string `mandatory:"false" json:"nsgIds"`

    // The username of the user who created the resource.  If the username of the owner does not exist,
    // `null` will be returned and the caller should refer to the ownerPrincipalId value instead.
    OwnerUserName *string `mandatory:"false" json:"ownerUserName"`
}

func (PrivateEndpoint) String

func (m PrivateEndpoint) String() string

type PrivateEndpointCollection

PrivateEndpointCollection Results of a query for a list of private endpoints. Contains PrivateEndpointSummary items.

type PrivateEndpointCollection struct {

    // A list of private endpoints
    Items []PrivateEndpointSummary `mandatory:"true" json:"items"`
}

func (PrivateEndpointCollection) String

func (m PrivateEndpointCollection) String() string

type PrivateEndpointLifecycleStateEnum

PrivateEndpointLifecycleStateEnum Enum with underlying type: string

type PrivateEndpointLifecycleStateEnum string

Set of constants representing the allowable values for PrivateEndpointLifecycleStateEnum

const (
    PrivateEndpointLifecycleStateCreating PrivateEndpointLifecycleStateEnum = "CREATING"
    PrivateEndpointLifecycleStateActive   PrivateEndpointLifecycleStateEnum = "ACTIVE"
    PrivateEndpointLifecycleStateInactive PrivateEndpointLifecycleStateEnum = "INACTIVE"
    PrivateEndpointLifecycleStateUpdating PrivateEndpointLifecycleStateEnum = "UPDATING"
    PrivateEndpointLifecycleStateDeleting PrivateEndpointLifecycleStateEnum = "DELETING"
    PrivateEndpointLifecycleStateDeleted  PrivateEndpointLifecycleStateEnum = "DELETED"
    PrivateEndpointLifecycleStateFailed   PrivateEndpointLifecycleStateEnum = "FAILED"
)

func GetPrivateEndpointLifecycleStateEnumValues

func GetPrivateEndpointLifecycleStateEnumValues() []PrivateEndpointLifecycleStateEnum

GetPrivateEndpointLifecycleStateEnumValues Enumerates the set of values for PrivateEndpointLifecycleStateEnum

type PrivateEndpointSummary

PrivateEndpointSummary A Data Flow private endpoint object used in bulk listings.

type PrivateEndpointSummary struct {

    // The OCID of a compartment.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

    // A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    DisplayName *string `mandatory:"true" json:"displayName"`

    // An array of DNS zone names.
    // Example: `[ "app.examplecorp.com", "app.examplecorp2.com" ]`
    DnsZones []string `mandatory:"true" json:"dnsZones"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

    // The OCID of a private endpoint.
    Id *string `mandatory:"true" json:"id"`

    // The current state of this private endpoint.
    LifecycleState PrivateEndpointLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The OCID of the user who created the resource.
    OwnerPrincipalId *string `mandatory:"true" json:"ownerPrincipalId"`

    // The OCID of a subnet.
    SubnetId *string `mandatory:"true" json:"subnetId"`

    // The date and time a application was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The date and time a application was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

    // The maximum number of hosts to be accessed through the private endpoint. This value is used
    // to calculate the relevant CIDR block and should be a multiple of 256.  If the value is not a
    // multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up
    // to 512.
    MaxHostCount *int `mandatory:"false" json:"maxHostCount"`

    // An array of network security group OCIDs.
    NsgIds []string `mandatory:"false" json:"nsgIds"`

    // The username of the user who created the resource.  If the username of the owner does not exist,
    // `null` will be returned and the caller should refer to the ownerPrincipalId value instead.
    OwnerUserName *string `mandatory:"false" json:"ownerUserName"`
}

func (PrivateEndpointSummary) String

func (m PrivateEndpointSummary) String() string

type Run

Run A run object.

type Run struct {

    // The application ID.
    ApplicationId *string `mandatory:"true" json:"applicationId"`

    // The OCID of a compartment.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The VM shape for the driver. Sets the driver cores and memory.
    DriverShape *string `mandatory:"true" json:"driverShape"`

    // The VM shape for the executors. Sets the executor cores and memory.
    ExecutorShape *string `mandatory:"true" json:"executorShape"`

    // An Oracle Cloud Infrastructure URI of the file containing the application to execute.
    // See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    FileUri *string `mandatory:"true" json:"fileUri"`

    // The ID of a run.
    Id *string `mandatory:"true" json:"id"`

    // The Spark language.
    Language ApplicationLanguageEnum `mandatory:"true" json:"language"`

    // The current state of this run.
    LifecycleState RunLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The number of executor VMs requested.
    NumExecutors *int `mandatory:"true" json:"numExecutors"`

    // The Spark version utilized to run the application.
    SparkVersion *string `mandatory:"true" json:"sparkVersion"`

    // The date and time a application was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The date and time a application was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

    // An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application.
    // See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    ArchiveUri *string `mandatory:"false" json:"archiveUri"`

    // The arguments passed to the running application as command line arguments.  An argument is
    // either a plain text or a placeholder. Placeholders are replaced using values from the parameters
    // map.  Each placeholder specified must be represented in the parameters map else the request
    // (POST or PUT) will fail with a HTTP 400 status code.  Placeholders are specified as
    // `Service Api Spec`, where `name` is the name of the parameter.
    // Example:  `[ "--input", "${input_file}", "--name", "John Doe" ]`
    // If "input_file" has a value of "mydata.xml", then the value above will be translated to
    // `--input mydata.xml --name "John Doe"`
    Arguments []string `mandatory:"false" json:"arguments"`

    // The class for the application.
    ClassName *string `mandatory:"false" json:"className"`

    // The Spark configuration passed to the running process.
    // See https://spark.apache.org/docs/latest/configuration.html#available-properties.
    // Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" }
    // Note: Not all Spark properties are permitted to be set.  Attempting to set a property that is
    // not allowed to be overwritten will cause a 400 status to be returned.
    Configuration map[string]string `mandatory:"false" json:"configuration"`

    // The data read by the run in bytes.
    DataReadInBytes *int64 `mandatory:"false" json:"dataReadInBytes"`

    // The data written by the run in bytes.
    DataWrittenInBytes *int64 `mandatory:"false" json:"dataWrittenInBytes"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // A user-friendly name. This name is not necessarily unique.
    DisplayName *string `mandatory:"false" json:"displayName"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // The detailed messages about the lifecycle state.
    LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

    // An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded.
    // See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    LogsBucketUri *string `mandatory:"false" json:"logsBucketUri"`

    // Unique Oracle assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" json:"opcRequestId"`

    // The OCID of the user who created the resource.
    OwnerPrincipalId *string `mandatory:"false" json:"ownerPrincipalId"`

    // The username of the user who created the resource.  If the username of the owner does not exist,
    // `null` will be returned and the caller should refer to the ownerPrincipalId value instead.
    OwnerUserName *string `mandatory:"false" json:"ownerUserName"`

    // An array of name/value pairs used to fill placeholders found in properties like
    // `Application.arguments`.  The name must be a string of one or more word characters
    // (a-z, A-Z, 0-9, _).  The value can be a string of 0 or more characters of any kind.
    // Example:  [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ]
    Parameters []ApplicationParameter `mandatory:"false" json:"parameters"`

    // An array of DNS zone names.
    // Example: `[ "app.examplecorp.com", "app.examplecorp2.com" ]`
    PrivateEndpointDnsZones []string `mandatory:"false" json:"privateEndpointDnsZones"`

    // The maximum number of hosts to be accessed through the private endpoint. This value is used
    // to calculate the relevant CIDR block and should be a multiple of 256.  If the value is not a
    // multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up
    // to 512.
    PrivateEndpointMaxHostCount *int `mandatory:"false" json:"privateEndpointMaxHostCount"`

    // An array of network security group OCIDs.
    PrivateEndpointNsgIds []string `mandatory:"false" json:"privateEndpointNsgIds"`

    // The OCID of a private endpoint.
    PrivateEndpointId *string `mandatory:"false" json:"privateEndpointId"`

    // The OCID of a subnet.
    PrivateEndpointSubnetId *string `mandatory:"false" json:"privateEndpointSubnetId"`

    // The duration of the run in milliseconds.
    RunDurationInMilliseconds *int64 `mandatory:"false" json:"runDurationInMilliseconds"`

    // The total number of oCPU requested by the run.
    TotalOCpu *int `mandatory:"false" json:"totalOCpu"`

    // An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory
    // for BATCH SQL runs.
    // See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    WarehouseBucketUri *string `mandatory:"false" json:"warehouseBucketUri"`
}

func (Run) String

func (m Run) String() string

type RunLifecycleStateEnum

RunLifecycleStateEnum Enum with underlying type: string

type RunLifecycleStateEnum string

Set of constants representing the allowable values for RunLifecycleStateEnum

const (
    RunLifecycleStateAccepted   RunLifecycleStateEnum = "ACCEPTED"
    RunLifecycleStateInProgress RunLifecycleStateEnum = "IN_PROGRESS"
    RunLifecycleStateCanceling  RunLifecycleStateEnum = "CANCELING"
    RunLifecycleStateCanceled   RunLifecycleStateEnum = "CANCELED"
    RunLifecycleStateFailed     RunLifecycleStateEnum = "FAILED"
    RunLifecycleStateSucceeded  RunLifecycleStateEnum = "SUCCEEDED"
)

func GetRunLifecycleStateEnumValues

func GetRunLifecycleStateEnumValues() []RunLifecycleStateEnum

GetRunLifecycleStateEnumValues Enumerates the set of values for RunLifecycleStateEnum

type RunLogSummary

RunLogSummary A summary of a log associated with a particular run.

type RunLogSummary struct {

    // The name of the log.
    // Example: spark_driver_stderr_20190917T114000Z.log.gz
    Name *string `mandatory:"true" json:"name"`

    // The runId associated with the log.
    RunId *string `mandatory:"true" json:"runId"`

    // The source of the log such as driver and executor.
    Source RunLogSummarySourceEnum `mandatory:"true" json:"source"`

    // The type of log such as stdout and stderr.
    Type RunLogSummaryTypeEnum `mandatory:"true" json:"type"`

    // The size of the object in bytes.
    SizeInBytes *int64 `mandatory:"false" json:"sizeInBytes"`

    // The date and time the object was created, as described in RFC 2616 (https://tools.ietf.org/rfc/rfc2616), section 14.29.
    TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

func (RunLogSummary) String

func (m RunLogSummary) String() string

type RunLogSummarySourceEnum

RunLogSummarySourceEnum Enum with underlying type: string

type RunLogSummarySourceEnum string

Set of constants representing the allowable values for RunLogSummarySourceEnum

const (
    RunLogSummarySourceApplication RunLogSummarySourceEnum = "APPLICATION"
    RunLogSummarySourceDriver      RunLogSummarySourceEnum = "DRIVER"
    RunLogSummarySourceExecutor    RunLogSummarySourceEnum = "EXECUTOR"
)

func GetRunLogSummarySourceEnumValues

func GetRunLogSummarySourceEnumValues() []RunLogSummarySourceEnum

GetRunLogSummarySourceEnumValues Enumerates the set of values for RunLogSummarySourceEnum

type RunLogSummaryTypeEnum

RunLogSummaryTypeEnum Enum with underlying type: string

type RunLogSummaryTypeEnum string

Set of constants representing the allowable values for RunLogSummaryTypeEnum

const (
    RunLogSummaryTypeStderr RunLogSummaryTypeEnum = "STDERR"
    RunLogSummaryTypeStdout RunLogSummaryTypeEnum = "STDOUT"
)

func GetRunLogSummaryTypeEnumValues

func GetRunLogSummaryTypeEnumValues() []RunLogSummaryTypeEnum

GetRunLogSummaryTypeEnumValues Enumerates the set of values for RunLogSummaryTypeEnum

type RunSummary

RunSummary A summary of the run.

type RunSummary struct {

    // The application ID.
    ApplicationId *string `mandatory:"true" json:"applicationId"`

    // The OCID of a compartment.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

    // The ID of a run.
    Id *string `mandatory:"true" json:"id"`

    // The Spark language.
    Language ApplicationLanguageEnum `mandatory:"true" json:"language"`

    // The current state of this run.
    LifecycleState RunLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

    // The date and time a application was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

    // The date and time a application was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
    // Example: `2018-04-03T21:10:29.600Z`
    TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

    // The data read by the run in bytes.
    DataReadInBytes *int64 `mandatory:"false" json:"dataReadInBytes"`

    // The data written by the run in bytes.
    DataWrittenInBytes *int64 `mandatory:"false" json:"dataWrittenInBytes"`

    // A user-friendly name. This name is not necessarily unique.
    DisplayName *string `mandatory:"false" json:"displayName"`

    // The detailed messages about the lifecycle state.
    LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

    // Unique Oracle assigned identifier for the request.
    // If you need to contact Oracle about a particular request, please provide the request ID.
    OpcRequestId *string `mandatory:"false" json:"opcRequestId"`

    // The OCID of the user who created the resource.
    OwnerPrincipalId *string `mandatory:"false" json:"ownerPrincipalId"`

    // The username of the user who created the resource.  If the username of the owner does not exist,
    // `null` will be returned and the caller should refer to the ownerPrincipalId value instead.
    OwnerUserName *string `mandatory:"false" json:"ownerUserName"`

    // The duration of the run in milliseconds.
    RunDurationInMilliseconds *int64 `mandatory:"false" json:"runDurationInMilliseconds"`

    // The total number of oCPU requested by the run.
    TotalOCpu *int `mandatory:"false" json:"totalOCpu"`
}

func (RunSummary) String

func (m RunSummary) String() string

type UpdateApplicationDetails

UpdateApplicationDetails The update application details.

type UpdateApplicationDetails struct {

    // The class for the application.
    ClassName *string `mandatory:"false" json:"className"`

    // An Oracle Cloud Infrastructure URI of the file containing the application to execute.
    // See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    FileUri *string `mandatory:"false" json:"fileUri"`

    // The Spark version utilized to run the application.
    SparkVersion *string `mandatory:"false" json:"sparkVersion"`

    // The Spark language.
    Language ApplicationLanguageEnum `mandatory:"false" json:"language,omitempty"`

    // An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution a Python, Java, or Scala application.
    // See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    ArchiveUri *string `mandatory:"false" json:"archiveUri"`

    // The arguments passed to the running application as command line arguments.  An argument is
    // either a plain text or a placeholder. Placeholders are replaced using values from the parameters
    // map.  Each placeholder specified must be represented in the parameters map else the request
    // (POST or PUT) will fail with a HTTP 400 status code.  Placeholders are specified as
    // `Service Api Spec`, where `name` is the name of the parameter.
    // Example:  `[ "--input", "${input_file}", "--name", "John Doe" ]`
    // If "input_file" has a value of "mydata.xml", then the value above will be translated to
    // `--input mydata.xml --name "John Doe"`
    Arguments []string `mandatory:"false" json:"arguments"`

    // The Spark configuration passed to the running process.
    // See https://spark.apache.org/docs/latest/configuration.html#available-properties.
    // Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" }
    // Note: Not all Spark properties are permitted to be set.  Attempting to set a property that is
    // not allowed to be overwritten will cause a 400 status to be returned.
    Configuration map[string]string `mandatory:"false" json:"configuration"`

    // Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // A user-friendly description. Avoid entering confidential information.
    Description *string `mandatory:"false" json:"description"`

    // A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    DisplayName *string `mandatory:"false" json:"displayName"`

    // The VM shape for the driver. Sets the driver cores and memory.
    DriverShape *string `mandatory:"false" json:"driverShape"`

    // The VM shape for the executors. Sets the executor cores and memory.
    ExecutorShape *string `mandatory:"false" json:"executorShape"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded.
    // See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    LogsBucketUri *string `mandatory:"false" json:"logsBucketUri"`

    // The number of executor VMs requested.
    NumExecutors *int `mandatory:"false" json:"numExecutors"`

    // An array of name/value pairs used to fill placeholders found in properties like
    // `Application.arguments`.  The name must be a string of one or more word characters
    // (a-z, A-Z, 0-9, _).  The value can be a string of 0 or more characters of any kind.
    // Example:  [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ]
    Parameters []ApplicationParameter `mandatory:"false" json:"parameters"`

    // The OCID of a private endpoint.
    PrivateEndpointId *string `mandatory:"false" json:"privateEndpointId"`

    // An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory
    // for BATCH SQL runs.
    // See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
    WarehouseBucketUri *string `mandatory:"false" json:"warehouseBucketUri"`
}

func (UpdateApplicationDetails) String

func (m UpdateApplicationDetails) String() string

type UpdateApplicationRequest

UpdateApplicationRequest wrapper for the UpdateApplication operation

See also

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

type UpdateApplicationRequest struct {

    // Details for updating an application.
    UpdateApplicationDetails `contributesTo:"body"`

    // The unique ID for an application.
    ApplicationId *string `mandatory:"true" contributesTo:"path" name:"applicationId"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // 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"`

    // 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 (UpdateApplicationRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateApplicationRequest) RetryPolicy

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

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

func (UpdateApplicationRequest) String

func (request UpdateApplicationRequest) String() string

type UpdateApplicationResponse

UpdateApplicationResponse wrapper for the UpdateApplication operation

type UpdateApplicationResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For optimistic concurrency control.
    // See ETags for Optimistic Concurrency Control (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
    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 (UpdateApplicationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateApplicationResponse) String

func (response UpdateApplicationResponse) String() string

type UpdatePrivateEndpointDetails

UpdatePrivateEndpointDetails The update private endpoint details.

type UpdatePrivateEndpointDetails struct {

    // Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // A user-friendly description. Avoid entering confidential information.
    Description *string `mandatory:"false" json:"description"`

    // A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    DisplayName *string `mandatory:"false" json:"displayName"`

    // An array of DNS zone names.
    // Example: `[ "app.examplecorp.com", "app.examplecorp2.com" ]`
    DnsZones []string `mandatory:"false" json:"dnsZones"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // The maximum number of hosts to be accessed through the private endpoint. This value is used
    // to calculate the relevant CIDR block and should be a multiple of 256.  If the value is not a
    // multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up
    // to 512.
    MaxHostCount *int `mandatory:"false" json:"maxHostCount"`

    // An array of network security group OCIDs.
    NsgIds []string `mandatory:"false" json:"nsgIds"`
}

func (UpdatePrivateEndpointDetails) String

func (m UpdatePrivateEndpointDetails) String() string

type UpdatePrivateEndpointRequest

UpdatePrivateEndpointRequest wrapper for the UpdatePrivateEndpoint operation

See also

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

type UpdatePrivateEndpointRequest struct {

    // Details for updating a private endpoint.
    UpdatePrivateEndpointDetails `contributesTo:"body"`

    // The unique ID for a private endpoint.
    PrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"privateEndpointId"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // 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"`

    // 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 (UpdatePrivateEndpointRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdatePrivateEndpointRequest) RetryPolicy

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

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

func (UpdatePrivateEndpointRequest) String

func (request UpdatePrivateEndpointRequest) String() string

type UpdatePrivateEndpointResponse

UpdatePrivateEndpointResponse wrapper for the UpdatePrivateEndpoint operation

type UpdatePrivateEndpointResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // 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"`

    // Unique Oracle assigned identifier for a work request.
    OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}

func (UpdatePrivateEndpointResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdatePrivateEndpointResponse) String

func (response UpdatePrivateEndpointResponse) String() string

type UpdateRunDetails

UpdateRunDetails The update run details. Only the tags of a run can be updated.

type UpdateRunDetails struct {

    // Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
    // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Department": "Finance"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

func (UpdateRunDetails) String

func (m UpdateRunDetails) String() string

type UpdateRunRequest

UpdateRunRequest wrapper for the UpdateRun operation

See also

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

type UpdateRunRequest struct {

    // Details for updating a run.
    UpdateRunDetails `contributesTo:"body"`

    // The unique ID for the run
    RunId *string `mandatory:"true" contributesTo:"path" name:"runId"`

    // Unique identifier for the request. If provided, the returned request ID will include this value.
    // Otherwise, a random request ID will be generated by the service.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // 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"`

    // 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 (UpdateRunRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateRunRequest) RetryPolicy

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

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

func (UpdateRunRequest) String

func (request UpdateRunRequest) String() string

type UpdateRunResponse

UpdateRunResponse wrapper for the UpdateRun operation

type UpdateRunResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For optimistic concurrency control.
    // See ETags for Optimistic Concurrency Control (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven).
    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 (UpdateRunResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateRunResponse) String

func (response UpdateRunResponse) String() string

type WorkRequest

WorkRequest A Data Flow work request object.

type WorkRequest struct {

    // The OCID of a compartment.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

    // The operation related to this work request.
    Operation WorkRequestOperationEnum `mandatory:"true" json:"operation"`

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

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

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

    // 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:"false" 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 a query for a list of work requests. Contains WorkRequestSummary items.

type WorkRequestCollection struct {

    // A list of work requests
    Items []WorkRequestSummary `mandatory:"true" json:"items"`
}

func (WorkRequestCollection) String

func (m WorkRequestCollection) String() string

type WorkRequestError

WorkRequestError A Data Flow work request error object.

type WorkRequestError struct {

    // A Machine-usable code for the error that occured.
    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"`

    // The id of a work request error.
    Id *int64 `mandatory:"false" json:"id"`

    // The OCID of a work request.
    WorkRequestid *string `mandatory:"false" json:"workRequestid"`
}

func (WorkRequestError) String

func (m WorkRequestError) String() string

type WorkRequestErrorCollection

WorkRequestErrorCollection Results of a query for a list of work request errors. Contains WorkRequestError items.

type WorkRequestErrorCollection struct {

    // A list of work request errors.
    Items []WorkRequestError `mandatory:"true" json:"items"`
}

func (WorkRequestErrorCollection) String

func (m WorkRequestErrorCollection) String() string

type WorkRequestLog

WorkRequestLog A Data Flow work request log object.

type WorkRequestLog struct {

    // A 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"`

    // The id of a work request log.
    Id *int64 `mandatory:"false" json:"id"`

    // The OCID of a work request.
    WorkRequestid *string `mandatory:"false" json:"workRequestid"`
}

func (WorkRequestLog) String

func (m WorkRequestLog) String() string

type WorkRequestLogCollection

WorkRequestLogCollection Results of a query for a list of work request logs. Contains WorkRequestLog items.

type WorkRequestLogCollection struct {

    // A list of work request logs.
    Items []WorkRequestLog `mandatory:"true" json:"items"`
}

func (WorkRequestLogCollection) String

func (m WorkRequestLogCollection) String() string

type WorkRequestOperationEnum

WorkRequestOperationEnum Enum with underlying type: string

type WorkRequestOperationEnum string

Set of constants representing the allowable values for WorkRequestOperationEnum

const (
    WorkRequestOperationCreatePrivateEndpoint WorkRequestOperationEnum = "CREATE_PRIVATE_ENDPOINT"
    WorkRequestOperationUpdatePrivateEndpoint WorkRequestOperationEnum = "UPDATE_PRIVATE_ENDPOINT"
    WorkRequestOperationDeletePrivateEndpoint WorkRequestOperationEnum = "DELETE_PRIVATE_ENDPOINT"
    WorkRequestOperationMovePrivateEndpoint   WorkRequestOperationEnum = "MOVE_PRIVATE_ENDPOINT"
)

func GetWorkRequestOperationEnumValues

func GetWorkRequestOperationEnumValues() []WorkRequestOperationEnum

GetWorkRequestOperationEnumValues Enumerates the set of values for WorkRequestOperationEnum

type WorkRequestResource

WorkRequestResource A resource related to a Data Flow work request.

type WorkRequestResource struct {

    // The way in which this resource is affected by the work tracked in the work request.
    ActionType WorkRequestResourceActionTypeEnum `mandatory:"true" json:"actionType"`

    // The id of the releated resource. See resourceType to identity the specific type of resource.
    ResourceId *string `mandatory:"true" json:"resourceId"`

    // The type of resource.  See resourceId for the id of the specific resource.
    ResourceType *string `mandatory:"true" json:"resourceType"`

    // The id of a work request resource object.
    Id *int64 `mandatory:"false" json:"id"`

    // The URI path that the user can use to get access to the resource metadata
    ResourceUri *string `mandatory:"false" json:"resourceUri"`

    // The OCID of a work request.
    WorkRequestid *string `mandatory:"false" json:"workRequestid"`
}

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 = "INPROGRESS"
    WorkRequestResourceActionTypeRelated    WorkRequestResourceActionTypeEnum = "RELATED"
)

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"
    WorkRequestStatusCancelled  WorkRequestStatusEnum = "CANCELLED"
    WorkRequestStatusCancelling WorkRequestStatusEnum = "CANCELLING"
    WorkRequestStatusFailed     WorkRequestStatusEnum = "FAILED"
    WorkRequestStatusInprogress WorkRequestStatusEnum = "INPROGRESS"
    WorkRequestStatusSucceeded  WorkRequestStatusEnum = "SUCCEEDED"
)

func GetWorkRequestStatusEnumValues

func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum

GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum

type WorkRequestSummary

WorkRequestSummary A Data Flow work request object.

type WorkRequestSummary struct {

    // The OCID of a compartment.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

    // The operation related to this work request.
    Operation WorkRequestOperationEnum `mandatory:"true" json:"operation"`

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

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

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

    // 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:"false" 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