func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetConnectorPluginKindEnumStringValues() []string
GetConnectorPluginKindEnumStringValues Enumerates the set of values in String for ConnectorPluginKindEnum
func GetConnectorPluginLifecycleStateEnumStringValues() []string
GetConnectorPluginLifecycleStateEnumStringValues Enumerates the set of values in String for ConnectorPluginLifecycleStateEnum
func GetConnectorPluginSummaryKindEnumStringValues() []string
GetConnectorPluginSummaryKindEnumStringValues Enumerates the set of values in String for ConnectorPluginSummaryKindEnum
func GetDimensionValueDetailsKindEnumStringValues() []string
GetDimensionValueDetailsKindEnumStringValues Enumerates the set of values in String for DimensionValueDetailsKindEnum
func GetEstimatedThroughputEnumStringValues() []string
GetEstimatedThroughputEnumStringValues Enumerates the set of values in String for EstimatedThroughputEnum
func GetLifecycleStateEnumStringValues() []string
GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum
func GetListConnectorPluginsLifecycleStateEnumStringValues() []string
GetListConnectorPluginsLifecycleStateEnumStringValues Enumerates the set of values in String for ListConnectorPluginsLifecycleStateEnum
func GetListConnectorPluginsSortByEnumStringValues() []string
GetListConnectorPluginsSortByEnumStringValues Enumerates the set of values in String for ListConnectorPluginsSortByEnum
func GetListConnectorPluginsSortOrderEnumStringValues() []string
GetListConnectorPluginsSortOrderEnumStringValues Enumerates the set of values in String for ListConnectorPluginsSortOrderEnum
func GetListServiceConnectorsLifecycleStateEnumStringValues() []string
GetListServiceConnectorsLifecycleStateEnumStringValues Enumerates the set of values in String for ListServiceConnectorsLifecycleStateEnum
func GetListServiceConnectorsSortByEnumStringValues() []string
GetListServiceConnectorsSortByEnumStringValues Enumerates the set of values in String for ListServiceConnectorsSortByEnum
func GetListServiceConnectorsSortOrderEnumStringValues() []string
GetListServiceConnectorsSortOrderEnumStringValues Enumerates the set of values in String for ListServiceConnectorsSortOrderEnum
func GetMonitoringSourceMetricDetailsKindEnumStringValues() []string
GetMonitoringSourceMetricDetailsKindEnumStringValues Enumerates the set of values in String for MonitoringSourceMetricDetailsKindEnum
func GetMonitoringSourceNamespaceDetailsKindEnumStringValues() []string
GetMonitoringSourceNamespaceDetailsKindEnumStringValues Enumerates the set of values in String for MonitoringSourceNamespaceDetailsKindEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetSourceDetailsKindEnumStringValues() []string
GetSourceDetailsKindEnumStringValues Enumerates the set of values in String for SourceDetailsKindEnum
func GetStreamingCursorDetailsKindEnumStringValues() []string
GetStreamingCursorDetailsKindEnumStringValues Enumerates the set of values in String for StreamingCursorDetailsKindEnum
func GetTargetDetailsKindEnumStringValues() []string
GetTargetDetailsKindEnumStringValues Enumerates the set of values in String for TargetDetailsKindEnum
func GetTaskDetailsKindEnumStringValues() []string
GetTaskDetailsKindEnumStringValues Enumerates the set of values in String for TaskDetailsKindEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ActivateServiceConnectorRequest wrapper for the ActivateServiceConnector operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/ActivateServiceConnector.go.html to see an example of how to use ActivateServiceConnectorRequest.
type ActivateServiceConnectorRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connector.
ServiceConnectorId *string `mandatory:"true" contributesTo:"path" name:"serviceConnectorId"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The 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" 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 ActivateServiceConnectorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ActivateServiceConnectorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ActivateServiceConnectorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ActivateServiceConnectorRequest) String() string
func (request ActivateServiceConnectorRequest) 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
ActivateServiceConnectorResponse wrapper for the ActivateServiceConnector operation
type ActivateServiceConnectorResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ActivateServiceConnectorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ActivateServiceConnectorResponse) String() string
ChangeServiceConnectorCompartmentDetails The configuration details for moving a connector to a different compartment.
type ChangeServiceConnectorCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment
// to move the connector to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeServiceConnectorCompartmentDetails) String() string
func (m ChangeServiceConnectorCompartmentDetails) 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
ChangeServiceConnectorCompartmentRequest wrapper for the ChangeServiceConnectorCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/ChangeServiceConnectorCompartment.go.html to see an example of how to use ChangeServiceConnectorCompartmentRequest.
type ChangeServiceConnectorCompartmentRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connector.
ServiceConnectorId *string `mandatory:"true" contributesTo:"path" name:"serviceConnectorId"`
// The configuration details for moving a connector to a different compartment.
ChangeServiceConnectorCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The 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" 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 ChangeServiceConnectorCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeServiceConnectorCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeServiceConnectorCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeServiceConnectorCompartmentRequest) String() string
func (request ChangeServiceConnectorCompartmentRequest) 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
ChangeServiceConnectorCompartmentResponse wrapper for the ChangeServiceConnectorCompartment operation
type ChangeServiceConnectorCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeServiceConnectorCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeServiceConnectorCompartmentResponse) String() string
ConnectorPlugin A service source or service target used to create a connector. Example connector plugins include the Queue source and the Notifications target. For more information about flows defined by connectors, see Overview of Connector Hub (https://docs.cloud.oracle.com/iaas/Content/connector-hub/overview.htm). For configuration instructions, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm).
type ConnectorPlugin interface {
// The service to be called by the connector plugin.
// Example: `QueueSource`
GetName() *string
// The date and time when this plugin became available.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2023-09-09T21:10:29.600Z`
GetTimeCreated() *common.SDKTime
// The current state of the service connector.
GetLifecycleState() ConnectorPluginLifecycleStateEnum
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
GetDisplayName() *string
// The estimated throughput range (LOW, MEDIUM, HIGH).
GetEstimatedThroughput() EstimatedThroughputEnum
// Gets the specified connector plugin configuration information in OpenAPI specification format.
GetSchema() *string
}
ConnectorPluginCollection A list of connector plugins that match filter criteria. Results contain `ConnectorPlugin` objects.
type ConnectorPluginCollection struct {
// A list of connector plugins.
Items []ConnectorPluginSummary `mandatory:"true" json:"items"`
}
func (m ConnectorPluginCollection) String() string
func (m *ConnectorPluginCollection) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ConnectorPluginCollection) 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
ConnectorPluginKindEnum Enum with underlying type: string
type ConnectorPluginKindEnum string
Set of constants representing the allowable values for ConnectorPluginKindEnum
const (
ConnectorPluginKindSource ConnectorPluginKindEnum = "SOURCE"
ConnectorPluginKindTarget ConnectorPluginKindEnum = "TARGET"
)
func GetConnectorPluginKindEnumValues() []ConnectorPluginKindEnum
GetConnectorPluginKindEnumValues Enumerates the set of values for ConnectorPluginKindEnum
func GetMappingConnectorPluginKindEnum(val string) (ConnectorPluginKindEnum, bool)
GetMappingConnectorPluginKindEnum performs case Insensitive comparison on enum value and return the desired enum
ConnectorPluginLifecycleStateEnum Enum with underlying type: string
type ConnectorPluginLifecycleStateEnum string
Set of constants representing the allowable values for ConnectorPluginLifecycleStateEnum
const (
ConnectorPluginLifecycleStateActive ConnectorPluginLifecycleStateEnum = "ACTIVE"
ConnectorPluginLifecycleStateDeleted ConnectorPluginLifecycleStateEnum = "DELETED"
)
func GetConnectorPluginLifecycleStateEnumValues() []ConnectorPluginLifecycleStateEnum
GetConnectorPluginLifecycleStateEnumValues Enumerates the set of values for ConnectorPluginLifecycleStateEnum
func GetMappingConnectorPluginLifecycleStateEnum(val string) (ConnectorPluginLifecycleStateEnum, bool)
GetMappingConnectorPluginLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ConnectorPluginSummary Summary information for a connector plugin. Example connector plugins include the Streaming source and the Notifications target. For more information about flows defined by connectors, see Overview of Connector Hub (https://docs.cloud.oracle.com/iaas/Content/connector-hub/overview.htm). For configuration instructions, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm).
type ConnectorPluginSummary interface {
// The service to be called by the connector plugin.
GetName() *string
// The date and time when this plugin became available.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2023-09-10T21:10:29.600Z`
GetTimeCreated() *common.SDKTime
// The current state of the service connector.
GetLifecycleState() ConnectorPluginLifecycleStateEnum
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
GetDisplayName() *string
// The estimated throughput range (LOW, MEDIUM, HIGH).
GetEstimatedThroughput() EstimatedThroughputEnum
}
ConnectorPluginSummaryKindEnum Enum with underlying type: string
type ConnectorPluginSummaryKindEnum string
Set of constants representing the allowable values for ConnectorPluginSummaryKindEnum
const (
ConnectorPluginSummaryKindSource ConnectorPluginSummaryKindEnum = "SOURCE"
ConnectorPluginSummaryKindTarget ConnectorPluginSummaryKindEnum = "TARGET"
)
func GetConnectorPluginSummaryKindEnumValues() []ConnectorPluginSummaryKindEnum
GetConnectorPluginSummaryKindEnumValues Enumerates the set of values for ConnectorPluginSummaryKindEnum
func GetMappingConnectorPluginSummaryKindEnum(val string) (ConnectorPluginSummaryKindEnum, bool)
GetMappingConnectorPluginSummaryKindEnum performs case Insensitive comparison on enum value and return the desired enum
ConnectorPluginsClient a client for ConnectorPlugins
type ConnectorPluginsClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewConnectorPluginsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ConnectorPluginsClient, err error)
NewConnectorPluginsClientWithConfigurationProvider Creates a new default ConnectorPlugins client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewConnectorPluginsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ConnectorPluginsClient, err error)
NewConnectorPluginsClientWithOboToken Creates a new default ConnectorPlugins 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 *ConnectorPluginsClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ConnectorPluginsClient) GetConnectorPlugin(ctx context.Context, request GetConnectorPluginRequest) (response GetConnectorPluginResponse, err error)
GetConnectorPlugin Gets the specified connector plugin configuration information.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/GetConnectorPlugin.go.html to see an example of how to use GetConnectorPlugin API. A default retry strategy applies to this operation GetConnectorPlugin()
func (client ConnectorPluginsClient) ListConnectorPlugins(ctx context.Context, request ListConnectorPluginsRequest) (response ListConnectorPluginsResponse, err error)
ListConnectorPlugins Lists connector plugins according to the specified filter.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/ListConnectorPlugins.go.html to see an example of how to use ListConnectorPlugins API. A default retry strategy applies to this operation ListConnectorPlugins()
func (client *ConnectorPluginsClient) SetRegion(region string)
SetRegion overrides the region of this client.
CreateServiceConnectorDetails The configuration details for creating a connector.
type CreateServiceConnectorDetails struct {
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the
// comparment to create the connector in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
Source SourceDetails `mandatory:"true" json:"source"`
Target TargetDetails `mandatory:"true" json:"target"`
// The description of the resource. Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
// The list of tasks.
Tasks []TaskDetails `mandatory:"false" json:"tasks"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateServiceConnectorDetails) String() string
func (m *CreateServiceConnectorDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateServiceConnectorDetails) 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
CreateServiceConnectorRequest wrapper for the CreateServiceConnector operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/CreateServiceConnector.go.html to see an example of how to use CreateServiceConnectorRequest.
type CreateServiceConnectorRequest struct {
// Configuration details for the new connector.
CreateServiceConnectorDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The 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" 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 CreateServiceConnectorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateServiceConnectorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateServiceConnectorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateServiceConnectorRequest) String() string
func (request CreateServiceConnectorRequest) 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
CreateServiceConnectorResponse wrapper for the CreateServiceConnector operation
type CreateServiceConnectorResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateServiceConnectorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateServiceConnectorResponse) String() string
DeactivateServiceConnectorRequest wrapper for the DeactivateServiceConnector operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/DeactivateServiceConnector.go.html to see an example of how to use DeactivateServiceConnectorRequest.
type DeactivateServiceConnectorRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connector.
ServiceConnectorId *string `mandatory:"true" contributesTo:"path" name:"serviceConnectorId"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The 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" 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 DeactivateServiceConnectorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeactivateServiceConnectorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeactivateServiceConnectorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeactivateServiceConnectorRequest) String() string
func (request DeactivateServiceConnectorRequest) 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
DeactivateServiceConnectorResponse wrapper for the DeactivateServiceConnector operation
type DeactivateServiceConnectorResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeactivateServiceConnectorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeactivateServiceConnectorResponse) String() string
DeleteServiceConnectorRequest wrapper for the DeleteServiceConnector operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/DeleteServiceConnector.go.html to see an example of how to use DeleteServiceConnectorRequest.
type DeleteServiceConnectorRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connector.
ServiceConnectorId *string `mandatory:"true" contributesTo:"path" name:"serviceConnectorId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The 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" 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 DeleteServiceConnectorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteServiceConnectorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteServiceConnectorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteServiceConnectorRequest) String() string
func (request DeleteServiceConnectorRequest) 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
DeleteServiceConnectorResponse wrapper for the DeleteServiceConnector operation
type DeleteServiceConnectorResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteServiceConnectorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteServiceConnectorResponse) String() string
DimensionDetails A dimension name and value.
type DimensionDetails struct {
// Dimension key. A valid dimension key includes only printable ASCII, excluding periods (.) and spaces.
// Custom dimension keys are acceptable. Avoid entering confidential information.
// Due to use by Connector Hub, the following dimension names are reserved: `connectorId`, `connectorName`, `connectorSourceType`.
// For information on valid dimension keys and values, see MetricDataDetails.
// Example: `type`
Name *string `mandatory:"true" json:"name"`
DimensionValue DimensionValueDetails `mandatory:"true" json:"dimensionValue"`
}
func (m DimensionDetails) String() string
func (m *DimensionDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m DimensionDetails) 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
DimensionValueDetails Instructions for extracting the value corresponding to the specified dimension key: Either extract the value as-is (static) or derive the value from a path (evaluated).
type DimensionValueDetails interface {
}
DimensionValueDetailsKindEnum Enum with underlying type: string
type DimensionValueDetailsKindEnum string
Set of constants representing the allowable values for DimensionValueDetailsKindEnum
const (
DimensionValueDetailsKindJmespath DimensionValueDetailsKindEnum = "jmesPath"
DimensionValueDetailsKindStatic DimensionValueDetailsKindEnum = "static"
)
func GetDimensionValueDetailsKindEnumValues() []DimensionValueDetailsKindEnum
GetDimensionValueDetailsKindEnumValues Enumerates the set of values for DimensionValueDetailsKindEnum
func GetMappingDimensionValueDetailsKindEnum(val string) (DimensionValueDetailsKindEnum, bool)
GetMappingDimensionValueDetailsKindEnum performs case Insensitive comparison on enum value and return the desired enum
EstimatedThroughputEnum Enum with underlying type: string
type EstimatedThroughputEnum string
Set of constants representing the allowable values for EstimatedThroughputEnum
const (
EstimatedThroughputLow EstimatedThroughputEnum = "LOW"
EstimatedThroughputMedium EstimatedThroughputEnum = "MEDIUM"
EstimatedThroughputHigh EstimatedThroughputEnum = "HIGH"
EstimatedThroughputUnknown EstimatedThroughputEnum = "UNKNOWN"
)
func GetEstimatedThroughputEnumValues() []EstimatedThroughputEnum
GetEstimatedThroughputEnumValues Enumerates the set of values for EstimatedThroughputEnum
func GetMappingEstimatedThroughputEnum(val string) (EstimatedThroughputEnum, bool)
GetMappingEstimatedThroughputEnum performs case Insensitive comparison on enum value and return the desired enum
FunctionTaskDetails The Functions task. Batch input for a function can be limited by either size or time. The first limit reached determines the boundary of the batch. For configuration instructions, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm).
type FunctionTaskDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the function to be used as a task.
FunctionId *string `mandatory:"true" json:"functionId"`
// Size limit (kilobytes) for batch sent to invoke the function.
BatchSizeInKbs *int `mandatory:"false" json:"batchSizeInKbs"`
// Time limit (seconds) for batch sent to invoke the function.
BatchTimeInSec *int `mandatory:"false" json:"batchTimeInSec"`
}
func (m FunctionTaskDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FunctionTaskDetails) String() string
func (m FunctionTaskDetails) 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
FunctionsTargetDetails The destination function for data transferred from the source. For configuration instructions, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm).
type FunctionsTargetDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the function.
FunctionId *string `mandatory:"true" json:"functionId"`
// The batch rollover size in kilobytes.
BatchSizeInKbs *int `mandatory:"false" json:"batchSizeInKbs"`
// The batch rollover size in number of messages.
BatchSizeInNum *int `mandatory:"false" json:"batchSizeInNum"`
// The batch rollover time in seconds.
BatchTimeInSec *int `mandatory:"false" json:"batchTimeInSec"`
}
func (m FunctionsTargetDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FunctionsTargetDetails) String() string
func (m FunctionsTargetDetails) 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
GetConnectorPluginRequest wrapper for the GetConnectorPlugin operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/GetConnectorPlugin.go.html to see an example of how to use GetConnectorPluginRequest.
type GetConnectorPluginRequest struct {
// The name of the connector plugin. This name indicates the service to be called by the connector plugin. For example, `QueueSource` indicates the Queue service.
ConnectorPluginName *string `mandatory:"true" contributesTo:"path" name:"connectorPluginName"`
// The 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" 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 GetConnectorPluginRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetConnectorPluginRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetConnectorPluginRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetConnectorPluginRequest) String() string
func (request GetConnectorPluginRequest) 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
GetConnectorPluginResponse wrapper for the GetConnectorPlugin operation
type GetConnectorPluginResponse struct {
// The underlying http response
RawResponse *http.Response
// The ConnectorPlugin instance
ConnectorPlugin `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 GetConnectorPluginResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetConnectorPluginResponse) String() string
GetServiceConnectorRequest wrapper for the GetServiceConnector operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/GetServiceConnector.go.html to see an example of how to use GetServiceConnectorRequest.
type GetServiceConnectorRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connector.
ServiceConnectorId *string `mandatory:"true" contributesTo:"path" name:"serviceConnectorId"`
// The 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" 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 GetServiceConnectorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetServiceConnectorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetServiceConnectorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetServiceConnectorRequest) String() string
func (request GetServiceConnectorRequest) 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
GetServiceConnectorResponse wrapper for the GetServiceConnector operation
type GetServiceConnectorResponse struct {
// The underlying http response
RawResponse *http.Response
// The ServiceConnector instance
ServiceConnector `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetServiceConnectorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetServiceConnectorResponse) 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/sch/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The 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" 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"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
JmesPathDimensionValue Evaluated type of dimension value.
type JmesPathDimensionValue struct {
// The location to use for deriving the dimension value (evaluated).
// The path must start with `logContent` in an acceptable notation style with supported JMESPath selectors (https://jmespath.org/specification.html): expression with dot and index operator (`.` and `MetricDataDetails.
// The returned value depends on the results of evaluation.
// If the evaluated value is valid, then the evaluated value is returned without double quotes. (Any front or trailing double quotes are trimmed before returning the value. For example, the evaluated value `"compartmentId"` is returned as `compartmentId`.)
// If the evaluated value is invalid, then the returned value is `SCH_EVAL_INVALID_VALUE`.
// If the evaluated value is empty, then the returned value is `SCH_EVAL_VALUE_EMPTY`.
Path *string `mandatory:"true" json:"path"`
}
func (m JmesPathDimensionValue) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m JmesPathDimensionValue) String() string
func (m JmesPathDimensionValue) 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
LatestStreamingCursor `LATEST` cursor type. Starts reading messages published after creating the connector. For configuration instructions, see Creating a Connector with a Streaming Source (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector-streaming-source.htm).
type LatestStreamingCursor struct {
}
func (m LatestStreamingCursor) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m LatestStreamingCursor) String() string
func (m LatestStreamingCursor) 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
LifecycleStateEnum Enum with underlying type: string
type LifecycleStateEnum string
Set of constants representing the allowable values for LifecycleStateEnum
const (
LifecycleStateCreating LifecycleStateEnum = "CREATING"
LifecycleStateUpdating LifecycleStateEnum = "UPDATING"
LifecycleStateActive LifecycleStateEnum = "ACTIVE"
LifecycleStateInactive LifecycleStateEnum = "INACTIVE"
LifecycleStateDeleting LifecycleStateEnum = "DELETING"
LifecycleStateDeleted LifecycleStateEnum = "DELETED"
LifecycleStateFailed LifecycleStateEnum = "FAILED"
)
func GetLifecycleStateEnumValues() []LifecycleStateEnum
GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum
func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)
GetMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListConnectorPluginsLifecycleStateEnum Enum with underlying type: string
type ListConnectorPluginsLifecycleStateEnum string
Set of constants representing the allowable values for ListConnectorPluginsLifecycleStateEnum
const (
ListConnectorPluginsLifecycleStateCreating ListConnectorPluginsLifecycleStateEnum = "CREATING"
ListConnectorPluginsLifecycleStateUpdating ListConnectorPluginsLifecycleStateEnum = "UPDATING"
ListConnectorPluginsLifecycleStateActive ListConnectorPluginsLifecycleStateEnum = "ACTIVE"
ListConnectorPluginsLifecycleStateInactive ListConnectorPluginsLifecycleStateEnum = "INACTIVE"
ListConnectorPluginsLifecycleStateDeleting ListConnectorPluginsLifecycleStateEnum = "DELETING"
ListConnectorPluginsLifecycleStateDeleted ListConnectorPluginsLifecycleStateEnum = "DELETED"
ListConnectorPluginsLifecycleStateFailed ListConnectorPluginsLifecycleStateEnum = "FAILED"
)
func GetListConnectorPluginsLifecycleStateEnumValues() []ListConnectorPluginsLifecycleStateEnum
GetListConnectorPluginsLifecycleStateEnumValues Enumerates the set of values for ListConnectorPluginsLifecycleStateEnum
func GetMappingListConnectorPluginsLifecycleStateEnum(val string) (ListConnectorPluginsLifecycleStateEnum, bool)
GetMappingListConnectorPluginsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListConnectorPluginsRequest wrapper for the ListConnectorPlugins operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/ListConnectorPlugins.go.html to see an example of how to use ListConnectorPluginsRequest.
type ListConnectorPluginsRequest struct {
// A filter to return only resources that match the given lifecycle state.
// Example: `ACTIVE`
LifecycleState ListConnectorPluginsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the given display name exactly.
// Example: `example_service_connector`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the given connector plugin name ignoring case.
// Example: `QueueSource`
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// For list pagination. The maximum number of results per page, or items to return
// in a paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListConnectorPluginsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for `timeCreated` is descending.
// Default order for `displayName` is ascending. If no value is specified `timeCreated` is default.
SortBy ListConnectorPluginsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The 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" 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 ListConnectorPluginsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListConnectorPluginsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListConnectorPluginsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListConnectorPluginsRequest) String() string
func (request ListConnectorPluginsRequest) 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
ListConnectorPluginsResponse wrapper for the ListConnectorPlugins operation
type ListConnectorPluginsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ConnectorPluginCollection instances
ConnectorPluginCollection `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"`
// For list pagination. When this header appears in the response,
// additional pages of results remain. For important details about
// how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response,
// previous pages of results exist. For important details about
// how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListConnectorPluginsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListConnectorPluginsResponse) String() string
ListConnectorPluginsSortByEnum Enum with underlying type: string
type ListConnectorPluginsSortByEnum string
Set of constants representing the allowable values for ListConnectorPluginsSortByEnum
const (
ListConnectorPluginsSortByTimecreated ListConnectorPluginsSortByEnum = "timeCreated"
ListConnectorPluginsSortByDisplayname ListConnectorPluginsSortByEnum = "displayName"
)
func GetListConnectorPluginsSortByEnumValues() []ListConnectorPluginsSortByEnum
GetListConnectorPluginsSortByEnumValues Enumerates the set of values for ListConnectorPluginsSortByEnum
func GetMappingListConnectorPluginsSortByEnum(val string) (ListConnectorPluginsSortByEnum, bool)
GetMappingListConnectorPluginsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListConnectorPluginsSortOrderEnum Enum with underlying type: string
type ListConnectorPluginsSortOrderEnum string
Set of constants representing the allowable values for ListConnectorPluginsSortOrderEnum
const (
ListConnectorPluginsSortOrderAsc ListConnectorPluginsSortOrderEnum = "ASC"
ListConnectorPluginsSortOrderDesc ListConnectorPluginsSortOrderEnum = "DESC"
)
func GetListConnectorPluginsSortOrderEnumValues() []ListConnectorPluginsSortOrderEnum
GetListConnectorPluginsSortOrderEnumValues Enumerates the set of values for ListConnectorPluginsSortOrderEnum
func GetMappingListConnectorPluginsSortOrderEnum(val string) (ListConnectorPluginsSortOrderEnum, bool)
GetMappingListConnectorPluginsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListServiceConnectorsLifecycleStateEnum Enum with underlying type: string
type ListServiceConnectorsLifecycleStateEnum string
Set of constants representing the allowable values for ListServiceConnectorsLifecycleStateEnum
const (
ListServiceConnectorsLifecycleStateCreating ListServiceConnectorsLifecycleStateEnum = "CREATING"
ListServiceConnectorsLifecycleStateUpdating ListServiceConnectorsLifecycleStateEnum = "UPDATING"
ListServiceConnectorsLifecycleStateActive ListServiceConnectorsLifecycleStateEnum = "ACTIVE"
ListServiceConnectorsLifecycleStateInactive ListServiceConnectorsLifecycleStateEnum = "INACTIVE"
ListServiceConnectorsLifecycleStateDeleting ListServiceConnectorsLifecycleStateEnum = "DELETING"
ListServiceConnectorsLifecycleStateDeleted ListServiceConnectorsLifecycleStateEnum = "DELETED"
ListServiceConnectorsLifecycleStateFailed ListServiceConnectorsLifecycleStateEnum = "FAILED"
)
func GetListServiceConnectorsLifecycleStateEnumValues() []ListServiceConnectorsLifecycleStateEnum
GetListServiceConnectorsLifecycleStateEnumValues Enumerates the set of values for ListServiceConnectorsLifecycleStateEnum
func GetMappingListServiceConnectorsLifecycleStateEnum(val string) (ListServiceConnectorsLifecycleStateEnum, bool)
GetMappingListServiceConnectorsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListServiceConnectorsRequest wrapper for the ListServiceConnectors operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/ListServiceConnectors.go.html to see an example of how to use ListServiceConnectorsRequest.
type ListServiceConnectorsRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for this request.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that match the given lifecycle state.
// Example: `ACTIVE`
LifecycleState ListServiceConnectorsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the given display name exactly.
// Example: `example_service_connector`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// For list pagination. The maximum number of results per page, or items to return
// in a paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListServiceConnectorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for `timeCreated` is descending.
// Default order for `displayName` is ascending. If no value is specified `timeCreated` is default.
SortBy ListServiceConnectorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The 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" 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 ListServiceConnectorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListServiceConnectorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListServiceConnectorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListServiceConnectorsRequest) String() string
func (request ListServiceConnectorsRequest) 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
ListServiceConnectorsResponse wrapper for the ListServiceConnectors operation
type ListServiceConnectorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ServiceConnectorCollection instances
ServiceConnectorCollection `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"`
// For list pagination. When this header appears in the response,
// additional pages of results remain. For important details about
// how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response,
// previous pages of results exist. For important details about
// how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListServiceConnectorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListServiceConnectorsResponse) String() string
ListServiceConnectorsSortByEnum Enum with underlying type: string
type ListServiceConnectorsSortByEnum string
Set of constants representing the allowable values for ListServiceConnectorsSortByEnum
const (
ListServiceConnectorsSortByTimecreated ListServiceConnectorsSortByEnum = "timeCreated"
ListServiceConnectorsSortByDisplayname ListServiceConnectorsSortByEnum = "displayName"
)
func GetListServiceConnectorsSortByEnumValues() []ListServiceConnectorsSortByEnum
GetListServiceConnectorsSortByEnumValues Enumerates the set of values for ListServiceConnectorsSortByEnum
func GetMappingListServiceConnectorsSortByEnum(val string) (ListServiceConnectorsSortByEnum, bool)
GetMappingListServiceConnectorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListServiceConnectorsSortOrderEnum Enum with underlying type: string
type ListServiceConnectorsSortOrderEnum string
Set of constants representing the allowable values for ListServiceConnectorsSortOrderEnum
const (
ListServiceConnectorsSortOrderAsc ListServiceConnectorsSortOrderEnum = "ASC"
ListServiceConnectorsSortOrderDesc ListServiceConnectorsSortOrderEnum = "DESC"
)
func GetListServiceConnectorsSortOrderEnumValues() []ListServiceConnectorsSortOrderEnum
GetListServiceConnectorsSortOrderEnumValues Enumerates the set of values for ListServiceConnectorsSortOrderEnum
func GetMappingListServiceConnectorsSortOrderEnum(val string) (ListServiceConnectorsSortOrderEnum, bool)
GetMappingListServiceConnectorsSortOrderEnum 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/sch/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The 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" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return
// in a paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (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"`
// For list pagination. When this header appears in the response,
// additional pages of results remain. For important details about
// how pagination works, 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"`
// For list pagination. When this header appears in the response,
// previous pages of results exist. For important details about
// how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
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/sch/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The 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" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return
// in a paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (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 WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `presentIn:"body"`
// For list pagination. When this header appears in the response,
// additional pages of results remain. For important details about
// how pagination works, 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"`
// For list pagination. When this header appears in the response,
// previous pages of results exist. For important details about
// how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
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/sch/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for this request.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The 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" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the opc-next-page response header from the previous
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return
// in a paginated "List" call. For important details about how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (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"`
// 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 list pagination. When this header appears in the response,
// additional pages of results remain. For important details about
// how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response,
// previous pages of results exist. For important details about
// how pagination works, see
// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
LogRuleTaskDetails The log filter task. For configuration instructions, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm).
type LogRuleTaskDetails struct {
// A filter or mask to limit the source used in the flow defined by the connector.
Condition *string `mandatory:"true" json:"condition"`
}
func (m LogRuleTaskDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m LogRuleTaskDetails) String() string
func (m LogRuleTaskDetails) 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
LogSource The logs for this Logging source.
type LogSource struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the log source.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group.
// Note: For the Notifications target, only _Audit is allowed.
// Example OCID for _Audit log group: ocid1.tenancy.oc1..exampleuniqueid/_Audit
LogGroupId *string `mandatory:"false" json:"logGroupId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log.
LogId *string `mandatory:"false" json:"logId"`
}
func (m LogSource) String() string
func (m LogSource) 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
LoggingAnalyticsTargetDetails The destination log group for data transferred from the source. For configuration instructions, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm).
type LoggingAnalyticsTargetDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Logging Analytics log group.
LogGroupId *string `mandatory:"true" json:"logGroupId"`
// Identifier of the log source that you want to use for processing data received from the connector source.
// Applies to `StreamingSource` only.
// Equivalent to `name` at LogAnalyticsSource.
LogSourceIdentifier *string `mandatory:"false" json:"logSourceIdentifier"`
}
func (m LoggingAnalyticsTargetDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m LoggingAnalyticsTargetDetails) String() string
func (m LoggingAnalyticsTargetDetails) 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
LoggingSourceDetails The Logging source. For configuration instructions, see Creating a Connector with a Logging Source (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector-logging-source.htm).
type LoggingSourceDetails struct {
// The logs for this Logging source.
LogSources []LogSource `mandatory:"true" json:"logSources"`
}
func (m LoggingSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m LoggingSourceDetails) String() string
func (m LoggingSourceDetails) 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
MonitoringSource A compartment-specific list of metric namespaces to retrieve data from.
type MonitoringSource struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a compartment containing metric namespaces you want to use for the Monitoring source.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
NamespaceDetails MonitoringSourceNamespaceDetails `mandatory:"true" json:"namespaceDetails"`
}
func (m MonitoringSource) String() string
func (m *MonitoringSource) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m MonitoringSource) 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
MonitoringSourceAllMetrics Discriminator for metrics in the compartment-specific list.
type MonitoringSourceAllMetrics struct {
}
func (m MonitoringSourceAllMetrics) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m MonitoringSourceAllMetrics) String() string
func (m MonitoringSourceAllMetrics) 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
MonitoringSourceDetails The Monitoring source. For configuration instructions, see Creating a Connector with a Monitoring Source (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector-monitoring-source.htm).
type MonitoringSourceDetails struct {
// One or more compartment-specific lists of metric namespaces to retrieve data from.
MonitoringSources []MonitoringSource `mandatory:"true" json:"monitoringSources"`
}
func (m MonitoringSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m MonitoringSourceDetails) String() string
func (m MonitoringSourceDetails) 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
MonitoringSourceMetricDetails The metrics to query for the specified metric namespace.
type MonitoringSourceMetricDetails interface {
}
MonitoringSourceMetricDetailsKindEnum Enum with underlying type: string
type MonitoringSourceMetricDetailsKindEnum string
Set of constants representing the allowable values for MonitoringSourceMetricDetailsKindEnum
const (
MonitoringSourceMetricDetailsKindAll MonitoringSourceMetricDetailsKindEnum = "all"
)
func GetMappingMonitoringSourceMetricDetailsKindEnum(val string) (MonitoringSourceMetricDetailsKindEnum, bool)
GetMappingMonitoringSourceMetricDetailsKindEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMonitoringSourceMetricDetailsKindEnumValues() []MonitoringSourceMetricDetailsKindEnum
GetMonitoringSourceMetricDetailsKindEnumValues Enumerates the set of values for MonitoringSourceMetricDetailsKindEnum
MonitoringSourceNamespaceDetails Discriminator for namespaces in the compartment-specific list.
type MonitoringSourceNamespaceDetails interface {
}
MonitoringSourceNamespaceDetailsKindEnum Enum with underlying type: string
type MonitoringSourceNamespaceDetailsKindEnum string
Set of constants representing the allowable values for MonitoringSourceNamespaceDetailsKindEnum
const (
MonitoringSourceNamespaceDetailsKindSelected MonitoringSourceNamespaceDetailsKindEnum = "selected"
)
func GetMappingMonitoringSourceNamespaceDetailsKindEnum(val string) (MonitoringSourceNamespaceDetailsKindEnum, bool)
GetMappingMonitoringSourceNamespaceDetailsKindEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMonitoringSourceNamespaceDetailsKindEnumValues() []MonitoringSourceNamespaceDetailsKindEnum
GetMonitoringSourceNamespaceDetailsKindEnumValues Enumerates the set of values for MonitoringSourceNamespaceDetailsKindEnum
MonitoringSourceSelectedNamespace A metric namespace for the compartment-specific list.
type MonitoringSourceSelectedNamespace struct {
// The source service or application to use when querying for metric data points. Must begin with `oci_`.
// Example: `oci_computeagent`
Namespace *string `mandatory:"true" json:"namespace"`
Metrics MonitoringSourceMetricDetails `mandatory:"true" json:"metrics"`
}
func (m MonitoringSourceSelectedNamespace) String() string
func (m *MonitoringSourceSelectedNamespace) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m MonitoringSourceSelectedNamespace) 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
MonitoringSourceSelectedNamespaceDetails The namespaces for the compartment-specific list.
type MonitoringSourceSelectedNamespaceDetails struct {
// The namespaces for the compartment-specific list.
Namespaces []MonitoringSourceSelectedNamespace `mandatory:"true" json:"namespaces"`
}
func (m MonitoringSourceSelectedNamespaceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m MonitoringSourceSelectedNamespaceDetails) String() string
func (m MonitoringSourceSelectedNamespaceDetails) 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
MonitoringTargetDetails The destination metric for data transferred from the source. For configuration instructions, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm).
type MonitoringTargetDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The namespace of the metric.
// Example: `oci_computeagent`
MetricNamespace *string `mandatory:"true" json:"metricNamespace"`
// The name of the metric.
// Example: `CpuUtilization`
Metric *string `mandatory:"true" json:"metric"`
// List of dimension names and values.
Dimensions []DimensionDetails `mandatory:"false" json:"dimensions"`
}
func (m MonitoringTargetDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m MonitoringTargetDetails) String() string
func (m MonitoringTargetDetails) 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
NotificationsTargetDetails The destination topic for data transferred from the source. For configuration instructions, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm).
type NotificationsTargetDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic.
TopicId *string `mandatory:"true" json:"topicId"`
// Whether to apply a simplified, user-friendly format to the message. Applies only when friendly formatting is supported by the connector source and the subscription protocol.
// Example: `true`
EnableFormattedMessaging *bool `mandatory:"false" json:"enableFormattedMessaging"`
}
func (m NotificationsTargetDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NotificationsTargetDetails) String() string
func (m NotificationsTargetDetails) 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
ObjectStorageTargetDetails The destination bucket for data transferred from the source. For configuration instructions, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm).
type ObjectStorageTargetDetails struct {
// The name of the bucket. Valid characters are letters (upper or lower case), numbers, hyphens (-),
// underscores(_), and periods (.). Bucket names must be unique within an Object Storage namespace.
// Avoid entering confidential information. Example: my-new-bucket1
BucketName *string `mandatory:"true" json:"bucketName"`
// The namespace.
Namespace *string `mandatory:"false" json:"namespace"`
// The prefix of the objects. Avoid entering confidential information.
ObjectNamePrefix *string `mandatory:"false" json:"objectNamePrefix"`
// The batch rollover size in megabytes.
BatchRolloverSizeInMBs *int `mandatory:"false" json:"batchRolloverSizeInMBs"`
// The batch rollover time in milliseconds.
BatchRolloverTimeInMs *int `mandatory:"false" json:"batchRolloverTimeInMs"`
}
func (m ObjectStorageTargetDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStorageTargetDetails) String() string
func (m ObjectStorageTargetDetails) 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
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreateServiceConnector OperationTypeEnum = "CREATE_SERVICE_CONNECTOR"
OperationTypeUpdateServiceConnector OperationTypeEnum = "UPDATE_SERVICE_CONNECTOR"
OperationTypeDeleteServiceConnector OperationTypeEnum = "DELETE_SERVICE_CONNECTOR"
OperationTypeActivateServiceConnector OperationTypeEnum = "ACTIVATE_SERVICE_CONNECTOR"
OperationTypeDeactivateServiceConnector OperationTypeEnum = "DEACTIVATE_SERVICE_CONNECTOR"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
PluginSourceDetails Details about a connector plugin used to fetch data from a source. For configuration instructions, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm).
type PluginSourceDetails struct {
// The name of the connector plugin. This name indicates the service to be called by the connector plugin. For example, `QueueSource` indicates the Queue service.
// To find names of connector plugins, list the plugin using (ListConnectorPlugin)[#/en/serviceconnectors/latest/ConnectorPluginSummary/ListConnectorPlugins].
PluginName *string `mandatory:"true" json:"pluginName"`
// The configuration map for the connector plugin. This map includes parameters specific to the connector plugin type.
// For example, for `QueueSource`, the map lists the OCID of the selected queue.
// To find the parameters for a connector plugin, get the plugin using (GetConnectorPlugin)[#/en/serviceconnectors/latest/ConnectorPlugin/GetConnectorPlugin] and review its schema value.
ConfigMap *interface{} `mandatory:"true" json:"configMap"`
}
func (m PluginSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PluginSourceDetails) String() string
func (m PluginSourceDetails) 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
ServiceConnector The configuration details of the flow defined by the connector. For more information about flows defined by connectors, see Overview of Connector Hub (https://docs.cloud.oracle.com/iaas/Content/connector-hub/overview.htm).
type ServiceConnector struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connector.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the connector.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time when the connector was created.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time when the connector was updated.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the connector.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The description of the resource. Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
// A message describing the current state in more detail.
// For example, the message might provide actionable
// information for a resource in a `FAILED` state.
LifecyleDetails *string `mandatory:"false" json:"lifecyleDetails"`
Source SourceDetails `mandatory:"false" json:"source"`
// The list of tasks.
Tasks []TaskDetails `mandatory:"false" json:"tasks"`
Target TargetDetails `mandatory:"false" json:"target"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// 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"`
}
func (m ServiceConnector) String() string
func (m *ServiceConnector) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ServiceConnector) 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
ServiceConnectorClient a client for ServiceConnector
type ServiceConnectorClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewServiceConnectorClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ServiceConnectorClient, err error)
NewServiceConnectorClientWithConfigurationProvider Creates a new default ServiceConnector client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewServiceConnectorClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ServiceConnectorClient, err error)
NewServiceConnectorClientWithOboToken Creates a new default ServiceConnector 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 ServiceConnectorClient) ActivateServiceConnector(ctx context.Context, request ActivateServiceConnectorRequest) (response ActivateServiceConnectorResponse, err error)
ActivateServiceConnector Activates the specified connector. After you send your request, the connector's state is temporarily UPDATING. When the state changes to ACTIVE, data begins transferring from the source service to the target service. For more information, see Activating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/activate-service-connector.htm).
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/ActivateServiceConnector.go.html to see an example of how to use ActivateServiceConnector API. A default retry strategy applies to this operation ActivateServiceConnector()
func (client ServiceConnectorClient) ChangeServiceConnectorCompartment(ctx context.Context, request ChangeServiceConnectorCompartmentRequest) (response ChangeServiceConnectorCompartmentResponse, err error)
ChangeServiceConnectorCompartment Moves a connector into a different compartment within the same tenancy. For more information, see Moving a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/change-compartment-service-connector.htm). 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/sch/ChangeServiceConnectorCompartment.go.html to see an example of how to use ChangeServiceConnectorCompartment API. A default retry strategy applies to this operation ChangeServiceConnectorCompartment()
func (client *ServiceConnectorClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ServiceConnectorClient) CreateServiceConnector(ctx context.Context, request CreateServiceConnectorRequest) (response CreateServiceConnectorResponse, err error)
CreateServiceConnector Creates a new connector in the specified compartment. A connector is a logically defined flow for moving data from a source service to a destination service in Oracle Cloud Infrastructure. For more information, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm). For general information about connectors, see Overview of Connector Hub (https://docs.cloud.oracle.com/iaas/Content/connector-hub/overview.htm). For purposes of access control, you must provide the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the connector to reside. Notice that the connector doesn't have to be in the same compartment as the source or target services. For information about access control and compartments, see Overview of the IAM Service (https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). After you send your request, the new connector's state is temporarily CREATING. When the state changes to ACTIVE, data begins transferring from the source service to the target service. For instructions on deactivating and activating connectors, see Activating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/activate-service-connector.htm).
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/CreateServiceConnector.go.html to see an example of how to use CreateServiceConnector API. A default retry strategy applies to this operation CreateServiceConnector()
func (client ServiceConnectorClient) DeactivateServiceConnector(ctx context.Context, request DeactivateServiceConnectorRequest) (response DeactivateServiceConnectorResponse, err error)
DeactivateServiceConnector Deactivates the specified connector. After you send your request, the connector's state is temporarily UPDATING and any data transfer stops. The state then changes to INACTIVE. For more information, see Deactivating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/deactivate-service-connector.htm).
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/DeactivateServiceConnector.go.html to see an example of how to use DeactivateServiceConnector API. A default retry strategy applies to this operation DeactivateServiceConnector()
func (client ServiceConnectorClient) DeleteServiceConnector(ctx context.Context, request DeleteServiceConnectorRequest) (response DeleteServiceConnectorResponse, err error)
DeleteServiceConnector Deletes the specified connector. For more information, see Deleting a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/delete-service-connector.htm). After you send your request, the connector's state is temporarily DELETING and any data transfer stops. The state then changes to DELETED.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/DeleteServiceConnector.go.html to see an example of how to use DeleteServiceConnector API. A default retry strategy applies to this operation DeleteServiceConnector()
func (client ServiceConnectorClient) GetServiceConnector(ctx context.Context, request GetServiceConnectorRequest) (response GetServiceConnectorResponse, err error)
GetServiceConnector Gets the specified connector's configuration information. For more information, see Getting a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/get-service-connector.htm).
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/GetServiceConnector.go.html to see an example of how to use GetServiceConnector API. A default retry strategy applies to this operation GetServiceConnector()
func (client ServiceConnectorClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the details of the specified work request. For more information, see Getting a Work Request's Details (https://docs.cloud.oracle.com/iaas/Content/connector-hub/get-work-request.htm).
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client ServiceConnectorClient) ListServiceConnectors(ctx context.Context, request ListServiceConnectorsRequest) (response ListServiceConnectorsResponse, err error)
ListServiceConnectors Lists connectors in the specified compartment. For more information, see Listing Connectors (https://docs.cloud.oracle.com/iaas/Content/connector-hub/list-service-connector.htm).
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/ListServiceConnectors.go.html to see an example of how to use ListServiceConnectors API. A default retry strategy applies to this operation ListServiceConnectors()
func (client ServiceConnectorClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Lists work request errors for the specified work request. Results are paginated. For more information, see Listing Work Request Errors (https://docs.cloud.oracle.com/iaas/Content/connector-hub/list-work-request-error.htm).
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client ServiceConnectorClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Lists logs for the specified work request. Results are paginated. For more information, see Listing Work Request Log Entries (https://docs.cloud.oracle.com/iaas/Content/connector-hub/list-work-request-log-entry.htm).
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client ServiceConnectorClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in the specified compartment. For more information, see Listing Work Requests (https://docs.cloud.oracle.com/iaas/Content/connector-hub/list-work-request.htm).
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *ServiceConnectorClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client ServiceConnectorClient) UpdateServiceConnector(ctx context.Context, request UpdateServiceConnectorRequest) (response UpdateServiceConnectorResponse, err error)
UpdateServiceConnector Updates the configuration information for the specified connector. For more information, see Updating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/update-service-connector.htm). After you send your request, the connector's state is temporarily UPDATING and any data transfer pauses. The state then changes back to its original value: if ACTIVE, then data transfer resumes.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/UpdateServiceConnector.go.html to see an example of how to use UpdateServiceConnector API. A default retry strategy applies to this operation UpdateServiceConnector()
ServiceConnectorCollection Collection of connector property summaries.
type ServiceConnectorCollection struct {
// The list of items.
Items []ServiceConnectorSummary `mandatory:"true" json:"items"`
}
func (m ServiceConnectorCollection) String() string
func (m ServiceConnectorCollection) 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
ServiceConnectorSummary A summary of properties for the specified connector.
type ServiceConnectorSummary struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connector.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the connector.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time when the connector was created.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time when the connector was updated.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the connector.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The description of the resource. Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
// A message describing the current state in more detail.
// For example, the message might provide actionable
// information for a resource in a `FAILED` state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// 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"`
}
func (m ServiceConnectorSummary) String() string
func (m ServiceConnectorSummary) 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
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
SourceConnectorPlugin A connector plugin for fetching data from a source service. For configuration instructions, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm).
type SourceConnectorPlugin struct {
// The service to be called by the connector plugin.
// Example: `QueueSource`
Name *string `mandatory:"true" json:"name"`
// The date and time when this plugin became available.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2023-09-09T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Gets the specified connector plugin configuration information in OpenAPI specification format.
Schema *string `mandatory:"false" json:"schema"`
// The estimated maximum period of time the data will be kept at the source.
// The duration is specified as a string in ISO 8601 format (P1D for one day or P30D for thrity days).
MaxRetention *string `mandatory:"false" json:"maxRetention"`
// The estimated throughput range (LOW, MEDIUM, HIGH).
EstimatedThroughput EstimatedThroughputEnum `mandatory:"false" json:"estimatedThroughput,omitempty"`
// The current state of the service connector.
LifecycleState ConnectorPluginLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m SourceConnectorPlugin) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m SourceConnectorPlugin) GetEstimatedThroughput() EstimatedThroughputEnum
GetEstimatedThroughput returns EstimatedThroughput
func (m SourceConnectorPlugin) GetLifecycleState() ConnectorPluginLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m SourceConnectorPlugin) GetName() *string
GetName returns Name
func (m SourceConnectorPlugin) GetSchema() *string
GetSchema returns Schema
func (m SourceConnectorPlugin) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m SourceConnectorPlugin) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SourceConnectorPlugin) String() string
func (m SourceConnectorPlugin) 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
SourceConnectorPluginSummary Summary information for a connector plugin that fetches data from a source service. For configuration instructions, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm).
type SourceConnectorPluginSummary struct {
// The service to be called by the connector plugin.
Name *string `mandatory:"true" json:"name"`
// The date and time when this plugin became available.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2023-09-10T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The estimated maximum period of time the data will be kept at the source.
// description: |
MaxRetention *string `mandatory:"false" json:"maxRetention"`
// The estimated throughput range (LOW, MEDIUM, HIGH).
EstimatedThroughput EstimatedThroughputEnum `mandatory:"false" json:"estimatedThroughput,omitempty"`
// The current state of the service connector.
LifecycleState ConnectorPluginLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m SourceConnectorPluginSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m SourceConnectorPluginSummary) GetEstimatedThroughput() EstimatedThroughputEnum
GetEstimatedThroughput returns EstimatedThroughput
func (m SourceConnectorPluginSummary) GetLifecycleState() ConnectorPluginLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m SourceConnectorPluginSummary) GetName() *string
GetName returns Name
func (m SourceConnectorPluginSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m SourceConnectorPluginSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SourceConnectorPluginSummary) String() string
func (m SourceConnectorPluginSummary) 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
SourceDetails An object that represents the source of the flow defined by the connector. An example source is the VCNFlow logs within the NetworkLogs group. For more information about flows defined by connectors, see Overview of Connector Hub (https://docs.cloud.oracle.com/iaas/Content/connector-hub/overview.htm). For configuration instructions, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm).
type SourceDetails interface {
}
SourceDetailsKindEnum Enum with underlying type: string
type SourceDetailsKindEnum string
Set of constants representing the allowable values for SourceDetailsKindEnum
const (
SourceDetailsKindLogging SourceDetailsKindEnum = "logging"
SourceDetailsKindMonitoring SourceDetailsKindEnum = "monitoring"
SourceDetailsKindStreaming SourceDetailsKindEnum = "streaming"
SourceDetailsKindPlugin SourceDetailsKindEnum = "plugin"
)
func GetMappingSourceDetailsKindEnum(val string) (SourceDetailsKindEnum, bool)
GetMappingSourceDetailsKindEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSourceDetailsKindEnumValues() []SourceDetailsKindEnum
GetSourceDetailsKindEnumValues Enumerates the set of values for SourceDetailsKindEnum
StaticDimensionValue Static type of dimension value (passed as-is).
type StaticDimensionValue struct {
// The data extracted from the specified dimension value (passed as-is). Unicode characters only.
// For information on valid dimension keys and values, see MetricDataDetails.
Value *string `mandatory:"true" json:"value"`
}
func (m StaticDimensionValue) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StaticDimensionValue) String() string
func (m StaticDimensionValue) 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
StreamingCursorDetails The read setting (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector-streaming-source.htm), which determines where in the stream to start moving data. For configuration instructions, see Creating a Connector with a Streaming Source (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector-streaming-source.htm).
type StreamingCursorDetails interface {
}
StreamingCursorDetailsKindEnum Enum with underlying type: string
type StreamingCursorDetailsKindEnum string
Set of constants representing the allowable values for StreamingCursorDetailsKindEnum
const (
StreamingCursorDetailsKindLatest StreamingCursorDetailsKindEnum = "LATEST"
StreamingCursorDetailsKindTrimHorizon StreamingCursorDetailsKindEnum = "TRIM_HORIZON"
)
func GetMappingStreamingCursorDetailsKindEnum(val string) (StreamingCursorDetailsKindEnum, bool)
GetMappingStreamingCursorDetailsKindEnum performs case Insensitive comparison on enum value and return the desired enum
func GetStreamingCursorDetailsKindEnumValues() []StreamingCursorDetailsKindEnum
GetStreamingCursorDetailsKindEnumValues Enumerates the set of values for StreamingCursorDetailsKindEnum
StreamingSourceDetails The Streaming source. For configuration instructions, see Creating a Connector with a Streaming Source (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector-streaming-source.htm).
type StreamingSourceDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream.
StreamId *string `mandatory:"true" json:"streamId"`
Cursor StreamingCursorDetails `mandatory:"false" json:"cursor"`
}
func (m StreamingSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StreamingSourceDetails) String() string
func (m *StreamingSourceDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m StreamingSourceDetails) 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
StreamingTargetDetails The destination stream for data transferred from the source. For configuration instructions, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm).
type StreamingTargetDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream.
StreamId *string `mandatory:"true" json:"streamId"`
}
func (m StreamingTargetDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StreamingTargetDetails) String() string
func (m StreamingTargetDetails) 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
TargetConnectorPlugin A connector plugin for sending data to a target service. For configuration instructions, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm).
type TargetConnectorPlugin struct {
// The service to be called by the connector plugin.
// Example: `QueueSource`
Name *string `mandatory:"true" json:"name"`
// The date and time when this plugin became available.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2023-09-09T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Gets the specified connector plugin configuration information in OpenAPI specification format.
Schema *string `mandatory:"false" json:"schema"`
// The estimated throughput range (LOW, MEDIUM, HIGH).
EstimatedThroughput EstimatedThroughputEnum `mandatory:"false" json:"estimatedThroughput,omitempty"`
// The current state of the service connector.
LifecycleState ConnectorPluginLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m TargetConnectorPlugin) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m TargetConnectorPlugin) GetEstimatedThroughput() EstimatedThroughputEnum
GetEstimatedThroughput returns EstimatedThroughput
func (m TargetConnectorPlugin) GetLifecycleState() ConnectorPluginLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m TargetConnectorPlugin) GetName() *string
GetName returns Name
func (m TargetConnectorPlugin) GetSchema() *string
GetSchema returns Schema
func (m TargetConnectorPlugin) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m TargetConnectorPlugin) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TargetConnectorPlugin) String() string
func (m TargetConnectorPlugin) 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
TargetConnectorPluginSummary Summary information for a connector plugin that sends data to a target service. For configuration instructions, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm).
type TargetConnectorPluginSummary struct {
// The service to be called by the connector plugin.
Name *string `mandatory:"true" json:"name"`
// The date and time when this plugin became available.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2023-09-10T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The estimated throughput range (LOW, MEDIUM, HIGH).
EstimatedThroughput EstimatedThroughputEnum `mandatory:"false" json:"estimatedThroughput,omitempty"`
// The current state of the service connector.
LifecycleState ConnectorPluginLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m TargetConnectorPluginSummary) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m TargetConnectorPluginSummary) GetEstimatedThroughput() EstimatedThroughputEnum
GetEstimatedThroughput returns EstimatedThroughput
func (m TargetConnectorPluginSummary) GetLifecycleState() ConnectorPluginLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m TargetConnectorPluginSummary) GetName() *string
GetName returns Name
func (m TargetConnectorPluginSummary) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m TargetConnectorPluginSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TargetConnectorPluginSummary) String() string
func (m TargetConnectorPluginSummary) 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
TargetDetails An object that represents the target of the flow defined by the connector. An example target is a stream (Streaming service). For more information about flows defined by connectors, see Overview of Connector Hub (https://docs.cloud.oracle.com/iaas/Content/connector-hub/overview.htm). For configuration instructions, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm).
type TargetDetails interface {
}
TargetDetailsKindEnum Enum with underlying type: string
type TargetDetailsKindEnum string
Set of constants representing the allowable values for TargetDetailsKindEnum
const (
TargetDetailsKindFunctions TargetDetailsKindEnum = "functions"
TargetDetailsKindLogginganalytics TargetDetailsKindEnum = "loggingAnalytics"
TargetDetailsKindMonitoring TargetDetailsKindEnum = "monitoring"
TargetDetailsKindNotifications TargetDetailsKindEnum = "notifications"
TargetDetailsKindObjectstorage TargetDetailsKindEnum = "objectStorage"
TargetDetailsKindStreaming TargetDetailsKindEnum = "streaming"
)
func GetMappingTargetDetailsKindEnum(val string) (TargetDetailsKindEnum, bool)
GetMappingTargetDetailsKindEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTargetDetailsKindEnumValues() []TargetDetailsKindEnum
GetTargetDetailsKindEnumValues Enumerates the set of values for TargetDetailsKindEnum
TaskDetails An object that represents a task within the flow defined by the connector. An example task is a filter for error logs. For more information about flows defined by connectors, see Overview of Connector Hub (https://docs.cloud.oracle.com/iaas/Content/connector-hub/overview.htm). For configuration instructions, see Creating a Connector (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector.htm).
type TaskDetails interface {
}
TaskDetailsKindEnum Enum with underlying type: string
type TaskDetailsKindEnum string
Set of constants representing the allowable values for TaskDetailsKindEnum
const (
TaskDetailsKindFunction TaskDetailsKindEnum = "function"
TaskDetailsKindLogrule TaskDetailsKindEnum = "logRule"
)
func GetMappingTaskDetailsKindEnum(val string) (TaskDetailsKindEnum, bool)
GetMappingTaskDetailsKindEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTaskDetailsKindEnumValues() []TaskDetailsKindEnum
GetTaskDetailsKindEnumValues Enumerates the set of values for TaskDetailsKindEnum
TrimHorizonStreamingCursor `TRIM_HORIZON` cursor type. Starts reading from the oldest available message in the stream. For configuration instructions, see Creating a Connector with a Streaming Source (https://docs.cloud.oracle.com/iaas/Content/connector-hub/create-service-connector-streaming-source.htm).
type TrimHorizonStreamingCursor struct {
}
func (m TrimHorizonStreamingCursor) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TrimHorizonStreamingCursor) String() string
func (m TrimHorizonStreamingCursor) 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
UpdateServiceConnectorDetails The configuration details for updating a connector.
type UpdateServiceConnectorDetails struct {
// A user-friendly name. It does not have to be unique, and it is changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The description of the resource. Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
Source SourceDetails `mandatory:"false" json:"source"`
// The list of the tasks.
Tasks []TaskDetails `mandatory:"false" json:"tasks"`
Target TargetDetails `mandatory:"false" json:"target"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateServiceConnectorDetails) String() string
func (m *UpdateServiceConnectorDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateServiceConnectorDetails) 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
UpdateServiceConnectorRequest wrapper for the UpdateServiceConnector operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/sch/UpdateServiceConnector.go.html to see an example of how to use UpdateServiceConnectorRequest.
type UpdateServiceConnectorRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connector.
ServiceConnectorId *string `mandatory:"true" contributesTo:"path" name:"serviceConnectorId"`
// The information to be updated.
UpdateServiceConnectorDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The 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" 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 UpdateServiceConnectorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateServiceConnectorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateServiceConnectorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateServiceConnectorRequest) String() string
func (request UpdateServiceConnectorRequest) 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
UpdateServiceConnectorResponse wrapper for the UpdateServiceConnector operation
type UpdateServiceConnectorResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateServiceConnectorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateServiceConnectorResponse) String() string
WorkRequest An object representing an asynchronous work flow. Many of the API requests you use to create and configure connectors do not take effect immediately. In these cases, the request spawns an asynchronous work flow to fulfill the request. WorkRequest objects provide visibility for in-progress work flows. For more information about work requests, see Viewing the State of a Work Request (https://docs.cloud.oracle.com/iaas/Content/connector-hub/workrequests.htm).
type WorkRequest struct {
// The type of action the work request represents.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment
// containing the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time when the request was created.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time when the request was started.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time when the object finished.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
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 Collection of work requests.
type WorkRequestCollection struct {
// The list of items.
Items []WorkRequest `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 An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. See
// API Errors (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm).
Code *string `mandatory:"true" json:"code"`
// A human readable description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The date and time when the error occurred.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
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 Collection of work request errors.
type WorkRequestErrorCollection struct {
// The list of items.
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
WorkRequestLogEntry A log message from the execution of a work request.
type WorkRequestLogEntry struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The date and time when the log message was written.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-01-25T21:10:29.600Z`
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) 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
WorkRequestLogEntryCollection Collection of work request logs.
type WorkRequestLogEntryCollection struct {
// The list of items.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) 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
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request.
// A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
// work is complete for that resource at which point it will transition to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// An OCID or other unique identifier for the resource affected by the work request.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that you can use for a GET request to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
}
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