func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetChangeIotDomainDataRetentionPeriodDetailsTypeEnumStringValues() []string
GetChangeIotDomainDataRetentionPeriodDetailsTypeEnumStringValues Enumerates the set of values in String for ChangeIotDomainDataRetentionPeriodDetailsTypeEnum
func GetConfigureIotDomainDataAccessDetailsTypeEnumStringValues() []string
GetConfigureIotDomainDataAccessDetailsTypeEnumStringValues Enumerates the set of values in String for ConfigureIotDomainDataAccessDetailsTypeEnum
func GetDigitalTwinAdapterPayloadDataFormatEnumStringValues() []string
GetDigitalTwinAdapterPayloadDataFormatEnumStringValues Enumerates the set of values in String for DigitalTwinAdapterPayloadDataFormatEnum
func GetInvokeRawCommandDetailsRequestDataFormatEnumStringValues() []string
GetInvokeRawCommandDetailsRequestDataFormatEnumStringValues Enumerates the set of values in String for InvokeRawCommandDetailsRequestDataFormatEnum
func GetIotDomainGroupLifecycleStateEnumStringValues() []string
GetIotDomainGroupLifecycleStateEnumStringValues Enumerates the set of values in String for IotDomainGroupLifecycleStateEnum
func GetIotDomainLifecycleStateEnumStringValues() []string
GetIotDomainLifecycleStateEnumStringValues Enumerates the set of values in String for IotDomainLifecycleStateEnum
func GetLifecycleStateEnumStringValues() []string
GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum
func GetListDigitalTwinAdaptersLifecycleStateEnumStringValues() []string
GetListDigitalTwinAdaptersLifecycleStateEnumStringValues Enumerates the set of values in String for ListDigitalTwinAdaptersLifecycleStateEnum
func GetListDigitalTwinAdaptersSortByEnumStringValues() []string
GetListDigitalTwinAdaptersSortByEnumStringValues Enumerates the set of values in String for ListDigitalTwinAdaptersSortByEnum
func GetListDigitalTwinAdaptersSortOrderEnumStringValues() []string
GetListDigitalTwinAdaptersSortOrderEnumStringValues Enumerates the set of values in String for ListDigitalTwinAdaptersSortOrderEnum
func GetListDigitalTwinInstancesLifecycleStateEnumStringValues() []string
GetListDigitalTwinInstancesLifecycleStateEnumStringValues Enumerates the set of values in String for ListDigitalTwinInstancesLifecycleStateEnum
func GetListDigitalTwinInstancesSortByEnumStringValues() []string
GetListDigitalTwinInstancesSortByEnumStringValues Enumerates the set of values in String for ListDigitalTwinInstancesSortByEnum
func GetListDigitalTwinInstancesSortOrderEnumStringValues() []string
GetListDigitalTwinInstancesSortOrderEnumStringValues Enumerates the set of values in String for ListDigitalTwinInstancesSortOrderEnum
func GetListDigitalTwinModelsLifecycleStateEnumStringValues() []string
GetListDigitalTwinModelsLifecycleStateEnumStringValues Enumerates the set of values in String for ListDigitalTwinModelsLifecycleStateEnum
func GetListDigitalTwinModelsSortByEnumStringValues() []string
GetListDigitalTwinModelsSortByEnumStringValues Enumerates the set of values in String for ListDigitalTwinModelsSortByEnum
func GetListDigitalTwinModelsSortOrderEnumStringValues() []string
GetListDigitalTwinModelsSortOrderEnumStringValues Enumerates the set of values in String for ListDigitalTwinModelsSortOrderEnum
func GetListDigitalTwinRelationshipsLifecycleStateEnumStringValues() []string
GetListDigitalTwinRelationshipsLifecycleStateEnumStringValues Enumerates the set of values in String for ListDigitalTwinRelationshipsLifecycleStateEnum
func GetListDigitalTwinRelationshipsSortByEnumStringValues() []string
GetListDigitalTwinRelationshipsSortByEnumStringValues Enumerates the set of values in String for ListDigitalTwinRelationshipsSortByEnum
func GetListDigitalTwinRelationshipsSortOrderEnumStringValues() []string
GetListDigitalTwinRelationshipsSortOrderEnumStringValues Enumerates the set of values in String for ListDigitalTwinRelationshipsSortOrderEnum
func GetListIotDomainGroupsSortByEnumStringValues() []string
GetListIotDomainGroupsSortByEnumStringValues Enumerates the set of values in String for ListIotDomainGroupsSortByEnum
func GetListIotDomainGroupsSortOrderEnumStringValues() []string
GetListIotDomainGroupsSortOrderEnumStringValues Enumerates the set of values in String for ListIotDomainGroupsSortOrderEnum
func GetListIotDomainsSortByEnumStringValues() []string
GetListIotDomainsSortByEnumStringValues Enumerates the set of values in String for ListIotDomainsSortByEnum
func GetListIotDomainsSortOrderEnumStringValues() []string
GetListIotDomainsSortOrderEnumStringValues Enumerates the set of values in String for ListIotDomainsSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
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 GetWorkRequestResourceMetadataKeyEnumStringValues() []string
GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum
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"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
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
ApexDataAccessDetails This contains configuration for apex data access.
type ApexDataAccessDetails struct {
// Initial admin password for APEX workspace associated with the IoT domain.
DbWorkspaceAdminInitialPassword *string `mandatory:"true" json:"dbWorkspaceAdminInitialPassword"`
}
func (m ApexDataAccessDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ApexDataAccessDetails) String() string
func (m ApexDataAccessDetails) 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
ChangeIotDomainCompartmentDetails The configuration details for the move operation.
type ChangeIotDomainCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeIotDomainCompartmentDetails) String() string
func (m ChangeIotDomainCompartmentDetails) 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
ChangeIotDomainCompartmentRequest wrapper for the ChangeIotDomainCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ChangeIotDomainCompartment.go.html to see an example of how to use ChangeIotDomainCompartmentRequest.
type ChangeIotDomainCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain.
IotDomainId *string `mandatory:"true" contributesTo:"path" name:"iotDomainId"`
// Details for changing the IoT domain compartment.
ChangeIotDomainCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeIotDomainCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeIotDomainCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeIotDomainCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeIotDomainCompartmentRequest) String() string
func (request ChangeIotDomainCompartmentRequest) 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
ChangeIotDomainCompartmentResponse wrapper for the ChangeIotDomainCompartment operation
type ChangeIotDomainCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 ChangeIotDomainCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeIotDomainCompartmentResponse) String() string
ChangeIotDomainDataRetentionPeriodDetails The configuration details for data retention periods.
type ChangeIotDomainDataRetentionPeriodDetails struct {
// The type of data retention period to apply. Allowed values are RAW_DATA, REJECTED_DATA, HISTORIZED_DATA, and RAW_COMMAND_DATA.
Type ChangeIotDomainDataRetentionPeriodDetailsTypeEnum `mandatory:"true" json:"type"`
// The duration (in days) for which data will be retained in the IoT domain.
DataRetentionPeriodInDays *int `mandatory:"true" json:"dataRetentionPeriodInDays"`
}
func (m ChangeIotDomainDataRetentionPeriodDetails) String() string
func (m ChangeIotDomainDataRetentionPeriodDetails) 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
ChangeIotDomainDataRetentionPeriodDetailsTypeEnum Enum with underlying type: string
type ChangeIotDomainDataRetentionPeriodDetailsTypeEnum string
Set of constants representing the allowable values for ChangeIotDomainDataRetentionPeriodDetailsTypeEnum
const (
ChangeIotDomainDataRetentionPeriodDetailsTypeRawData ChangeIotDomainDataRetentionPeriodDetailsTypeEnum = "RAW_DATA"
ChangeIotDomainDataRetentionPeriodDetailsTypeRejectedData ChangeIotDomainDataRetentionPeriodDetailsTypeEnum = "REJECTED_DATA"
ChangeIotDomainDataRetentionPeriodDetailsTypeHistorizedData ChangeIotDomainDataRetentionPeriodDetailsTypeEnum = "HISTORIZED_DATA"
ChangeIotDomainDataRetentionPeriodDetailsTypeRawCommandData ChangeIotDomainDataRetentionPeriodDetailsTypeEnum = "RAW_COMMAND_DATA"
)
func GetChangeIotDomainDataRetentionPeriodDetailsTypeEnumValues() []ChangeIotDomainDataRetentionPeriodDetailsTypeEnum
GetChangeIotDomainDataRetentionPeriodDetailsTypeEnumValues Enumerates the set of values for ChangeIotDomainDataRetentionPeriodDetailsTypeEnum
func GetMappingChangeIotDomainDataRetentionPeriodDetailsTypeEnum(val string) (ChangeIotDomainDataRetentionPeriodDetailsTypeEnum, bool)
GetMappingChangeIotDomainDataRetentionPeriodDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ChangeIotDomainDataRetentionPeriodRequest wrapper for the ChangeIotDomainDataRetentionPeriod operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ChangeIotDomainDataRetentionPeriod.go.html to see an example of how to use ChangeIotDomainDataRetentionPeriodRequest.
type ChangeIotDomainDataRetentionPeriodRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain.
IotDomainId *string `mandatory:"true" contributesTo:"path" name:"iotDomainId"`
// Details for changing data retention period of IoT domain data.
ChangeIotDomainDataRetentionPeriodDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeIotDomainDataRetentionPeriodRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeIotDomainDataRetentionPeriodRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeIotDomainDataRetentionPeriodRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeIotDomainDataRetentionPeriodRequest) String() string
func (request ChangeIotDomainDataRetentionPeriodRequest) 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
ChangeIotDomainDataRetentionPeriodResponse wrapper for the ChangeIotDomainDataRetentionPeriod operation
type ChangeIotDomainDataRetentionPeriodResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 ChangeIotDomainDataRetentionPeriodResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeIotDomainDataRetentionPeriodResponse) String() string
ChangeIotDomainGroupCompartmentDetails The configuration details for the move operation.
type ChangeIotDomainGroupCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeIotDomainGroupCompartmentDetails) String() string
func (m ChangeIotDomainGroupCompartmentDetails) 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
ChangeIotDomainGroupCompartmentRequest wrapper for the ChangeIotDomainGroupCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ChangeIotDomainGroupCompartment.go.html to see an example of how to use ChangeIotDomainGroupCompartmentRequest.
type ChangeIotDomainGroupCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an IoT Domain Group.
IotDomainGroupId *string `mandatory:"true" contributesTo:"path" name:"iotDomainGroupId"`
// Details for changing the IoT domain group compartment.
ChangeIotDomainGroupCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeIotDomainGroupCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeIotDomainGroupCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeIotDomainGroupCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeIotDomainGroupCompartmentRequest) String() string
func (request ChangeIotDomainGroupCompartmentRequest) 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
ChangeIotDomainGroupCompartmentResponse wrapper for the ChangeIotDomainGroupCompartment operation
type ChangeIotDomainGroupCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 ChangeIotDomainGroupCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeIotDomainGroupCompartmentResponse) String() string
ConfigureIotDomainDataAccessDetails The configuration details for IoT Domain Data Access.
type ConfigureIotDomainDataAccessDetails interface {
}
ConfigureIotDomainDataAccessDetailsTypeEnum Enum with underlying type: string
type ConfigureIotDomainDataAccessDetailsTypeEnum string
Set of constants representing the allowable values for ConfigureIotDomainDataAccessDetailsTypeEnum
const (
ConfigureIotDomainDataAccessDetailsTypeDirect ConfigureIotDomainDataAccessDetailsTypeEnum = "DIRECT"
ConfigureIotDomainDataAccessDetailsTypeOrds ConfigureIotDomainDataAccessDetailsTypeEnum = "ORDS"
ConfigureIotDomainDataAccessDetailsTypeApex ConfigureIotDomainDataAccessDetailsTypeEnum = "APEX"
)
func GetConfigureIotDomainDataAccessDetailsTypeEnumValues() []ConfigureIotDomainDataAccessDetailsTypeEnum
GetConfigureIotDomainDataAccessDetailsTypeEnumValues Enumerates the set of values for ConfigureIotDomainDataAccessDetailsTypeEnum
func GetMappingConfigureIotDomainDataAccessDetailsTypeEnum(val string) (ConfigureIotDomainDataAccessDetailsTypeEnum, bool)
GetMappingConfigureIotDomainDataAccessDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ConfigureIotDomainDataAccessRequest wrapper for the ConfigureIotDomainDataAccess operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ConfigureIotDomainDataAccess.go.html to see an example of how to use ConfigureIotDomainDataAccessRequest.
type ConfigureIotDomainDataAccessRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain.
IotDomainId *string `mandatory:"true" contributesTo:"path" name:"iotDomainId"`
// Details for configuring data access.
ConfigureIotDomainDataAccessDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ConfigureIotDomainDataAccessRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ConfigureIotDomainDataAccessRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ConfigureIotDomainDataAccessRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ConfigureIotDomainDataAccessRequest) String() string
func (request ConfigureIotDomainDataAccessRequest) 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
ConfigureIotDomainDataAccessResponse wrapper for the ConfigureIotDomainDataAccess operation
type ConfigureIotDomainDataAccessResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 ConfigureIotDomainDataAccessResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ConfigureIotDomainDataAccessResponse) String() string
ConfigureIotDomainGroupDataAccessDetails The configuration details for an IoT Domain Group Data Access through allowlisted vcn ids.
type ConfigureIotDomainGroupDataAccessDetails struct {
// This is an array of VCN OCID (virtual cloud network Oracle Cloud ID) that is allowed to connect the data host.
DbAllowListedVcnIds []string `mandatory:"true" json:"dbAllowListedVcnIds"`
}
func (m ConfigureIotDomainGroupDataAccessDetails) String() string
func (m ConfigureIotDomainGroupDataAccessDetails) 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
ConfigureIotDomainGroupDataAccessRequest wrapper for the ConfigureIotDomainGroupDataAccess operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ConfigureIotDomainGroupDataAccess.go.html to see an example of how to use ConfigureIotDomainGroupDataAccessRequest.
type ConfigureIotDomainGroupDataAccessRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an IoT Domain Group.
IotDomainGroupId *string `mandatory:"true" contributesTo:"path" name:"iotDomainGroupId"`
// Details for configuring data access.
ConfigureIotDomainGroupDataAccessDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ConfigureIotDomainGroupDataAccessRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ConfigureIotDomainGroupDataAccessRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ConfigureIotDomainGroupDataAccessRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ConfigureIotDomainGroupDataAccessRequest) String() string
func (request ConfigureIotDomainGroupDataAccessRequest) 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
ConfigureIotDomainGroupDataAccessResponse wrapper for the ConfigureIotDomainGroupDataAccess operation
type ConfigureIotDomainGroupDataAccessResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 ConfigureIotDomainGroupDataAccessResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ConfigureIotDomainGroupDataAccessResponse) String() string
CreateDigitalTwinAdapterDetails The information about new digital twin adapter to be created.
type CreateDigitalTwinAdapterDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain.
IotDomainId *string `mandatory:"true" json:"iotDomainId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model.
DigitalTwinModelId *string `mandatory:"false" json:"digitalTwinModelId"`
// The URI of the digital twin model specification.
DigitalTwinModelSpecUri *string `mandatory:"false" json:"digitalTwinModelSpecUri"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
InboundEnvelope *DigitalTwinAdapterInboundEnvelope `mandatory:"false" json:"inboundEnvelope"`
// list of inbound routes
InboundRoutes []DigitalTwinAdapterInboundRoute `mandatory:"false" json:"inboundRoutes"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateDigitalTwinAdapterDetails) String() string
func (m CreateDigitalTwinAdapterDetails) 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
CreateDigitalTwinAdapterRequest wrapper for the CreateDigitalTwinAdapter operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/CreateDigitalTwinAdapter.go.html to see an example of how to use CreateDigitalTwinAdapterRequest.
type CreateDigitalTwinAdapterRequest struct {
// Details for the new digital twin adapter.
CreateDigitalTwinAdapterDetails `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"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 CreateDigitalTwinAdapterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDigitalTwinAdapterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDigitalTwinAdapterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDigitalTwinAdapterRequest) String() string
func (request CreateDigitalTwinAdapterRequest) 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
CreateDigitalTwinAdapterResponse wrapper for the CreateDigitalTwinAdapter operation
type CreateDigitalTwinAdapterResponse struct {
// The underlying http response
RawResponse *http.Response
// The DigitalTwinAdapter instance
DigitalTwinAdapter `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 CreateDigitalTwinAdapterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDigitalTwinAdapterResponse) String() string
CreateDigitalTwinInstanceDetails The information about new digital twin instance to be created.
type CreateDigitalTwinInstanceDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain.
IotDomainId *string `mandatory:"true" json:"iotDomainId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
AuthId *string `mandatory:"false" json:"authId"`
// A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance.
// This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case.
// If not provided, the system will automatically generate one.
ExternalKey *string `mandatory:"false" json:"externalKey"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter.
DigitalTwinAdapterId *string `mandatory:"false" json:"digitalTwinAdapterId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model.
DigitalTwinModelId *string `mandatory:"false" json:"digitalTwinModelId"`
// The URI of the digital twin model specification.
DigitalTwinModelSpecUri *string `mandatory:"false" json:"digitalTwinModelSpecUri"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateDigitalTwinInstanceDetails) String() string
func (m CreateDigitalTwinInstanceDetails) 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
CreateDigitalTwinInstanceRequest wrapper for the CreateDigitalTwinInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/CreateDigitalTwinInstance.go.html to see an example of how to use CreateDigitalTwinInstanceRequest.
type CreateDigitalTwinInstanceRequest struct {
// Details for the new digital twin instance.
CreateDigitalTwinInstanceDetails `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"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 CreateDigitalTwinInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDigitalTwinInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDigitalTwinInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDigitalTwinInstanceRequest) String() string
func (request CreateDigitalTwinInstanceRequest) 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
CreateDigitalTwinInstanceResponse wrapper for the CreateDigitalTwinInstance operation
type CreateDigitalTwinInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// The DigitalTwinInstance instance
DigitalTwinInstance `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 CreateDigitalTwinInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDigitalTwinInstanceResponse) String() string
CreateDigitalTwinModelDetails The information about new digital twin model to be created.
type CreateDigitalTwinModelDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain.
IotDomainId *string `mandatory:"true" json:"iotDomainId"`
// The specification of the digital twin model (DTDL).
Spec map[string]interface{} `mandatory:"true" json:"spec"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
// If left blank, the display name will be derived from the spec.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the resource. If left blank, the description will be derived from the spec.
Description *string `mandatory:"false" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateDigitalTwinModelDetails) String() string
func (m CreateDigitalTwinModelDetails) 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
CreateDigitalTwinModelRequest wrapper for the CreateDigitalTwinModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/CreateDigitalTwinModel.go.html to see an example of how to use CreateDigitalTwinModelRequest.
type CreateDigitalTwinModelRequest struct {
// Details for the new digital twin model.
CreateDigitalTwinModelDetails `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"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 CreateDigitalTwinModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDigitalTwinModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDigitalTwinModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDigitalTwinModelRequest) String() string
func (request CreateDigitalTwinModelRequest) 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
CreateDigitalTwinModelResponse wrapper for the CreateDigitalTwinModel operation
type CreateDigitalTwinModelResponse struct {
// The underlying http response
RawResponse *http.Response
// The DigitalTwinModel instance
DigitalTwinModel `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 CreateDigitalTwinModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDigitalTwinModelResponse) String() string
CreateDigitalTwinRelationshipDetails The information about new digital twin relationship to be created.
type CreateDigitalTwinRelationshipDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain.
IotDomainId *string `mandatory:"true" json:"iotDomainId"`
// Its the name of the relationship that links two digital twin instances. Here, it is the relationship name of the source digital twin model.
ContentPath *string `mandatory:"true" json:"contentPath"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of source digital twin instance.
SourceDigitalTwinInstanceId *string `mandatory:"true" json:"sourceDigitalTwinInstanceId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of target digital twin instance.
TargetDigitalTwinInstanceId *string `mandatory:"true" json:"targetDigitalTwinInstanceId"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// The value(s) of the relationship properties defined in the source digital twin model.
Content map[string]interface{} `mandatory:"false" json:"content"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateDigitalTwinRelationshipDetails) String() string
func (m CreateDigitalTwinRelationshipDetails) 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
CreateDigitalTwinRelationshipRequest wrapper for the CreateDigitalTwinRelationship operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/CreateDigitalTwinRelationship.go.html to see an example of how to use CreateDigitalTwinRelationshipRequest.
type CreateDigitalTwinRelationshipRequest struct {
// Details for the new digital twin relationship.
CreateDigitalTwinRelationshipDetails `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"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 CreateDigitalTwinRelationshipRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDigitalTwinRelationshipRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDigitalTwinRelationshipRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDigitalTwinRelationshipRequest) String() string
func (request CreateDigitalTwinRelationshipRequest) 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
CreateDigitalTwinRelationshipResponse wrapper for the CreateDigitalTwinRelationship operation
type CreateDigitalTwinRelationshipResponse struct {
// The underlying http response
RawResponse *http.Response
// The DigitalTwinRelationship instance
DigitalTwinRelationship `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 CreateDigitalTwinRelationshipResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDigitalTwinRelationshipResponse) String() string
CreateIotDomainDetails The information about new IoT domain to be created.
type CreateIotDomainDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain group.
IotDomainGroupId *string `mandatory:"true" json:"iotDomainGroupId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateIotDomainDetails) String() string
func (m CreateIotDomainDetails) 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
CreateIotDomainGroupDetails The information about new IoT domain group to be created.
type CreateIotDomainGroupDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateIotDomainGroupDetails) String() string
func (m CreateIotDomainGroupDetails) 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
CreateIotDomainGroupRequest wrapper for the CreateIotDomainGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/CreateIotDomainGroup.go.html to see an example of how to use CreateIotDomainGroupRequest.
type CreateIotDomainGroupRequest struct {
// Details for the new IoT domain group.
CreateIotDomainGroupDetails `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"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 CreateIotDomainGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateIotDomainGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateIotDomainGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateIotDomainGroupRequest) String() string
func (request CreateIotDomainGroupRequest) 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
CreateIotDomainGroupResponse wrapper for the CreateIotDomainGroup operation
type CreateIotDomainGroupResponse struct {
// The underlying http response
RawResponse *http.Response
// The IotDomainGroup instance
IotDomainGroup `presentIn:"body"`
// URL for the created IoT Domain Group. The IoT Domain Group OCID is generated after this request is sent.
Location *string `presentIn:"header" name:"location"`
// Same as location.
ContentLocation *string `presentIn:"header" name:"content-location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 CreateIotDomainGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateIotDomainGroupResponse) String() string
CreateIotDomainRequest wrapper for the CreateIotDomain operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/CreateIotDomain.go.html to see an example of how to use CreateIotDomainRequest.
type CreateIotDomainRequest struct {
// Details for the new IoT domain.
CreateIotDomainDetails `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"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 CreateIotDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateIotDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateIotDomainRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateIotDomainRequest) String() string
func (request CreateIotDomainRequest) 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
CreateIotDomainResponse wrapper for the CreateIotDomain operation
type CreateIotDomainResponse struct {
// The underlying http response
RawResponse *http.Response
// The IotDomain instance
IotDomain `presentIn:"body"`
// URL for the created IoT domain. The IoT domain OCID is generated after this request is sent.
Location *string `presentIn:"header" name:"location"`
// Same as location.
ContentLocation *string `presentIn:"header" name:"content-location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 CreateIotDomainResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateIotDomainResponse) String() string
DataRetentionPeriodsInDays Data Retention periods
type DataRetentionPeriodsInDays struct {
// Number of days for which any raw data sent to IoT devices would be retained for.
RawData *int `mandatory:"true" json:"rawData"`
// Number of days for which any data sent to IoT devices would be retained for.
RejectedData *int `mandatory:"true" json:"rejectedData"`
// Number of days for which any normalized data sent to IoT devices would be retained for.
HistorizedData *int `mandatory:"true" json:"historizedData"`
// Number of days for which any raw command data sent to IoT devices would be retained for.
RawCommandData *int `mandatory:"true" json:"rawCommandData"`
}
func (m DataRetentionPeriodsInDays) String() string
func (m DataRetentionPeriodsInDays) 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
DeleteDigitalTwinAdapterRequest wrapper for the DeleteDigitalTwinAdapter operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/DeleteDigitalTwinAdapter.go.html to see an example of how to use DeleteDigitalTwinAdapterRequest.
type DeleteDigitalTwinAdapterRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter.
DigitalTwinAdapterId *string `mandatory:"true" contributesTo:"path" name:"digitalTwinAdapterId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 DeleteDigitalTwinAdapterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDigitalTwinAdapterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDigitalTwinAdapterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDigitalTwinAdapterRequest) String() string
func (request DeleteDigitalTwinAdapterRequest) 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
DeleteDigitalTwinAdapterResponse wrapper for the DeleteDigitalTwinAdapter operation
type DeleteDigitalTwinAdapterResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteDigitalTwinAdapterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDigitalTwinAdapterResponse) String() string
DeleteDigitalTwinInstanceRequest wrapper for the DeleteDigitalTwinInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/DeleteDigitalTwinInstance.go.html to see an example of how to use DeleteDigitalTwinInstanceRequest.
type DeleteDigitalTwinInstanceRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of digital twin instance.
DigitalTwinInstanceId *string `mandatory:"true" contributesTo:"path" name:"digitalTwinInstanceId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 DeleteDigitalTwinInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDigitalTwinInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDigitalTwinInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDigitalTwinInstanceRequest) String() string
func (request DeleteDigitalTwinInstanceRequest) 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
DeleteDigitalTwinInstanceResponse wrapper for the DeleteDigitalTwinInstance operation
type DeleteDigitalTwinInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteDigitalTwinInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDigitalTwinInstanceResponse) String() string
DeleteDigitalTwinModelRequest wrapper for the DeleteDigitalTwinModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/DeleteDigitalTwinModel.go.html to see an example of how to use DeleteDigitalTwinModelRequest.
type DeleteDigitalTwinModelRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of digital twin model.
DigitalTwinModelId *string `mandatory:"true" contributesTo:"path" name:"digitalTwinModelId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 DeleteDigitalTwinModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDigitalTwinModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDigitalTwinModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDigitalTwinModelRequest) String() string
func (request DeleteDigitalTwinModelRequest) 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
DeleteDigitalTwinModelResponse wrapper for the DeleteDigitalTwinModel operation
type DeleteDigitalTwinModelResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteDigitalTwinModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDigitalTwinModelResponse) String() string
DeleteDigitalTwinRelationshipRequest wrapper for the DeleteDigitalTwinRelationship operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/DeleteDigitalTwinRelationship.go.html to see an example of how to use DeleteDigitalTwinRelationshipRequest.
type DeleteDigitalTwinRelationshipRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of digital twin relationship.
DigitalTwinRelationshipId *string `mandatory:"true" contributesTo:"path" name:"digitalTwinRelationshipId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 DeleteDigitalTwinRelationshipRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDigitalTwinRelationshipRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDigitalTwinRelationshipRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDigitalTwinRelationshipRequest) String() string
func (request DeleteDigitalTwinRelationshipRequest) 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
DeleteDigitalTwinRelationshipResponse wrapper for the DeleteDigitalTwinRelationship operation
type DeleteDigitalTwinRelationshipResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteDigitalTwinRelationshipResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDigitalTwinRelationshipResponse) String() string
DeleteIotDomainGroupRequest wrapper for the DeleteIotDomainGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/DeleteIotDomainGroup.go.html to see an example of how to use DeleteIotDomainGroupRequest.
type DeleteIotDomainGroupRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an IoT Domain Group.
IotDomainGroupId *string `mandatory:"true" contributesTo:"path" name:"iotDomainGroupId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 DeleteIotDomainGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteIotDomainGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteIotDomainGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteIotDomainGroupRequest) String() string
func (request DeleteIotDomainGroupRequest) 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
DeleteIotDomainGroupResponse wrapper for the DeleteIotDomainGroup operation
type DeleteIotDomainGroupResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 DeleteIotDomainGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteIotDomainGroupResponse) String() string
DeleteIotDomainRequest wrapper for the DeleteIotDomain operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/DeleteIotDomain.go.html to see an example of how to use DeleteIotDomainRequest.
type DeleteIotDomainRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain.
IotDomainId *string `mandatory:"true" contributesTo:"path" name:"iotDomainId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 DeleteIotDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteIotDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteIotDomainRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteIotDomainRequest) String() string
func (request DeleteIotDomainRequest) 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
DeleteIotDomainResponse wrapper for the DeleteIotDomain operation
type DeleteIotDomainResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 DeleteIotDomainResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteIotDomainResponse) String() string
DigitalTwinAdapter The digital twin adapter maps incoming data from IoT device into the corresponding digital twin instance. It defines the envelope structure, reference payload, routing and transformation rules using JSON Path and JQ to normalize the raw device data within the IoT domain. To use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who needs to create policies to grant users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
type DigitalTwinAdapter struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain.
IotDomainId *string `mandatory:"true" json:"iotDomainId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model.
DigitalTwinModelId *string `mandatory:"true" json:"digitalTwinModelId"`
// The URI of the digital twin model specification.
DigitalTwinModelSpecUri *string `mandatory:"true" json:"digitalTwinModelSpecUri"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The current state of the digital twin adapter.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time when the resource was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
InboundEnvelope *DigitalTwinAdapterInboundEnvelope `mandatory:"false" json:"inboundEnvelope"`
// list of routes
InboundRoutes []DigitalTwinAdapterInboundRoute `mandatory:"false" json:"inboundRoutes"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The date and time when the resource was last updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m DigitalTwinAdapter) String() string
func (m DigitalTwinAdapter) 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
DigitalTwinAdapterCollection Results of a digital twin adapter search. Contains both summary and additional metadata information.
type DigitalTwinAdapterCollection struct {
// List of the digital twin adapters.
Items []DigitalTwinAdapterSummary `mandatory:"true" json:"items"`
}
func (m DigitalTwinAdapterCollection) String() string
func (m DigitalTwinAdapterCollection) 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
DigitalTwinAdapterEnvelopeMapping Maps the metadata fields from the inbound payload using JQ. These mappings allow you to extract specific metadata such as timestamps using JQ expressions.
type DigitalTwinAdapterEnvelopeMapping struct {
// JQ expression to extract the observation timestamp from the payload. If not specified,
// the system will default to using `timeReceived` as the timestamp.
// Example: For payload `{"time": "<timestamp>","temp": 65,"hum": 55}`
// 'timeObserved' can be mapped as JQ Expression (https://jqplay.org/) `$.time`.
TimeObserved *string `mandatory:"false" json:"timeObserved"`
}
func (m DigitalTwinAdapterEnvelopeMapping) String() string
func (m DigitalTwinAdapterEnvelopeMapping) 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
DigitalTwinAdapterInboundEnvelope Payload containing device-specific metadata and optional value mappings used to interpret or transform that metadata. This structure includes the device endpoint, the actual payload, and an optional envelope mapping that applies JQ (https://stedolan.github.io/jq/) expressions to extract or reshape the data as needed.
type DigitalTwinAdapterInboundEnvelope struct {
// The device endpoint.
ReferenceEndpoint *string `mandatory:"true" json:"referenceEndpoint"`
ReferencePayload DigitalTwinAdapterPayload `mandatory:"false" json:"referencePayload"`
EnvelopeMapping *DigitalTwinAdapterEnvelopeMapping `mandatory:"false" json:"envelopeMapping"`
}
func (m DigitalTwinAdapterInboundEnvelope) String() string
func (m *DigitalTwinAdapterInboundEnvelope) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m DigitalTwinAdapterInboundEnvelope) 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
DigitalTwinAdapterInboundRoute Defines how inbound device payloads should be routed and mapped within a digital twin context. Routes are evaluated in the order they are defined, and only the first matching condition is processed. A final default route (with a condition that always evaluates to true) is recommended for fallback handling.
type DigitalTwinAdapterInboundRoute struct {
// A boolean expression used to determine whether the following transformation
// should be processed for the incoming payload. This expression is typically based
// on fields defined at the inbound Envelope and is evaluated before applying the `payloadMapping`.
Condition *string `mandatory:"true" json:"condition"`
ReferencePayload DigitalTwinAdapterPayload `mandatory:"false" json:"referencePayload"`
// A set of key-value JQ expressions used to transform the incoming payload into a shape
// compatible with the digital twin model's context or schema.
// The keys are target fields (in the digital twin model), and values are JQ expressions
// pointing to data in the reference payload.
// Example:
// Given payload:
// {
// "time": "<timestamp>",
// "temp": 65,
// "hum": 55
// }
// And mapping:
// {
// "temperature": "$.temp",
// "humidity": "$.hum",
// "timeObserved": "$.time"
// }
// The output will be:
// {
// "temperature": 65,
// "humidity": 55,
// "timeObserved": "<timestamp>"
// }
PayloadMapping map[string]string `mandatory:"false" json:"payloadMapping"`
// Meaningful write up about the inbound route.
Description *string `mandatory:"false" json:"description"`
}
func (m DigitalTwinAdapterInboundRoute) String() string
func (m *DigitalTwinAdapterInboundRoute) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m DigitalTwinAdapterInboundRoute) 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
DigitalTwinAdapterJsonPayload A payload structure containing JSON-formatted data from the digital twin device. This schema should be used when the parent payload 'dataFormat' is set to `JSON`. The `data` property contains the reference JSON content being passed from the device. Example: `{"temperature": 0,"location": {"type": "point"},"serialNumber": "<serialNumber>"}`
type DigitalTwinAdapterJsonPayload struct {
// JSON raw data.
Data map[string]interface{} `mandatory:"true" json:"data"`
}
func (m DigitalTwinAdapterJsonPayload) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DigitalTwinAdapterJsonPayload) String() string
func (m DigitalTwinAdapterJsonPayload) 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
DigitalTwinAdapterPayload Reference payload structure template received from IoT device. This payload must specify its content type using the `dataFormat` property.
type DigitalTwinAdapterPayload interface {
}
DigitalTwinAdapterPayloadDataFormatEnum Enum with underlying type: string
type DigitalTwinAdapterPayloadDataFormatEnum string
Set of constants representing the allowable values for DigitalTwinAdapterPayloadDataFormatEnum
const (
DigitalTwinAdapterPayloadDataFormatJson DigitalTwinAdapterPayloadDataFormatEnum = "JSON"
)
func GetDigitalTwinAdapterPayloadDataFormatEnumValues() []DigitalTwinAdapterPayloadDataFormatEnum
GetDigitalTwinAdapterPayloadDataFormatEnumValues Enumerates the set of values for DigitalTwinAdapterPayloadDataFormatEnum
func GetMappingDigitalTwinAdapterPayloadDataFormatEnum(val string) (DigitalTwinAdapterPayloadDataFormatEnum, bool)
GetMappingDigitalTwinAdapterPayloadDataFormatEnum performs case Insensitive comparison on enum value and return the desired enum
DigitalTwinAdapterSummary Summary information about a digital twin adapter.
type DigitalTwinAdapterSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain.
IotDomainId *string `mandatory:"true" json:"iotDomainId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model.
DigitalTwinModelId *string `mandatory:"true" json:"digitalTwinModelId"`
// The URI of the digital twin model specification.
DigitalTwinModelSpecUri *string `mandatory:"true" json:"digitalTwinModelSpecUri"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The current state of the the digital twin adapter.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time when the resource was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The date and time when the resource was last updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m DigitalTwinAdapterSummary) String() string
func (m DigitalTwinAdapterSummary) 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
DigitalTwinInstance A digital twin instance is a virtual representation of a physical IoT device within the IoT domain. To use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who needs to create policies to grant users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
type DigitalTwinInstance struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain.
IotDomainId *string `mandatory:"true" json:"iotDomainId"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The current state of the digital twin instance.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time when the resource was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
AuthId *string `mandatory:"false" json:"authId"`
// A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance.
// This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case.
// If not provided, the system will automatically generate one.
ExternalKey *string `mandatory:"false" json:"externalKey"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model.
DigitalTwinModelId *string `mandatory:"false" json:"digitalTwinModelId"`
// The URI of the digital twin model specification.
DigitalTwinModelSpecUri *string `mandatory:"false" json:"digitalTwinModelSpecUri"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter.
DigitalTwinAdapterId *string `mandatory:"false" json:"digitalTwinAdapterId"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The date and time when the resource was last updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m DigitalTwinInstance) String() string
func (m DigitalTwinInstance) 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
DigitalTwinInstanceCollection Results of digital twin instance search. Contains both summary and additional metadata information
type DigitalTwinInstanceCollection struct {
// List of digital twin instances.
Items []DigitalTwinInstanceSummary `mandatory:"true" json:"items"`
}
func (m DigitalTwinInstanceCollection) String() string
func (m DigitalTwinInstanceCollection) 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
DigitalTwinInstanceSummary Summary of the digital twin instance
type DigitalTwinInstanceSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain.
IotDomainId *string `mandatory:"true" json:"iotDomainId"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The current state of the digital twin instance.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time when the resource was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
AuthId *string `mandatory:"false" json:"authId"`
// A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance.
// This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case.
// If not provided, the system will automatically generate one.
ExternalKey *string `mandatory:"false" json:"externalKey"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model.
DigitalTwinModelId *string `mandatory:"false" json:"digitalTwinModelId"`
// The URI of the digital twin model specification.
DigitalTwinModelSpecUri *string `mandatory:"false" json:"digitalTwinModelSpecUri"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter.
DigitalTwinAdapterId *string `mandatory:"false" json:"digitalTwinAdapterId"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The date and time when the resource was last updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m DigitalTwinInstanceSummary) String() string
func (m DigitalTwinInstanceSummary) 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
DigitalTwinModel A digital twin model, defined using Digital Twins Definition Language (https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v3/DTDL.v3.md), specifies the schema for digital twin instance, including its components, properties, telemetry, commands, and relationships within the IoT domain. To use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who needs to create policies to grant users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
type DigitalTwinModel struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain.
IotDomainId *string `mandatory:"true" json:"iotDomainId"`
// This is the DTMI (Digital Twin Model Identifier) of the digital twin model as defined in DTDL specification.
SpecUri *string `mandatory:"true" json:"specUri"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
// If left blank, the display name will be derived from the spec.
DisplayName *string `mandatory:"true" json:"displayName"`
// The current state of the digital twin model.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time when the resource was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A short description of the resource. If left blank, the description will be derived from the spec.
Description *string `mandatory:"false" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The date and time when the resource was last updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m DigitalTwinModel) String() string
func (m DigitalTwinModel) 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
DigitalTwinModelCollection Results of a digital twin model search. Contains both summary and additional metadata information.
type DigitalTwinModelCollection struct {
// List of digital twin models.
Items []DigitalTwinModelSummary `mandatory:"true" json:"items"`
}
func (m DigitalTwinModelCollection) String() string
func (m DigitalTwinModelCollection) 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
DigitalTwinModelSummary Summary of the digital twin model.
type DigitalTwinModelSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain.
IotDomainId *string `mandatory:"true" json:"iotDomainId"`
// This is the DTMI (Digital Twin Model Identifier) of the digital twin model as defined in DTDL specification.
SpecUri *string `mandatory:"true" json:"specUri"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
// If left blank, the display name will be derived from the spec.
DisplayName *string `mandatory:"true" json:"displayName"`
// The current state of the digital twin model.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time when the resource was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A short description of the resource. If left blank, the description will be derived from the spec.
Description *string `mandatory:"false" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The date and time when the resource was last updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m DigitalTwinModelSummary) String() string
func (m DigitalTwinModelSummary) 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
DigitalTwinRelationship A digital twin relationship represents an association between two digital twin instances. It can include properties to describe the nature and context of the association within the IoT domain. To use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who needs to create policies to grant users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
type DigitalTwinRelationship struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain.
IotDomainId *string `mandatory:"true" json:"iotDomainId"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Its the name of the relationship that links two digital twin instances. Here, it is the relationship name of the source digital twin model.
ContentPath *string `mandatory:"true" json:"contentPath"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of source digital twin instance.
SourceDigitalTwinInstanceId *string `mandatory:"true" json:"sourceDigitalTwinInstanceId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of target digital twin instance.
TargetDigitalTwinInstanceId *string `mandatory:"true" json:"targetDigitalTwinInstanceId"`
// The current state of the digital twin relationship.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time when the resource was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// The value(s) of the relationship properties defined in the source digital twin model.
Content map[string]interface{} `mandatory:"false" json:"content"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The date and time when the resource was last updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m DigitalTwinRelationship) String() string
func (m DigitalTwinRelationship) 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
DigitalTwinRelationshipCollection Results of digital twin relationships search. Contains both summary and additional metadata information
type DigitalTwinRelationshipCollection struct {
// List of digital twin relationships
Items []DigitalTwinRelationshipSummary `mandatory:"true" json:"items"`
}
func (m DigitalTwinRelationshipCollection) String() string
func (m DigitalTwinRelationshipCollection) 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
DigitalTwinRelationshipSummary Describes digital twin relationship summary
type DigitalTwinRelationshipSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain.
IotDomainId *string `mandatory:"true" json:"iotDomainId"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Its the name of the relationship that links two digital twin instances. Here, it is the relationship name of the source digital twin model.
ContentPath *string `mandatory:"true" json:"contentPath"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of source digital twin instance.
SourceDigitalTwinInstanceId *string `mandatory:"true" json:"sourceDigitalTwinInstanceId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of target digital twin instance.
TargetDigitalTwinInstanceId *string `mandatory:"true" json:"targetDigitalTwinInstanceId"`
// The current state of the digital twin relationship.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time when the resource was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The date and time when the resource was last updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m DigitalTwinRelationshipSummary) String() string
func (m DigitalTwinRelationshipSummary) 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
DirectDataAccessDetails This contains configuration for direct data access.
type DirectDataAccessDetails struct {
// List of IAM groups of form described in here (https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/mnqmn/#GUID-3634D6C9-A7F1-4875-9925-BAEA2D3C5197) that are allowed to directly connect to the data host.
DbAllowListedIdentityGroupNames []string `mandatory:"true" json:"dbAllowListedIdentityGroupNames"`
}
func (m DirectDataAccessDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DirectDataAccessDetails) String() string
func (m DirectDataAccessDetails) 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
ErrorDetails Error Information.
type ErrorDetails struct {
// A short error code that defines the error, meant for programmatic parsing.
Code *string `mandatory:"true" json:"code"`
// A human-readable error string.
Message *string `mandatory:"true" json:"message"`
}
func (m ErrorDetails) String() string
func (m ErrorDetails) 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
GetDigitalTwinAdapterRequest wrapper for the GetDigitalTwinAdapter operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/GetDigitalTwinAdapter.go.html to see an example of how to use GetDigitalTwinAdapterRequest.
type GetDigitalTwinAdapterRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter.
DigitalTwinAdapterId *string `mandatory:"true" contributesTo:"path" name:"digitalTwinAdapterId"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 GetDigitalTwinAdapterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDigitalTwinAdapterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDigitalTwinAdapterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDigitalTwinAdapterRequest) String() string
func (request GetDigitalTwinAdapterRequest) 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
GetDigitalTwinAdapterResponse wrapper for the GetDigitalTwinAdapter operation
type GetDigitalTwinAdapterResponse struct {
// The underlying http response
RawResponse *http.Response
// The DigitalTwinAdapter instance
DigitalTwinAdapter `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 GetDigitalTwinAdapterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDigitalTwinAdapterResponse) String() string
GetDigitalTwinInstanceContentRequest wrapper for the GetDigitalTwinInstanceContent operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/GetDigitalTwinInstanceContent.go.html to see an example of how to use GetDigitalTwinInstanceContentRequest.
type GetDigitalTwinInstanceContentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of digital twin instance.
DigitalTwinInstanceId *string `mandatory:"true" contributesTo:"path" name:"digitalTwinInstanceId"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// If set to true , digital twin instance metadata is included in the response.
ShouldIncludeMetadata *bool `mandatory:"false" contributesTo:"query" name:"shouldIncludeMetadata"`
// 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 GetDigitalTwinInstanceContentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDigitalTwinInstanceContentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDigitalTwinInstanceContentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDigitalTwinInstanceContentRequest) String() string
func (request GetDigitalTwinInstanceContentRequest) 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
GetDigitalTwinInstanceContentResponse wrapper for the GetDigitalTwinInstanceContent operation
type GetDigitalTwinInstanceContentResponse struct {
// The underlying http response
RawResponse *http.Response
// The map[string]interface{} instance
Object map[string]interface{} `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 GetDigitalTwinInstanceContentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDigitalTwinInstanceContentResponse) String() string
GetDigitalTwinInstanceRequest wrapper for the GetDigitalTwinInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/GetDigitalTwinInstance.go.html to see an example of how to use GetDigitalTwinInstanceRequest.
type GetDigitalTwinInstanceRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of digital twin instance.
DigitalTwinInstanceId *string `mandatory:"true" contributesTo:"path" name:"digitalTwinInstanceId"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 GetDigitalTwinInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDigitalTwinInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDigitalTwinInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDigitalTwinInstanceRequest) String() string
func (request GetDigitalTwinInstanceRequest) 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
GetDigitalTwinInstanceResponse wrapper for the GetDigitalTwinInstance operation
type GetDigitalTwinInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// The DigitalTwinInstance instance
DigitalTwinInstance `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 GetDigitalTwinInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDigitalTwinInstanceResponse) String() string
GetDigitalTwinModelRequest wrapper for the GetDigitalTwinModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/GetDigitalTwinModel.go.html to see an example of how to use GetDigitalTwinModelRequest.
type GetDigitalTwinModelRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of digital twin model.
DigitalTwinModelId *string `mandatory:"true" contributesTo:"path" name:"digitalTwinModelId"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 GetDigitalTwinModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDigitalTwinModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDigitalTwinModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDigitalTwinModelRequest) String() string
func (request GetDigitalTwinModelRequest) 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
GetDigitalTwinModelResponse wrapper for the GetDigitalTwinModel operation
type GetDigitalTwinModelResponse struct {
// The underlying http response
RawResponse *http.Response
// The DigitalTwinModel instance
DigitalTwinModel `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 GetDigitalTwinModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDigitalTwinModelResponse) String() string
GetDigitalTwinModelSpecRequest wrapper for the GetDigitalTwinModelSpec operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/GetDigitalTwinModelSpec.go.html to see an example of how to use GetDigitalTwinModelSpecRequest.
type GetDigitalTwinModelSpecRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of digital twin model.
DigitalTwinModelId *string `mandatory:"true" contributesTo:"path" name:"digitalTwinModelId"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 GetDigitalTwinModelSpecRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDigitalTwinModelSpecRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDigitalTwinModelSpecRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDigitalTwinModelSpecRequest) String() string
func (request GetDigitalTwinModelSpecRequest) 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
GetDigitalTwinModelSpecResponse wrapper for the GetDigitalTwinModelSpec operation
type GetDigitalTwinModelSpecResponse struct {
// The underlying http response
RawResponse *http.Response
// The map[string]interface{} instance
Object map[string]interface{} `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 GetDigitalTwinModelSpecResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDigitalTwinModelSpecResponse) String() string
GetDigitalTwinRelationshipRequest wrapper for the GetDigitalTwinRelationship operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/GetDigitalTwinRelationship.go.html to see an example of how to use GetDigitalTwinRelationshipRequest.
type GetDigitalTwinRelationshipRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of digital twin relationship.
DigitalTwinRelationshipId *string `mandatory:"true" contributesTo:"path" name:"digitalTwinRelationshipId"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 GetDigitalTwinRelationshipRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDigitalTwinRelationshipRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDigitalTwinRelationshipRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDigitalTwinRelationshipRequest) String() string
func (request GetDigitalTwinRelationshipRequest) 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
GetDigitalTwinRelationshipResponse wrapper for the GetDigitalTwinRelationship operation
type GetDigitalTwinRelationshipResponse struct {
// The underlying http response
RawResponse *http.Response
// The DigitalTwinRelationship instance
DigitalTwinRelationship `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 GetDigitalTwinRelationshipResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDigitalTwinRelationshipResponse) String() string
GetIotDomainGroupRequest wrapper for the GetIotDomainGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/GetIotDomainGroup.go.html to see an example of how to use GetIotDomainGroupRequest.
type GetIotDomainGroupRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an IoT Domain Group.
IotDomainGroupId *string `mandatory:"true" contributesTo:"path" name:"iotDomainGroupId"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 GetIotDomainGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetIotDomainGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetIotDomainGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetIotDomainGroupRequest) String() string
func (request GetIotDomainGroupRequest) 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
GetIotDomainGroupResponse wrapper for the GetIotDomainGroup operation
type GetIotDomainGroupResponse struct {
// The underlying http response
RawResponse *http.Response
// The IotDomainGroup instance
IotDomainGroup `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 GetIotDomainGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetIotDomainGroupResponse) String() string
GetIotDomainRequest wrapper for the GetIotDomain operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/GetIotDomain.go.html to see an example of how to use GetIotDomainRequest.
type GetIotDomainRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain.
IotDomainId *string `mandatory:"true" contributesTo:"path" name:"iotDomainId"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 GetIotDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetIotDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetIotDomainRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetIotDomainRequest) String() string
func (request GetIotDomainRequest) 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
GetIotDomainResponse wrapper for the GetIotDomain operation
type GetIotDomainResponse struct {
// The underlying http response
RawResponse *http.Response
// The IotDomain instance
IotDomain `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 GetIotDomainResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetIotDomainResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
InvokeRawBinaryCommandDetails Binary data payload definition
type InvokeRawBinaryCommandDetails struct {
// Device endpoint where request should be forwarded to.
RequestEndpoint *string `mandatory:"true" json:"requestEndpoint"`
// Specified duration by which to send the request by.
RequestDuration *string `mandatory:"false" json:"requestDuration"`
// Specified duration by which to receive the response by.
ResponseDuration *string `mandatory:"false" json:"responseDuration"`
// Device endpoint from which response is expected to come.
ResponseEndpoint *string `mandatory:"false" json:"responseEndpoint"`
// Mime content type of data encoded using base64, default is application/octet-stream
RequestDataContentType *string `mandatory:"false" json:"requestDataContentType"`
// base 64 encoded request data
RequestData *string `mandatory:"false" json:"requestData"`
}
func (m InvokeRawBinaryCommandDetails) GetRequestDuration() *string
GetRequestDuration returns RequestDuration
func (m InvokeRawBinaryCommandDetails) GetRequestEndpoint() *string
GetRequestEndpoint returns RequestEndpoint
func (m InvokeRawBinaryCommandDetails) GetResponseDuration() *string
GetResponseDuration returns ResponseDuration
func (m InvokeRawBinaryCommandDetails) GetResponseEndpoint() *string
GetResponseEndpoint returns ResponseEndpoint
func (m InvokeRawBinaryCommandDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m InvokeRawBinaryCommandDetails) String() string
func (m InvokeRawBinaryCommandDetails) 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
InvokeRawCommandDetails Definition of unstructured command invocation payload
type InvokeRawCommandDetails interface {
// Device endpoint where request should be forwarded to.
GetRequestEndpoint() *string
// Specified duration by which to send the request by.
GetRequestDuration() *string
// Specified duration by which to receive the response by.
GetResponseDuration() *string
// Device endpoint from which response is expected to come.
GetResponseEndpoint() *string
}
InvokeRawCommandDetailsRequestDataFormatEnum Enum with underlying type: string
type InvokeRawCommandDetailsRequestDataFormatEnum string
Set of constants representing the allowable values for InvokeRawCommandDetailsRequestDataFormatEnum
const (
InvokeRawCommandDetailsRequestDataFormatText InvokeRawCommandDetailsRequestDataFormatEnum = "TEXT"
InvokeRawCommandDetailsRequestDataFormatJson InvokeRawCommandDetailsRequestDataFormatEnum = "JSON"
InvokeRawCommandDetailsRequestDataFormatBinary InvokeRawCommandDetailsRequestDataFormatEnum = "BINARY"
)
func GetInvokeRawCommandDetailsRequestDataFormatEnumValues() []InvokeRawCommandDetailsRequestDataFormatEnum
GetInvokeRawCommandDetailsRequestDataFormatEnumValues Enumerates the set of values for InvokeRawCommandDetailsRequestDataFormatEnum
func GetMappingInvokeRawCommandDetailsRequestDataFormatEnum(val string) (InvokeRawCommandDetailsRequestDataFormatEnum, bool)
GetMappingInvokeRawCommandDetailsRequestDataFormatEnum performs case Insensitive comparison on enum value and return the desired enum
InvokeRawCommandRequest wrapper for the InvokeRawCommand operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/InvokeRawCommand.go.html to see an example of how to use InvokeRawCommandRequest.
type InvokeRawCommandRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of digital twin instance.
DigitalTwinInstanceId *string `mandatory:"true" contributesTo:"path" name:"digitalTwinInstanceId"`
// Details for the raw command invocation.
InvokeRawCommandDetails `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"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 InvokeRawCommandRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request InvokeRawCommandRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request InvokeRawCommandRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request InvokeRawCommandRequest) String() string
func (request InvokeRawCommandRequest) 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
InvokeRawCommandResponse wrapper for the InvokeRawCommand operation
type InvokeRawCommandResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// URL where the status of command invocation could be retrieved
ContentLocation *string `presentIn:"header" name:"content-location"`
}
func (response InvokeRawCommandResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response InvokeRawCommandResponse) String() string
InvokeRawJsonCommandDetails Json data payload definition
type InvokeRawJsonCommandDetails struct {
// Device endpoint where request should be forwarded to.
RequestEndpoint *string `mandatory:"true" json:"requestEndpoint"`
// Specified duration by which to send the request by.
RequestDuration *string `mandatory:"false" json:"requestDuration"`
// Specified duration by which to receive the response by.
ResponseDuration *string `mandatory:"false" json:"responseDuration"`
// Device endpoint from which response is expected to come.
ResponseEndpoint *string `mandatory:"false" json:"responseEndpoint"`
// Mime content type of json data, default is application/json
RequestDataContentType *string `mandatory:"false" json:"requestDataContentType"`
// request data
RequestData map[string]interface{} `mandatory:"false" json:"requestData"`
}
func (m InvokeRawJsonCommandDetails) GetRequestDuration() *string
GetRequestDuration returns RequestDuration
func (m InvokeRawJsonCommandDetails) GetRequestEndpoint() *string
GetRequestEndpoint returns RequestEndpoint
func (m InvokeRawJsonCommandDetails) GetResponseDuration() *string
GetResponseDuration returns ResponseDuration
func (m InvokeRawJsonCommandDetails) GetResponseEndpoint() *string
GetResponseEndpoint returns ResponseEndpoint
func (m InvokeRawJsonCommandDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m InvokeRawJsonCommandDetails) String() string
func (m InvokeRawJsonCommandDetails) 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
InvokeRawTextCommandDetails Text data payload definition
type InvokeRawTextCommandDetails struct {
// Device endpoint where request should be forwarded to.
RequestEndpoint *string `mandatory:"true" json:"requestEndpoint"`
// Specified duration by which to send the request by.
RequestDuration *string `mandatory:"false" json:"requestDuration"`
// Specified duration by which to receive the response by.
ResponseDuration *string `mandatory:"false" json:"responseDuration"`
// Device endpoint from which response is expected to come.
ResponseEndpoint *string `mandatory:"false" json:"responseEndpoint"`
// Mime content type of text data, default is text/plain
RequestDataContentType *string `mandatory:"false" json:"requestDataContentType"`
// Plain text request data
RequestData *string `mandatory:"false" json:"requestData"`
}
func (m InvokeRawTextCommandDetails) GetRequestDuration() *string
GetRequestDuration returns RequestDuration
func (m InvokeRawTextCommandDetails) GetRequestEndpoint() *string
GetRequestEndpoint returns RequestEndpoint
func (m InvokeRawTextCommandDetails) GetResponseDuration() *string
GetResponseDuration returns ResponseDuration
func (m InvokeRawTextCommandDetails) GetResponseEndpoint() *string
GetResponseEndpoint returns ResponseEndpoint
func (m InvokeRawTextCommandDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m InvokeRawTextCommandDetails) String() string
func (m InvokeRawTextCommandDetails) 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
IotClient a client for Iot
type IotClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewIotClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client IotClient, err error)
NewIotClientWithConfigurationProvider Creates a new default Iot client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewIotClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client IotClient, err error)
NewIotClientWithOboToken Creates a new default Iot 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 IotClient) ChangeIotDomainCompartment(ctx context.Context, request ChangeIotDomainCompartmentRequest) (response ChangeIotDomainCompartmentResponse, err error)
ChangeIotDomainCompartment Moves an IoT domain to a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ChangeIotDomainCompartment.go.html to see an example of how to use ChangeIotDomainCompartment API. A default retry strategy applies to this operation ChangeIotDomainCompartment()
func (client IotClient) ChangeIotDomainDataRetentionPeriod(ctx context.Context, request ChangeIotDomainDataRetentionPeriodRequest) (response ChangeIotDomainDataRetentionPeriodResponse, err error)
ChangeIotDomainDataRetentionPeriod Updates Data Retention Period of the IoT Domain.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ChangeIotDomainDataRetentionPeriod.go.html to see an example of how to use ChangeIotDomainDataRetentionPeriod API. A default retry strategy applies to this operation ChangeIotDomainDataRetentionPeriod()
func (client IotClient) ChangeIotDomainGroupCompartment(ctx context.Context, request ChangeIotDomainGroupCompartmentRequest) (response ChangeIotDomainGroupCompartmentResponse, err error)
ChangeIotDomainGroupCompartment Moves an IoT domain group to a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ChangeIotDomainGroupCompartment.go.html to see an example of how to use ChangeIotDomainGroupCompartment API. A default retry strategy applies to this operation ChangeIotDomainGroupCompartment()
func (client *IotClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client IotClient) ConfigureIotDomainDataAccess(ctx context.Context, request ConfigureIotDomainDataAccessRequest) (response ConfigureIotDomainDataAccessResponse, err error)
ConfigureIotDomainDataAccess Updates an IoT domain Data Access.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ConfigureIotDomainDataAccess.go.html to see an example of how to use ConfigureIotDomainDataAccess API. A default retry strategy applies to this operation ConfigureIotDomainDataAccess()
func (client IotClient) ConfigureIotDomainGroupDataAccess(ctx context.Context, request ConfigureIotDomainGroupDataAccessRequest) (response ConfigureIotDomainGroupDataAccessResponse, err error)
ConfigureIotDomainGroupDataAccess Updates an IoT domain Group Data Access.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ConfigureIotDomainGroupDataAccess.go.html to see an example of how to use ConfigureIotDomainGroupDataAccess API. A default retry strategy applies to this operation ConfigureIotDomainGroupDataAccess()
func (client IotClient) CreateDigitalTwinAdapter(ctx context.Context, request CreateDigitalTwinAdapterRequest) (response CreateDigitalTwinAdapterResponse, err error)
CreateDigitalTwinAdapter Creates a new digital twin adapter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/CreateDigitalTwinAdapter.go.html to see an example of how to use CreateDigitalTwinAdapter API. A default retry strategy applies to this operation CreateDigitalTwinAdapter()
func (client IotClient) CreateDigitalTwinInstance(ctx context.Context, request CreateDigitalTwinInstanceRequest) (response CreateDigitalTwinInstanceResponse, err error)
CreateDigitalTwinInstance Creates a new digital twin instance.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/CreateDigitalTwinInstance.go.html to see an example of how to use CreateDigitalTwinInstance API. A default retry strategy applies to this operation CreateDigitalTwinInstance()
func (client IotClient) CreateDigitalTwinModel(ctx context.Context, request CreateDigitalTwinModelRequest) (response CreateDigitalTwinModelResponse, err error)
CreateDigitalTwinModel Creates a new digital twin model.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/CreateDigitalTwinModel.go.html to see an example of how to use CreateDigitalTwinModel API. A default retry strategy applies to this operation CreateDigitalTwinModel()
func (client IotClient) CreateDigitalTwinRelationship(ctx context.Context, request CreateDigitalTwinRelationshipRequest) (response CreateDigitalTwinRelationshipResponse, err error)
CreateDigitalTwinRelationship Creates a new digital twin relationship.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/CreateDigitalTwinRelationship.go.html to see an example of how to use CreateDigitalTwinRelationship API. A default retry strategy applies to this operation CreateDigitalTwinRelationship()
func (client IotClient) CreateIotDomain(ctx context.Context, request CreateIotDomainRequest) (response CreateIotDomainResponse, err error)
CreateIotDomain Creates a new IoT domain.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/CreateIotDomain.go.html to see an example of how to use CreateIotDomain API. A default retry strategy applies to this operation CreateIotDomain()
func (client IotClient) CreateIotDomainGroup(ctx context.Context, request CreateIotDomainGroupRequest) (response CreateIotDomainGroupResponse, err error)
CreateIotDomainGroup Creates a new IoT domain group.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/CreateIotDomainGroup.go.html to see an example of how to use CreateIotDomainGroup API. A default retry strategy applies to this operation CreateIotDomainGroup()
func (client IotClient) DeleteDigitalTwinAdapter(ctx context.Context, request DeleteDigitalTwinAdapterRequest) (response DeleteDigitalTwinAdapterResponse, err error)
DeleteDigitalTwinAdapter Deletes the digital twin adapter identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/DeleteDigitalTwinAdapter.go.html to see an example of how to use DeleteDigitalTwinAdapter API. A default retry strategy applies to this operation DeleteDigitalTwinAdapter()
func (client IotClient) DeleteDigitalTwinInstance(ctx context.Context, request DeleteDigitalTwinInstanceRequest) (response DeleteDigitalTwinInstanceResponse, err error)
DeleteDigitalTwinInstance Deletes the digital twin instance identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/DeleteDigitalTwinInstance.go.html to see an example of how to use DeleteDigitalTwinInstance API. A default retry strategy applies to this operation DeleteDigitalTwinInstance()
func (client IotClient) DeleteDigitalTwinModel(ctx context.Context, request DeleteDigitalTwinModelRequest) (response DeleteDigitalTwinModelResponse, err error)
DeleteDigitalTwinModel Deletes the digital twin model identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/DeleteDigitalTwinModel.go.html to see an example of how to use DeleteDigitalTwinModel API. A default retry strategy applies to this operation DeleteDigitalTwinModel()
func (client IotClient) DeleteDigitalTwinRelationship(ctx context.Context, request DeleteDigitalTwinRelationshipRequest) (response DeleteDigitalTwinRelationshipResponse, err error)
DeleteDigitalTwinRelationship Deletes the digital twin relationship identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/DeleteDigitalTwinRelationship.go.html to see an example of how to use DeleteDigitalTwinRelationship API. A default retry strategy applies to this operation DeleteDigitalTwinRelationship()
func (client IotClient) DeleteIotDomain(ctx context.Context, request DeleteIotDomainRequest) (response DeleteIotDomainResponse, err error)
DeleteIotDomain Deletes the IoT domain identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/DeleteIotDomain.go.html to see an example of how to use DeleteIotDomain API. A default retry strategy applies to this operation DeleteIotDomain()
func (client IotClient) DeleteIotDomainGroup(ctx context.Context, request DeleteIotDomainGroupRequest) (response DeleteIotDomainGroupResponse, err error)
DeleteIotDomainGroup Deletes the IoT domain group identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/DeleteIotDomainGroup.go.html to see an example of how to use DeleteIotDomainGroup API. A default retry strategy applies to this operation DeleteIotDomainGroup()
func (client IotClient) GetDigitalTwinAdapter(ctx context.Context, request GetDigitalTwinAdapterRequest) (response GetDigitalTwinAdapterResponse, err error)
GetDigitalTwinAdapter Retrieves the digital twin adapter identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/GetDigitalTwinAdapter.go.html to see an example of how to use GetDigitalTwinAdapter API. A default retry strategy applies to this operation GetDigitalTwinAdapter()
func (client IotClient) GetDigitalTwinInstance(ctx context.Context, request GetDigitalTwinInstanceRequest) (response GetDigitalTwinInstanceResponse, err error)
GetDigitalTwinInstance Retrieves the digital twin instance identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/GetDigitalTwinInstance.go.html to see an example of how to use GetDigitalTwinInstance API. A default retry strategy applies to this operation GetDigitalTwinInstance()
func (client IotClient) GetDigitalTwinInstanceContent(ctx context.Context, request GetDigitalTwinInstanceContentRequest) (response GetDigitalTwinInstanceContentResponse, err error)
GetDigitalTwinInstanceContent Retrieves the latest snapshot data of digital twin instance identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/GetDigitalTwinInstanceContent.go.html to see an example of how to use GetDigitalTwinInstanceContent API. A default retry strategy applies to this operation GetDigitalTwinInstanceContent()
func (client IotClient) GetDigitalTwinModel(ctx context.Context, request GetDigitalTwinModelRequest) (response GetDigitalTwinModelResponse, err error)
GetDigitalTwinModel Retrieves the digital twin model identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/GetDigitalTwinModel.go.html to see an example of how to use GetDigitalTwinModel API. A default retry strategy applies to this operation GetDigitalTwinModel()
func (client IotClient) GetDigitalTwinModelSpec(ctx context.Context, request GetDigitalTwinModelSpecRequest) (response GetDigitalTwinModelSpecResponse, err error)
GetDigitalTwinModelSpec Retrieves the spec of digital twin model identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/GetDigitalTwinModelSpec.go.html to see an example of how to use GetDigitalTwinModelSpec API. A default retry strategy applies to this operation GetDigitalTwinModelSpec()
func (client IotClient) GetDigitalTwinRelationship(ctx context.Context, request GetDigitalTwinRelationshipRequest) (response GetDigitalTwinRelationshipResponse, err error)
GetDigitalTwinRelationship Retrieves the digital twin relationship identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/GetDigitalTwinRelationship.go.html to see an example of how to use GetDigitalTwinRelationship API. A default retry strategy applies to this operation GetDigitalTwinRelationship()
func (client IotClient) GetIotDomain(ctx context.Context, request GetIotDomainRequest) (response GetIotDomainResponse, err error)
GetIotDomain Retrieves the IoT domain identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/GetIotDomain.go.html to see an example of how to use GetIotDomain API. A default retry strategy applies to this operation GetIotDomain()
func (client IotClient) GetIotDomainGroup(ctx context.Context, request GetIotDomainGroupRequest) (response GetIotDomainGroupResponse, err error)
GetIotDomainGroup Retrieves the IoT domain group identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/GetIotDomainGroup.go.html to see an example of how to use GetIotDomainGroup API. A default retry strategy applies to this operation GetIotDomainGroup()
func (client IotClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Retrieves the status of the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client IotClient) InvokeRawCommand(ctx context.Context, request InvokeRawCommandRequest) (response InvokeRawCommandResponse, err error)
InvokeRawCommand Invokes the raw command on the specified digital twin instance.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/InvokeRawCommand.go.html to see an example of how to use InvokeRawCommand API. A default retry strategy applies to this operation InvokeRawCommand()
func (client IotClient) ListDigitalTwinAdapters(ctx context.Context, request ListDigitalTwinAdaptersRequest) (response ListDigitalTwinAdaptersResponse, err error)
ListDigitalTwinAdapters Retrieves a list of digital twin adapters within the specified IoT domain.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ListDigitalTwinAdapters.go.html to see an example of how to use ListDigitalTwinAdapters API. A default retry strategy applies to this operation ListDigitalTwinAdapters()
func (client IotClient) ListDigitalTwinInstances(ctx context.Context, request ListDigitalTwinInstancesRequest) (response ListDigitalTwinInstancesResponse, err error)
ListDigitalTwinInstances Retrieves a list of digital twin instances within the specified IoT domain.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ListDigitalTwinInstances.go.html to see an example of how to use ListDigitalTwinInstances API. A default retry strategy applies to this operation ListDigitalTwinInstances()
func (client IotClient) ListDigitalTwinModels(ctx context.Context, request ListDigitalTwinModelsRequest) (response ListDigitalTwinModelsResponse, err error)
ListDigitalTwinModels Retrieves a list of digital twin models within the specified IoT domain.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ListDigitalTwinModels.go.html to see an example of how to use ListDigitalTwinModels API. A default retry strategy applies to this operation ListDigitalTwinModels()
func (client IotClient) ListDigitalTwinRelationships(ctx context.Context, request ListDigitalTwinRelationshipsRequest) (response ListDigitalTwinRelationshipsResponse, err error)
ListDigitalTwinRelationships Retrieves a list of digital twin relationships within the specified IoT domain.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ListDigitalTwinRelationships.go.html to see an example of how to use ListDigitalTwinRelationships API. A default retry strategy applies to this operation ListDigitalTwinRelationships()
func (client IotClient) ListIotDomainGroups(ctx context.Context, request ListIotDomainGroupsRequest) (response ListIotDomainGroupsResponse, err error)
ListIotDomainGroups Retrieves a list of IoT domain groups within the specified compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ListIotDomainGroups.go.html to see an example of how to use ListIotDomainGroups API. A default retry strategy applies to this operation ListIotDomainGroups()
func (client IotClient) ListIotDomains(ctx context.Context, request ListIotDomainsRequest) (response ListIotDomainsResponse, err error)
ListIotDomains Retrieves a list of IoT domains within the specified compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ListIotDomains.go.html to see an example of how to use ListIotDomains API. A default retry strategy applies to this operation ListIotDomains()
func (client IotClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Lists errors associated with the specified work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client IotClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Lists the logs associated with the specified work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client IotClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists work requests in the specified compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *IotClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client IotClient) UpdateDigitalTwinAdapter(ctx context.Context, request UpdateDigitalTwinAdapterRequest) (response UpdateDigitalTwinAdapterResponse, err error)
UpdateDigitalTwinAdapter Updates the details of digital twin adapter identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/UpdateDigitalTwinAdapter.go.html to see an example of how to use UpdateDigitalTwinAdapter API. A default retry strategy applies to this operation UpdateDigitalTwinAdapter()
func (client IotClient) UpdateDigitalTwinInstance(ctx context.Context, request UpdateDigitalTwinInstanceRequest) (response UpdateDigitalTwinInstanceResponse, err error)
UpdateDigitalTwinInstance Updates the details of digital twin instance identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/UpdateDigitalTwinInstance.go.html to see an example of how to use UpdateDigitalTwinInstance API. A default retry strategy applies to this operation UpdateDigitalTwinInstance()
func (client IotClient) UpdateDigitalTwinModel(ctx context.Context, request UpdateDigitalTwinModelRequest) (response UpdateDigitalTwinModelResponse, err error)
UpdateDigitalTwinModel Updates the details of the digital twin model identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/UpdateDigitalTwinModel.go.html to see an example of how to use UpdateDigitalTwinModel API. A default retry strategy applies to this operation UpdateDigitalTwinModel()
func (client IotClient) UpdateDigitalTwinRelationship(ctx context.Context, request UpdateDigitalTwinRelationshipRequest) (response UpdateDigitalTwinRelationshipResponse, err error)
UpdateDigitalTwinRelationship Updates the details of digital twin relationship identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/UpdateDigitalTwinRelationship.go.html to see an example of how to use UpdateDigitalTwinRelationship API. A default retry strategy applies to this operation UpdateDigitalTwinRelationship()
func (client IotClient) UpdateIotDomain(ctx context.Context, request UpdateIotDomainRequest) (response UpdateIotDomainResponse, err error)
UpdateIotDomain Updates the details of IoT domain identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/UpdateIotDomain.go.html to see an example of how to use UpdateIotDomain API. A default retry strategy applies to this operation UpdateIotDomain()
func (client IotClient) UpdateIotDomainGroup(ctx context.Context, request UpdateIotDomainGroupRequest) (response UpdateIotDomainGroupResponse, err error)
UpdateIotDomainGroup Updates the details of IoT domain group identified by the specified OCID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/UpdateIotDomainGroup.go.html to see an example of how to use UpdateIotDomainGroup API. A default retry strategy applies to this operation UpdateIotDomainGroup()
IotDomain An IoT domain is an Oracle Cloud Infrastructure resource that provides a managed environment for organizing and managing digital twin resources, such as models, adapters, instances and relationships, within a compartment and IoT domain group. To use any API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who needs to create policies to grant users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
type IotDomain struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain group.
IotDomainGroupId *string `mandatory:"true" json:"iotDomainGroupId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The current state of the IoT domain.
LifecycleState IotDomainLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time when the resource was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// Host name of an IoT domain, where IoT devices can connect to.
DeviceHost *string `mandatory:"false" json:"deviceHost"`
// List of IAM groups of form described in here (https://docs.oracle.com/en/cloud/paas/autonomous-database/dedicated/mnqmn/#GUID-3634D6C9-A7F1-4875-9925-BAEA2D3C5197) that are allowed to directly connect to the data host.
DbAllowListedIdentityGroupNames []string `mandatory:"false" json:"dbAllowListedIdentityGroupNames"`
// Host name of identity domain that is used for authenticating connect to data host via ORDS.
DbAllowedIdentityDomainHost *string `mandatory:"false" json:"dbAllowedIdentityDomainHost"`
DataRetentionPeriodsInDays *DataRetentionPeriodsInDays `mandatory:"false" json:"dataRetentionPeriodsInDays"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The date and time when the resource was last updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m IotDomain) String() string
func (m IotDomain) 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
IotDomainCollection Results of an IoT domain search. Contains both summary items and other information, such as metadata.
type IotDomainCollection struct {
// List of IoT domains.
Items []IotDomainSummary `mandatory:"true" json:"items"`
}
func (m IotDomainCollection) String() string
func (m IotDomainCollection) 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
IotDomainGroup An IoT domain group is an Oracle Cloud Infrastructure resource that provides a managed environment for organizing and managing IoT domains, within a compartment. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
type IotDomainGroup struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The current state of an IoT Domain Group.
LifecycleState IotDomainGroupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time when the resource was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// The host name of the database corresponding to the IoT Domain group.
DataHost *string `mandatory:"false" json:"dataHost"`
// This is an array of VCN OCID (virtual cloud network Oracle Cloud ID) that is allowed to connect the data host.
DbAllowListedVcnIds []string `mandatory:"false" json:"dbAllowListedVcnIds"`
// The connection string used to connect to the data host associated with the IoT domain group.
DbConnectionString *string `mandatory:"false" json:"dbConnectionString"`
// The token scope used to connect to the data host associated with the IoT domain group.
DbTokenScope *string `mandatory:"false" json:"dbTokenScope"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The date and time when the resource was last updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m IotDomainGroup) String() string
func (m IotDomainGroup) 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
IotDomainGroupCollection Results of an IoT Domain Group search. Contains both summary and additional metadata information.
type IotDomainGroupCollection struct {
// List of IoT Domain Group.
Items []IotDomainGroupSummary `mandatory:"true" json:"items"`
}
func (m IotDomainGroupCollection) String() string
func (m IotDomainGroupCollection) 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
IotDomainGroupLifecycleStateEnum Enum with underlying type: string
type IotDomainGroupLifecycleStateEnum string
Set of constants representing the allowable values for IotDomainGroupLifecycleStateEnum
const (
IotDomainGroupLifecycleStateCreating IotDomainGroupLifecycleStateEnum = "CREATING"
IotDomainGroupLifecycleStateUpdating IotDomainGroupLifecycleStateEnum = "UPDATING"
IotDomainGroupLifecycleStateActive IotDomainGroupLifecycleStateEnum = "ACTIVE"
IotDomainGroupLifecycleStateDeleting IotDomainGroupLifecycleStateEnum = "DELETING"
IotDomainGroupLifecycleStateDeleted IotDomainGroupLifecycleStateEnum = "DELETED"
IotDomainGroupLifecycleStateFailed IotDomainGroupLifecycleStateEnum = "FAILED"
)
func GetIotDomainGroupLifecycleStateEnumValues() []IotDomainGroupLifecycleStateEnum
GetIotDomainGroupLifecycleStateEnumValues Enumerates the set of values for IotDomainGroupLifecycleStateEnum
func GetMappingIotDomainGroupLifecycleStateEnum(val string) (IotDomainGroupLifecycleStateEnum, bool)
GetMappingIotDomainGroupLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
IotDomainGroupSummary Summary information about an IoT Domain Group.
type IotDomainGroupSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The current state of an IoT Domain Group.
LifecycleState IotDomainGroupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time when the resource was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The date and time when the resource was last updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m IotDomainGroupSummary) String() string
func (m IotDomainGroupSummary) 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
IotDomainLifecycleStateEnum Enum with underlying type: string
type IotDomainLifecycleStateEnum string
Set of constants representing the allowable values for IotDomainLifecycleStateEnum
const (
IotDomainLifecycleStateCreating IotDomainLifecycleStateEnum = "CREATING"
IotDomainLifecycleStateUpdating IotDomainLifecycleStateEnum = "UPDATING"
IotDomainLifecycleStateActive IotDomainLifecycleStateEnum = "ACTIVE"
IotDomainLifecycleStateDeleting IotDomainLifecycleStateEnum = "DELETING"
IotDomainLifecycleStateDeleted IotDomainLifecycleStateEnum = "DELETED"
IotDomainLifecycleStateFailed IotDomainLifecycleStateEnum = "FAILED"
)
func GetIotDomainLifecycleStateEnumValues() []IotDomainLifecycleStateEnum
GetIotDomainLifecycleStateEnumValues Enumerates the set of values for IotDomainLifecycleStateEnum
func GetMappingIotDomainLifecycleStateEnum(val string) (IotDomainLifecycleStateEnum, bool)
GetMappingIotDomainLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
IotDomainSummary Summary information about a IoT domain.
type IotDomainSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain group.
IotDomainGroupId *string `mandatory:"true" json:"iotDomainGroupId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment corresponding to the resource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The current state of the IoT domain.
LifecycleState IotDomainLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time when the resource was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The date and time when the resource was last updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m IotDomainSummary) String() string
func (m IotDomainSummary) 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 (
LifecycleStateActive LifecycleStateEnum = "ACTIVE"
LifecycleStateDeleted LifecycleStateEnum = "DELETED"
)
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
ListDigitalTwinAdaptersLifecycleStateEnum Enum with underlying type: string
type ListDigitalTwinAdaptersLifecycleStateEnum string
Set of constants representing the allowable values for ListDigitalTwinAdaptersLifecycleStateEnum
const (
ListDigitalTwinAdaptersLifecycleStateActive ListDigitalTwinAdaptersLifecycleStateEnum = "ACTIVE"
ListDigitalTwinAdaptersLifecycleStateDeleted ListDigitalTwinAdaptersLifecycleStateEnum = "DELETED"
)
func GetListDigitalTwinAdaptersLifecycleStateEnumValues() []ListDigitalTwinAdaptersLifecycleStateEnum
GetListDigitalTwinAdaptersLifecycleStateEnumValues Enumerates the set of values for ListDigitalTwinAdaptersLifecycleStateEnum
func GetMappingListDigitalTwinAdaptersLifecycleStateEnum(val string) (ListDigitalTwinAdaptersLifecycleStateEnum, bool)
GetMappingListDigitalTwinAdaptersLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDigitalTwinAdaptersRequest wrapper for the ListDigitalTwinAdapters operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ListDigitalTwinAdapters.go.html to see an example of how to use ListDigitalTwinAdaptersRequest.
type ListDigitalTwinAdaptersRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain in which to list digital twin resources.
IotDomainId *string `mandatory:"true" contributesTo:"query" name:"iotDomainId"`
// Filter resources by OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// Filter resources that match the specified URI (DTMI) of the digital twin model.
DigitalTwinModelSpecUri *string `mandatory:"false" contributesTo:"query" name:"digitalTwinModelSpecUri"`
// Filter resources that match the specified OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model.
DigitalTwinModelId *string `mandatory:"false" contributesTo:"query" name:"digitalTwinModelId"`
// Filter resources whose display name matches the specified value.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Filter resources whose lifecycleState matches the specified value.
LifecycleState ListDigitalTwinAdaptersLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// 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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Page representing the requested page of items.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Specifies sort order to use, either ASC (ascending) or DESC (descending).
SortOrder ListDigitalTwinAdaptersSortOrderEnum `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.
SortBy ListDigitalTwinAdaptersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 ListDigitalTwinAdaptersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDigitalTwinAdaptersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDigitalTwinAdaptersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDigitalTwinAdaptersRequest) String() string
func (request ListDigitalTwinAdaptersRequest) 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
ListDigitalTwinAdaptersResponse wrapper for the ListDigitalTwinAdapters operation
type ListDigitalTwinAdaptersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DigitalTwinAdapterCollection instances
DigitalTwinAdapterCollection `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.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, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListDigitalTwinAdaptersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDigitalTwinAdaptersResponse) String() string
ListDigitalTwinAdaptersSortByEnum Enum with underlying type: string
type ListDigitalTwinAdaptersSortByEnum string
Set of constants representing the allowable values for ListDigitalTwinAdaptersSortByEnum
const (
ListDigitalTwinAdaptersSortByTimecreated ListDigitalTwinAdaptersSortByEnum = "timeCreated"
ListDigitalTwinAdaptersSortByDisplayname ListDigitalTwinAdaptersSortByEnum = "displayName"
)
func GetListDigitalTwinAdaptersSortByEnumValues() []ListDigitalTwinAdaptersSortByEnum
GetListDigitalTwinAdaptersSortByEnumValues Enumerates the set of values for ListDigitalTwinAdaptersSortByEnum
func GetMappingListDigitalTwinAdaptersSortByEnum(val string) (ListDigitalTwinAdaptersSortByEnum, bool)
GetMappingListDigitalTwinAdaptersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDigitalTwinAdaptersSortOrderEnum Enum with underlying type: string
type ListDigitalTwinAdaptersSortOrderEnum string
Set of constants representing the allowable values for ListDigitalTwinAdaptersSortOrderEnum
const (
ListDigitalTwinAdaptersSortOrderAsc ListDigitalTwinAdaptersSortOrderEnum = "ASC"
ListDigitalTwinAdaptersSortOrderDesc ListDigitalTwinAdaptersSortOrderEnum = "DESC"
)
func GetListDigitalTwinAdaptersSortOrderEnumValues() []ListDigitalTwinAdaptersSortOrderEnum
GetListDigitalTwinAdaptersSortOrderEnumValues Enumerates the set of values for ListDigitalTwinAdaptersSortOrderEnum
func GetMappingListDigitalTwinAdaptersSortOrderEnum(val string) (ListDigitalTwinAdaptersSortOrderEnum, bool)
GetMappingListDigitalTwinAdaptersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDigitalTwinInstancesLifecycleStateEnum Enum with underlying type: string
type ListDigitalTwinInstancesLifecycleStateEnum string
Set of constants representing the allowable values for ListDigitalTwinInstancesLifecycleStateEnum
const (
ListDigitalTwinInstancesLifecycleStateActive ListDigitalTwinInstancesLifecycleStateEnum = "ACTIVE"
ListDigitalTwinInstancesLifecycleStateDeleted ListDigitalTwinInstancesLifecycleStateEnum = "DELETED"
)
func GetListDigitalTwinInstancesLifecycleStateEnumValues() []ListDigitalTwinInstancesLifecycleStateEnum
GetListDigitalTwinInstancesLifecycleStateEnumValues Enumerates the set of values for ListDigitalTwinInstancesLifecycleStateEnum
func GetMappingListDigitalTwinInstancesLifecycleStateEnum(val string) (ListDigitalTwinInstancesLifecycleStateEnum, bool)
GetMappingListDigitalTwinInstancesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDigitalTwinInstancesRequest wrapper for the ListDigitalTwinInstances operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ListDigitalTwinInstances.go.html to see an example of how to use ListDigitalTwinInstancesRequest.
type ListDigitalTwinInstancesRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain in which to list digital twin resources.
IotDomainId *string `mandatory:"true" contributesTo:"query" name:"iotDomainId"`
// Filter resources whose display name matches the specified value.
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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Page representing the requested page of items.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Filter resources whose lifecycleState matches the specified value.
LifecycleState ListDigitalTwinInstancesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Specifies sort order to use, either ASC (ascending) or DESC (descending).
SortOrder ListDigitalTwinInstancesSortOrderEnum `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.
SortBy ListDigitalTwinInstancesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Filter resources that match the specified OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model.
DigitalTwinModelId *string `mandatory:"false" contributesTo:"query" name:"digitalTwinModelId"`
// Filter resources that match the specified URI (DTMI) of the digital twin model.
DigitalTwinModelSpecUri *string `mandatory:"false" contributesTo:"query" name:"digitalTwinModelSpecUri"`
// Filter resources by OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type.
Id *string `mandatory:"false" contributesTo:"query" name:"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 ListDigitalTwinInstancesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDigitalTwinInstancesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDigitalTwinInstancesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDigitalTwinInstancesRequest) String() string
func (request ListDigitalTwinInstancesRequest) 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
ListDigitalTwinInstancesResponse wrapper for the ListDigitalTwinInstances operation
type ListDigitalTwinInstancesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DigitalTwinInstanceCollection instances
DigitalTwinInstanceCollection `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.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, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListDigitalTwinInstancesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDigitalTwinInstancesResponse) String() string
ListDigitalTwinInstancesSortByEnum Enum with underlying type: string
type ListDigitalTwinInstancesSortByEnum string
Set of constants representing the allowable values for ListDigitalTwinInstancesSortByEnum
const (
ListDigitalTwinInstancesSortByTimecreated ListDigitalTwinInstancesSortByEnum = "timeCreated"
ListDigitalTwinInstancesSortByDisplayname ListDigitalTwinInstancesSortByEnum = "displayName"
)
func GetListDigitalTwinInstancesSortByEnumValues() []ListDigitalTwinInstancesSortByEnum
GetListDigitalTwinInstancesSortByEnumValues Enumerates the set of values for ListDigitalTwinInstancesSortByEnum
func GetMappingListDigitalTwinInstancesSortByEnum(val string) (ListDigitalTwinInstancesSortByEnum, bool)
GetMappingListDigitalTwinInstancesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDigitalTwinInstancesSortOrderEnum Enum with underlying type: string
type ListDigitalTwinInstancesSortOrderEnum string
Set of constants representing the allowable values for ListDigitalTwinInstancesSortOrderEnum
const (
ListDigitalTwinInstancesSortOrderAsc ListDigitalTwinInstancesSortOrderEnum = "ASC"
ListDigitalTwinInstancesSortOrderDesc ListDigitalTwinInstancesSortOrderEnum = "DESC"
)
func GetListDigitalTwinInstancesSortOrderEnumValues() []ListDigitalTwinInstancesSortOrderEnum
GetListDigitalTwinInstancesSortOrderEnumValues Enumerates the set of values for ListDigitalTwinInstancesSortOrderEnum
func GetMappingListDigitalTwinInstancesSortOrderEnum(val string) (ListDigitalTwinInstancesSortOrderEnum, bool)
GetMappingListDigitalTwinInstancesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDigitalTwinModelsLifecycleStateEnum Enum with underlying type: string
type ListDigitalTwinModelsLifecycleStateEnum string
Set of constants representing the allowable values for ListDigitalTwinModelsLifecycleStateEnum
const (
ListDigitalTwinModelsLifecycleStateActive ListDigitalTwinModelsLifecycleStateEnum = "ACTIVE"
ListDigitalTwinModelsLifecycleStateDeleted ListDigitalTwinModelsLifecycleStateEnum = "DELETED"
)
func GetListDigitalTwinModelsLifecycleStateEnumValues() []ListDigitalTwinModelsLifecycleStateEnum
GetListDigitalTwinModelsLifecycleStateEnumValues Enumerates the set of values for ListDigitalTwinModelsLifecycleStateEnum
func GetMappingListDigitalTwinModelsLifecycleStateEnum(val string) (ListDigitalTwinModelsLifecycleStateEnum, bool)
GetMappingListDigitalTwinModelsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDigitalTwinModelsRequest wrapper for the ListDigitalTwinModels operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ListDigitalTwinModels.go.html to see an example of how to use ListDigitalTwinModelsRequest.
type ListDigitalTwinModelsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain in which to list digital twin resources.
IotDomainId *string `mandatory:"true" contributesTo:"query" name:"iotDomainId"`
// Filter resources by OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// Filter resources whose display name matches the specified value.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Filters resources by spec URI prefix. For example, to search all versions of the `dtmi:example:device;1` model, pass the prefix without the version: `dtmi:example:device`.
SpecUriStartsWith *string `mandatory:"false" contributesTo:"query" name:"specUriStartsWith"`
// 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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Page representing the requested page of items.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Filter resources whose lifecycleState matches the specified value.
LifecycleState ListDigitalTwinModelsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Specifies sort order to use, either ASC (ascending) or DESC (descending).
SortOrder ListDigitalTwinModelsSortOrderEnum `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.
SortBy ListDigitalTwinModelsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 ListDigitalTwinModelsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDigitalTwinModelsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDigitalTwinModelsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDigitalTwinModelsRequest) String() string
func (request ListDigitalTwinModelsRequest) 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
ListDigitalTwinModelsResponse wrapper for the ListDigitalTwinModels operation
type ListDigitalTwinModelsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DigitalTwinModelCollection instances
DigitalTwinModelCollection `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.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, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListDigitalTwinModelsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDigitalTwinModelsResponse) String() string
ListDigitalTwinModelsSortByEnum Enum with underlying type: string
type ListDigitalTwinModelsSortByEnum string
Set of constants representing the allowable values for ListDigitalTwinModelsSortByEnum
const (
ListDigitalTwinModelsSortByTimecreated ListDigitalTwinModelsSortByEnum = "timeCreated"
ListDigitalTwinModelsSortByDisplayname ListDigitalTwinModelsSortByEnum = "displayName"
)
func GetListDigitalTwinModelsSortByEnumValues() []ListDigitalTwinModelsSortByEnum
GetListDigitalTwinModelsSortByEnumValues Enumerates the set of values for ListDigitalTwinModelsSortByEnum
func GetMappingListDigitalTwinModelsSortByEnum(val string) (ListDigitalTwinModelsSortByEnum, bool)
GetMappingListDigitalTwinModelsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDigitalTwinModelsSortOrderEnum Enum with underlying type: string
type ListDigitalTwinModelsSortOrderEnum string
Set of constants representing the allowable values for ListDigitalTwinModelsSortOrderEnum
const (
ListDigitalTwinModelsSortOrderAsc ListDigitalTwinModelsSortOrderEnum = "ASC"
ListDigitalTwinModelsSortOrderDesc ListDigitalTwinModelsSortOrderEnum = "DESC"
)
func GetListDigitalTwinModelsSortOrderEnumValues() []ListDigitalTwinModelsSortOrderEnum
GetListDigitalTwinModelsSortOrderEnumValues Enumerates the set of values for ListDigitalTwinModelsSortOrderEnum
func GetMappingListDigitalTwinModelsSortOrderEnum(val string) (ListDigitalTwinModelsSortOrderEnum, bool)
GetMappingListDigitalTwinModelsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDigitalTwinRelationshipsLifecycleStateEnum Enum with underlying type: string
type ListDigitalTwinRelationshipsLifecycleStateEnum string
Set of constants representing the allowable values for ListDigitalTwinRelationshipsLifecycleStateEnum
const (
ListDigitalTwinRelationshipsLifecycleStateActive ListDigitalTwinRelationshipsLifecycleStateEnum = "ACTIVE"
ListDigitalTwinRelationshipsLifecycleStateDeleted ListDigitalTwinRelationshipsLifecycleStateEnum = "DELETED"
)
func GetListDigitalTwinRelationshipsLifecycleStateEnumValues() []ListDigitalTwinRelationshipsLifecycleStateEnum
GetListDigitalTwinRelationshipsLifecycleStateEnumValues Enumerates the set of values for ListDigitalTwinRelationshipsLifecycleStateEnum
func GetMappingListDigitalTwinRelationshipsLifecycleStateEnum(val string) (ListDigitalTwinRelationshipsLifecycleStateEnum, bool)
GetMappingListDigitalTwinRelationshipsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDigitalTwinRelationshipsRequest wrapper for the ListDigitalTwinRelationships operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ListDigitalTwinRelationships.go.html to see an example of how to use ListDigitalTwinRelationshipsRequest.
type ListDigitalTwinRelationshipsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain in which to list digital twin resources.
IotDomainId *string `mandatory:"true" contributesTo:"query" name:"iotDomainId"`
// Filter resources whose display name matches the specified value.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Filters resources that match the content path of the digital twin relationship.
ContentPath *string `mandatory:"false" contributesTo:"query" name:"contentPath"`
// Filter resources that match the specified OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of source digital twin instance.
SourceDigitalTwinInstanceId *string `mandatory:"false" contributesTo:"query" name:"sourceDigitalTwinInstanceId"`
// Filter resources that match the specified OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of target digital twin instance.
TargetDigitalTwinInstanceId *string `mandatory:"false" contributesTo:"query" name:"targetDigitalTwinInstanceId"`
// Filter resources whose lifecycleState matches the specified value.
LifecycleState ListDigitalTwinRelationshipsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// 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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Page representing the requested page of items.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Specifies sort order to use, either ASC (ascending) or DESC (descending).
SortOrder ListDigitalTwinRelationshipsSortOrderEnum `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.
SortBy ListDigitalTwinRelationshipsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Filter resources by OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type.
Id *string `mandatory:"false" contributesTo:"query" name:"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 ListDigitalTwinRelationshipsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDigitalTwinRelationshipsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDigitalTwinRelationshipsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDigitalTwinRelationshipsRequest) String() string
func (request ListDigitalTwinRelationshipsRequest) 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
ListDigitalTwinRelationshipsResponse wrapper for the ListDigitalTwinRelationships operation
type ListDigitalTwinRelationshipsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DigitalTwinRelationshipCollection instances
DigitalTwinRelationshipCollection `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.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, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListDigitalTwinRelationshipsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDigitalTwinRelationshipsResponse) String() string
ListDigitalTwinRelationshipsSortByEnum Enum with underlying type: string
type ListDigitalTwinRelationshipsSortByEnum string
Set of constants representing the allowable values for ListDigitalTwinRelationshipsSortByEnum
const (
ListDigitalTwinRelationshipsSortByTimecreated ListDigitalTwinRelationshipsSortByEnum = "timeCreated"
ListDigitalTwinRelationshipsSortByDisplayname ListDigitalTwinRelationshipsSortByEnum = "displayName"
)
func GetListDigitalTwinRelationshipsSortByEnumValues() []ListDigitalTwinRelationshipsSortByEnum
GetListDigitalTwinRelationshipsSortByEnumValues Enumerates the set of values for ListDigitalTwinRelationshipsSortByEnum
func GetMappingListDigitalTwinRelationshipsSortByEnum(val string) (ListDigitalTwinRelationshipsSortByEnum, bool)
GetMappingListDigitalTwinRelationshipsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDigitalTwinRelationshipsSortOrderEnum Enum with underlying type: string
type ListDigitalTwinRelationshipsSortOrderEnum string
Set of constants representing the allowable values for ListDigitalTwinRelationshipsSortOrderEnum
const (
ListDigitalTwinRelationshipsSortOrderAsc ListDigitalTwinRelationshipsSortOrderEnum = "ASC"
ListDigitalTwinRelationshipsSortOrderDesc ListDigitalTwinRelationshipsSortOrderEnum = "DESC"
)
func GetListDigitalTwinRelationshipsSortOrderEnumValues() []ListDigitalTwinRelationshipsSortOrderEnum
GetListDigitalTwinRelationshipsSortOrderEnumValues Enumerates the set of values for ListDigitalTwinRelationshipsSortOrderEnum
func GetMappingListDigitalTwinRelationshipsSortOrderEnum(val string) (ListDigitalTwinRelationshipsSortOrderEnum, bool)
GetMappingListDigitalTwinRelationshipsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListIotDomainGroupsRequest wrapper for the ListIotDomainGroups operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ListIotDomainGroups.go.html to see an example of how to use ListIotDomainGroupsRequest.
type ListIotDomainGroupsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Filter resources by OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// Filter resources whose display name matches the specified value.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Filter resources whose lifecycleState matches the specified value.
LifecycleState IotDomainGroupLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// 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.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 on how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Specifies sort order to use, either ASC (ascending) or DESC (descending).
SortOrder ListIotDomainGroupsSortOrderEnum `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.
SortBy ListIotDomainGroupsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 ListIotDomainGroupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListIotDomainGroupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListIotDomainGroupsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListIotDomainGroupsRequest) String() string
func (request ListIotDomainGroupsRequest) 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
ListIotDomainGroupsResponse wrapper for the ListIotDomainGroups operation
type ListIotDomainGroupsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of IotDomainGroupCollection instances
IotDomainGroupCollection `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.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, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListIotDomainGroupsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListIotDomainGroupsResponse) String() string
ListIotDomainGroupsSortByEnum Enum with underlying type: string
type ListIotDomainGroupsSortByEnum string
Set of constants representing the allowable values for ListIotDomainGroupsSortByEnum
const (
ListIotDomainGroupsSortByTimecreated ListIotDomainGroupsSortByEnum = "timeCreated"
ListIotDomainGroupsSortByDisplayname ListIotDomainGroupsSortByEnum = "displayName"
)
func GetListIotDomainGroupsSortByEnumValues() []ListIotDomainGroupsSortByEnum
GetListIotDomainGroupsSortByEnumValues Enumerates the set of values for ListIotDomainGroupsSortByEnum
func GetMappingListIotDomainGroupsSortByEnum(val string) (ListIotDomainGroupsSortByEnum, bool)
GetMappingListIotDomainGroupsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListIotDomainGroupsSortOrderEnum Enum with underlying type: string
type ListIotDomainGroupsSortOrderEnum string
Set of constants representing the allowable values for ListIotDomainGroupsSortOrderEnum
const (
ListIotDomainGroupsSortOrderAsc ListIotDomainGroupsSortOrderEnum = "ASC"
ListIotDomainGroupsSortOrderDesc ListIotDomainGroupsSortOrderEnum = "DESC"
)
func GetListIotDomainGroupsSortOrderEnumValues() []ListIotDomainGroupsSortOrderEnum
GetListIotDomainGroupsSortOrderEnumValues Enumerates the set of values for ListIotDomainGroupsSortOrderEnum
func GetMappingListIotDomainGroupsSortOrderEnum(val string) (ListIotDomainGroupsSortOrderEnum, bool)
GetMappingListIotDomainGroupsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListIotDomainsRequest wrapper for the ListIotDomains operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ListIotDomains.go.html to see an example of how to use ListIotDomainsRequest.
type ListIotDomainsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Filter resources by OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// Filter resources that match the specified OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain group.
IotDomainGroupId *string `mandatory:"false" contributesTo:"query" name:"iotDomainGroupId"`
// Filter resources whose display name matches the specified value.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Filter resources whose lifecycleState matches the specified value.
LifecycleState IotDomainLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// 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.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 on how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Specifies sort order to use, either ASC (ascending) or DESC (descending).
SortOrder ListIotDomainsSortOrderEnum `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.
SortBy ListIotDomainsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 ListIotDomainsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListIotDomainsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListIotDomainsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListIotDomainsRequest) String() string
func (request ListIotDomainsRequest) 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
ListIotDomainsResponse wrapper for the ListIotDomains operation
type ListIotDomainsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of IotDomainCollection instances
IotDomainCollection `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.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, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}
func (response ListIotDomainsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListIotDomainsResponse) String() string
ListIotDomainsSortByEnum Enum with underlying type: string
type ListIotDomainsSortByEnum string
Set of constants representing the allowable values for ListIotDomainsSortByEnum
const (
ListIotDomainsSortByTimecreated ListIotDomainsSortByEnum = "timeCreated"
ListIotDomainsSortByDisplayname ListIotDomainsSortByEnum = "displayName"
)
func GetListIotDomainsSortByEnumValues() []ListIotDomainsSortByEnum
GetListIotDomainsSortByEnumValues Enumerates the set of values for ListIotDomainsSortByEnum
func GetMappingListIotDomainsSortByEnum(val string) (ListIotDomainsSortByEnum, bool)
GetMappingListIotDomainsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListIotDomainsSortOrderEnum Enum with underlying type: string
type ListIotDomainsSortOrderEnum string
Set of constants representing the allowable values for ListIotDomainsSortOrderEnum
const (
ListIotDomainsSortOrderAsc ListIotDomainsSortOrderEnum = "ASC"
ListIotDomainsSortOrderDesc ListIotDomainsSortOrderEnum = "DESC"
)
func GetListIotDomainsSortOrderEnumValues() []ListIotDomainsSortOrderEnum
GetListIotDomainsSortOrderEnumValues Enumerates the set of values for ListIotDomainsSortOrderEnum
func GetMappingListIotDomainsSortOrderEnum(val string) (ListIotDomainsSortOrderEnum, bool)
GetMappingListIotDomainsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 on how pagination works, see
// List Pagination (https://docs.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order can be specified. The default order for `timeCreated` is descending.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Specifies sort order to use, either ASC (ascending) or DESC (descending).
SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (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"`
// 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.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, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.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
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimecreated ListWorkRequestErrorsSortByEnum = "timeCreated"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 on how pagination works, see
// List Pagination (https://docs.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order can be specified. The default order for `timeCreated` is descending.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Specifies sort order to use, either ASC (ascending) or DESC (descending).
SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (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"`
// 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.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, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.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
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimecreated ListWorkRequestLogsSortByEnum = "timeCreated"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to return only the resources that match the given lifecycle state.
Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 on how pagination works, see
// List Pagination (https://docs.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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Specifies sort order to use, either ASC (ascending) or DESC (descending).
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order can be specified. Default order for `timeAccepted` is descending.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (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 WorkRequestSummaryCollection instances
WorkRequestSummaryCollection `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.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, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.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
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const (
ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusWaiting ListWorkRequestsStatusEnum = "WAITING"
ListWorkRequestsStatusNeedsAttention ListWorkRequestsStatusEnum = "NEEDS_ATTENTION"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
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"
OperationStatusWaiting OperationStatusEnum = "WAITING"
OperationStatusNeedsAttention OperationStatusEnum = "NEEDS_ATTENTION"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
)
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 (
OperationTypeCreateIotDomain OperationTypeEnum = "CREATE_IOT_DOMAIN"
OperationTypeUpdateIotDomain OperationTypeEnum = "UPDATE_IOT_DOMAIN"
OperationTypeDeleteIotDomain OperationTypeEnum = "DELETE_IOT_DOMAIN"
OperationTypeMoveIotDomain OperationTypeEnum = "MOVE_IOT_DOMAIN"
OperationTypeMoveIotDomainGroup OperationTypeEnum = "MOVE_IOT_DOMAIN_GROUP"
OperationTypeCreateIotDomainGroup OperationTypeEnum = "CREATE_IOT_DOMAIN_GROUP"
OperationTypeUpdateIotDomainGroup OperationTypeEnum = "UPDATE_IOT_DOMAIN_GROUP"
OperationTypeDeleteIotDomainGroup OperationTypeEnum = "DELETE_IOT_DOMAIN_GROUP"
OperationTypeConfigureDomainDataAccess OperationTypeEnum = "CONFIGURE_DOMAIN_DATA_ACCESS"
OperationTypeConfigureDomainGroupDataAccess OperationTypeEnum = "CONFIGURE_DOMAIN_GROUP_DATA_ACCESS"
OperationTypeChangeIotDomainDataRetention OperationTypeEnum = "CHANGE_IOT_DOMAIN_DATA_RETENTION"
)
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
OrdsDataAccessDetails This contains configuration for ORDS data access.
type OrdsDataAccessDetails struct {
// Host name of identity domain that is used for authenticating connect to data host via ORDS.
DbAllowedIdentityDomainHost *string `mandatory:"true" json:"dbAllowedIdentityDomainHost"`
}
func (m OrdsDataAccessDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OrdsDataAccessDetails) String() string
func (m OrdsDataAccessDetails) 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
UpdateDigitalTwinAdapterDetails The information to be updated for the given digital twin adapter.
type UpdateDigitalTwinAdapterDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
InboundEnvelope *DigitalTwinAdapterInboundEnvelope `mandatory:"false" json:"inboundEnvelope"`
// list of routes
InboundRoutes []DigitalTwinAdapterInboundRoute `mandatory:"false" json:"inboundRoutes"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateDigitalTwinAdapterDetails) String() string
func (m UpdateDigitalTwinAdapterDetails) 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
UpdateDigitalTwinAdapterRequest wrapper for the UpdateDigitalTwinAdapter operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/UpdateDigitalTwinAdapter.go.html to see an example of how to use UpdateDigitalTwinAdapterRequest.
type UpdateDigitalTwinAdapterRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter.
DigitalTwinAdapterId *string `mandatory:"true" contributesTo:"path" name:"digitalTwinAdapterId"`
// The digital twin adapter details to be updated.
UpdateDigitalTwinAdapterDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 UpdateDigitalTwinAdapterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDigitalTwinAdapterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDigitalTwinAdapterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDigitalTwinAdapterRequest) String() string
func (request UpdateDigitalTwinAdapterRequest) 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
UpdateDigitalTwinAdapterResponse wrapper for the UpdateDigitalTwinAdapter operation
type UpdateDigitalTwinAdapterResponse struct {
// The underlying http response
RawResponse *http.Response
// The DigitalTwinAdapter instance
DigitalTwinAdapter `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 UpdateDigitalTwinAdapterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDigitalTwinAdapterResponse) String() string
UpdateDigitalTwinInstanceDetails The information to be updated for the given digital twin instance.
type UpdateDigitalTwinInstanceDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
AuthId *string `mandatory:"false" json:"authId"`
// A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance.
// This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case.
// If not provided, the system will automatically generate one.
ExternalKey *string `mandatory:"false" json:"externalKey"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter.
DigitalTwinAdapterId *string `mandatory:"false" json:"digitalTwinAdapterId"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateDigitalTwinInstanceDetails) String() string
func (m UpdateDigitalTwinInstanceDetails) 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
UpdateDigitalTwinInstanceRequest wrapper for the UpdateDigitalTwinInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/UpdateDigitalTwinInstance.go.html to see an example of how to use UpdateDigitalTwinInstanceRequest.
type UpdateDigitalTwinInstanceRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of digital twin instance.
DigitalTwinInstanceId *string `mandatory:"true" contributesTo:"path" name:"digitalTwinInstanceId"`
// The digital twin instance details to be updated.
UpdateDigitalTwinInstanceDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 UpdateDigitalTwinInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDigitalTwinInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDigitalTwinInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDigitalTwinInstanceRequest) String() string
func (request UpdateDigitalTwinInstanceRequest) 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
UpdateDigitalTwinInstanceResponse wrapper for the UpdateDigitalTwinInstance operation
type UpdateDigitalTwinInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// The DigitalTwinInstance instance
DigitalTwinInstance `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 UpdateDigitalTwinInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDigitalTwinInstanceResponse) String() string
UpdateDigitalTwinModelDetails The information to be updated for the given digital twin model.
type UpdateDigitalTwinModelDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
// If left blank, the display name will be derived from the spec.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the resource. If left blank, the description will be derived from the spec.
Description *string `mandatory:"false" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateDigitalTwinModelDetails) String() string
func (m UpdateDigitalTwinModelDetails) 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
UpdateDigitalTwinModelRequest wrapper for the UpdateDigitalTwinModel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/UpdateDigitalTwinModel.go.html to see an example of how to use UpdateDigitalTwinModelRequest.
type UpdateDigitalTwinModelRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of digital twin model.
DigitalTwinModelId *string `mandatory:"true" contributesTo:"path" name:"digitalTwinModelId"`
// The digital twin model details to be updated.
UpdateDigitalTwinModelDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 UpdateDigitalTwinModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDigitalTwinModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDigitalTwinModelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDigitalTwinModelRequest) String() string
func (request UpdateDigitalTwinModelRequest) 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
UpdateDigitalTwinModelResponse wrapper for the UpdateDigitalTwinModel operation
type UpdateDigitalTwinModelResponse struct {
// The underlying http response
RawResponse *http.Response
// The DigitalTwinModel instance
DigitalTwinModel `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 UpdateDigitalTwinModelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDigitalTwinModelResponse) String() string
UpdateDigitalTwinRelationshipDetails The information to be updated for the given digital twin relationship.
type UpdateDigitalTwinRelationshipDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// The value(s) of the relationship properties defined in the source digital twin model.
Content map[string]interface{} `mandatory:"false" json:"content"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateDigitalTwinRelationshipDetails) String() string
func (m UpdateDigitalTwinRelationshipDetails) 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
UpdateDigitalTwinRelationshipRequest wrapper for the UpdateDigitalTwinRelationship operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/UpdateDigitalTwinRelationship.go.html to see an example of how to use UpdateDigitalTwinRelationshipRequest.
type UpdateDigitalTwinRelationshipRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of digital twin relationship.
DigitalTwinRelationshipId *string `mandatory:"true" contributesTo:"path" name:"digitalTwinRelationshipId"`
// The digital twin relationship details to be updated.
UpdateDigitalTwinRelationshipDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 UpdateDigitalTwinRelationshipRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDigitalTwinRelationshipRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDigitalTwinRelationshipRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDigitalTwinRelationshipRequest) String() string
func (request UpdateDigitalTwinRelationshipRequest) 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
UpdateDigitalTwinRelationshipResponse wrapper for the UpdateDigitalTwinRelationship operation
type UpdateDigitalTwinRelationshipResponse struct {
// The underlying http response
RawResponse *http.Response
// The DigitalTwinRelationship instance
DigitalTwinRelationship `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 UpdateDigitalTwinRelationshipResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDigitalTwinRelationshipResponse) String() string
UpdateIotDomainDetails The information to be updated for the given IoT domain.
type UpdateIotDomainDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateIotDomainDetails) String() string
func (m UpdateIotDomainDetails) 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
UpdateIotDomainGroupDetails The information to be updated for the given IoT domain group.
type UpdateIotDomainGroupDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateIotDomainGroupDetails) String() string
func (m UpdateIotDomainGroupDetails) 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
UpdateIotDomainGroupRequest wrapper for the UpdateIotDomainGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/UpdateIotDomainGroup.go.html to see an example of how to use UpdateIotDomainGroupRequest.
type UpdateIotDomainGroupRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an IoT Domain Group.
IotDomainGroupId *string `mandatory:"true" contributesTo:"path" name:"iotDomainGroupId"`
// The IoT domain group details to be updated.
UpdateIotDomainGroupDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 UpdateIotDomainGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateIotDomainGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateIotDomainGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateIotDomainGroupRequest) String() string
func (request UpdateIotDomainGroupRequest) 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
UpdateIotDomainGroupResponse wrapper for the UpdateIotDomainGroup operation
type UpdateIotDomainGroupResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 UpdateIotDomainGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateIotDomainGroupResponse) String() string
UpdateIotDomainRequest wrapper for the UpdateIotDomain operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/iot/UpdateIotDomain.go.html to see an example of how to use UpdateIotDomainRequest.
type UpdateIotDomainRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain.
IotDomainId *string `mandatory:"true" contributesTo:"path" name:"iotDomainId"`
// The IoT domain details to be updated.
UpdateIotDomainDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request.
// If you need to contact Oracle about a particular request, 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 UpdateIotDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateIotDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateIotDomainRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateIotDomainRequest) String() string
func (request UpdateIotDomainRequest) 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
UpdateIotDomainResponse wrapper for the UpdateIotDomain operation
type UpdateIotDomainResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
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 UpdateIotDomainResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateIotDomainResponse) String() string
WorkRequest An asynchronous work request helps monitor long-running operations. When you initiate a long-running operation, the service creates a work request. This work request acts as an activity log, allowing you to track each step of the operation’s progress. Each work request has an OCID, enabling programmatic interaction and automation.
type WorkRequest struct {
// The asynchronous operation tracked by this work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources that are affected by the work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Shows the progress of the operation tracked by the work request as a percentage of the total work to be completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the work request was created, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request was started, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request was finished, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// The date and time the work request was updated, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
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
WorkRequestError An error encountered while performing an operation that is tracked by a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occurred. For a list of error codes, see
// API Errors (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm).
Code *string `mandatory:"true" json:"code"`
// A human-readable error message.
Message *string `mandatory:"true" json:"message"`
// The date and time the error occurred, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
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 A list of work request errors. Can contain both errors and other information, such as metadata.
type WorkRequestErrorCollection struct {
// A list of work request errors.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntry A log message from performing an operation that is tracked by a work request.
type WorkRequestLogEntry struct {
// A human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The date and time the log message was written, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
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 A list of work request logs. Can contain both logs and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// A list of work request log entries.
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 that the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// Describes how this resource is affected by the operation tracked in the work request.
// A resource being created, updated, or deleted remains in the IN_PROGRESS state until the work is complete,
// at which point it transitions to CREATED, UPDATED, or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// An OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource.
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"`
// Additional information that helps to explain the resource.
Metadata map[string]string `mandatory:"false" json:"metadata"`
}
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
WorkRequestResourceMetadataKeyEnum Enum with underlying type: string
type WorkRequestResourceMetadataKeyEnum string
Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum
const (
WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)
func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)
GetMappingWorkRequestResourceMetadataKeyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum
GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum
WorkRequestSummary Summary information about an asynchronous work request.
type WorkRequestSummary struct {
// The asynchronous operation tracked by this work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources that are affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Shows the progress of the operation tracked by the work request, as a percentage of the total work
// that must be performed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the work request was created, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request was started, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request was finished, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// The date and time the work request was updated, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestSummaryCollection A list of work requests. Can contain both work requests and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// A list of work requests.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
func (m WorkRequestSummaryCollection) 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