func GetApplicationLanguageEnumStringValues() []string
GetApplicationLanguageEnumStringValues Enumerates the set of values in String for ApplicationLanguageEnum
func GetApplicationLifecycleStateEnumStringValues() []string
GetApplicationLifecycleStateEnumStringValues Enumerates the set of values in String for ApplicationLifecycleStateEnum
func GetApplicationTypeEnumStringValues() []string
GetApplicationTypeEnumStringValues Enumerates the set of values in String for ApplicationTypeEnum
func GetDayOfWeekEnumStringValues() []string
GetDayOfWeekEnumStringValues Enumerates the set of values in String for DayOfWeekEnum
func GetIpNotationTypeEnumStringValues() []string
GetIpNotationTypeEnumStringValues Enumerates the set of values in String for IpNotationTypeEnum
func GetListApplicationsSortByEnumStringValues() []string
GetListApplicationsSortByEnumStringValues Enumerates the set of values in String for ListApplicationsSortByEnum
func GetListApplicationsSortOrderEnumStringValues() []string
GetListApplicationsSortOrderEnumStringValues Enumerates the set of values in String for ListApplicationsSortOrderEnum
func GetListPoolsLifecycleStateEnumStringValues() []string
GetListPoolsLifecycleStateEnumStringValues Enumerates the set of values in String for ListPoolsLifecycleStateEnum
func GetListPoolsSortByEnumStringValues() []string
GetListPoolsSortByEnumStringValues Enumerates the set of values in String for ListPoolsSortByEnum
func GetListPoolsSortOrderEnumStringValues() []string
GetListPoolsSortOrderEnumStringValues Enumerates the set of values in String for ListPoolsSortOrderEnum
func GetListPrivateEndpointsLifecycleStateEnumStringValues() []string
GetListPrivateEndpointsLifecycleStateEnumStringValues Enumerates the set of values in String for ListPrivateEndpointsLifecycleStateEnum
func GetListPrivateEndpointsSortByEnumStringValues() []string
GetListPrivateEndpointsSortByEnumStringValues Enumerates the set of values in String for ListPrivateEndpointsSortByEnum
func GetListPrivateEndpointsSortOrderEnumStringValues() []string
GetListPrivateEndpointsSortOrderEnumStringValues Enumerates the set of values in String for ListPrivateEndpointsSortOrderEnum
func GetListRunsLifecycleStateEnumStringValues() []string
GetListRunsLifecycleStateEnumStringValues Enumerates the set of values in String for ListRunsLifecycleStateEnum
func GetListRunsSortByEnumStringValues() []string
GetListRunsSortByEnumStringValues Enumerates the set of values in String for ListRunsSortByEnum
func GetListRunsSortOrderEnumStringValues() []string
GetListRunsSortOrderEnumStringValues Enumerates the set of values in String for ListRunsSortOrderEnum
func GetListSqlEndpointsLifecycleStateEnumStringValues() []string
GetListSqlEndpointsLifecycleStateEnumStringValues Enumerates the set of values in String for ListSqlEndpointsLifecycleStateEnum
func GetListSqlEndpointsSortByEnumStringValues() []string
GetListSqlEndpointsSortByEnumStringValues Enumerates the set of values in String for ListSqlEndpointsSortByEnum
func GetListSqlEndpointsSortOrderEnumStringValues() []string
GetListSqlEndpointsSortOrderEnumStringValues Enumerates the set of values in String for ListSqlEndpointsSortOrderEnum
func GetListStatementsLifecycleStateEnumStringValues() []string
GetListStatementsLifecycleStateEnumStringValues Enumerates the set of values in String for ListStatementsLifecycleStateEnum
func GetListStatementsSortByEnumStringValues() []string
GetListStatementsSortByEnumStringValues Enumerates the set of values in String for ListStatementsSortByEnum
func GetListStatementsSortOrderEnumStringValues() []string
GetListStatementsSortOrderEnumStringValues Enumerates the set of values in String for ListStatementsSortOrderEnum
func GetNetworkTypeEnumStringValues() []string
GetNetworkTypeEnumStringValues Enumerates the set of values in String for NetworkTypeEnum
func GetPoolLifecycleStateEnumStringValues() []string
GetPoolLifecycleStateEnumStringValues Enumerates the set of values in String for PoolLifecycleStateEnum
func GetPrivateEndpointLifecycleStateEnumStringValues() []string
GetPrivateEndpointLifecycleStateEnumStringValues Enumerates the set of values in String for PrivateEndpointLifecycleStateEnum
func GetRunLifecycleStateEnumStringValues() []string
GetRunLifecycleStateEnumStringValues Enumerates the set of values in String for RunLifecycleStateEnum
func GetRunLogSummarySourceEnumStringValues() []string
GetRunLogSummarySourceEnumStringValues Enumerates the set of values in String for RunLogSummarySourceEnum
func GetRunLogSummaryTypeEnumStringValues() []string
GetRunLogSummaryTypeEnumStringValues Enumerates the set of values in String for RunLogSummaryTypeEnum
func GetSqlEndpointLifecycleStateEnumStringValues() []string
GetSqlEndpointLifecycleStateEnumStringValues Enumerates the set of values in String for SqlEndpointLifecycleStateEnum
func GetStatementLifecycleStateEnumStringValues() []string
GetStatementLifecycleStateEnumStringValues Enumerates the set of values in String for StatementLifecycleStateEnum
func GetStatementOutputDataTypeEnumStringValues() []string
GetStatementOutputDataTypeEnumStringValues Enumerates the set of values in String for StatementOutputDataTypeEnum
func GetStatementOutputStatusEnumStringValues() []string
GetStatementOutputStatusEnumStringValues Enumerates the set of values in String for StatementOutputStatusEnum
func GetWorkRequestOperationEnumStringValues() []string
GetWorkRequestOperationEnumStringValues Enumerates the set of values in String for WorkRequestOperationEnum
func GetWorkRequestResourceActionTypeEnumStringValues() []string
GetWorkRequestResourceActionTypeEnumStringValues Enumerates the set of values in String for WorkRequestResourceActionTypeEnum
func GetWorkRequestStatusEnumStringValues() []string
GetWorkRequestStatusEnumStringValues Enumerates the set of values in String for WorkRequestStatusEnum
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 the resource 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 the resource 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"`
ApplicationLogConfig *ApplicationLogConfig `mandatory:"false" json:"applicationLogConfig"`
// A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example, ``oci://path/to/a.zip,oci://path/to/b.zip``. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of 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"`
DriverShapeConfig *ShapeConfig `mandatory:"false" json:"driverShapeConfig"`
// The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit.
// Supported options include ``--class``, ``--file``, ``--jars``, ``--conf``, ``--py-files``, and main application file with arguments.
// Example: ``--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10``
// Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit,
// Data Flow service will use derived information from execute input only.
Execute *string `mandatory:"false" json:"execute"`
ExecutorShapeConfig *ShapeConfig `mandatory:"false" json:"executorShapeConfig"`
// 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 OCID of OCI Hive Metastore.
MetastoreId *string `mandatory:"false" json:"metastoreId"`
// 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 pool. Unique Id to indentify a dataflow pool resource.
PoolId *string `mandatory:"false" json:"poolId"`
// The OCID of a private endpoint.
PrivateEndpointId *string `mandatory:"false" json:"privateEndpointId"`
// The Spark application processing type.
Type ApplicationTypeEnum `mandatory:"false" json:"type,omitempty"`
// 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"`
// The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated
// once it reaches this duration from the time it transitions to `IN_PROGRESS` state.
MaxDurationInMinutes *int64 `mandatory:"false" json:"maxDurationInMinutes"`
// The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period.
// Note: This parameter is currently only applicable for Runs of type `SESSION`. Default value is 2880 minutes (2 days)
IdleTimeoutInMinutes *int64 `mandatory:"false" json:"idleTimeoutInMinutes"`
}
func (m Application) String() string
func (m Application) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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() []ApplicationLanguageEnum
GetApplicationLanguageEnumValues Enumerates the set of values for ApplicationLanguageEnum
func GetMappingApplicationLanguageEnum(val string) (ApplicationLanguageEnum, bool)
GetMappingApplicationLanguageEnum performs case Insensitive comparison on enum value and return the desired enum
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() []ApplicationLifecycleStateEnum
GetApplicationLifecycleStateEnumValues Enumerates the set of values for ApplicationLifecycleStateEnum
func GetMappingApplicationLifecycleStateEnum(val string) (ApplicationLifecycleStateEnum, bool)
GetMappingApplicationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ApplicationLogConfig Logging details of Application logs for Data Flow Run.
type ApplicationLogConfig struct {
// The log group id for where log objects will be for Data Flow Runs.
LogGroupId *string `mandatory:"true" json:"logGroupId"`
// The log id of the log object the Application Logs of Data Flow Run will be shipped to.
LogId *string `mandatory:"true" json:"logId"`
}
func (m ApplicationLogConfig) String() string
func (m ApplicationLogConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (m ApplicationParameter) String() string
func (m ApplicationParameter) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 Spark version utilized to run the application.
SparkVersion *string `mandatory:"true" json:"sparkVersion"`
// The date and time the resource 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 the resource 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"`
// The OCID of a pool. Unique Id to indentify a dataflow pool resource.
PoolId *string `mandatory:"false" json:"poolId"`
// The Spark application processing type.
Type ApplicationTypeEnum `mandatory:"false" json:"type,omitempty"`
}
func (m ApplicationSummary) String() string
func (m ApplicationSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ApplicationTypeEnum Enum with underlying type: string
type ApplicationTypeEnum string
Set of constants representing the allowable values for ApplicationTypeEnum
const (
ApplicationTypeBatch ApplicationTypeEnum = "BATCH"
ApplicationTypeStreaming ApplicationTypeEnum = "STREAMING"
ApplicationTypeSession ApplicationTypeEnum = "SESSION"
)
func GetApplicationTypeEnumValues() []ApplicationTypeEnum
GetApplicationTypeEnumValues Enumerates the set of values for ApplicationTypeEnum
func GetMappingApplicationTypeEnum(val string) (ApplicationTypeEnum, bool)
GetMappingApplicationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ChangeApplicationCompartmentDetails The change application compartment details.
type ChangeApplicationCompartmentDetails struct {
// The OCID of a compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeApplicationCompartmentDetails) String() string
func (m ChangeApplicationCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeApplicationCompartmentRequest wrapper for the ChangeApplicationCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request ChangeApplicationCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeApplicationCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeApplicationCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeApplicationCompartmentRequest) String() string
func (request ChangeApplicationCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response ChangeApplicationCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeApplicationCompartmentResponse) String() string
ChangePoolCompartmentDetails The details required to change a pool compartment.
type ChangePoolCompartmentDetails struct {
// The OCID of a compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangePoolCompartmentDetails) String() string
func (m ChangePoolCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangePoolCompartmentRequest wrapper for the ChangePoolCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/ChangePoolCompartment.go.html to see an example of how to use ChangePoolCompartmentRequest.
type ChangePoolCompartmentRequest struct {
// The unique ID for a pool.
PoolId *string `mandatory:"true" contributesTo:"path" name:"poolId"`
// Details for changing a pool's compartment.
ChangePoolCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource,
// set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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 (request ChangePoolCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangePoolCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangePoolCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangePoolCompartmentRequest) String() string
func (request ChangePoolCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangePoolCompartmentResponse wrapper for the ChangePoolCompartment operation
type ChangePoolCompartmentResponse 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 (response ChangePoolCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangePoolCompartmentResponse) String() string
ChangePrivateEndpointCompartmentDetails The details required to change a private endpoint compartment.
type ChangePrivateEndpointCompartmentDetails struct {
// The OCID of a compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangePrivateEndpointCompartmentDetails) String() string
func (m ChangePrivateEndpointCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangePrivateEndpointCompartmentRequest wrapper for the ChangePrivateEndpointCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request ChangePrivateEndpointCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangePrivateEndpointCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangePrivateEndpointCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangePrivateEndpointCompartmentRequest) String() string
func (request ChangePrivateEndpointCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response ChangePrivateEndpointCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangePrivateEndpointCompartmentResponse) String() string
ChangeRunCompartmentDetails The change run compartment details.
type ChangeRunCompartmentDetails struct {
// The OCID of a compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeRunCompartmentDetails) String() string
func (m ChangeRunCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeRunCompartmentRequest wrapper for the ChangeRunCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request ChangeRunCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeRunCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeRunCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeRunCompartmentRequest) String() string
func (request ChangeRunCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response ChangeRunCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeRunCompartmentResponse) String() string
ChangeSqlEndpointCompartmentDetails Details for changing the compartment of a SQL Endpoint.
type ChangeSqlEndpointCompartmentDetails struct {
// The OCID of the compartment into which the resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeSqlEndpointCompartmentDetails) String() string
func (m ChangeSqlEndpointCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeSqlEndpointCompartmentRequest wrapper for the ChangeSqlEndpointCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/ChangeSqlEndpointCompartment.go.html to see an example of how to use ChangeSqlEndpointCompartmentRequest.
type ChangeSqlEndpointCompartmentRequest struct {
// The unique id of the SQL Endpoint.
SqlEndpointId *string `mandatory:"true" contributesTo:"path" name:"sqlEndpointId"`
// The details to change the compartment of the Sql Endpoint.
ChangeSqlEndpointCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource,
// set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// 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"`
// 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 (request ChangeSqlEndpointCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeSqlEndpointCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeSqlEndpointCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeSqlEndpointCompartmentRequest) String() string
func (request ChangeSqlEndpointCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeSqlEndpointCompartmentResponse wrapper for the ChangeSqlEndpointCompartment operation
type ChangeSqlEndpointCompartmentResponse 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 (response ChangeSqlEndpointCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeSqlEndpointCompartmentResponse) String() string
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"`
// 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"`
// A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example, ``oci://path/to/a.zip,oci://path/to/b.zip``. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of 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"`
ApplicationLogConfig *ApplicationLogConfig `mandatory:"false" json:"applicationLogConfig"`
// 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"`
DriverShapeConfig *ShapeConfig `mandatory:"false" json:"driverShapeConfig"`
// The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit.
// Supported options include ``--class``, ``--file``, ``--jars``, ``--conf``, ``--py-files``, and main application file with arguments.
// Example: ``--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10``
// Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit,
// Data Flow service will use derived information from execute input only.
Execute *string `mandatory:"false" json:"execute"`
ExecutorShapeConfig *ShapeConfig `mandatory:"false" json:"executorShapeConfig"`
// 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"`
// 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 OCID of OCI Hive Metastore.
MetastoreId *string `mandatory:"false" json:"metastoreId"`
// 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 pool. Unique Id to indentify a dataflow pool resource.
PoolId *string `mandatory:"false" json:"poolId"`
// The OCID of a private endpoint.
PrivateEndpointId *string `mandatory:"false" json:"privateEndpointId"`
// The Spark application processing type.
Type ApplicationTypeEnum `mandatory:"false" json:"type,omitempty"`
// 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"`
// The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated
// once it reaches this duration from the time it transitions to `IN_PROGRESS` state.
MaxDurationInMinutes *int64 `mandatory:"false" json:"maxDurationInMinutes"`
// The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period.
// Note: This parameter is currently only applicable for Runs of type `SESSION`. Default value is 2880 minutes (2 days)
IdleTimeoutInMinutes *int64 `mandatory:"false" json:"idleTimeoutInMinutes"`
}
func (m CreateApplicationDetails) String() string
func (m CreateApplicationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateApplicationRequest wrapper for the CreateApplication operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request CreateApplicationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateApplicationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateApplicationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateApplicationRequest) String() string
func (request CreateApplicationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response CreateApplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateApplicationResponse) String() string
CreatePoolDetails The details required to create a pool.
type CreatePoolDetails 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"`
// List of PoolConfig items.
Configurations []PoolConfig `mandatory:"true" json:"configurations"`
// A user-friendly description. Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
// A list of schedules for pool to auto start and stop.
Schedules []PoolSchedule `mandatory:"false" json:"schedules"`
// Optional timeout value in minutes used to auto stop Pools. A Pool will be auto stopped after inactivity for this amount of time period.
// If value not set, pool will not be auto stopped auto.
IdleTimeoutInMinutes *int `mandatory:"false" json:"idleTimeoutInMinutes"`
// 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"`
// 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"`
}
func (m CreatePoolDetails) String() string
func (m CreatePoolDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreatePoolRequest wrapper for the CreatePool operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/CreatePool.go.html to see an example of how to use CreatePoolRequest.
type CreatePoolRequest struct {
// The parameter required to create a pool.
CreatePoolDetails `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 (request CreatePoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreatePoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreatePoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreatePoolRequest) String() string
func (request CreatePoolRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreatePoolResponse wrapper for the CreatePool operation
type CreatePoolResponse struct {
// The underlying http response
RawResponse *http.Response
// The Pool instance
Pool `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 (response CreatePoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreatePoolResponse) String() string
CreatePrivateEndpointDetails The details required to create a private endpoint.
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"`
// An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value.
// [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
ScanDetails []Scan `mandatory:"false" json:"scanDetails"`
}
func (m CreatePrivateEndpointDetails) String() string
func (m CreatePrivateEndpointDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreatePrivateEndpointRequest wrapper for the CreatePrivateEndpoint operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/CreatePrivateEndpoint.go.html to see an example of how to use CreatePrivateEndpointRequest.
type CreatePrivateEndpointRequest struct {
// The parameters required 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 (request CreatePrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreatePrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreatePrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreatePrivateEndpointRequest) String() string
func (request CreatePrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response CreatePrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreatePrivateEndpointResponse) String() string
CreateRunDetails The create run details. The following properties are optional and override the default values set in the associated application:
- applicationId - archiveUri - applicationLogConfig - arguments - configuration - definedTags - displayName - driverShape - execute - executorShape - freeformTags - logsBucketUri - metastoreId - numExecutors - parameters - sparkVersion - warehouseBucketUri
It is expected that either the applicationId or the execute parameter is specified; but not both. If both or none are set, a Bad Request (HTTP 400) status will be sent as the response. If an appicationId is not specified, then a value for the execute parameter is expected. Using data parsed from the value, a new application will be created and assicated with the new run. See information on the execute parameter for details on the format of this parameter. The optional parameter spark version can only be specified when using the execute parameter. If it is not specified when using the execute parameter, the latest version will be used as default. If the execute parameter is not used, the spark version will be taken from the associated application. If displayName is not specified, it will be derived from the displayName of associated application or set by API using fileUri's application file name. 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 OCID of a compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
ApplicationLogConfig *ApplicationLogConfig `mandatory:"false" json:"applicationLogConfig"`
// The OCID of the associated application. If this value is set, then no value for the execute parameter is required. If this value is not set, then a value for the execute parameter is required, and a new application is created and associated with the new run.
ApplicationId *string `mandatory:"false" json:"applicationId"`
// A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example, ``oci://path/to/a.zip,oci://path/to/b.zip``. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of 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 name that does not have to be unique. Avoid entering confidential information. If this value is not specified, it will be derived from the associated application's displayName or set by API using fileUri's application file name.
DisplayName *string `mandatory:"false" json:"displayName"`
// The VM shape for the driver. Sets the driver cores and memory.
DriverShape *string `mandatory:"false" json:"driverShape"`
DriverShapeConfig *ShapeConfig `mandatory:"false" json:"driverShapeConfig"`
// The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit.
// Supported options include ``--class``, ``--file``, ``--jars``, ``--conf``, ``--py-files``, and main application file with arguments.
// Example: ``--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10``
// Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit,
// Data Flow service will use derived information from execute input only.
Execute *string `mandatory:"false" json:"execute"`
// The VM shape for the executors. Sets the executor cores and memory.
ExecutorShape *string `mandatory:"false" json:"executorShape"`
ExecutorShapeConfig *ShapeConfig `mandatory:"false" json:"executorShapeConfig"`
// 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 OCID of OCI Hive Metastore.
MetastoreId *string `mandatory:"false" json:"metastoreId"`
// 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 pool. Unique Id to indentify a dataflow pool resource.
PoolId *string `mandatory:"false" json:"poolId"`
// The Spark version utilized to run the application. This value may be set if applicationId is not since the Spark version will be taken from the associated application.
SparkVersion *string `mandatory:"false" json:"sparkVersion"`
// The Spark application processing type.
Type ApplicationTypeEnum `mandatory:"false" json:"type,omitempty"`
// 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"`
// The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated
// once it reaches this duration from the time it transitions to `IN_PROGRESS` state.
MaxDurationInMinutes *int64 `mandatory:"false" json:"maxDurationInMinutes"`
// The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period.
// Note: This parameter is currently only applicable for Runs of type `SESSION`. Default value is 2880 minutes (2 days)
IdleTimeoutInMinutes *int64 `mandatory:"false" json:"idleTimeoutInMinutes"`
}
func (m CreateRunDetails) String() string
func (m CreateRunDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateRunRequest wrapper for the CreateRun operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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"`
// (Optional header param, required for Resource Principal version 3.0+)
// Parent resource control plane endpoint used to exchange for upper level resource principal token.
OpcParentRptUrl *string `mandatory:"false" contributesTo:"header" name:"opc-parent-rpt-url"`
// 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 (request CreateRunRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateRunRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateRunRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateRunRequest) String() string
func (request CreateRunRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response CreateRunResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateRunResponse) String() string
CreateSqlEndpointDetails The information about a new SQL Endpoint.
type CreateSqlEndpointDetails struct {
// The identifier of the compartment used with the SQL Endpoint.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The SQL Endpoint name, which can be changed.
DisplayName *string `mandatory:"true" json:"displayName"`
// The version of the SQL Endpoint.
SqlEndpointVersion *string `mandatory:"true" json:"sqlEndpointVersion"`
// The shape of the SQL Endpoint driver instance.
DriverShape *string `mandatory:"true" json:"driverShape"`
// The shape of the SQL Endpoint worker instance.
ExecutorShape *string `mandatory:"true" json:"executorShape"`
// The minimum number of executors.
MinExecutorCount *int `mandatory:"true" json:"minExecutorCount"`
// The maximum number of executors.
MaxExecutorCount *int `mandatory:"true" json:"maxExecutorCount"`
// Metastore OCID
MetastoreId *string `mandatory:"true" json:"metastoreId"`
// OCI lake OCID
LakeId *string `mandatory:"true" json:"lakeId"`
// The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html
WarehouseBucketUri *string `mandatory:"true" json:"warehouseBucketUri"`
NetworkConfiguration SqlEndpointNetworkConfiguration `mandatory:"true" json:"networkConfiguration"`
// The description of CreateSQLEndpointDetails.
Description *string `mandatory:"false" json:"description"`
DriverShapeConfig *ShapeConfig `mandatory:"false" json:"driverShapeConfig"`
ExecutorShapeConfig *ShapeConfig `mandatory:"false" json:"executorShapeConfig"`
// 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"`
// 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 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.
SparkAdvancedConfigurations map[string]string `mandatory:"false" json:"sparkAdvancedConfigurations"`
}
func (m CreateSqlEndpointDetails) String() string
func (m *CreateSqlEndpointDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateSqlEndpointDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateSqlEndpointRequest wrapper for the CreateSqlEndpoint operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/CreateSqlEndpoint.go.html to see an example of how to use CreateSqlEndpointRequest.
type CreateSqlEndpointRequest struct {
// Details of the new Sql Endpoint.
CreateSqlEndpointDetails `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 (request CreateSqlEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSqlEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSqlEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSqlEndpointRequest) String() string
func (request CreateSqlEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateSqlEndpointResponse wrapper for the CreateSqlEndpoint operation
type CreateSqlEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The SqlEndpoint instance
SqlEndpoint `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"`
// Unique Oracle assigned identifier for a work request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-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"`
}
func (response CreateSqlEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSqlEndpointResponse) String() string
CreateStatementDetails The details required to create a statement.
type CreateStatementDetails struct {
// The statement code to execute.
// Example: `println(sc.version)`
Code *string `mandatory:"true" json:"code"`
}
func (m CreateStatementDetails) String() string
func (m CreateStatementDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateStatementRequest wrapper for the CreateStatement operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/CreateStatement.go.html to see an example of how to use CreateStatementRequest.
type CreateStatementRequest struct {
// Details for creating a statement.
CreateStatementDetails `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"`
// 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 (request CreateStatementRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateStatementRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateStatementRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateStatementRequest) String() string
func (request CreateStatementRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateStatementResponse wrapper for the CreateStatement operation
type CreateStatementResponse struct {
// The underlying http response
RawResponse *http.Response
// The Statement instance
Statement `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 (response CreateStatementResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateStatementResponse) String() string
DataFlowClient a client for DataFlow
type DataFlowClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (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/65.63.2/dataflow/ChangeApplicationCompartment.go.html to see an example of how to use ChangeApplicationCompartment API.
func (client DataFlowClient) ChangePoolCompartment(ctx context.Context, request ChangePoolCompartmentRequest) (response ChangePoolCompartmentResponse, err error)
ChangePoolCompartment Moves a pool 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 pool must be in a terminal state (STOPPED, FAILED) 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/65.63.2/dataflow/ChangePoolCompartment.go.html to see an example of how to use ChangePoolCompartment API. A default retry strategy applies to this operation ChangePoolCompartment()
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/65.63.2/dataflow/ChangePrivateEndpointCompartment.go.html to see an example of how to use ChangePrivateEndpointCompartment API.
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/65.63.2/dataflow/ChangeRunCompartment.go.html to see an example of how to use ChangeRunCompartment API.
func (client DataFlowClient) ChangeSqlEndpointCompartment(ctx context.Context, request ChangeSqlEndpointCompartmentRequest) (response ChangeSqlEndpointCompartmentResponse, err error)
ChangeSqlEndpointCompartment Moves an Sql Endpoint from one compartment to another. When provided, If-Match is checked against ETag values of the Sql Endpoint.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/ChangeSqlEndpointCompartment.go.html to see an example of how to use ChangeSqlEndpointCompartment API.
func (client *DataFlowClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
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/65.63.2/dataflow/CreateApplication.go.html to see an example of how to use CreateApplication API.
func (client DataFlowClient) CreatePool(ctx context.Context, request CreatePoolRequest) (response CreatePoolResponse, err error)
CreatePool Create a pool to be used by dataflow runs or applications.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/CreatePool.go.html to see an example of how to use CreatePool API. A default retry strategy applies to this operation CreatePool()
func (client DataFlowClient) CreatePrivateEndpoint(ctx context.Context, request CreatePrivateEndpointRequest) (response CreatePrivateEndpointResponse, err error)
CreatePrivateEndpoint Creates a private endpoint to be used by applications.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/CreatePrivateEndpoint.go.html to see an example of how to use CreatePrivateEndpoint API.
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/65.63.2/dataflow/CreateRun.go.html to see an example of how to use CreateRun API.
func (client DataFlowClient) CreateSqlEndpoint(ctx context.Context, request CreateSqlEndpointRequest) (response CreateSqlEndpointResponse, err error)
CreateSqlEndpoint Create a new Sql Endpoint.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/CreateSqlEndpoint.go.html to see an example of how to use CreateSqlEndpoint API.
func (client DataFlowClient) CreateStatement(ctx context.Context, request CreateStatementRequest) (response CreateStatementResponse, err error)
CreateStatement Executes a statement for a Session run.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/CreateStatement.go.html to see an example of how to use CreateStatement API.
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/65.63.2/dataflow/DeleteApplication.go.html to see an example of how to use DeleteApplication API.
func (client DataFlowClient) DeletePool(ctx context.Context, request DeletePoolRequest) (response DeletePoolResponse, err error)
DeletePool Deletes a pool using a `poolId`.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/DeletePool.go.html to see an example of how to use DeletePool API.
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/65.63.2/dataflow/DeletePrivateEndpoint.go.html to see an example of how to use DeletePrivateEndpoint API.
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/65.63.2/dataflow/DeleteRun.go.html to see an example of how to use DeleteRun API.
func (client DataFlowClient) DeleteSqlEndpoint(ctx context.Context, request DeleteSqlEndpointRequest) (response DeleteSqlEndpointResponse, err error)
DeleteSqlEndpoint Delete a Sql Endpoint resource, identified by the SqlEndpoint id.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/DeleteSqlEndpoint.go.html to see an example of how to use DeleteSqlEndpoint API.
func (client DataFlowClient) DeleteStatement(ctx context.Context, request DeleteStatementRequest) (response DeleteStatementResponse, err error)
DeleteStatement Cancels the specified statement for a Session run.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/DeleteStatement.go.html to see an example of how to use DeleteStatement API. A default retry strategy applies to this operation DeleteStatement()
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/65.63.2/dataflow/GetApplication.go.html to see an example of how to use GetApplication API. A default retry strategy applies to this operation GetApplication()
func (client DataFlowClient) GetPool(ctx context.Context, request GetPoolRequest) (response GetPoolResponse, err error)
GetPool Retrieves a pool using a `poolId`.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/GetPool.go.html to see an example of how to use GetPool API. A default retry strategy applies to this operation GetPool()
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/65.63.2/dataflow/GetPrivateEndpoint.go.html to see an example of how to use GetPrivateEndpoint API. A default retry strategy applies to this operation GetPrivateEndpoint()
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/65.63.2/dataflow/GetRun.go.html to see an example of how to use GetRun API. A default retry strategy applies to this operation GetRun()
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/65.63.2/dataflow/GetRunLog.go.html to see an example of how to use GetRunLog API. A default retry strategy applies to this operation GetRunLog()
func (client DataFlowClient) GetSqlEndpoint(ctx context.Context, request GetSqlEndpointRequest) (response GetSqlEndpointResponse, err error)
GetSqlEndpoint Retrieves a SQL Endpoint using a sqlEndpointId.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/GetSqlEndpoint.go.html to see an example of how to use GetSqlEndpoint API. A default retry strategy applies to this operation GetSqlEndpoint()
func (client DataFlowClient) GetStatement(ctx context.Context, request GetStatementRequest) (response GetStatementResponse, err error)
GetStatement Retrieves the statement corresponding to the `statementId` for a Session run specified by `runId`.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/GetStatement.go.html to see an example of how to use GetStatement API. A default retry strategy applies to this operation GetStatement()
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/65.63.2/dataflow/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client DataFlowClient) ListApplications(ctx context.Context, request ListApplicationsRequest) (response ListApplicationsResponse, err error)
ListApplications Lists all applications in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/ListApplications.go.html to see an example of how to use ListApplications API. A default retry strategy applies to this operation ListApplications()
func (client DataFlowClient) ListPools(ctx context.Context, request ListPoolsRequest) (response ListPoolsResponse, err error)
ListPools Lists all pools in the specified compartment. The query must include compartmentId. The query may also include one other parameter. If the query does not include compartmentId, or includes compartmentId, but with two or more other parameters, an error is returned.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/ListPools.go.html to see an example of how to use ListPools API. A default retry strategy applies to this operation ListPools()
func (client DataFlowClient) ListPrivateEndpoints(ctx context.Context, request ListPrivateEndpointsRequest) (response ListPrivateEndpointsResponse, err error)
ListPrivateEndpoints Lists all private endpoints in the specified compartment. The query must include compartmentId. The query may also include one other parameter. If the query does not include compartmentId, or includes compartmentId, but with two or more other parameters, an error is returned.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/ListPrivateEndpoints.go.html to see an example of how to use ListPrivateEndpoints API. A default retry strategy applies to this operation ListPrivateEndpoints()
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/65.63.2/dataflow/ListRunLogs.go.html to see an example of how to use ListRunLogs API. A default retry strategy applies to this operation ListRunLogs()
func (client DataFlowClient) ListRuns(ctx context.Context, request ListRunsRequest) (response ListRunsResponse, err error)
ListRuns Lists all runs of an application in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/ListRuns.go.html to see an example of how to use ListRuns API. A default retry strategy applies to this operation ListRuns()
func (client DataFlowClient) ListSqlEndpoints(ctx context.Context, request ListSqlEndpointsRequest) (response ListSqlEndpointsResponse, err error)
ListSqlEndpoints Lists all Sql Endpoints in the specified compartment. The query must include compartmentId or sqlEndpointId. If the query does not include either compartmentId or sqlEndpointId, an error is returned.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/ListSqlEndpoints.go.html to see an example of how to use ListSqlEndpoints API. A default retry strategy applies to this operation ListSqlEndpoints()
func (client DataFlowClient) ListStatements(ctx context.Context, request ListStatementsRequest) (response ListStatementsResponse, err error)
ListStatements Lists all statements for a Session run.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/ListStatements.go.html to see an example of how to use ListStatements API. A default retry strategy applies to this operation ListStatements()
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/65.63.2/dataflow/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
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/65.63.2/dataflow/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
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/65.63.2/dataflow/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *DataFlowClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client DataFlowClient) StartPool(ctx context.Context, request StartPoolRequest) (response StartPoolResponse, err error)
StartPool Starts the dataflow pool for a given `poolId`. 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/65.63.2/dataflow/StartPool.go.html to see an example of how to use StartPool API. A default retry strategy applies to this operation StartPool()
func (client DataFlowClient) StopPool(ctx context.Context, request StopPoolRequest) (response StopPoolResponse, err error)
StopPool Stops the dataflow pool for a given `poolId`. 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/65.63.2/dataflow/StopPool.go.html to see an example of how to use StopPool API. A default retry strategy applies to this operation StopPool()
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/65.63.2/dataflow/UpdateApplication.go.html to see an example of how to use UpdateApplication API.
func (client DataFlowClient) UpdatePool(ctx context.Context, request UpdatePoolRequest) (response UpdatePoolResponse, err error)
UpdatePool Updates a pool using a `poolId`.If changes to a pool doesn't match a previously defined pool,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/65.63.2/dataflow/UpdatePool.go.html to see an example of how to use UpdatePool API.
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/65.63.2/dataflow/UpdatePrivateEndpoint.go.html to see an example of how to use UpdatePrivateEndpoint API.
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/65.63.2/dataflow/UpdateRun.go.html to see an example of how to use UpdateRun API.
func (client DataFlowClient) UpdateSqlEndpoint(ctx context.Context, request UpdateSqlEndpointRequest) (response UpdateSqlEndpointResponse, err error)
UpdateSqlEndpoint Update a Sql Endpoint resource, identified by the SqlEndpoint id.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/UpdateSqlEndpoint.go.html to see an example of how to use UpdateSqlEndpoint API.
DayOfWeekEnum Enum with underlying type: string
type DayOfWeekEnum string
Set of constants representing the allowable values for DayOfWeekEnum
const (
DayOfWeekSunday DayOfWeekEnum = "SUNDAY"
DayOfWeekMonday DayOfWeekEnum = "MONDAY"
DayOfWeekTuesday DayOfWeekEnum = "TUESDAY"
DayOfWeekWednesday DayOfWeekEnum = "WEDNESDAY"
DayOfWeekThursday DayOfWeekEnum = "THURSDAY"
DayOfWeekFriday DayOfWeekEnum = "FRIDAY"
DayOfWeekSaturday DayOfWeekEnum = "SATURDAY"
)
func GetDayOfWeekEnumValues() []DayOfWeekEnum
GetDayOfWeekEnumValues Enumerates the set of values for DayOfWeekEnum
func GetMappingDayOfWeekEnum(val string) (DayOfWeekEnum, bool)
GetMappingDayOfWeekEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteApplicationRequest wrapper for the DeleteApplication operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request DeleteApplicationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteApplicationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteApplicationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteApplicationRequest) String() string
func (request DeleteApplicationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response DeleteApplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteApplicationResponse) String() string
DeletePoolRequest wrapper for the DeletePool operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/DeletePool.go.html to see an example of how to use DeletePoolRequest.
type DeletePoolRequest struct {
// The unique ID for a pool.
PoolId *string `mandatory:"true" contributesTo:"path" name:"poolId"`
// 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 (request DeletePoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeletePoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeletePoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeletePoolRequest) String() string
func (request DeletePoolRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeletePoolResponse wrapper for the DeletePool operation
type DeletePoolResponse 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 (response DeletePoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeletePoolResponse) String() string
DeletePrivateEndpointRequest wrapper for the DeletePrivateEndpoint operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request DeletePrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeletePrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeletePrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeletePrivateEndpointRequest) String() string
func (request DeletePrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response DeletePrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeletePrivateEndpointResponse) String() string
DeleteRunRequest wrapper for the DeleteRun operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request DeleteRunRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteRunRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteRunRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteRunRequest) String() string
func (request DeleteRunRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response DeleteRunResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteRunResponse) String() string
DeleteSqlEndpointRequest wrapper for the DeleteSqlEndpoint operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/DeleteSqlEndpoint.go.html to see an example of how to use DeleteSqlEndpointRequest.
type DeleteSqlEndpointRequest struct {
// The unique id of the SQL Endpoint.
SqlEndpointId *string `mandatory:"true" contributesTo:"path" name:"sqlEndpointId"`
// 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"`
// 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 (request DeleteSqlEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteSqlEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSqlEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSqlEndpointRequest) String() string
func (request DeleteSqlEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteSqlEndpointResponse wrapper for the DeleteSqlEndpoint operation
type DeleteSqlEndpointResponse 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 (response DeleteSqlEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSqlEndpointResponse) String() string
DeleteStatementRequest wrapper for the DeleteStatement operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/DeleteStatement.go.html to see an example of how to use DeleteStatementRequest.
type DeleteStatementRequest struct {
// The unique ID for the run
RunId *string `mandatory:"true" contributesTo:"path" name:"runId"`
// The unique ID for the statement.
StatementId *string `mandatory:"true" contributesTo:"path" name:"statementId"`
// 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 (request DeleteStatementRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteStatementRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteStatementRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteStatementRequest) String() string
func (request DeleteStatementRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteStatementResponse wrapper for the DeleteStatement operation
type DeleteStatementResponse 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 (response DeleteStatementResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteStatementResponse) String() string
GetApplicationRequest wrapper for the GetApplication operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request GetApplicationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetApplicationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetApplicationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetApplicationRequest) String() string
func (request GetApplicationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response GetApplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetApplicationResponse) String() string
GetPoolRequest wrapper for the GetPool operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/GetPool.go.html to see an example of how to use GetPoolRequest.
type GetPoolRequest struct {
// The unique ID for a pool.
PoolId *string `mandatory:"true" contributesTo:"path" name:"poolId"`
// 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 (request GetPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPoolRequest) String() string
func (request GetPoolRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetPoolResponse wrapper for the GetPool operation
type GetPoolResponse struct {
// The underlying http response
RawResponse *http.Response
// The Pool instance
Pool `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 (response GetPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPoolResponse) String() string
GetPrivateEndpointRequest wrapper for the GetPrivateEndpoint operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request GetPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPrivateEndpointRequest) String() string
func (request GetPrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response GetPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPrivateEndpointResponse) String() string
GetRunLogRequest wrapper for the GetRunLog operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request GetRunLogRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRunLogRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRunLogRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRunLogRequest) String() string
func (request GetRunLogRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response GetRunLogResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRunLogResponse) String() string
GetRunRequest wrapper for the GetRun operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request GetRunRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRunRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRunRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRunRequest) String() string
func (request GetRunRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response GetRunResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRunResponse) String() string
GetSqlEndpointRequest wrapper for the GetSqlEndpoint operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/GetSqlEndpoint.go.html to see an example of how to use GetSqlEndpointRequest.
type GetSqlEndpointRequest struct {
// The unique id of the SQL Endpoint.
SqlEndpointId *string `mandatory:"true" contributesTo:"path" name:"sqlEndpointId"`
// 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 (request GetSqlEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSqlEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSqlEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSqlEndpointRequest) String() string
func (request GetSqlEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetSqlEndpointResponse wrapper for the GetSqlEndpoint operation
type GetSqlEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The SqlEndpoint instance
SqlEndpoint `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 (response GetSqlEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSqlEndpointResponse) String() string
GetStatementRequest wrapper for the GetStatement operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/GetStatement.go.html to see an example of how to use GetStatementRequest.
type GetStatementRequest struct {
// The unique ID for the run
RunId *string `mandatory:"true" contributesTo:"path" name:"runId"`
// The unique ID for the statement.
StatementId *string `mandatory:"true" contributesTo:"path" name:"statementId"`
// 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 (request GetStatementRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetStatementRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetStatementRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetStatementRequest) String() string
func (request GetStatementRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetStatementResponse wrapper for the GetStatement operation
type GetStatementResponse struct {
// The underlying http response
RawResponse *http.Response
// The Statement instance
Statement `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 (response GetStatementResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetStatementResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
ImagePngStatementOutputData The statement output data in png format.
type ImagePngStatementOutputData struct {
// The statement code execution output in png format.
Value io.ReadCloser `mandatory:"true" json:"value"`
}
func (m ImagePngStatementOutputData) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ImagePngStatementOutputData) String() string
func (m ImagePngStatementOutputData) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
IpNotationTypeEnum Enum with underlying type: string
type IpNotationTypeEnum string
Set of constants representing the allowable values for IpNotationTypeEnum
const (
IpNotationTypeIpAddress IpNotationTypeEnum = "IP_ADDRESS"
IpNotationTypeCidr IpNotationTypeEnum = "CIDR"
IpNotationTypeVcn IpNotationTypeEnum = "VCN"
IpNotationTypeVcnOcid IpNotationTypeEnum = "VCN_OCID"
)
func GetIpNotationTypeEnumValues() []IpNotationTypeEnum
GetIpNotationTypeEnumValues Enumerates the set of values for IpNotationTypeEnum
func GetMappingIpNotationTypeEnum(val string) (IpNotationTypeEnum, bool)
GetMappingIpNotationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListApplicationsRequest wrapper for the ListApplications operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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"`
// The Spark version utilized to run the application.
SparkVersion *string `mandatory:"false" contributesTo:"query" name:"sparkVersion"`
// 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 (request ListApplicationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListApplicationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListApplicationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListApplicationsRequest) String() string
func (request ListApplicationsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response ListApplicationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListApplicationsResponse) String() string
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() []ListApplicationsSortByEnum
GetListApplicationsSortByEnumValues Enumerates the set of values for ListApplicationsSortByEnum
func GetMappingListApplicationsSortByEnum(val string) (ListApplicationsSortByEnum, bool)
GetMappingListApplicationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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() []ListApplicationsSortOrderEnum
GetListApplicationsSortOrderEnumValues Enumerates the set of values for ListApplicationsSortOrderEnum
func GetMappingListApplicationsSortOrderEnum(val string) (ListApplicationsSortOrderEnum, bool)
GetMappingListApplicationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListPoolsLifecycleStateEnum Enum with underlying type: string
type ListPoolsLifecycleStateEnum string
Set of constants representing the allowable values for ListPoolsLifecycleStateEnum
const (
ListPoolsLifecycleStateAccepted ListPoolsLifecycleStateEnum = "ACCEPTED"
ListPoolsLifecycleStateScheduled ListPoolsLifecycleStateEnum = "SCHEDULED"
ListPoolsLifecycleStateCreating ListPoolsLifecycleStateEnum = "CREATING"
ListPoolsLifecycleStateActive ListPoolsLifecycleStateEnum = "ACTIVE"
ListPoolsLifecycleStateStopping ListPoolsLifecycleStateEnum = "STOPPING"
ListPoolsLifecycleStateStopped ListPoolsLifecycleStateEnum = "STOPPED"
ListPoolsLifecycleStateUpdating ListPoolsLifecycleStateEnum = "UPDATING"
ListPoolsLifecycleStateDeleting ListPoolsLifecycleStateEnum = "DELETING"
ListPoolsLifecycleStateDeleted ListPoolsLifecycleStateEnum = "DELETED"
ListPoolsLifecycleStateFailed ListPoolsLifecycleStateEnum = "FAILED"
)
func GetListPoolsLifecycleStateEnumValues() []ListPoolsLifecycleStateEnum
GetListPoolsLifecycleStateEnumValues Enumerates the set of values for ListPoolsLifecycleStateEnum
func GetMappingListPoolsLifecycleStateEnum(val string) (ListPoolsLifecycleStateEnum, bool)
GetMappingListPoolsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListPoolsRequest wrapper for the ListPools operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/ListPools.go.html to see an example of how to use ListPoolsRequest.
type ListPoolsRequest 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 pool.
LifecycleState ListPoolsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The field used to sort the results. Multiple fields are not supported.
SortBy ListPoolsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The ordering of results in ascending or descending order.
SortOrder ListPoolsSortOrderEnum `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 (request ListPoolsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPoolsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPoolsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPoolsRequest) String() string
func (request ListPoolsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListPoolsResponse wrapper for the ListPools operation
type ListPoolsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of PoolCollection instances
PoolCollection `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 (response ListPoolsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPoolsResponse) String() string
ListPoolsSortByEnum Enum with underlying type: string
type ListPoolsSortByEnum string
Set of constants representing the allowable values for ListPoolsSortByEnum
const (
ListPoolsSortByTimecreated ListPoolsSortByEnum = "timeCreated"
)
func GetListPoolsSortByEnumValues() []ListPoolsSortByEnum
GetListPoolsSortByEnumValues Enumerates the set of values for ListPoolsSortByEnum
func GetMappingListPoolsSortByEnum(val string) (ListPoolsSortByEnum, bool)
GetMappingListPoolsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListPoolsSortOrderEnum Enum with underlying type: string
type ListPoolsSortOrderEnum string
Set of constants representing the allowable values for ListPoolsSortOrderEnum
const (
ListPoolsSortOrderAsc ListPoolsSortOrderEnum = "ASC"
ListPoolsSortOrderDesc ListPoolsSortOrderEnum = "DESC"
)
func GetListPoolsSortOrderEnumValues() []ListPoolsSortOrderEnum
GetListPoolsSortOrderEnumValues Enumerates the set of values for ListPoolsSortOrderEnum
func GetMappingListPoolsSortOrderEnum(val string) (ListPoolsSortOrderEnum, bool)
GetMappingListPoolsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
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() []ListPrivateEndpointsLifecycleStateEnum
GetListPrivateEndpointsLifecycleStateEnumValues Enumerates the set of values for ListPrivateEndpointsLifecycleStateEnum
func GetMappingListPrivateEndpointsLifecycleStateEnum(val string) (ListPrivateEndpointsLifecycleStateEnum, bool)
GetMappingListPrivateEndpointsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListPrivateEndpointsRequest wrapper for the ListPrivateEndpoints operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request ListPrivateEndpointsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPrivateEndpointsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPrivateEndpointsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPrivateEndpointsRequest) String() string
func (request ListPrivateEndpointsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response ListPrivateEndpointsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPrivateEndpointsResponse) String() string
ListPrivateEndpointsSortByEnum Enum with underlying type: string
type ListPrivateEndpointsSortByEnum string
Set of constants representing the allowable values for ListPrivateEndpointsSortByEnum
const (
ListPrivateEndpointsSortByTimecreated ListPrivateEndpointsSortByEnum = "timeCreated"
)
func GetListPrivateEndpointsSortByEnumValues() []ListPrivateEndpointsSortByEnum
GetListPrivateEndpointsSortByEnumValues Enumerates the set of values for ListPrivateEndpointsSortByEnum
func GetMappingListPrivateEndpointsSortByEnum(val string) (ListPrivateEndpointsSortByEnum, bool)
GetMappingListPrivateEndpointsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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() []ListPrivateEndpointsSortOrderEnum
GetListPrivateEndpointsSortOrderEnumValues Enumerates the set of values for ListPrivateEndpointsSortOrderEnum
func GetMappingListPrivateEndpointsSortOrderEnum(val string) (ListPrivateEndpointsSortOrderEnum, bool)
GetMappingListPrivateEndpointsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRunLogsRequest wrapper for the ListRunLogs operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request ListRunLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRunLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRunLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRunLogsRequest) String() string
func (request ListRunLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response ListRunLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRunLogsResponse) String() string
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"
ListRunsLifecycleStateStopping ListRunsLifecycleStateEnum = "STOPPING"
ListRunsLifecycleStateStopped ListRunsLifecycleStateEnum = "STOPPED"
)
func GetListRunsLifecycleStateEnumValues() []ListRunsLifecycleStateEnum
GetListRunsLifecycleStateEnumValues Enumerates the set of values for ListRunsLifecycleStateEnum
func GetMappingListRunsLifecycleStateEnum(val string) (ListRunsLifecycleStateEnum, bool)
GetMappingListRunsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListRunsRequest wrapper for the ListRuns operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 ID of the pool.
PoolId *string `mandatory:"false" contributesTo:"query" name:"poolId"`
// 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 (request ListRunsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRunsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRunsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRunsRequest) String() string
func (request ListRunsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response ListRunsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRunsResponse) String() string
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() []ListRunsSortByEnum
GetListRunsSortByEnumValues Enumerates the set of values for ListRunsSortByEnum
func GetMappingListRunsSortByEnum(val string) (ListRunsSortByEnum, bool)
GetMappingListRunsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
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() []ListRunsSortOrderEnum
GetListRunsSortOrderEnumValues Enumerates the set of values for ListRunsSortOrderEnum
func GetMappingListRunsSortOrderEnum(val string) (ListRunsSortOrderEnum, bool)
GetMappingListRunsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSqlEndpointsLifecycleStateEnum Enum with underlying type: string
type ListSqlEndpointsLifecycleStateEnum string
Set of constants representing the allowable values for ListSqlEndpointsLifecycleStateEnum
const (
ListSqlEndpointsLifecycleStateCreating ListSqlEndpointsLifecycleStateEnum = "CREATING"
ListSqlEndpointsLifecycleStateActive ListSqlEndpointsLifecycleStateEnum = "ACTIVE"
ListSqlEndpointsLifecycleStateDeleting ListSqlEndpointsLifecycleStateEnum = "DELETING"
ListSqlEndpointsLifecycleStateDeleted ListSqlEndpointsLifecycleStateEnum = "DELETED"
ListSqlEndpointsLifecycleStateFailed ListSqlEndpointsLifecycleStateEnum = "FAILED"
ListSqlEndpointsLifecycleStateUpdating ListSqlEndpointsLifecycleStateEnum = "UPDATING"
ListSqlEndpointsLifecycleStateNeedsAttention ListSqlEndpointsLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetListSqlEndpointsLifecycleStateEnumValues() []ListSqlEndpointsLifecycleStateEnum
GetListSqlEndpointsLifecycleStateEnumValues Enumerates the set of values for ListSqlEndpointsLifecycleStateEnum
func GetMappingListSqlEndpointsLifecycleStateEnum(val string) (ListSqlEndpointsLifecycleStateEnum, bool)
GetMappingListSqlEndpointsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListSqlEndpointsRequest wrapper for the ListSqlEndpoints operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/ListSqlEndpoints.go.html to see an example of how to use ListSqlEndpointsRequest.
type ListSqlEndpointsRequest struct {
// The OCID of the compartment in which to query resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// The unique id of the SQL Endpoint.
SqlEndpointId *string `mandatory:"false" contributesTo:"query" name:"sqlEndpointId"`
// A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState.
LifecycleState ListSqlEndpointsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The query parameter for the Spark application name.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The maximum number of items that can be returned.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The ordering of results in ascending or descending order.
SortOrder ListSqlEndpointsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified timeCreated is used by default.
SortBy ListSqlEndpointsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 (request ListSqlEndpointsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSqlEndpointsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSqlEndpointsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSqlEndpointsRequest) String() string
func (request ListSqlEndpointsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListSqlEndpointsResponse wrapper for the ListSqlEndpoints operation
type ListSqlEndpointsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SqlEndpointCollection instances
SqlEndpointCollection `presentIn:"body"`
// 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 (response ListSqlEndpointsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSqlEndpointsResponse) String() string
ListSqlEndpointsSortByEnum Enum with underlying type: string
type ListSqlEndpointsSortByEnum string
Set of constants representing the allowable values for ListSqlEndpointsSortByEnum
const (
ListSqlEndpointsSortById ListSqlEndpointsSortByEnum = "id"
ListSqlEndpointsSortByTimecreated ListSqlEndpointsSortByEnum = "timeCreated"
ListSqlEndpointsSortByDisplayname ListSqlEndpointsSortByEnum = "displayName"
)
func GetListSqlEndpointsSortByEnumValues() []ListSqlEndpointsSortByEnum
GetListSqlEndpointsSortByEnumValues Enumerates the set of values for ListSqlEndpointsSortByEnum
func GetMappingListSqlEndpointsSortByEnum(val string) (ListSqlEndpointsSortByEnum, bool)
GetMappingListSqlEndpointsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSqlEndpointsSortOrderEnum Enum with underlying type: string
type ListSqlEndpointsSortOrderEnum string
Set of constants representing the allowable values for ListSqlEndpointsSortOrderEnum
const (
ListSqlEndpointsSortOrderAsc ListSqlEndpointsSortOrderEnum = "ASC"
ListSqlEndpointsSortOrderDesc ListSqlEndpointsSortOrderEnum = "DESC"
)
func GetListSqlEndpointsSortOrderEnumValues() []ListSqlEndpointsSortOrderEnum
GetListSqlEndpointsSortOrderEnumValues Enumerates the set of values for ListSqlEndpointsSortOrderEnum
func GetMappingListSqlEndpointsSortOrderEnum(val string) (ListSqlEndpointsSortOrderEnum, bool)
GetMappingListSqlEndpointsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListStatementsLifecycleStateEnum Enum with underlying type: string
type ListStatementsLifecycleStateEnum string
Set of constants representing the allowable values for ListStatementsLifecycleStateEnum
const (
ListStatementsLifecycleStateAccepted ListStatementsLifecycleStateEnum = "ACCEPTED"
ListStatementsLifecycleStateCancelling ListStatementsLifecycleStateEnum = "CANCELLING"
ListStatementsLifecycleStateCancelled ListStatementsLifecycleStateEnum = "CANCELLED"
ListStatementsLifecycleStateFailed ListStatementsLifecycleStateEnum = "FAILED"
ListStatementsLifecycleStateInProgress ListStatementsLifecycleStateEnum = "IN_PROGRESS"
ListStatementsLifecycleStateSucceeded ListStatementsLifecycleStateEnum = "SUCCEEDED"
)
func GetListStatementsLifecycleStateEnumValues() []ListStatementsLifecycleStateEnum
GetListStatementsLifecycleStateEnumValues Enumerates the set of values for ListStatementsLifecycleStateEnum
func GetMappingListStatementsLifecycleStateEnum(val string) (ListStatementsLifecycleStateEnum, bool)
GetMappingListStatementsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListStatementsRequest wrapper for the ListStatements operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/ListStatements.go.html to see an example of how to use ListStatementsRequest.
type ListStatementsRequest struct {
// The unique ID for the run
RunId *string `mandatory:"true" contributesTo:"path" name:"runId"`
// The LifecycleState of the statement.
LifecycleState ListStatementsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The field used to sort the results. Multiple fields are not supported.
SortBy ListStatementsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The ordering of results in ascending or descending order.
SortOrder ListStatementsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// 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"`
// 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 (request ListStatementsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListStatementsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListStatementsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListStatementsRequest) String() string
func (request ListStatementsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListStatementsResponse wrapper for the ListStatements operation
type ListStatementsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of StatementCollection instances
StatementCollection `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 (response ListStatementsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListStatementsResponse) String() string
ListStatementsSortByEnum Enum with underlying type: string
type ListStatementsSortByEnum string
Set of constants representing the allowable values for ListStatementsSortByEnum
const (
ListStatementsSortByTimecreated ListStatementsSortByEnum = "timeCreated"
)
func GetListStatementsSortByEnumValues() []ListStatementsSortByEnum
GetListStatementsSortByEnumValues Enumerates the set of values for ListStatementsSortByEnum
func GetMappingListStatementsSortByEnum(val string) (ListStatementsSortByEnum, bool)
GetMappingListStatementsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListStatementsSortOrderEnum Enum with underlying type: string
type ListStatementsSortOrderEnum string
Set of constants representing the allowable values for ListStatementsSortOrderEnum
const (
ListStatementsSortOrderAsc ListStatementsSortOrderEnum = "ASC"
ListStatementsSortOrderDesc ListStatementsSortOrderEnum = "DESC"
)
func GetListStatementsSortOrderEnumValues() []ListStatementsSortOrderEnum
GetListStatementsSortOrderEnumValues Enumerates the set of values for ListStatementsSortOrderEnum
func GetMappingListStatementsSortOrderEnum(val string) (ListStatementsSortOrderEnum, bool)
GetMappingListStatementsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
NetworkTypeEnum Enum with underlying type: string
type NetworkTypeEnum string
Set of constants representing the allowable values for NetworkTypeEnum
const (
NetworkTypeVcn NetworkTypeEnum = "VCN"
NetworkTypeSecureAccess NetworkTypeEnum = "SECURE_ACCESS"
)
func GetMappingNetworkTypeEnum(val string) (NetworkTypeEnum, bool)
GetMappingNetworkTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNetworkTypeEnumValues() []NetworkTypeEnum
GetNetworkTypeEnumValues Enumerates the set of values for NetworkTypeEnum
NodeCount An object with a logical shape and count of the number of nodes with that shape.
type NodeCount struct {
// The compute shape of the nodes that the count is for.
LogicalShape *string `mandatory:"false" json:"logicalShape"`
// The node count of this compute shape.
Count *int `mandatory:"false" json:"count"`
}
func (m NodeCount) String() string
func (m NodeCount) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Pool A Data Flow pool object.
type Pool 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"`
// 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 pool. Unique Id to indentify a dataflow pool resource.
Id *string `mandatory:"true" json:"id"`
// The current state of this pool.
LifecycleState PoolLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID of the user who created the resource.
OwnerPrincipalId *string `mandatory:"true" json:"ownerPrincipalId"`
// List of PoolConfig items.
Configurations []PoolConfig `mandatory:"true" json:"configurations"`
// The date and time the resource 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 the resource 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 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"`
PoolMetrics *PoolMetrics `mandatory:"false" json:"poolMetrics"`
// A list of schedules for pool to auto start and stop.
Schedules []PoolSchedule `mandatory:"false" json:"schedules"`
// Optional timeout value in minutes used to auto stop Pools. A Pool will be auto stopped after inactivity for this amount of time period.
// If value not set, pool will not be auto stopped auto.
IdleTimeoutInMinutes *int `mandatory:"false" json:"idleTimeoutInMinutes"`
}
func (m Pool) String() string
func (m Pool) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PoolCollection The results of a query for a list of pools. It contains PoolSummary items.
type PoolCollection struct {
// A list of pools.
Items []PoolSummary `mandatory:"true" json:"items"`
}
func (m PoolCollection) String() string
func (m PoolCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PoolConfig An object containing the details about the compute shapes and number of compute instances to provison.
type PoolConfig struct {
// The compute shape of the resources you would like to provision.
Shape *string `mandatory:"false" json:"shape"`
ShapeConfig *ShapeConfig `mandatory:"false" json:"shapeConfig"`
// Minimum number of compute instances in the pool for a given compute shape.
Min *int `mandatory:"false" json:"min"`
// Maximum number of compute instances in the pool for a given compute shape.
Max *int `mandatory:"false" json:"max"`
}
func (m PoolConfig) String() string
func (m PoolConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PoolLifecycleStateEnum Enum with underlying type: string
type PoolLifecycleStateEnum string
Set of constants representing the allowable values for PoolLifecycleStateEnum
const (
PoolLifecycleStateAccepted PoolLifecycleStateEnum = "ACCEPTED"
PoolLifecycleStateScheduled PoolLifecycleStateEnum = "SCHEDULED"
PoolLifecycleStateCreating PoolLifecycleStateEnum = "CREATING"
PoolLifecycleStateActive PoolLifecycleStateEnum = "ACTIVE"
PoolLifecycleStateStopping PoolLifecycleStateEnum = "STOPPING"
PoolLifecycleStateStopped PoolLifecycleStateEnum = "STOPPED"
PoolLifecycleStateUpdating PoolLifecycleStateEnum = "UPDATING"
PoolLifecycleStateDeleting PoolLifecycleStateEnum = "DELETING"
PoolLifecycleStateDeleted PoolLifecycleStateEnum = "DELETED"
PoolLifecycleStateFailed PoolLifecycleStateEnum = "FAILED"
)
func GetMappingPoolLifecycleStateEnum(val string) (PoolLifecycleStateEnum, bool)
GetMappingPoolLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPoolLifecycleStateEnumValues() []PoolLifecycleStateEnum
GetPoolLifecycleStateEnumValues Enumerates the set of values for PoolLifecycleStateEnum
PoolMetrics A collection of metrics related to a particular pool.
type PoolMetrics struct {
// The last time this pool was started.
TimeLastStarted *common.SDKTime `mandatory:"false" json:"timeLastStarted"`
// The last time this pool was stopped.
TimeLastStopped *common.SDKTime `mandatory:"false" json:"timeLastStopped"`
// The last time a run used this pool.
TimeLastUsed *common.SDKTime `mandatory:"false" json:"timeLastUsed"`
// The last time the mertics were updated for this.
TimeLastMetricsUpdated *common.SDKTime `mandatory:"false" json:"timeLastMetricsUpdated"`
// The number of runs that are currently running that are using this pool.
ActiveRunsCount *int64 `mandatory:"false" json:"activeRunsCount"`
// A count of the nodes that are currently being used for each shape in this pool.
ActivelyUsedNodeCount []NodeCount `mandatory:"false" json:"activelyUsedNodeCount"`
}
func (m PoolMetrics) String() string
func (m PoolMetrics) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PoolSchedule Definition of when pool auto start or stop for a given day of a week.
type PoolSchedule struct {
// Day of the week SUN-SAT
DayOfWeek DayOfWeekEnum `mandatory:"false" json:"dayOfWeek,omitempty"`
// Hour of the day to start or stop pool.
StartTime *int `mandatory:"false" json:"startTime"`
// Hour of the day to stop the pool.
StopTime *int `mandatory:"false" json:"stopTime"`
}
func (m PoolSchedule) String() string
func (m PoolSchedule) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PoolSummary A pool object used in bulk listings.
type PoolSummary 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"`
// 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 pool. Unique Id to indentify a dataflow pool resource.
Id *string `mandatory:"true" json:"id"`
// The current state of this pool.
LifecycleState PoolLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID of the user who created the resource.
OwnerPrincipalId *string `mandatory:"true" 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:"true" json:"ownerUserName"`
// The date and time the resource 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 the resource 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"`
}
func (m PoolSummary) String() string
func (m PoolSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 the resource 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 the resource 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"`
// An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value.
// [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
ScanDetails []Scan `mandatory:"false" json:"scanDetails"`
}
func (m PrivateEndpoint) String() string
func (m PrivateEndpoint) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PrivateEndpointCollection The results of a query for a list of private endpoints. It contains PrivateEndpointSummary items.
type PrivateEndpointCollection struct {
// A list of private endpoints.
Items []PrivateEndpointSummary `mandatory:"true" json:"items"`
}
func (m PrivateEndpointCollection) String() string
func (m PrivateEndpointCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 GetMappingPrivateEndpointLifecycleStateEnum(val string) (PrivateEndpointLifecycleStateEnum, bool)
GetMappingPrivateEndpointLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPrivateEndpointLifecycleStateEnumValues() []PrivateEndpointLifecycleStateEnum
GetPrivateEndpointLifecycleStateEnumValues Enumerates the set of values for PrivateEndpointLifecycleStateEnum
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 the resource 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 the resource 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"`
// An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value.
// [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
ScanDetails []Scan `mandatory:"false" json:"scanDetails"`
}
func (m PrivateEndpointSummary) String() string
func (m PrivateEndpointSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 the resource 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 the resource 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 comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example, ``oci://path/to/a.zip,oci://path/to/b.zip``. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of 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"`
ApplicationLogConfig *ApplicationLogConfig `mandatory:"false" json:"applicationLogConfig"`
// 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"`
DriverShapeConfig *ShapeConfig `mandatory:"false" json:"driverShapeConfig"`
// The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit.
// Supported options include ``--class``, ``--file``, ``--jars``, ``--conf``, ``--py-files``, and main application file with arguments.
// Example: ``--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10``
// Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit,
// Data Flow service will use derived information from execute input only.
Execute *string `mandatory:"false" json:"execute"`
ExecutorShapeConfig *ShapeConfig `mandatory:"false" json:"executorShapeConfig"`
// 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"`
// The OCID of OCI Hive Metastore.
MetastoreId *string `mandatory:"false" json:"metastoreId"`
// 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"`
// The OCID of a pool. Unique Id to indentify a dataflow pool resource.
PoolId *string `mandatory:"false" json:"poolId"`
// 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"`
// The Spark application processing type.
Type ApplicationTypeEnum `mandatory:"false" json:"type,omitempty"`
// 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"`
// The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated
// once it reaches this duration from the time it transitions to `IN_PROGRESS` state.
MaxDurationInMinutes *int64 `mandatory:"false" json:"maxDurationInMinutes"`
// The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period.
// Note: This parameter is currently only applicable for Runs of type `SESSION`. Default value is 2880 minutes (2 days)
IdleTimeoutInMinutes *int64 `mandatory:"false" json:"idleTimeoutInMinutes"`
}
func (m Run) String() string
func (m Run) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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"
RunLifecycleStateStopping RunLifecycleStateEnum = "STOPPING"
RunLifecycleStateStopped RunLifecycleStateEnum = "STOPPED"
)
func GetMappingRunLifecycleStateEnum(val string) (RunLifecycleStateEnum, bool)
GetMappingRunLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRunLifecycleStateEnumValues() []RunLifecycleStateEnum
GetRunLifecycleStateEnumValues Enumerates the set of values for RunLifecycleStateEnum
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 (m RunLogSummary) String() string
func (m RunLogSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 GetMappingRunLogSummarySourceEnum(val string) (RunLogSummarySourceEnum, bool)
GetMappingRunLogSummarySourceEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRunLogSummarySourceEnumValues() []RunLogSummarySourceEnum
GetRunLogSummarySourceEnumValues Enumerates the set of values for RunLogSummarySourceEnum
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 GetMappingRunLogSummaryTypeEnum(val string) (RunLogSummaryTypeEnum, bool)
GetMappingRunLogSummaryTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRunLogSummaryTypeEnumValues() []RunLogSummaryTypeEnum
GetRunLogSummaryTypeEnumValues Enumerates the set of values for RunLogSummaryTypeEnum
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 the resource 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 the resource 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 OCID of a pool. Unique Id to indentify a dataflow pool resource.
PoolId *string `mandatory:"false" json:"poolId"`
// 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"`
// The Spark application processing type.
Type ApplicationTypeEnum `mandatory:"false" json:"type,omitempty"`
}
func (m RunSummary) String() string
func (m RunSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Scan Single Client Access Name (SCAN) is the object with a fully-qualified domain name and a port number.
type Scan struct {
// A fully-qualified domain name (FQDN).
Fqdn *string `mandatory:"false" json:"fqdn"`
// The port number of the FQDN
Port *string `mandatory:"false" json:"port"`
}
func (m Scan) String() string
func (m Scan) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SecureAccessControlRule The access control rule for SECURE_ACCESS network type selection.
type SecureAccessControlRule struct {
// The type of IP notation.
IpNotation IpNotationTypeEnum `mandatory:"true" json:"ipNotation"`
// The associated value of the selected IP notation.
Value *string `mandatory:"true" json:"value"`
// A comma-separated IP or CIDR address for VCN OCID IP notation selection.
VcnIps *string `mandatory:"false" json:"vcnIps"`
}
func (m SecureAccessControlRule) String() string
func (m SecureAccessControlRule) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ShapeConfig This is used to configure the shape of the driver or executor if a flexible shape is used.
type ShapeConfig struct {
// The total number of OCPUs used for the driver or executors.
// See here (https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details.
Ocpus *float32 `mandatory:"false" json:"ocpus"`
// The amount of memory used for the driver or executors.
MemoryInGBs *float32 `mandatory:"false" json:"memoryInGBs"`
}
func (m ShapeConfig) String() string
func (m ShapeConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SqlEndpoint The description of a SQL Endpoint.
type SqlEndpoint struct {
// The provision identifier that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// The SQL Endpoint name, which can be changed.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of a compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The version of SQL Endpoint.
SqlEndpointVersion *string `mandatory:"true" json:"sqlEndpointVersion"`
// The shape of the SQL Endpoint driver instance.
DriverShape *string `mandatory:"true" json:"driverShape"`
// The shape of the SQL Endpoint executor instance.
ExecutorShape *string `mandatory:"true" json:"executorShape"`
// The minimum number of executors.
MinExecutorCount *int `mandatory:"true" json:"minExecutorCount"`
// The maximum number of executors.
MaxExecutorCount *int `mandatory:"true" json:"maxExecutorCount"`
// The OCID of OCI Hive Metastore.
MetastoreId *string `mandatory:"true" json:"metastoreId"`
// The OCID of OCI Lake.
LakeId *string `mandatory:"true" json:"lakeId"`
// The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html
WarehouseBucketUri *string `mandatory:"true" json:"warehouseBucketUri"`
// The description of the SQL Endpoint.
Description *string `mandatory:"true" json:"description"`
// The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI
JdbcEndpointUrl *string `mandatory:"false" json:"jdbcEndpointUrl"`
// The time the Sql Endpoint was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the Sql Endpoint was updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the Sql Endpoint.
LifecycleState SqlEndpointLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the reason why the resource is in it's current state. Helps bubble up errors in state changes. For example, it can be used to provide actionable information for a resource in the Failed state.
StateMessage *string `mandatory:"false" json:"stateMessage"`
DriverShapeConfig *ShapeConfig `mandatory:"false" json:"driverShapeConfig"`
ExecutorShapeConfig *ShapeConfig `mandatory:"false" json:"executorShapeConfig"`
// This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.
LastAcceptedRequestToken *string `mandatory:"false" json:"lastAcceptedRequestToken"`
// 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"`
// 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 system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// 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.
SparkAdvancedConfigurations map[string]string `mandatory:"false" json:"sparkAdvancedConfigurations"`
// The SQL Endpoint message displayed as a banner to provide user with any action items required on the resource.
BannerMessage *string `mandatory:"false" json:"bannerMessage"`
NetworkConfiguration SqlEndpointNetworkConfiguration `mandatory:"false" json:"networkConfiguration"`
}
func (m SqlEndpoint) String() string
func (m *SqlEndpoint) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m SqlEndpoint) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SqlEndpointCollection The results of a Sql Endpoint search. It contains the objects in a SqlEndpointSummary.
type SqlEndpointCollection struct {
// The collection of SqlEndpointSummary objects.
Items []SqlEndpointSummary `mandatory:"true" json:"items"`
}
func (m SqlEndpointCollection) String() string
func (m SqlEndpointCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SqlEndpointLifecycleStateEnum Enum with underlying type: string
type SqlEndpointLifecycleStateEnum string
Set of constants representing the allowable values for SqlEndpointLifecycleStateEnum
const (
SqlEndpointLifecycleStateCreating SqlEndpointLifecycleStateEnum = "CREATING"
SqlEndpointLifecycleStateActive SqlEndpointLifecycleStateEnum = "ACTIVE"
SqlEndpointLifecycleStateDeleting SqlEndpointLifecycleStateEnum = "DELETING"
SqlEndpointLifecycleStateDeleted SqlEndpointLifecycleStateEnum = "DELETED"
SqlEndpointLifecycleStateFailed SqlEndpointLifecycleStateEnum = "FAILED"
SqlEndpointLifecycleStateUpdating SqlEndpointLifecycleStateEnum = "UPDATING"
SqlEndpointLifecycleStateNeedsAttention SqlEndpointLifecycleStateEnum = "NEEDS_ATTENTION"
)
func GetMappingSqlEndpointLifecycleStateEnum(val string) (SqlEndpointLifecycleStateEnum, bool)
GetMappingSqlEndpointLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSqlEndpointLifecycleStateEnumValues() []SqlEndpointLifecycleStateEnum
GetSqlEndpointLifecycleStateEnumValues Enumerates the set of values for SqlEndpointLifecycleStateEnum
SqlEndpointNetworkConfiguration The network configuration of a SQL Endpoint.
type SqlEndpointNetworkConfiguration interface {
}
SqlEndpointSecureAccessConfig Access control rules for secure access selection.
type SqlEndpointSecureAccessConfig struct {
// A list of SecureAccessControlRule's to which access is limited to
AccessControlRules []SecureAccessControlRule `mandatory:"false" json:"accessControlRules"`
// Ip Address of public endpoint
PublicEndpointIp *string `mandatory:"false" json:"publicEndpointIp"`
}
func (m SqlEndpointSecureAccessConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SqlEndpointSecureAccessConfig) String() string
func (m SqlEndpointSecureAccessConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SqlEndpointSummary A summary of the Sql Endpoint.
type SqlEndpointSummary struct {
// The provision identifier that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// The SQL Endpoint name, which can be changed.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of a compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The version of SQL Endpoint.
SqlEndpointVersion *string `mandatory:"true" json:"sqlEndpointVersion"`
// The shape of the SQL Endpoint driver instance.
DriverShape *string `mandatory:"true" json:"driverShape"`
// The shape of the SQL Endpoint executor instance.
ExecutorShape *string `mandatory:"true" json:"executorShape"`
// The minimum number of executors.
MinExecutorCount *int `mandatory:"true" json:"minExecutorCount"`
// The maximum number of executors.
MaxExecutorCount *int `mandatory:"true" json:"maxExecutorCount"`
// The OCID of OCI Hive Metastore.
MetastoreId *string `mandatory:"true" json:"metastoreId"`
// The OCID of OCI Lake.
LakeId *string `mandatory:"true" json:"lakeId"`
// The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html
WarehouseBucketUri *string `mandatory:"true" json:"warehouseBucketUri"`
// The description of the SQL Endpoint.
Description *string `mandatory:"true" json:"description"`
// The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI
JdbcEndpointUrl *string `mandatory:"false" json:"jdbcEndpointUrl"`
// The time the Sql Endpoint was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the Sql Endpoint was updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the Sql Endpoint.
LifecycleState SqlEndpointLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the reason why the resource is in it's current state. Helps bubble up errors in state changes. For example, it can be used to provide actionable information for a resource in the Failed state.
StateMessage *string `mandatory:"false" json:"stateMessage"`
DriverShapeConfig *ShapeConfig `mandatory:"false" json:"driverShapeConfig"`
ExecutorShapeConfig *ShapeConfig `mandatory:"false" json:"executorShapeConfig"`
// The OCID of the user who created the resource.
OwnerPrincipalId *string `mandatory:"false" json:"ownerPrincipalId"`
// This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.
LastAcceptedRequestToken *string `mandatory:"false" json:"lastAcceptedRequestToken"`
// 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"`
// 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 system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{orcl-cloud: {free-tier-retain: true}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// 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.
SparkAdvancedConfigurations map[string]string `mandatory:"false" json:"sparkAdvancedConfigurations"`
NetworkConfiguration SqlEndpointNetworkConfiguration `mandatory:"false" json:"networkConfiguration"`
}
func (m SqlEndpointSummary) String() string
func (m *SqlEndpointSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m SqlEndpointSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SqlEndpointVcnConfig The VCN configuration for VCN network type selection.
type SqlEndpointVcnConfig struct {
// The VCN OCID.
VcnId *string `mandatory:"true" json:"vcnId"`
// The VCN Subnet OCID.
SubnetId *string `mandatory:"true" json:"subnetId"`
// The host name prefix.
HostNamePrefix *string `mandatory:"false" json:"hostNamePrefix"`
// The OCIDs of Network Security Groups (NSGs).
NsgIds []string `mandatory:"false" json:"nsgIds"`
// Ip Address of private endpoint
PrivateEndpointIp *string `mandatory:"false" json:"privateEndpointIp"`
}
func (m SqlEndpointVcnConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SqlEndpointVcnConfig) String() string
func (m SqlEndpointVcnConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StartPoolRequest wrapper for the StartPool operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/StartPool.go.html to see an example of how to use StartPoolRequest.
type StartPoolRequest struct {
// The unique ID for a pool.
PoolId *string `mandatory:"true" contributesTo:"path" name:"poolId"`
// 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"`
// 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 (request StartPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StartPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartPoolRequest) String() string
func (request StartPoolRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StartPoolResponse wrapper for the StartPool operation
type StartPoolResponse 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 (response StartPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartPoolResponse) String() string
Statement A statement object.
type Statement struct {
// The statement ID.
Id *int64 `mandatory:"true" json:"id"`
// The statement code to execute.
// Example: `println(sc.version)`
Code *string `mandatory:"true" json:"code"`
// The current state of this statement.
LifecycleState StatementLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the resource 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"`
Output *StatementOutput `mandatory:"false" json:"output"`
// The execution progress.
Progress *float64 `mandatory:"false" json:"progress"`
// The ID of a run.
RunId *string `mandatory:"false" json:"runId"`
// The date and time a statement execution was completed, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
// Example: `2022-05-31T21:10:29.600Z`
TimeCompleted *common.SDKTime `mandatory:"false" json:"timeCompleted"`
}
func (m Statement) String() string
func (m Statement) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StatementCollection The results of a query for a list of statements of a Session Run. It contains StatementSummary items.
type StatementCollection struct {
// A list of statements for a Session Run.
Items []StatementSummary `mandatory:"true" json:"items"`
}
func (m StatementCollection) String() string
func (m StatementCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StatementLifecycleStateEnum Enum with underlying type: string
type StatementLifecycleStateEnum string
Set of constants representing the allowable values for StatementLifecycleStateEnum
const (
StatementLifecycleStateAccepted StatementLifecycleStateEnum = "ACCEPTED"
StatementLifecycleStateCancelling StatementLifecycleStateEnum = "CANCELLING"
StatementLifecycleStateCancelled StatementLifecycleStateEnum = "CANCELLED"
StatementLifecycleStateFailed StatementLifecycleStateEnum = "FAILED"
StatementLifecycleStateInProgress StatementLifecycleStateEnum = "IN_PROGRESS"
StatementLifecycleStateSucceeded StatementLifecycleStateEnum = "SUCCEEDED"
)
func GetMappingStatementLifecycleStateEnum(val string) (StatementLifecycleStateEnum, bool)
GetMappingStatementLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStatementLifecycleStateEnumValues() []StatementLifecycleStateEnum
GetStatementLifecycleStateEnumValues Enumerates the set of values for StatementLifecycleStateEnum
StatementOutput The execution output of a statement.
type StatementOutput struct {
Data StatementOutputData `mandatory:"false" json:"data"`
// Status of the statement output.
Status StatementOutputStatusEnum `mandatory:"false" json:"status,omitempty"`
// The name of the error in the statement output.
ErrorName *string `mandatory:"false" json:"errorName"`
// The value of the error in the statement output.
ErrorValue *string `mandatory:"false" json:"errorValue"`
// The traceback of the statement output.
Traceback []string `mandatory:"false" json:"traceback"`
}
func (m StatementOutput) String() string
func (m *StatementOutput) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m StatementOutput) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StatementOutputData An object representing execution output of a statement.
type StatementOutputData interface {
}
StatementOutputDataTypeEnum Enum with underlying type: string
type StatementOutputDataTypeEnum string
Set of constants representing the allowable values for StatementOutputDataTypeEnum
const (
StatementOutputDataTypeTextPlain StatementOutputDataTypeEnum = "TEXT_PLAIN"
StatementOutputDataTypeTextHtml StatementOutputDataTypeEnum = "TEXT_HTML"
StatementOutputDataTypeImagePng StatementOutputDataTypeEnum = "IMAGE_PNG"
)
func GetMappingStatementOutputDataTypeEnum(val string) (StatementOutputDataTypeEnum, bool)
GetMappingStatementOutputDataTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStatementOutputDataTypeEnumValues() []StatementOutputDataTypeEnum
GetStatementOutputDataTypeEnumValues Enumerates the set of values for StatementOutputDataTypeEnum
StatementOutputStatusEnum Enum with underlying type: string
type StatementOutputStatusEnum string
Set of constants representing the allowable values for StatementOutputStatusEnum
const (
StatementOutputStatusOk StatementOutputStatusEnum = "OK"
StatementOutputStatusError StatementOutputStatusEnum = "ERROR"
)
func GetMappingStatementOutputStatusEnum(val string) (StatementOutputStatusEnum, bool)
GetMappingStatementOutputStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStatementOutputStatusEnumValues() []StatementOutputStatusEnum
GetStatementOutputStatusEnumValues Enumerates the set of values for StatementOutputStatusEnum
StatementSummary Summary of the statement.
type StatementSummary struct {
// The statement ID.
Id *int64 `mandatory:"true" json:"id"`
// The current state of this statement.
LifecycleState StatementLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the resource 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 ID of a run.
RunId *string `mandatory:"false" json:"runId"`
// The date and time a statement execution was completed, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format.
// Example: `2022-05-31T21:10:29.600Z`
TimeCompleted *common.SDKTime `mandatory:"false" json:"timeCompleted"`
}
func (m StatementSummary) String() string
func (m StatementSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StopPoolRequest wrapper for the StopPool operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/StopPool.go.html to see an example of how to use StopPoolRequest.
type StopPoolRequest struct {
// The unique ID for a pool.
PoolId *string `mandatory:"true" contributesTo:"path" name:"poolId"`
// 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"`
// 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 (request StopPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StopPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopPoolRequest) String() string
func (request StopPoolRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StopPoolResponse wrapper for the StopPool operation
type StopPoolResponse 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 (response StopPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopPoolResponse) String() string
TextHtmlStatementOutputData The statement output data in html format.
type TextHtmlStatementOutputData struct {
// The statement code execution output in html format.
Value *string `mandatory:"true" json:"value"`
}
func (m TextHtmlStatementOutputData) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TextHtmlStatementOutputData) String() string
func (m TextHtmlStatementOutputData) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TextPlainStatementOutputData The statement output data in text format.
type TextPlainStatementOutputData struct {
// The statement code execution output in text format.
Value *string `mandatory:"true" json:"value"`
}
func (m TextPlainStatementOutputData) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TextPlainStatementOutputData) String() string
func (m TextPlainStatementOutputData) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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"`
ApplicationLogConfig *ApplicationLogConfig `mandatory:"false" json:"applicationLogConfig"`
// A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example, ``oci://path/to/a.zip,oci://path/to/b.zip``. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of 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"`
DriverShapeConfig *ShapeConfig `mandatory:"false" json:"driverShapeConfig"`
// The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit.
// Supported options include ``--class``, ``--file``, ``--jars``, ``--conf``, ``--py-files``, and main application file with arguments.
// Example: ``--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10``
// Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit,
// Data Flow service will use derived information from execute input only.
Execute *string `mandatory:"false" json:"execute"`
// The VM shape for the executors. Sets the executor cores and memory.
ExecutorShape *string `mandatory:"false" json:"executorShape"`
ExecutorShapeConfig *ShapeConfig `mandatory:"false" json:"executorShapeConfig"`
// 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 OCID of OCI Hive Metastore.
MetastoreId *string `mandatory:"false" json:"metastoreId"`
// 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 pool. Unique Id to indentify a dataflow pool resource.
PoolId *string `mandatory:"false" json:"poolId"`
// 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"`
// The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated
// once it reaches this duration from the time it transitions to `IN_PROGRESS` state.
MaxDurationInMinutes *int64 `mandatory:"false" json:"maxDurationInMinutes"`
// The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period.
// Note: This parameter is currently only applicable for Runs of type `SESSION`. Default value is 2880 minutes (2 days)
IdleTimeoutInMinutes *int64 `mandatory:"false" json:"idleTimeoutInMinutes"`
}
func (m UpdateApplicationDetails) String() string
func (m UpdateApplicationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateApplicationRequest wrapper for the UpdateApplication operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request UpdateApplicationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateApplicationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateApplicationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateApplicationRequest) String() string
func (request UpdateApplicationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response UpdateApplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateApplicationResponse) String() string
UpdatePoolDetails The details required to update a given pool with “`poolId“`.
type UpdatePoolDetails struct {
// A user-friendly name. It does not have to be unique. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A user-friendly description. Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
// List of PoolConfig items.
Configurations []PoolConfig `mandatory:"false" json:"configurations"`
// A list of schedules for pool to auto start and stop.
Schedules []PoolSchedule `mandatory:"false" json:"schedules"`
// Optional timeout value in minutes used to auto stop Pools. A Pool will be auto stopped after inactivity for this amount of time period.
// If value not set, pool will not be auto stopped auto.
IdleTimeoutInMinutes *int `mandatory:"false" json:"idleTimeoutInMinutes"`
// 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"`
// 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"`
}
func (m UpdatePoolDetails) String() string
func (m UpdatePoolDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdatePoolRequest wrapper for the UpdatePool operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/UpdatePool.go.html to see an example of how to use UpdatePoolRequest.
type UpdatePoolRequest struct {
// Details for updating a pool.
UpdatePoolDetails `contributesTo:"body"`
// The unique ID for a pool.
PoolId *string `mandatory:"true" contributesTo:"path" name:"poolId"`
// 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 (request UpdatePoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdatePoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdatePoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdatePoolRequest) String() string
func (request UpdatePoolRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdatePoolResponse wrapper for the UpdatePool operation
type UpdatePoolResponse 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 (response UpdatePoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdatePoolResponse) String() string
UpdatePrivateEndpointDetails The details required to update a private endpoint.
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"`
// An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value.
// [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
ScanDetails []Scan `mandatory:"false" json:"scanDetails"`
}
func (m UpdatePrivateEndpointDetails) String() string
func (m UpdatePrivateEndpointDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdatePrivateEndpointRequest wrapper for the UpdatePrivateEndpoint operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request UpdatePrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdatePrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdatePrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdatePrivateEndpointRequest) String() string
func (request UpdatePrivateEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response UpdatePrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdatePrivateEndpointResponse) String() string
UpdateRunDetails The update run details. Only a limited set of properties 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"`
// The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated
// once it reaches this duration from the time it transitions to `IN_PROGRESS` state.
MaxDurationInMinutes *int64 `mandatory:"false" json:"maxDurationInMinutes"`
// The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period.
// Note: This parameter is currently only applicable for Runs of type `SESSION`. Default value is 2880 minutes (2 days)
IdleTimeoutInMinutes *int64 `mandatory:"false" json:"idleTimeoutInMinutes"`
}
func (m UpdateRunDetails) String() string
func (m UpdateRunDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateRunRequest wrapper for the UpdateRun operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/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 (request UpdateRunRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateRunRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateRunRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateRunRequest) String() string
func (request UpdateRunRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (response UpdateRunResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateRunResponse) String() string
UpdateSqlEndpointDetails Currently only the tags of a SQL Endpoint can be updated.
type UpdateSqlEndpointDetails 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 (m UpdateSqlEndpointDetails) String() string
func (m UpdateSqlEndpointDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateSqlEndpointRequest wrapper for the UpdateSqlEndpoint operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/dataflow/UpdateSqlEndpoint.go.html to see an example of how to use UpdateSqlEndpointRequest.
type UpdateSqlEndpointRequest struct {
// Details of the Sql Endpoint to be updated.
UpdateSqlEndpointDetails `contributesTo:"body"`
// The unique id of the SQL Endpoint.
SqlEndpointId *string `mandatory:"true" contributesTo:"path" name:"sqlEndpointId"`
// 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"`
// 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 (request UpdateSqlEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateSqlEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSqlEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSqlEndpointRequest) String() string
func (request UpdateSqlEndpointRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateSqlEndpointResponse wrapper for the UpdateSqlEndpoint operation
type UpdateSqlEndpointResponse 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 (response UpdateSqlEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSqlEndpointResponse) String() string
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 (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (m WorkRequestCollection) String() string
func (m WorkRequestCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (m WorkRequestLog) String() string
func (m WorkRequestLog) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 (m WorkRequestLogCollection) String() string
func (m WorkRequestLogCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 GetMappingWorkRequestOperationEnum(val string) (WorkRequestOperationEnum, bool)
GetMappingWorkRequestOperationEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestOperationEnumValues() []WorkRequestOperationEnum
GetWorkRequestOperationEnumValues Enumerates the set of values for WorkRequestOperationEnum
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 (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
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 GetMappingWorkRequestResourceActionTypeEnum(val string) (WorkRequestResourceActionTypeEnum, bool)
GetMappingWorkRequestResourceActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum
GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum
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 GetMappingWorkRequestStatusEnum(val string) (WorkRequestStatusEnum, bool)
GetMappingWorkRequestStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum
GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum
WorkRequestSummary A Data Flow work request summary 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 (m WorkRequestSummary) String() string
func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly