iot

package
v65.103.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 28, 2025 License: Apache-2.0, UPL-1.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetActionTypeEnumStringValues

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetChangeIotDomainDataRetentionPeriodDetailsTypeEnumStringValues

func GetChangeIotDomainDataRetentionPeriodDetailsTypeEnumStringValues() []string

GetChangeIotDomainDataRetentionPeriodDetailsTypeEnumStringValues Enumerates the set of values in String for ChangeIotDomainDataRetentionPeriodDetailsTypeEnum

func GetConfigureIotDomainDataAccessDetailsTypeEnumStringValues

func GetConfigureIotDomainDataAccessDetailsTypeEnumStringValues() []string

GetConfigureIotDomainDataAccessDetailsTypeEnumStringValues Enumerates the set of values in String for ConfigureIotDomainDataAccessDetailsTypeEnum

func GetDigitalTwinAdapterPayloadDataFormatEnumStringValues

func GetDigitalTwinAdapterPayloadDataFormatEnumStringValues() []string

GetDigitalTwinAdapterPayloadDataFormatEnumStringValues Enumerates the set of values in String for DigitalTwinAdapterPayloadDataFormatEnum

func GetInvokeRawCommandDetailsRequestDataFormatEnumStringValues

func GetInvokeRawCommandDetailsRequestDataFormatEnumStringValues() []string

GetInvokeRawCommandDetailsRequestDataFormatEnumStringValues Enumerates the set of values in String for InvokeRawCommandDetailsRequestDataFormatEnum

func GetIotDomainGroupLifecycleStateEnumStringValues

func GetIotDomainGroupLifecycleStateEnumStringValues() []string

GetIotDomainGroupLifecycleStateEnumStringValues Enumerates the set of values in String for IotDomainGroupLifecycleStateEnum

func GetIotDomainLifecycleStateEnumStringValues

func GetIotDomainLifecycleStateEnumStringValues() []string

GetIotDomainLifecycleStateEnumStringValues Enumerates the set of values in String for IotDomainLifecycleStateEnum

func GetLifecycleStateEnumStringValues

func GetLifecycleStateEnumStringValues() []string

GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum

func GetListDigitalTwinAdaptersLifecycleStateEnumStringValues

func GetListDigitalTwinAdaptersLifecycleStateEnumStringValues() []string

GetListDigitalTwinAdaptersLifecycleStateEnumStringValues Enumerates the set of values in String for ListDigitalTwinAdaptersLifecycleStateEnum

func GetListDigitalTwinAdaptersSortByEnumStringValues

func GetListDigitalTwinAdaptersSortByEnumStringValues() []string

GetListDigitalTwinAdaptersSortByEnumStringValues Enumerates the set of values in String for ListDigitalTwinAdaptersSortByEnum

func GetListDigitalTwinAdaptersSortOrderEnumStringValues

func GetListDigitalTwinAdaptersSortOrderEnumStringValues() []string

GetListDigitalTwinAdaptersSortOrderEnumStringValues Enumerates the set of values in String for ListDigitalTwinAdaptersSortOrderEnum

func GetListDigitalTwinInstancesLifecycleStateEnumStringValues

func GetListDigitalTwinInstancesLifecycleStateEnumStringValues() []string

GetListDigitalTwinInstancesLifecycleStateEnumStringValues Enumerates the set of values in String for ListDigitalTwinInstancesLifecycleStateEnum

func GetListDigitalTwinInstancesSortByEnumStringValues

func GetListDigitalTwinInstancesSortByEnumStringValues() []string

GetListDigitalTwinInstancesSortByEnumStringValues Enumerates the set of values in String for ListDigitalTwinInstancesSortByEnum

func GetListDigitalTwinInstancesSortOrderEnumStringValues

func GetListDigitalTwinInstancesSortOrderEnumStringValues() []string

GetListDigitalTwinInstancesSortOrderEnumStringValues Enumerates the set of values in String for ListDigitalTwinInstancesSortOrderEnum

func GetListDigitalTwinModelsLifecycleStateEnumStringValues

func GetListDigitalTwinModelsLifecycleStateEnumStringValues() []string

GetListDigitalTwinModelsLifecycleStateEnumStringValues Enumerates the set of values in String for ListDigitalTwinModelsLifecycleStateEnum

func GetListDigitalTwinModelsSortByEnumStringValues

func GetListDigitalTwinModelsSortByEnumStringValues() []string

GetListDigitalTwinModelsSortByEnumStringValues Enumerates the set of values in String for ListDigitalTwinModelsSortByEnum

func GetListDigitalTwinModelsSortOrderEnumStringValues

func GetListDigitalTwinModelsSortOrderEnumStringValues() []string

GetListDigitalTwinModelsSortOrderEnumStringValues Enumerates the set of values in String for ListDigitalTwinModelsSortOrderEnum

func GetListDigitalTwinRelationshipsLifecycleStateEnumStringValues

func GetListDigitalTwinRelationshipsLifecycleStateEnumStringValues() []string

GetListDigitalTwinRelationshipsLifecycleStateEnumStringValues Enumerates the set of values in String for ListDigitalTwinRelationshipsLifecycleStateEnum

func GetListDigitalTwinRelationshipsSortByEnumStringValues

func GetListDigitalTwinRelationshipsSortByEnumStringValues() []string

GetListDigitalTwinRelationshipsSortByEnumStringValues Enumerates the set of values in String for ListDigitalTwinRelationshipsSortByEnum

func GetListDigitalTwinRelationshipsSortOrderEnumStringValues

func GetListDigitalTwinRelationshipsSortOrderEnumStringValues() []string

GetListDigitalTwinRelationshipsSortOrderEnumStringValues Enumerates the set of values in String for ListDigitalTwinRelationshipsSortOrderEnum

func GetListIotDomainGroupsSortByEnumStringValues

func GetListIotDomainGroupsSortByEnumStringValues() []string

GetListIotDomainGroupsSortByEnumStringValues Enumerates the set of values in String for ListIotDomainGroupsSortByEnum

func GetListIotDomainGroupsSortOrderEnumStringValues

func GetListIotDomainGroupsSortOrderEnumStringValues() []string

GetListIotDomainGroupsSortOrderEnumStringValues Enumerates the set of values in String for ListIotDomainGroupsSortOrderEnum

func GetListIotDomainsSortByEnumStringValues

func GetListIotDomainsSortByEnumStringValues() []string

GetListIotDomainsSortByEnumStringValues Enumerates the set of values in String for ListIotDomainsSortByEnum

func GetListIotDomainsSortOrderEnumStringValues

func GetListIotDomainsSortOrderEnumStringValues() []string

GetListIotDomainsSortOrderEnumStringValues Enumerates the set of values in String for ListIotDomainsSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsStatusEnumStringValues

func GetListWorkRequestsStatusEnumStringValues() []string

GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum

func GetOperationStatusEnumStringValues

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetWorkRequestResourceMetadataKeyEnumStringValues

func GetWorkRequestResourceMetadataKeyEnumStringValues() []string

GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum

Types

type ActionTypeEnum

type ActionTypeEnum string

ActionTypeEnum Enum with underlying type: string

const (
	ActionTypeCreated    ActionTypeEnum = "CREATED"
	ActionTypeUpdated    ActionTypeEnum = "UPDATED"
	ActionTypeDeleted    ActionTypeEnum = "DELETED"
	ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
	ActionTypeRelated    ActionTypeEnum = "RELATED"
	ActionTypeFailed     ActionTypeEnum = "FAILED"
)

Set of constants representing the allowable values for ActionTypeEnum

func GetActionTypeEnumValues

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ApexDataAccessDetails

type ApexDataAccessDetails struct {

	// Initial admin password for APEX workspace associated with the IoT domain.
	DbWorkspaceAdminInitialPassword *string `mandatory:"true" json:"dbWorkspaceAdminInitialPassword"`
}

ApexDataAccessDetails This contains configuration for apex data access.

func (ApexDataAccessDetails) MarshalJSON

func (m ApexDataAccessDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ApexDataAccessDetails) String

func (m ApexDataAccessDetails) String() string

func (ApexDataAccessDetails) ValidateEnumValue

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

type ChangeIotDomainCompartmentDetails

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

ChangeIotDomainCompartmentDetails The configuration details for the move operation.

func (ChangeIotDomainCompartmentDetails) String

func (ChangeIotDomainCompartmentDetails) ValidateEnumValue

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

type 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
}

ChangeIotDomainCompartmentRequest wrapper for the ChangeIotDomainCompartment operation

See also

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.

func (ChangeIotDomainCompartmentRequest) BinaryRequestBody

func (request ChangeIotDomainCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeIotDomainCompartmentRequest) HTTPRequest

func (request ChangeIotDomainCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeIotDomainCompartmentRequest) RetryPolicy

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

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

func (ChangeIotDomainCompartmentRequest) String

func (request ChangeIotDomainCompartmentRequest) String() string

func (ChangeIotDomainCompartmentRequest) ValidateEnumValue

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

type ChangeIotDomainCompartmentResponse

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

ChangeIotDomainCompartmentResponse wrapper for the ChangeIotDomainCompartment operation

func (ChangeIotDomainCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeIotDomainCompartmentResponse) String

func (response ChangeIotDomainCompartmentResponse) String() string

type ChangeIotDomainDataRetentionPeriodDetails

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

ChangeIotDomainDataRetentionPeriodDetails The configuration details for data retention periods.

func (ChangeIotDomainDataRetentionPeriodDetails) String

func (ChangeIotDomainDataRetentionPeriodDetails) ValidateEnumValue

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

type ChangeIotDomainDataRetentionPeriodDetailsTypeEnum

type ChangeIotDomainDataRetentionPeriodDetailsTypeEnum string

ChangeIotDomainDataRetentionPeriodDetailsTypeEnum Enum with underlying type: string

const (
	ChangeIotDomainDataRetentionPeriodDetailsTypeRawData        ChangeIotDomainDataRetentionPeriodDetailsTypeEnum = "RAW_DATA"
	ChangeIotDomainDataRetentionPeriodDetailsTypeRejectedData   ChangeIotDomainDataRetentionPeriodDetailsTypeEnum = "REJECTED_DATA"
	ChangeIotDomainDataRetentionPeriodDetailsTypeHistorizedData ChangeIotDomainDataRetentionPeriodDetailsTypeEnum = "HISTORIZED_DATA"
	ChangeIotDomainDataRetentionPeriodDetailsTypeRawCommandData ChangeIotDomainDataRetentionPeriodDetailsTypeEnum = "RAW_COMMAND_DATA"
)

Set of constants representing the allowable values for ChangeIotDomainDataRetentionPeriodDetailsTypeEnum

func GetChangeIotDomainDataRetentionPeriodDetailsTypeEnumValues

func GetChangeIotDomainDataRetentionPeriodDetailsTypeEnumValues() []ChangeIotDomainDataRetentionPeriodDetailsTypeEnum

GetChangeIotDomainDataRetentionPeriodDetailsTypeEnumValues Enumerates the set of values for ChangeIotDomainDataRetentionPeriodDetailsTypeEnum

func GetMappingChangeIotDomainDataRetentionPeriodDetailsTypeEnum

func GetMappingChangeIotDomainDataRetentionPeriodDetailsTypeEnum(val string) (ChangeIotDomainDataRetentionPeriodDetailsTypeEnum, bool)

GetMappingChangeIotDomainDataRetentionPeriodDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ChangeIotDomainDataRetentionPeriodRequest wrapper for the ChangeIotDomainDataRetentionPeriod operation

See also

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.

func (ChangeIotDomainDataRetentionPeriodRequest) BinaryRequestBody

BinaryRequestBody implements the OCIRequest interface

func (ChangeIotDomainDataRetentionPeriodRequest) HTTPRequest

func (request ChangeIotDomainDataRetentionPeriodRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeIotDomainDataRetentionPeriodRequest) RetryPolicy

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

func (ChangeIotDomainDataRetentionPeriodRequest) String

func (ChangeIotDomainDataRetentionPeriodRequest) ValidateEnumValue

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

type ChangeIotDomainDataRetentionPeriodResponse

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

ChangeIotDomainDataRetentionPeriodResponse wrapper for the ChangeIotDomainDataRetentionPeriod operation

func (ChangeIotDomainDataRetentionPeriodResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeIotDomainDataRetentionPeriodResponse) String

type ChangeIotDomainGroupCompartmentDetails

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

ChangeIotDomainGroupCompartmentDetails The configuration details for the move operation.

func (ChangeIotDomainGroupCompartmentDetails) String

func (ChangeIotDomainGroupCompartmentDetails) ValidateEnumValue

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

type 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
}

ChangeIotDomainGroupCompartmentRequest wrapper for the ChangeIotDomainGroupCompartment operation

See also

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.

func (ChangeIotDomainGroupCompartmentRequest) BinaryRequestBody

func (request ChangeIotDomainGroupCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeIotDomainGroupCompartmentRequest) HTTPRequest

func (request ChangeIotDomainGroupCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeIotDomainGroupCompartmentRequest) RetryPolicy

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

func (ChangeIotDomainGroupCompartmentRequest) String

func (ChangeIotDomainGroupCompartmentRequest) ValidateEnumValue

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

type ChangeIotDomainGroupCompartmentResponse

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

ChangeIotDomainGroupCompartmentResponse wrapper for the ChangeIotDomainGroupCompartment operation

func (ChangeIotDomainGroupCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeIotDomainGroupCompartmentResponse) String

type ConfigureIotDomainDataAccessDetails

type ConfigureIotDomainDataAccessDetails interface {
}

ConfigureIotDomainDataAccessDetails The configuration details for IoT Domain Data Access.

type ConfigureIotDomainDataAccessDetailsTypeEnum

type ConfigureIotDomainDataAccessDetailsTypeEnum string

ConfigureIotDomainDataAccessDetailsTypeEnum Enum with underlying type: string

const (
	ConfigureIotDomainDataAccessDetailsTypeDirect ConfigureIotDomainDataAccessDetailsTypeEnum = "DIRECT"
	ConfigureIotDomainDataAccessDetailsTypeOrds   ConfigureIotDomainDataAccessDetailsTypeEnum = "ORDS"
	ConfigureIotDomainDataAccessDetailsTypeApex   ConfigureIotDomainDataAccessDetailsTypeEnum = "APEX"
)

Set of constants representing the allowable values for ConfigureIotDomainDataAccessDetailsTypeEnum

func GetConfigureIotDomainDataAccessDetailsTypeEnumValues

func GetConfigureIotDomainDataAccessDetailsTypeEnumValues() []ConfigureIotDomainDataAccessDetailsTypeEnum

GetConfigureIotDomainDataAccessDetailsTypeEnumValues Enumerates the set of values for ConfigureIotDomainDataAccessDetailsTypeEnum

func GetMappingConfigureIotDomainDataAccessDetailsTypeEnum

func GetMappingConfigureIotDomainDataAccessDetailsTypeEnum(val string) (ConfigureIotDomainDataAccessDetailsTypeEnum, bool)

GetMappingConfigureIotDomainDataAccessDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ConfigureIotDomainDataAccessRequest wrapper for the ConfigureIotDomainDataAccess operation

See also

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.

func (ConfigureIotDomainDataAccessRequest) BinaryRequestBody

func (request ConfigureIotDomainDataAccessRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ConfigureIotDomainDataAccessRequest) HTTPRequest

func (request ConfigureIotDomainDataAccessRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ConfigureIotDomainDataAccessRequest) RetryPolicy

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

func (ConfigureIotDomainDataAccessRequest) String

func (ConfigureIotDomainDataAccessRequest) ValidateEnumValue

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

type ConfigureIotDomainDataAccessResponse

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

ConfigureIotDomainDataAccessResponse wrapper for the ConfigureIotDomainDataAccess operation

func (ConfigureIotDomainDataAccessResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ConfigureIotDomainDataAccessResponse) String

func (response ConfigureIotDomainDataAccessResponse) String() string

type ConfigureIotDomainGroupDataAccessDetails

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

ConfigureIotDomainGroupDataAccessDetails The configuration details for an IoT Domain Group Data Access through allowlisted vcn ids.

func (ConfigureIotDomainGroupDataAccessDetails) String

func (ConfigureIotDomainGroupDataAccessDetails) ValidateEnumValue

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

type 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
}

ConfigureIotDomainGroupDataAccessRequest wrapper for the ConfigureIotDomainGroupDataAccess operation

See also

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.

func (ConfigureIotDomainGroupDataAccessRequest) BinaryRequestBody

BinaryRequestBody implements the OCIRequest interface

func (ConfigureIotDomainGroupDataAccessRequest) HTTPRequest

func (request ConfigureIotDomainGroupDataAccessRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ConfigureIotDomainGroupDataAccessRequest) RetryPolicy

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

func (ConfigureIotDomainGroupDataAccessRequest) String

func (ConfigureIotDomainGroupDataAccessRequest) ValidateEnumValue

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

type ConfigureIotDomainGroupDataAccessResponse

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

ConfigureIotDomainGroupDataAccessResponse wrapper for the ConfigureIotDomainGroupDataAccess operation

func (ConfigureIotDomainGroupDataAccessResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ConfigureIotDomainGroupDataAccessResponse) String

type CreateDigitalTwinAdapterDetails

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

CreateDigitalTwinAdapterDetails The information about new digital twin adapter to be created.

func (CreateDigitalTwinAdapterDetails) String

func (CreateDigitalTwinAdapterDetails) ValidateEnumValue

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

type 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
}

CreateDigitalTwinAdapterRequest wrapper for the CreateDigitalTwinAdapter operation

See also

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.

func (CreateDigitalTwinAdapterRequest) BinaryRequestBody

func (request CreateDigitalTwinAdapterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateDigitalTwinAdapterRequest) HTTPRequest

func (request CreateDigitalTwinAdapterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateDigitalTwinAdapterRequest) RetryPolicy

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

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

func (CreateDigitalTwinAdapterRequest) String

func (request CreateDigitalTwinAdapterRequest) String() string

func (CreateDigitalTwinAdapterRequest) ValidateEnumValue

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

type CreateDigitalTwinAdapterResponse

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

CreateDigitalTwinAdapterResponse wrapper for the CreateDigitalTwinAdapter operation

func (CreateDigitalTwinAdapterResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateDigitalTwinAdapterResponse) String

func (response CreateDigitalTwinAdapterResponse) String() string

type CreateDigitalTwinInstanceDetails

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

CreateDigitalTwinInstanceDetails The information about new digital twin instance to be created.

func (CreateDigitalTwinInstanceDetails) String

func (CreateDigitalTwinInstanceDetails) ValidateEnumValue

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

type 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
}

CreateDigitalTwinInstanceRequest wrapper for the CreateDigitalTwinInstance operation

See also

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.

func (CreateDigitalTwinInstanceRequest) BinaryRequestBody

func (request CreateDigitalTwinInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateDigitalTwinInstanceRequest) HTTPRequest

func (request CreateDigitalTwinInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateDigitalTwinInstanceRequest) RetryPolicy

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

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

func (CreateDigitalTwinInstanceRequest) String

func (request CreateDigitalTwinInstanceRequest) String() string

func (CreateDigitalTwinInstanceRequest) ValidateEnumValue

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

type CreateDigitalTwinInstanceResponse

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

CreateDigitalTwinInstanceResponse wrapper for the CreateDigitalTwinInstance operation

func (CreateDigitalTwinInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateDigitalTwinInstanceResponse) String

func (response CreateDigitalTwinInstanceResponse) String() string

type CreateDigitalTwinModelDetails

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

CreateDigitalTwinModelDetails The information about new digital twin model to be created.

func (CreateDigitalTwinModelDetails) String

func (CreateDigitalTwinModelDetails) ValidateEnumValue

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

type 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
}

CreateDigitalTwinModelRequest wrapper for the CreateDigitalTwinModel operation

See also

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.

func (CreateDigitalTwinModelRequest) BinaryRequestBody

func (request CreateDigitalTwinModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateDigitalTwinModelRequest) HTTPRequest

func (request CreateDigitalTwinModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateDigitalTwinModelRequest) RetryPolicy

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

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

func (CreateDigitalTwinModelRequest) String

func (request CreateDigitalTwinModelRequest) String() string

func (CreateDigitalTwinModelRequest) ValidateEnumValue

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

type CreateDigitalTwinModelResponse

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

CreateDigitalTwinModelResponse wrapper for the CreateDigitalTwinModel operation

func (CreateDigitalTwinModelResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateDigitalTwinModelResponse) String

func (response CreateDigitalTwinModelResponse) String() string

type CreateDigitalTwinRelationshipDetails

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

CreateDigitalTwinRelationshipDetails The information about new digital twin relationship to be created.

func (CreateDigitalTwinRelationshipDetails) String

func (CreateDigitalTwinRelationshipDetails) ValidateEnumValue

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

type 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
}

CreateDigitalTwinRelationshipRequest wrapper for the CreateDigitalTwinRelationship operation

See also

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.

func (CreateDigitalTwinRelationshipRequest) BinaryRequestBody

func (request CreateDigitalTwinRelationshipRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateDigitalTwinRelationshipRequest) HTTPRequest

func (request CreateDigitalTwinRelationshipRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateDigitalTwinRelationshipRequest) RetryPolicy

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

func (CreateDigitalTwinRelationshipRequest) String

func (CreateDigitalTwinRelationshipRequest) ValidateEnumValue

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

type CreateDigitalTwinRelationshipResponse

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

CreateDigitalTwinRelationshipResponse wrapper for the CreateDigitalTwinRelationship operation

func (CreateDigitalTwinRelationshipResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateDigitalTwinRelationshipResponse) String

type CreateIotDomainDetails

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

CreateIotDomainDetails The information about new IoT domain to be created.

func (CreateIotDomainDetails) String

func (m CreateIotDomainDetails) String() string

func (CreateIotDomainDetails) ValidateEnumValue

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

type CreateIotDomainGroupDetails

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

CreateIotDomainGroupDetails The information about new IoT domain group to be created.

func (CreateIotDomainGroupDetails) String

func (CreateIotDomainGroupDetails) ValidateEnumValue

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

type 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
}

CreateIotDomainGroupRequest wrapper for the CreateIotDomainGroup operation

See also

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.

func (CreateIotDomainGroupRequest) BinaryRequestBody

func (request CreateIotDomainGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateIotDomainGroupRequest) HTTPRequest

func (request CreateIotDomainGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateIotDomainGroupRequest) RetryPolicy

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

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

func (CreateIotDomainGroupRequest) String

func (request CreateIotDomainGroupRequest) String() string

func (CreateIotDomainGroupRequest) ValidateEnumValue

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

type CreateIotDomainGroupResponse

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

CreateIotDomainGroupResponse wrapper for the CreateIotDomainGroup operation

func (CreateIotDomainGroupResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateIotDomainGroupResponse) String

func (response CreateIotDomainGroupResponse) String() string

type 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
}

CreateIotDomainRequest wrapper for the CreateIotDomain operation

See also

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.

func (CreateIotDomainRequest) BinaryRequestBody

func (request CreateIotDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateIotDomainRequest) HTTPRequest

func (request CreateIotDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateIotDomainRequest) RetryPolicy

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

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

func (CreateIotDomainRequest) String

func (request CreateIotDomainRequest) String() string

func (CreateIotDomainRequest) ValidateEnumValue

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

type CreateIotDomainResponse

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

CreateIotDomainResponse wrapper for the CreateIotDomain operation

func (CreateIotDomainResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateIotDomainResponse) String

func (response CreateIotDomainResponse) String() string

type DataRetentionPeriodsInDays

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

DataRetentionPeriodsInDays Data Retention periods

func (DataRetentionPeriodsInDays) String

func (DataRetentionPeriodsInDays) ValidateEnumValue

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

type 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
}

DeleteDigitalTwinAdapterRequest wrapper for the DeleteDigitalTwinAdapter operation

See also

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.

func (DeleteDigitalTwinAdapterRequest) BinaryRequestBody

func (request DeleteDigitalTwinAdapterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteDigitalTwinAdapterRequest) HTTPRequest

func (request DeleteDigitalTwinAdapterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDigitalTwinAdapterRequest) RetryPolicy

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

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

func (DeleteDigitalTwinAdapterRequest) String

func (request DeleteDigitalTwinAdapterRequest) String() string

func (DeleteDigitalTwinAdapterRequest) ValidateEnumValue

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

type DeleteDigitalTwinAdapterResponse

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

DeleteDigitalTwinAdapterResponse wrapper for the DeleteDigitalTwinAdapter operation

func (DeleteDigitalTwinAdapterResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteDigitalTwinAdapterResponse) String

func (response DeleteDigitalTwinAdapterResponse) String() string

type 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
}

DeleteDigitalTwinInstanceRequest wrapper for the DeleteDigitalTwinInstance operation

See also

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.

func (DeleteDigitalTwinInstanceRequest) BinaryRequestBody

func (request DeleteDigitalTwinInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteDigitalTwinInstanceRequest) HTTPRequest

func (request DeleteDigitalTwinInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDigitalTwinInstanceRequest) RetryPolicy

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

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

func (DeleteDigitalTwinInstanceRequest) String

func (request DeleteDigitalTwinInstanceRequest) String() string

func (DeleteDigitalTwinInstanceRequest) ValidateEnumValue

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

type DeleteDigitalTwinInstanceResponse

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

DeleteDigitalTwinInstanceResponse wrapper for the DeleteDigitalTwinInstance operation

func (DeleteDigitalTwinInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteDigitalTwinInstanceResponse) String

func (response DeleteDigitalTwinInstanceResponse) String() string

type 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
}

DeleteDigitalTwinModelRequest wrapper for the DeleteDigitalTwinModel operation

See also

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.

func (DeleteDigitalTwinModelRequest) BinaryRequestBody

func (request DeleteDigitalTwinModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteDigitalTwinModelRequest) HTTPRequest

func (request DeleteDigitalTwinModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDigitalTwinModelRequest) RetryPolicy

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

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

func (DeleteDigitalTwinModelRequest) String

func (request DeleteDigitalTwinModelRequest) String() string

func (DeleteDigitalTwinModelRequest) ValidateEnumValue

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

type DeleteDigitalTwinModelResponse

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

DeleteDigitalTwinModelResponse wrapper for the DeleteDigitalTwinModel operation

func (DeleteDigitalTwinModelResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteDigitalTwinModelResponse) String

func (response DeleteDigitalTwinModelResponse) String() string

type 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
}

DeleteDigitalTwinRelationshipRequest wrapper for the DeleteDigitalTwinRelationship operation

See also

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.

func (DeleteDigitalTwinRelationshipRequest) BinaryRequestBody

func (request DeleteDigitalTwinRelationshipRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteDigitalTwinRelationshipRequest) HTTPRequest

func (request DeleteDigitalTwinRelationshipRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDigitalTwinRelationshipRequest) RetryPolicy

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

func (DeleteDigitalTwinRelationshipRequest) String

func (DeleteDigitalTwinRelationshipRequest) ValidateEnumValue

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

type DeleteDigitalTwinRelationshipResponse

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

DeleteDigitalTwinRelationshipResponse wrapper for the DeleteDigitalTwinRelationship operation

func (DeleteDigitalTwinRelationshipResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteDigitalTwinRelationshipResponse) String

type 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
}

DeleteIotDomainGroupRequest wrapper for the DeleteIotDomainGroup operation

See also

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.

func (DeleteIotDomainGroupRequest) BinaryRequestBody

func (request DeleteIotDomainGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteIotDomainGroupRequest) HTTPRequest

func (request DeleteIotDomainGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteIotDomainGroupRequest) RetryPolicy

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

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

func (DeleteIotDomainGroupRequest) String

func (request DeleteIotDomainGroupRequest) String() string

func (DeleteIotDomainGroupRequest) ValidateEnumValue

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

type DeleteIotDomainGroupResponse

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

DeleteIotDomainGroupResponse wrapper for the DeleteIotDomainGroup operation

func (DeleteIotDomainGroupResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteIotDomainGroupResponse) String

func (response DeleteIotDomainGroupResponse) String() string

type 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
}

DeleteIotDomainRequest wrapper for the DeleteIotDomain operation

See also

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.

func (DeleteIotDomainRequest) BinaryRequestBody

func (request DeleteIotDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteIotDomainRequest) HTTPRequest

func (request DeleteIotDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteIotDomainRequest) RetryPolicy

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

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

func (DeleteIotDomainRequest) String

func (request DeleteIotDomainRequest) String() string

func (DeleteIotDomainRequest) ValidateEnumValue

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

type DeleteIotDomainResponse

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

DeleteIotDomainResponse wrapper for the DeleteIotDomain operation

func (DeleteIotDomainResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteIotDomainResponse) String

func (response DeleteIotDomainResponse) String() string

type DigitalTwinAdapter

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

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).

func (DigitalTwinAdapter) String

func (m DigitalTwinAdapter) String() string

func (DigitalTwinAdapter) ValidateEnumValue

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

type DigitalTwinAdapterCollection

type DigitalTwinAdapterCollection struct {

	// List of the digital twin adapters.
	Items []DigitalTwinAdapterSummary `mandatory:"true" json:"items"`
}

DigitalTwinAdapterCollection Results of a digital twin adapter search. Contains both summary and additional metadata information.

func (DigitalTwinAdapterCollection) String

func (DigitalTwinAdapterCollection) ValidateEnumValue

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

type DigitalTwinAdapterEnvelopeMapping

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

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.

func (DigitalTwinAdapterEnvelopeMapping) String

func (DigitalTwinAdapterEnvelopeMapping) ValidateEnumValue

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

type DigitalTwinAdapterInboundEnvelope

type DigitalTwinAdapterInboundEnvelope struct {

	// The device endpoint.
	ReferenceEndpoint *string `mandatory:"true" json:"referenceEndpoint"`

	ReferencePayload DigitalTwinAdapterPayload `mandatory:"false" json:"referencePayload"`

	EnvelopeMapping *DigitalTwinAdapterEnvelopeMapping `mandatory:"false" json:"envelopeMapping"`
}

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.

func (DigitalTwinAdapterInboundEnvelope) String

func (*DigitalTwinAdapterInboundEnvelope) UnmarshalJSON

func (m *DigitalTwinAdapterInboundEnvelope) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (DigitalTwinAdapterInboundEnvelope) ValidateEnumValue

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

type DigitalTwinAdapterInboundRoute

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

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.

func (DigitalTwinAdapterInboundRoute) String

func (*DigitalTwinAdapterInboundRoute) UnmarshalJSON

func (m *DigitalTwinAdapterInboundRoute) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (DigitalTwinAdapterInboundRoute) ValidateEnumValue

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

type DigitalTwinAdapterJsonPayload

type DigitalTwinAdapterJsonPayload struct {

	// JSON raw data.
	Data map[string]interface{} `mandatory:"true" json:"data"`
}

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

func (DigitalTwinAdapterJsonPayload) MarshalJSON

func (m DigitalTwinAdapterJsonPayload) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (DigitalTwinAdapterJsonPayload) String

func (DigitalTwinAdapterJsonPayload) ValidateEnumValue

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

type DigitalTwinAdapterPayload

type DigitalTwinAdapterPayload interface {
}

DigitalTwinAdapterPayload Reference payload structure template received from IoT device. This payload must specify its content type using the `dataFormat` property.

type DigitalTwinAdapterPayloadDataFormatEnum

type DigitalTwinAdapterPayloadDataFormatEnum string

DigitalTwinAdapterPayloadDataFormatEnum Enum with underlying type: string

const (
	DigitalTwinAdapterPayloadDataFormatJson DigitalTwinAdapterPayloadDataFormatEnum = "JSON"
)

Set of constants representing the allowable values for DigitalTwinAdapterPayloadDataFormatEnum

func GetDigitalTwinAdapterPayloadDataFormatEnumValues

func GetDigitalTwinAdapterPayloadDataFormatEnumValues() []DigitalTwinAdapterPayloadDataFormatEnum

GetDigitalTwinAdapterPayloadDataFormatEnumValues Enumerates the set of values for DigitalTwinAdapterPayloadDataFormatEnum

func GetMappingDigitalTwinAdapterPayloadDataFormatEnum

func GetMappingDigitalTwinAdapterPayloadDataFormatEnum(val string) (DigitalTwinAdapterPayloadDataFormatEnum, bool)

GetMappingDigitalTwinAdapterPayloadDataFormatEnum performs case Insensitive comparison on enum value and return the desired enum

type DigitalTwinAdapterSummary

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

DigitalTwinAdapterSummary Summary information about a digital twin adapter.

func (DigitalTwinAdapterSummary) String

func (m DigitalTwinAdapterSummary) String() string

func (DigitalTwinAdapterSummary) ValidateEnumValue

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

type DigitalTwinInstance

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

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).

func (DigitalTwinInstance) String

func (m DigitalTwinInstance) String() string

func (DigitalTwinInstance) ValidateEnumValue

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

type DigitalTwinInstanceCollection

type DigitalTwinInstanceCollection struct {

	// List of digital twin instances.
	Items []DigitalTwinInstanceSummary `mandatory:"true" json:"items"`
}

DigitalTwinInstanceCollection Results of digital twin instance search. Contains both summary and additional metadata information

func (DigitalTwinInstanceCollection) String

func (DigitalTwinInstanceCollection) ValidateEnumValue

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

type DigitalTwinInstanceSummary

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

DigitalTwinInstanceSummary Summary of the digital twin instance

func (DigitalTwinInstanceSummary) String

func (DigitalTwinInstanceSummary) ValidateEnumValue

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

type DigitalTwinModel

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

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).

func (DigitalTwinModel) String

func (m DigitalTwinModel) String() string

func (DigitalTwinModel) ValidateEnumValue

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

type DigitalTwinModelCollection

type DigitalTwinModelCollection struct {

	// List of digital twin models.
	Items []DigitalTwinModelSummary `mandatory:"true" json:"items"`
}

DigitalTwinModelCollection Results of a digital twin model search. Contains both summary and additional metadata information.

func (DigitalTwinModelCollection) String

func (DigitalTwinModelCollection) ValidateEnumValue

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

type DigitalTwinModelSummary

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

DigitalTwinModelSummary Summary of the digital twin model.

func (DigitalTwinModelSummary) String

func (m DigitalTwinModelSummary) String() string

func (DigitalTwinModelSummary) ValidateEnumValue

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

type DigitalTwinRelationship

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

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).

func (DigitalTwinRelationship) String

func (m DigitalTwinRelationship) String() string

func (DigitalTwinRelationship) ValidateEnumValue

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

type DigitalTwinRelationshipCollection

type DigitalTwinRelationshipCollection struct {

	// List of digital twin relationships
	Items []DigitalTwinRelationshipSummary `mandatory:"true" json:"items"`
}

DigitalTwinRelationshipCollection Results of digital twin relationships search. Contains both summary and additional metadata information

func (DigitalTwinRelationshipCollection) String

func (DigitalTwinRelationshipCollection) ValidateEnumValue

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

type DigitalTwinRelationshipSummary

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

DigitalTwinRelationshipSummary Describes digital twin relationship summary

func (DigitalTwinRelationshipSummary) String

func (DigitalTwinRelationshipSummary) ValidateEnumValue

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

type DirectDataAccessDetails

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

DirectDataAccessDetails This contains configuration for direct data access.

func (DirectDataAccessDetails) MarshalJSON

func (m DirectDataAccessDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (DirectDataAccessDetails) String

func (m DirectDataAccessDetails) String() string

func (DirectDataAccessDetails) ValidateEnumValue

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

type ErrorDetails

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

ErrorDetails Error Information.

func (ErrorDetails) String

func (m ErrorDetails) String() string

func (ErrorDetails) ValidateEnumValue

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

type 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
}

GetDigitalTwinAdapterRequest wrapper for the GetDigitalTwinAdapter operation

See also

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.

func (GetDigitalTwinAdapterRequest) BinaryRequestBody

func (request GetDigitalTwinAdapterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDigitalTwinAdapterRequest) HTTPRequest

func (request GetDigitalTwinAdapterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDigitalTwinAdapterRequest) RetryPolicy

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

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

func (GetDigitalTwinAdapterRequest) String

func (request GetDigitalTwinAdapterRequest) String() string

func (GetDigitalTwinAdapterRequest) ValidateEnumValue

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

type GetDigitalTwinAdapterResponse

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

GetDigitalTwinAdapterResponse wrapper for the GetDigitalTwinAdapter operation

func (GetDigitalTwinAdapterResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetDigitalTwinAdapterResponse) String

func (response GetDigitalTwinAdapterResponse) String() string

type 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
}

GetDigitalTwinInstanceContentRequest wrapper for the GetDigitalTwinInstanceContent operation

See also

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.

func (GetDigitalTwinInstanceContentRequest) BinaryRequestBody

func (request GetDigitalTwinInstanceContentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDigitalTwinInstanceContentRequest) HTTPRequest

func (request GetDigitalTwinInstanceContentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDigitalTwinInstanceContentRequest) RetryPolicy

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

func (GetDigitalTwinInstanceContentRequest) String

func (GetDigitalTwinInstanceContentRequest) ValidateEnumValue

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

type GetDigitalTwinInstanceContentResponse

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

GetDigitalTwinInstanceContentResponse wrapper for the GetDigitalTwinInstanceContent operation

func (GetDigitalTwinInstanceContentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetDigitalTwinInstanceContentResponse) String

type 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
}

GetDigitalTwinInstanceRequest wrapper for the GetDigitalTwinInstance operation

See also

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.

func (GetDigitalTwinInstanceRequest) BinaryRequestBody

func (request GetDigitalTwinInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDigitalTwinInstanceRequest) HTTPRequest

func (request GetDigitalTwinInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDigitalTwinInstanceRequest) RetryPolicy

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

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

func (GetDigitalTwinInstanceRequest) String

func (request GetDigitalTwinInstanceRequest) String() string

func (GetDigitalTwinInstanceRequest) ValidateEnumValue

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

type GetDigitalTwinInstanceResponse

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

GetDigitalTwinInstanceResponse wrapper for the GetDigitalTwinInstance operation

func (GetDigitalTwinInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetDigitalTwinInstanceResponse) String

func (response GetDigitalTwinInstanceResponse) String() string

type 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
}

GetDigitalTwinModelRequest wrapper for the GetDigitalTwinModel operation

See also

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.

func (GetDigitalTwinModelRequest) BinaryRequestBody

func (request GetDigitalTwinModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDigitalTwinModelRequest) HTTPRequest

func (request GetDigitalTwinModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDigitalTwinModelRequest) RetryPolicy

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

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

func (GetDigitalTwinModelRequest) String

func (request GetDigitalTwinModelRequest) String() string

func (GetDigitalTwinModelRequest) ValidateEnumValue

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

type GetDigitalTwinModelResponse

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

GetDigitalTwinModelResponse wrapper for the GetDigitalTwinModel operation

func (GetDigitalTwinModelResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetDigitalTwinModelResponse) String

func (response GetDigitalTwinModelResponse) String() string

type 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
}

GetDigitalTwinModelSpecRequest wrapper for the GetDigitalTwinModelSpec operation

See also

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.

func (GetDigitalTwinModelSpecRequest) BinaryRequestBody

func (request GetDigitalTwinModelSpecRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDigitalTwinModelSpecRequest) HTTPRequest

func (request GetDigitalTwinModelSpecRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDigitalTwinModelSpecRequest) RetryPolicy

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

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

func (GetDigitalTwinModelSpecRequest) String

func (request GetDigitalTwinModelSpecRequest) String() string

func (GetDigitalTwinModelSpecRequest) ValidateEnumValue

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

type GetDigitalTwinModelSpecResponse

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

GetDigitalTwinModelSpecResponse wrapper for the GetDigitalTwinModelSpec operation

func (GetDigitalTwinModelSpecResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetDigitalTwinModelSpecResponse) String

func (response GetDigitalTwinModelSpecResponse) String() string

type 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
}

GetDigitalTwinRelationshipRequest wrapper for the GetDigitalTwinRelationship operation

See also

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.

func (GetDigitalTwinRelationshipRequest) BinaryRequestBody

func (request GetDigitalTwinRelationshipRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDigitalTwinRelationshipRequest) HTTPRequest

func (request GetDigitalTwinRelationshipRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDigitalTwinRelationshipRequest) RetryPolicy

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

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

func (GetDigitalTwinRelationshipRequest) String

func (request GetDigitalTwinRelationshipRequest) String() string

func (GetDigitalTwinRelationshipRequest) ValidateEnumValue

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

type GetDigitalTwinRelationshipResponse

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

GetDigitalTwinRelationshipResponse wrapper for the GetDigitalTwinRelationship operation

func (GetDigitalTwinRelationshipResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetDigitalTwinRelationshipResponse) String

func (response GetDigitalTwinRelationshipResponse) String() string

type 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
}

GetIotDomainGroupRequest wrapper for the GetIotDomainGroup operation

See also

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.

func (GetIotDomainGroupRequest) BinaryRequestBody

func (request GetIotDomainGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetIotDomainGroupRequest) HTTPRequest

func (request GetIotDomainGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetIotDomainGroupRequest) RetryPolicy

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

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

func (GetIotDomainGroupRequest) String

func (request GetIotDomainGroupRequest) String() string

func (GetIotDomainGroupRequest) ValidateEnumValue

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

type GetIotDomainGroupResponse

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

GetIotDomainGroupResponse wrapper for the GetIotDomainGroup operation

func (GetIotDomainGroupResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetIotDomainGroupResponse) String

func (response GetIotDomainGroupResponse) String() string

type 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
}

GetIotDomainRequest wrapper for the GetIotDomain operation

See also

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.

func (GetIotDomainRequest) BinaryRequestBody

func (request GetIotDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetIotDomainRequest) HTTPRequest

func (request GetIotDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetIotDomainRequest) RetryPolicy

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

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

func (GetIotDomainRequest) String

func (request GetIotDomainRequest) String() string

func (GetIotDomainRequest) ValidateEnumValue

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

type GetIotDomainResponse

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

GetIotDomainResponse wrapper for the GetIotDomain operation

func (GetIotDomainResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetIotDomainResponse) String

func (response GetIotDomainResponse) String() string

type 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
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

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.

func (GetWorkRequestRequest) BinaryRequestBody

func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest

func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy

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

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

func (GetWorkRequestRequest) String

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue

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

type GetWorkRequestResponse

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

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type InvokeRawBinaryCommandDetails

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

InvokeRawBinaryCommandDetails Binary data payload definition

func (InvokeRawBinaryCommandDetails) GetRequestDuration

func (m InvokeRawBinaryCommandDetails) GetRequestDuration() *string

GetRequestDuration returns RequestDuration

func (InvokeRawBinaryCommandDetails) GetRequestEndpoint

func (m InvokeRawBinaryCommandDetails) GetRequestEndpoint() *string

GetRequestEndpoint returns RequestEndpoint

func (InvokeRawBinaryCommandDetails) GetResponseDuration

func (m InvokeRawBinaryCommandDetails) GetResponseDuration() *string

GetResponseDuration returns ResponseDuration

func (InvokeRawBinaryCommandDetails) GetResponseEndpoint

func (m InvokeRawBinaryCommandDetails) GetResponseEndpoint() *string

GetResponseEndpoint returns ResponseEndpoint

func (InvokeRawBinaryCommandDetails) MarshalJSON

func (m InvokeRawBinaryCommandDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (InvokeRawBinaryCommandDetails) String

func (InvokeRawBinaryCommandDetails) ValidateEnumValue

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

type InvokeRawCommandDetails

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
}

InvokeRawCommandDetails Definition of unstructured command invocation payload

type InvokeRawCommandDetailsRequestDataFormatEnum

type InvokeRawCommandDetailsRequestDataFormatEnum string

InvokeRawCommandDetailsRequestDataFormatEnum Enum with underlying type: string

const (
	InvokeRawCommandDetailsRequestDataFormatText   InvokeRawCommandDetailsRequestDataFormatEnum = "TEXT"
	InvokeRawCommandDetailsRequestDataFormatJson   InvokeRawCommandDetailsRequestDataFormatEnum = "JSON"
	InvokeRawCommandDetailsRequestDataFormatBinary InvokeRawCommandDetailsRequestDataFormatEnum = "BINARY"
)

Set of constants representing the allowable values for InvokeRawCommandDetailsRequestDataFormatEnum

func GetInvokeRawCommandDetailsRequestDataFormatEnumValues

func GetInvokeRawCommandDetailsRequestDataFormatEnumValues() []InvokeRawCommandDetailsRequestDataFormatEnum

GetInvokeRawCommandDetailsRequestDataFormatEnumValues Enumerates the set of values for InvokeRawCommandDetailsRequestDataFormatEnum

func GetMappingInvokeRawCommandDetailsRequestDataFormatEnum

func GetMappingInvokeRawCommandDetailsRequestDataFormatEnum(val string) (InvokeRawCommandDetailsRequestDataFormatEnum, bool)

GetMappingInvokeRawCommandDetailsRequestDataFormatEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

InvokeRawCommandRequest wrapper for the InvokeRawCommand operation

See also

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.

func (InvokeRawCommandRequest) BinaryRequestBody

func (request InvokeRawCommandRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (InvokeRawCommandRequest) HTTPRequest

func (request InvokeRawCommandRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (InvokeRawCommandRequest) RetryPolicy

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

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

func (InvokeRawCommandRequest) String

func (request InvokeRawCommandRequest) String() string

func (InvokeRawCommandRequest) ValidateEnumValue

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

type InvokeRawCommandResponse

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

InvokeRawCommandResponse wrapper for the InvokeRawCommand operation

func (InvokeRawCommandResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (InvokeRawCommandResponse) String

func (response InvokeRawCommandResponse) String() string

type InvokeRawJsonCommandDetails

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

InvokeRawJsonCommandDetails Json data payload definition

func (InvokeRawJsonCommandDetails) GetRequestDuration

func (m InvokeRawJsonCommandDetails) GetRequestDuration() *string

GetRequestDuration returns RequestDuration

func (InvokeRawJsonCommandDetails) GetRequestEndpoint

func (m InvokeRawJsonCommandDetails) GetRequestEndpoint() *string

GetRequestEndpoint returns RequestEndpoint

func (InvokeRawJsonCommandDetails) GetResponseDuration

func (m InvokeRawJsonCommandDetails) GetResponseDuration() *string

GetResponseDuration returns ResponseDuration

func (InvokeRawJsonCommandDetails) GetResponseEndpoint

func (m InvokeRawJsonCommandDetails) GetResponseEndpoint() *string

GetResponseEndpoint returns ResponseEndpoint

func (InvokeRawJsonCommandDetails) MarshalJSON

func (m InvokeRawJsonCommandDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (InvokeRawJsonCommandDetails) String

func (InvokeRawJsonCommandDetails) ValidateEnumValue

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

type InvokeRawTextCommandDetails

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

InvokeRawTextCommandDetails Text data payload definition

func (InvokeRawTextCommandDetails) GetRequestDuration

func (m InvokeRawTextCommandDetails) GetRequestDuration() *string

GetRequestDuration returns RequestDuration

func (InvokeRawTextCommandDetails) GetRequestEndpoint

func (m InvokeRawTextCommandDetails) GetRequestEndpoint() *string

GetRequestEndpoint returns RequestEndpoint

func (InvokeRawTextCommandDetails) GetResponseDuration

func (m InvokeRawTextCommandDetails) GetResponseDuration() *string

GetResponseDuration returns ResponseDuration

func (InvokeRawTextCommandDetails) GetResponseEndpoint

func (m InvokeRawTextCommandDetails) GetResponseEndpoint() *string

GetResponseEndpoint returns ResponseEndpoint

func (InvokeRawTextCommandDetails) MarshalJSON

func (m InvokeRawTextCommandDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (InvokeRawTextCommandDetails) String

func (InvokeRawTextCommandDetails) ValidateEnumValue

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

type IotClient

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

IotClient a client for Iot

func NewIotClientWithConfigurationProvider

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

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 (IotClient) ChangeIotDomainCompartment

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).

See also

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 (IotClient) ChangeIotDomainDataRetentionPeriod

func (client IotClient) ChangeIotDomainDataRetentionPeriod(ctx context.Context, request ChangeIotDomainDataRetentionPeriodRequest) (response ChangeIotDomainDataRetentionPeriodResponse, err error)

ChangeIotDomainDataRetentionPeriod Updates Data Retention Period of the IoT Domain.

See also

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 (IotClient) ChangeIotDomainGroupCompartment

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).

See also

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 (*IotClient) ConfigurationProvider

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

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

func (IotClient) ConfigureIotDomainDataAccess

func (client IotClient) ConfigureIotDomainDataAccess(ctx context.Context, request ConfigureIotDomainDataAccessRequest) (response ConfigureIotDomainDataAccessResponse, err error)

ConfigureIotDomainDataAccess Updates an IoT domain Data Access.

See also

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 (IotClient) ConfigureIotDomainGroupDataAccess

func (client IotClient) ConfigureIotDomainGroupDataAccess(ctx context.Context, request ConfigureIotDomainGroupDataAccessRequest) (response ConfigureIotDomainGroupDataAccessResponse, err error)

ConfigureIotDomainGroupDataAccess Updates an IoT domain Group Data Access.

See also

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 (IotClient) CreateDigitalTwinAdapter

func (client IotClient) CreateDigitalTwinAdapter(ctx context.Context, request CreateDigitalTwinAdapterRequest) (response CreateDigitalTwinAdapterResponse, err error)

CreateDigitalTwinAdapter Creates a new digital twin adapter.

See also

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 (IotClient) CreateDigitalTwinInstance

func (client IotClient) CreateDigitalTwinInstance(ctx context.Context, request CreateDigitalTwinInstanceRequest) (response CreateDigitalTwinInstanceResponse, err error)

CreateDigitalTwinInstance Creates a new digital twin instance.

See also

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 (IotClient) CreateDigitalTwinModel

func (client IotClient) CreateDigitalTwinModel(ctx context.Context, request CreateDigitalTwinModelRequest) (response CreateDigitalTwinModelResponse, err error)

CreateDigitalTwinModel Creates a new digital twin model.

See also

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 (IotClient) CreateDigitalTwinRelationship

func (client IotClient) CreateDigitalTwinRelationship(ctx context.Context, request CreateDigitalTwinRelationshipRequest) (response CreateDigitalTwinRelationshipResponse, err error)

CreateDigitalTwinRelationship Creates a new digital twin relationship.

See also

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 (IotClient) CreateIotDomain

func (client IotClient) CreateIotDomain(ctx context.Context, request CreateIotDomainRequest) (response CreateIotDomainResponse, err error)

CreateIotDomain Creates a new IoT domain.

See also

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 (IotClient) CreateIotDomainGroup

func (client IotClient) CreateIotDomainGroup(ctx context.Context, request CreateIotDomainGroupRequest) (response CreateIotDomainGroupResponse, err error)

CreateIotDomainGroup Creates a new IoT domain group.

See also

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 (IotClient) DeleteDigitalTwinAdapter

func (client IotClient) DeleteDigitalTwinAdapter(ctx context.Context, request DeleteDigitalTwinAdapterRequest) (response DeleteDigitalTwinAdapterResponse, err error)

DeleteDigitalTwinAdapter Deletes the digital twin adapter identified by the specified OCID.

See also

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 (IotClient) DeleteDigitalTwinInstance

func (client IotClient) DeleteDigitalTwinInstance(ctx context.Context, request DeleteDigitalTwinInstanceRequest) (response DeleteDigitalTwinInstanceResponse, err error)

DeleteDigitalTwinInstance Deletes the digital twin instance identified by the specified OCID.

See also

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 (IotClient) DeleteDigitalTwinModel

func (client IotClient) DeleteDigitalTwinModel(ctx context.Context, request DeleteDigitalTwinModelRequest) (response DeleteDigitalTwinModelResponse, err error)

DeleteDigitalTwinModel Deletes the digital twin model identified by the specified OCID.

See also

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 (IotClient) DeleteDigitalTwinRelationship

func (client IotClient) DeleteDigitalTwinRelationship(ctx context.Context, request DeleteDigitalTwinRelationshipRequest) (response DeleteDigitalTwinRelationshipResponse, err error)

DeleteDigitalTwinRelationship Deletes the digital twin relationship identified by the specified OCID.

See also

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 (IotClient) DeleteIotDomain

func (client IotClient) DeleteIotDomain(ctx context.Context, request DeleteIotDomainRequest) (response DeleteIotDomainResponse, err error)

DeleteIotDomain Deletes the IoT domain identified by the specified OCID.

See also

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 (IotClient) DeleteIotDomainGroup

func (client IotClient) DeleteIotDomainGroup(ctx context.Context, request DeleteIotDomainGroupRequest) (response DeleteIotDomainGroupResponse, err error)

DeleteIotDomainGroup Deletes the IoT domain group identified by the specified OCID.

See also

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 (IotClient) GetDigitalTwinAdapter

func (client IotClient) GetDigitalTwinAdapter(ctx context.Context, request GetDigitalTwinAdapterRequest) (response GetDigitalTwinAdapterResponse, err error)

GetDigitalTwinAdapter Retrieves the digital twin adapter identified by the specified OCID.

See also

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 (IotClient) GetDigitalTwinInstance

func (client IotClient) GetDigitalTwinInstance(ctx context.Context, request GetDigitalTwinInstanceRequest) (response GetDigitalTwinInstanceResponse, err error)

GetDigitalTwinInstance Retrieves the digital twin instance identified by the specified OCID.

See also

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 (IotClient) GetDigitalTwinInstanceContent

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.

See also

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 (IotClient) GetDigitalTwinModel

func (client IotClient) GetDigitalTwinModel(ctx context.Context, request GetDigitalTwinModelRequest) (response GetDigitalTwinModelResponse, err error)

GetDigitalTwinModel Retrieves the digital twin model identified by the specified OCID.

See also

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 (IotClient) GetDigitalTwinModelSpec

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.

See also

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 (IotClient) GetDigitalTwinRelationship

func (client IotClient) GetDigitalTwinRelationship(ctx context.Context, request GetDigitalTwinRelationshipRequest) (response GetDigitalTwinRelationshipResponse, err error)

GetDigitalTwinRelationship Retrieves the digital twin relationship identified by the specified OCID.

See also

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 (IotClient) GetIotDomain

func (client IotClient) GetIotDomain(ctx context.Context, request GetIotDomainRequest) (response GetIotDomainResponse, err error)

GetIotDomain Retrieves the IoT domain identified by the specified OCID.

See also

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 (IotClient) GetIotDomainGroup

func (client IotClient) GetIotDomainGroup(ctx context.Context, request GetIotDomainGroupRequest) (response GetIotDomainGroupResponse, err error)

GetIotDomainGroup Retrieves the IoT domain group identified by the specified OCID.

See also

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 (IotClient) GetWorkRequest

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.

See also

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 (IotClient) InvokeRawCommand

func (client IotClient) InvokeRawCommand(ctx context.Context, request InvokeRawCommandRequest) (response InvokeRawCommandResponse, err error)

InvokeRawCommand Invokes the raw command on the specified digital twin instance.

See also

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 (IotClient) ListDigitalTwinAdapters

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.

See also

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 (IotClient) ListDigitalTwinInstances

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.

See also

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 (IotClient) ListDigitalTwinModels

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.

See also

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 (IotClient) ListDigitalTwinRelationships

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.

See also

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 (IotClient) ListIotDomainGroups

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.

See also

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 (IotClient) ListIotDomains

func (client IotClient) ListIotDomains(ctx context.Context, request ListIotDomainsRequest) (response ListIotDomainsResponse, err error)

ListIotDomains Retrieves a list of IoT domains within the specified compartment.

See also

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 (IotClient) ListWorkRequestErrors

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

ListWorkRequestErrors Lists errors associated with the specified work request.

See also

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 (IotClient) ListWorkRequestLogs

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

ListWorkRequestLogs Lists the logs associated with the specified work request.

See also

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 (IotClient) ListWorkRequests

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

ListWorkRequests Lists work requests in the specified compartment.

See also

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 (*IotClient) SetRegion

func (client *IotClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (IotClient) UpdateDigitalTwinAdapter

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.

See also

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 (IotClient) UpdateDigitalTwinInstance

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.

See also

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 (IotClient) UpdateDigitalTwinModel

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.

See also

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 (IotClient) UpdateDigitalTwinRelationship

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.

See also

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 (IotClient) UpdateIotDomain

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.

See also

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 (IotClient) UpdateIotDomainGroup

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.

See also

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()

type IotDomain

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

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).

func (IotDomain) String

func (m IotDomain) String() string

func (IotDomain) ValidateEnumValue

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

type IotDomainCollection

type IotDomainCollection struct {

	// List of IoT domains.
	Items []IotDomainSummary `mandatory:"true" json:"items"`
}

IotDomainCollection Results of an IoT domain search. Contains both summary items and other information, such as metadata.

func (IotDomainCollection) String

func (m IotDomainCollection) String() string

func (IotDomainCollection) ValidateEnumValue

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

type IotDomainGroup

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

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).

func (IotDomainGroup) String

func (m IotDomainGroup) String() string

func (IotDomainGroup) ValidateEnumValue

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

type IotDomainGroupCollection

type IotDomainGroupCollection struct {

	// List of IoT Domain Group.
	Items []IotDomainGroupSummary `mandatory:"true" json:"items"`
}

IotDomainGroupCollection Results of an IoT Domain Group search. Contains both summary and additional metadata information.

func (IotDomainGroupCollection) String

func (m IotDomainGroupCollection) String() string

func (IotDomainGroupCollection) ValidateEnumValue

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

type IotDomainGroupLifecycleStateEnum

type IotDomainGroupLifecycleStateEnum string

IotDomainGroupLifecycleStateEnum Enum with underlying type: string

const (
	IotDomainGroupLifecycleStateCreating IotDomainGroupLifecycleStateEnum = "CREATING"
	IotDomainGroupLifecycleStateUpdating IotDomainGroupLifecycleStateEnum = "UPDATING"
	IotDomainGroupLifecycleStateActive   IotDomainGroupLifecycleStateEnum = "ACTIVE"
	IotDomainGroupLifecycleStateDeleting IotDomainGroupLifecycleStateEnum = "DELETING"
	IotDomainGroupLifecycleStateDeleted  IotDomainGroupLifecycleStateEnum = "DELETED"
	IotDomainGroupLifecycleStateFailed   IotDomainGroupLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for IotDomainGroupLifecycleStateEnum

func GetIotDomainGroupLifecycleStateEnumValues

func GetIotDomainGroupLifecycleStateEnumValues() []IotDomainGroupLifecycleStateEnum

GetIotDomainGroupLifecycleStateEnumValues Enumerates the set of values for IotDomainGroupLifecycleStateEnum

func GetMappingIotDomainGroupLifecycleStateEnum

func GetMappingIotDomainGroupLifecycleStateEnum(val string) (IotDomainGroupLifecycleStateEnum, bool)

GetMappingIotDomainGroupLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type IotDomainGroupSummary

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

IotDomainGroupSummary Summary information about an IoT Domain Group.

func (IotDomainGroupSummary) String

func (m IotDomainGroupSummary) String() string

func (IotDomainGroupSummary) ValidateEnumValue

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

type IotDomainLifecycleStateEnum

type IotDomainLifecycleStateEnum string

IotDomainLifecycleStateEnum Enum with underlying type: string

const (
	IotDomainLifecycleStateCreating IotDomainLifecycleStateEnum = "CREATING"
	IotDomainLifecycleStateUpdating IotDomainLifecycleStateEnum = "UPDATING"
	IotDomainLifecycleStateActive   IotDomainLifecycleStateEnum = "ACTIVE"
	IotDomainLifecycleStateDeleting IotDomainLifecycleStateEnum = "DELETING"
	IotDomainLifecycleStateDeleted  IotDomainLifecycleStateEnum = "DELETED"
	IotDomainLifecycleStateFailed   IotDomainLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for IotDomainLifecycleStateEnum

func GetIotDomainLifecycleStateEnumValues

func GetIotDomainLifecycleStateEnumValues() []IotDomainLifecycleStateEnum

GetIotDomainLifecycleStateEnumValues Enumerates the set of values for IotDomainLifecycleStateEnum

func GetMappingIotDomainLifecycleStateEnum

func GetMappingIotDomainLifecycleStateEnum(val string) (IotDomainLifecycleStateEnum, bool)

GetMappingIotDomainLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type IotDomainSummary

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

IotDomainSummary Summary information about a IoT domain.

func (IotDomainSummary) String

func (m IotDomainSummary) String() string

func (IotDomainSummary) ValidateEnumValue

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

type LifecycleStateEnum

type LifecycleStateEnum string

LifecycleStateEnum Enum with underlying type: string

const (
	LifecycleStateActive  LifecycleStateEnum = "ACTIVE"
	LifecycleStateDeleted LifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for LifecycleStateEnum

func GetLifecycleStateEnumValues

func GetLifecycleStateEnumValues() []LifecycleStateEnum

GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum

func GetMappingLifecycleStateEnum

func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)

GetMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDigitalTwinAdaptersLifecycleStateEnum

type ListDigitalTwinAdaptersLifecycleStateEnum string

ListDigitalTwinAdaptersLifecycleStateEnum Enum with underlying type: string

const (
	ListDigitalTwinAdaptersLifecycleStateActive  ListDigitalTwinAdaptersLifecycleStateEnum = "ACTIVE"
	ListDigitalTwinAdaptersLifecycleStateDeleted ListDigitalTwinAdaptersLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for ListDigitalTwinAdaptersLifecycleStateEnum

func GetListDigitalTwinAdaptersLifecycleStateEnumValues

func GetListDigitalTwinAdaptersLifecycleStateEnumValues() []ListDigitalTwinAdaptersLifecycleStateEnum

GetListDigitalTwinAdaptersLifecycleStateEnumValues Enumerates the set of values for ListDigitalTwinAdaptersLifecycleStateEnum

func GetMappingListDigitalTwinAdaptersLifecycleStateEnum

func GetMappingListDigitalTwinAdaptersLifecycleStateEnum(val string) (ListDigitalTwinAdaptersLifecycleStateEnum, bool)

GetMappingListDigitalTwinAdaptersLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListDigitalTwinAdaptersRequest wrapper for the ListDigitalTwinAdapters operation

See also

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.

func (ListDigitalTwinAdaptersRequest) BinaryRequestBody

func (request ListDigitalTwinAdaptersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDigitalTwinAdaptersRequest) HTTPRequest

func (request ListDigitalTwinAdaptersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDigitalTwinAdaptersRequest) RetryPolicy

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

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

func (ListDigitalTwinAdaptersRequest) String

func (request ListDigitalTwinAdaptersRequest) String() string

func (ListDigitalTwinAdaptersRequest) ValidateEnumValue

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

type ListDigitalTwinAdaptersResponse

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

ListDigitalTwinAdaptersResponse wrapper for the ListDigitalTwinAdapters operation

func (ListDigitalTwinAdaptersResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListDigitalTwinAdaptersResponse) String

func (response ListDigitalTwinAdaptersResponse) String() string

type ListDigitalTwinAdaptersSortByEnum

type ListDigitalTwinAdaptersSortByEnum string

ListDigitalTwinAdaptersSortByEnum Enum with underlying type: string

const (
	ListDigitalTwinAdaptersSortByTimecreated ListDigitalTwinAdaptersSortByEnum = "timeCreated"
	ListDigitalTwinAdaptersSortByDisplayname ListDigitalTwinAdaptersSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListDigitalTwinAdaptersSortByEnum

func GetListDigitalTwinAdaptersSortByEnumValues

func GetListDigitalTwinAdaptersSortByEnumValues() []ListDigitalTwinAdaptersSortByEnum

GetListDigitalTwinAdaptersSortByEnumValues Enumerates the set of values for ListDigitalTwinAdaptersSortByEnum

func GetMappingListDigitalTwinAdaptersSortByEnum

func GetMappingListDigitalTwinAdaptersSortByEnum(val string) (ListDigitalTwinAdaptersSortByEnum, bool)

GetMappingListDigitalTwinAdaptersSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDigitalTwinAdaptersSortOrderEnum

type ListDigitalTwinAdaptersSortOrderEnum string

ListDigitalTwinAdaptersSortOrderEnum Enum with underlying type: string

const (
	ListDigitalTwinAdaptersSortOrderAsc  ListDigitalTwinAdaptersSortOrderEnum = "ASC"
	ListDigitalTwinAdaptersSortOrderDesc ListDigitalTwinAdaptersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDigitalTwinAdaptersSortOrderEnum

func GetListDigitalTwinAdaptersSortOrderEnumValues

func GetListDigitalTwinAdaptersSortOrderEnumValues() []ListDigitalTwinAdaptersSortOrderEnum

GetListDigitalTwinAdaptersSortOrderEnumValues Enumerates the set of values for ListDigitalTwinAdaptersSortOrderEnum

func GetMappingListDigitalTwinAdaptersSortOrderEnum

func GetMappingListDigitalTwinAdaptersSortOrderEnum(val string) (ListDigitalTwinAdaptersSortOrderEnum, bool)

GetMappingListDigitalTwinAdaptersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDigitalTwinInstancesLifecycleStateEnum

type ListDigitalTwinInstancesLifecycleStateEnum string

ListDigitalTwinInstancesLifecycleStateEnum Enum with underlying type: string

const (
	ListDigitalTwinInstancesLifecycleStateActive  ListDigitalTwinInstancesLifecycleStateEnum = "ACTIVE"
	ListDigitalTwinInstancesLifecycleStateDeleted ListDigitalTwinInstancesLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for ListDigitalTwinInstancesLifecycleStateEnum

func GetListDigitalTwinInstancesLifecycleStateEnumValues

func GetListDigitalTwinInstancesLifecycleStateEnumValues() []ListDigitalTwinInstancesLifecycleStateEnum

GetListDigitalTwinInstancesLifecycleStateEnumValues Enumerates the set of values for ListDigitalTwinInstancesLifecycleStateEnum

func GetMappingListDigitalTwinInstancesLifecycleStateEnum

func GetMappingListDigitalTwinInstancesLifecycleStateEnum(val string) (ListDigitalTwinInstancesLifecycleStateEnum, bool)

GetMappingListDigitalTwinInstancesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListDigitalTwinInstancesRequest wrapper for the ListDigitalTwinInstances operation

See also

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.

func (ListDigitalTwinInstancesRequest) BinaryRequestBody

func (request ListDigitalTwinInstancesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDigitalTwinInstancesRequest) HTTPRequest

func (request ListDigitalTwinInstancesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDigitalTwinInstancesRequest) RetryPolicy

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

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

func (ListDigitalTwinInstancesRequest) String

func (request ListDigitalTwinInstancesRequest) String() string

func (ListDigitalTwinInstancesRequest) ValidateEnumValue

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

type ListDigitalTwinInstancesResponse

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

ListDigitalTwinInstancesResponse wrapper for the ListDigitalTwinInstances operation

func (ListDigitalTwinInstancesResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListDigitalTwinInstancesResponse) String

func (response ListDigitalTwinInstancesResponse) String() string

type ListDigitalTwinInstancesSortByEnum

type ListDigitalTwinInstancesSortByEnum string

ListDigitalTwinInstancesSortByEnum Enum with underlying type: string

const (
	ListDigitalTwinInstancesSortByTimecreated ListDigitalTwinInstancesSortByEnum = "timeCreated"
	ListDigitalTwinInstancesSortByDisplayname ListDigitalTwinInstancesSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListDigitalTwinInstancesSortByEnum

func GetListDigitalTwinInstancesSortByEnumValues

func GetListDigitalTwinInstancesSortByEnumValues() []ListDigitalTwinInstancesSortByEnum

GetListDigitalTwinInstancesSortByEnumValues Enumerates the set of values for ListDigitalTwinInstancesSortByEnum

func GetMappingListDigitalTwinInstancesSortByEnum

func GetMappingListDigitalTwinInstancesSortByEnum(val string) (ListDigitalTwinInstancesSortByEnum, bool)

GetMappingListDigitalTwinInstancesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDigitalTwinInstancesSortOrderEnum

type ListDigitalTwinInstancesSortOrderEnum string

ListDigitalTwinInstancesSortOrderEnum Enum with underlying type: string

const (
	ListDigitalTwinInstancesSortOrderAsc  ListDigitalTwinInstancesSortOrderEnum = "ASC"
	ListDigitalTwinInstancesSortOrderDesc ListDigitalTwinInstancesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDigitalTwinInstancesSortOrderEnum

func GetListDigitalTwinInstancesSortOrderEnumValues

func GetListDigitalTwinInstancesSortOrderEnumValues() []ListDigitalTwinInstancesSortOrderEnum

GetListDigitalTwinInstancesSortOrderEnumValues Enumerates the set of values for ListDigitalTwinInstancesSortOrderEnum

func GetMappingListDigitalTwinInstancesSortOrderEnum

func GetMappingListDigitalTwinInstancesSortOrderEnum(val string) (ListDigitalTwinInstancesSortOrderEnum, bool)

GetMappingListDigitalTwinInstancesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDigitalTwinModelsLifecycleStateEnum

type ListDigitalTwinModelsLifecycleStateEnum string

ListDigitalTwinModelsLifecycleStateEnum Enum with underlying type: string

const (
	ListDigitalTwinModelsLifecycleStateActive  ListDigitalTwinModelsLifecycleStateEnum = "ACTIVE"
	ListDigitalTwinModelsLifecycleStateDeleted ListDigitalTwinModelsLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for ListDigitalTwinModelsLifecycleStateEnum

func GetListDigitalTwinModelsLifecycleStateEnumValues

func GetListDigitalTwinModelsLifecycleStateEnumValues() []ListDigitalTwinModelsLifecycleStateEnum

GetListDigitalTwinModelsLifecycleStateEnumValues Enumerates the set of values for ListDigitalTwinModelsLifecycleStateEnum

func GetMappingListDigitalTwinModelsLifecycleStateEnum

func GetMappingListDigitalTwinModelsLifecycleStateEnum(val string) (ListDigitalTwinModelsLifecycleStateEnum, bool)

GetMappingListDigitalTwinModelsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListDigitalTwinModelsRequest wrapper for the ListDigitalTwinModels operation

See also

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.

func (ListDigitalTwinModelsRequest) BinaryRequestBody

func (request ListDigitalTwinModelsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDigitalTwinModelsRequest) HTTPRequest

func (request ListDigitalTwinModelsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDigitalTwinModelsRequest) RetryPolicy

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

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

func (ListDigitalTwinModelsRequest) String

func (request ListDigitalTwinModelsRequest) String() string

func (ListDigitalTwinModelsRequest) ValidateEnumValue

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

type ListDigitalTwinModelsResponse

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

ListDigitalTwinModelsResponse wrapper for the ListDigitalTwinModels operation

func (ListDigitalTwinModelsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListDigitalTwinModelsResponse) String

func (response ListDigitalTwinModelsResponse) String() string

type ListDigitalTwinModelsSortByEnum

type ListDigitalTwinModelsSortByEnum string

ListDigitalTwinModelsSortByEnum Enum with underlying type: string

const (
	ListDigitalTwinModelsSortByTimecreated ListDigitalTwinModelsSortByEnum = "timeCreated"
	ListDigitalTwinModelsSortByDisplayname ListDigitalTwinModelsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListDigitalTwinModelsSortByEnum

func GetListDigitalTwinModelsSortByEnumValues

func GetListDigitalTwinModelsSortByEnumValues() []ListDigitalTwinModelsSortByEnum

GetListDigitalTwinModelsSortByEnumValues Enumerates the set of values for ListDigitalTwinModelsSortByEnum

func GetMappingListDigitalTwinModelsSortByEnum

func GetMappingListDigitalTwinModelsSortByEnum(val string) (ListDigitalTwinModelsSortByEnum, bool)

GetMappingListDigitalTwinModelsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDigitalTwinModelsSortOrderEnum

type ListDigitalTwinModelsSortOrderEnum string

ListDigitalTwinModelsSortOrderEnum Enum with underlying type: string

const (
	ListDigitalTwinModelsSortOrderAsc  ListDigitalTwinModelsSortOrderEnum = "ASC"
	ListDigitalTwinModelsSortOrderDesc ListDigitalTwinModelsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDigitalTwinModelsSortOrderEnum

func GetListDigitalTwinModelsSortOrderEnumValues

func GetListDigitalTwinModelsSortOrderEnumValues() []ListDigitalTwinModelsSortOrderEnum

GetListDigitalTwinModelsSortOrderEnumValues Enumerates the set of values for ListDigitalTwinModelsSortOrderEnum

func GetMappingListDigitalTwinModelsSortOrderEnum

func GetMappingListDigitalTwinModelsSortOrderEnum(val string) (ListDigitalTwinModelsSortOrderEnum, bool)

GetMappingListDigitalTwinModelsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDigitalTwinRelationshipsLifecycleStateEnum

type ListDigitalTwinRelationshipsLifecycleStateEnum string

ListDigitalTwinRelationshipsLifecycleStateEnum Enum with underlying type: string

const (
	ListDigitalTwinRelationshipsLifecycleStateActive  ListDigitalTwinRelationshipsLifecycleStateEnum = "ACTIVE"
	ListDigitalTwinRelationshipsLifecycleStateDeleted ListDigitalTwinRelationshipsLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for ListDigitalTwinRelationshipsLifecycleStateEnum

func GetListDigitalTwinRelationshipsLifecycleStateEnumValues

func GetListDigitalTwinRelationshipsLifecycleStateEnumValues() []ListDigitalTwinRelationshipsLifecycleStateEnum

GetListDigitalTwinRelationshipsLifecycleStateEnumValues Enumerates the set of values for ListDigitalTwinRelationshipsLifecycleStateEnum

func GetMappingListDigitalTwinRelationshipsLifecycleStateEnum

func GetMappingListDigitalTwinRelationshipsLifecycleStateEnum(val string) (ListDigitalTwinRelationshipsLifecycleStateEnum, bool)

GetMappingListDigitalTwinRelationshipsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListDigitalTwinRelationshipsRequest wrapper for the ListDigitalTwinRelationships operation

See also

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.

func (ListDigitalTwinRelationshipsRequest) BinaryRequestBody

func (request ListDigitalTwinRelationshipsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDigitalTwinRelationshipsRequest) HTTPRequest

func (request ListDigitalTwinRelationshipsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDigitalTwinRelationshipsRequest) RetryPolicy

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

func (ListDigitalTwinRelationshipsRequest) String

func (ListDigitalTwinRelationshipsRequest) ValidateEnumValue

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

type ListDigitalTwinRelationshipsResponse

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

ListDigitalTwinRelationshipsResponse wrapper for the ListDigitalTwinRelationships operation

func (ListDigitalTwinRelationshipsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListDigitalTwinRelationshipsResponse) String

func (response ListDigitalTwinRelationshipsResponse) String() string

type ListDigitalTwinRelationshipsSortByEnum

type ListDigitalTwinRelationshipsSortByEnum string

ListDigitalTwinRelationshipsSortByEnum Enum with underlying type: string

const (
	ListDigitalTwinRelationshipsSortByTimecreated ListDigitalTwinRelationshipsSortByEnum = "timeCreated"
	ListDigitalTwinRelationshipsSortByDisplayname ListDigitalTwinRelationshipsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListDigitalTwinRelationshipsSortByEnum

func GetListDigitalTwinRelationshipsSortByEnumValues

func GetListDigitalTwinRelationshipsSortByEnumValues() []ListDigitalTwinRelationshipsSortByEnum

GetListDigitalTwinRelationshipsSortByEnumValues Enumerates the set of values for ListDigitalTwinRelationshipsSortByEnum

func GetMappingListDigitalTwinRelationshipsSortByEnum

func GetMappingListDigitalTwinRelationshipsSortByEnum(val string) (ListDigitalTwinRelationshipsSortByEnum, bool)

GetMappingListDigitalTwinRelationshipsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDigitalTwinRelationshipsSortOrderEnum

type ListDigitalTwinRelationshipsSortOrderEnum string

ListDigitalTwinRelationshipsSortOrderEnum Enum with underlying type: string

const (
	ListDigitalTwinRelationshipsSortOrderAsc  ListDigitalTwinRelationshipsSortOrderEnum = "ASC"
	ListDigitalTwinRelationshipsSortOrderDesc ListDigitalTwinRelationshipsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDigitalTwinRelationshipsSortOrderEnum

func GetListDigitalTwinRelationshipsSortOrderEnumValues

func GetListDigitalTwinRelationshipsSortOrderEnumValues() []ListDigitalTwinRelationshipsSortOrderEnum

GetListDigitalTwinRelationshipsSortOrderEnumValues Enumerates the set of values for ListDigitalTwinRelationshipsSortOrderEnum

func GetMappingListDigitalTwinRelationshipsSortOrderEnum

func GetMappingListDigitalTwinRelationshipsSortOrderEnum(val string) (ListDigitalTwinRelationshipsSortOrderEnum, bool)

GetMappingListDigitalTwinRelationshipsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListIotDomainGroupsRequest wrapper for the ListIotDomainGroups operation

See also

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.

func (ListIotDomainGroupsRequest) BinaryRequestBody

func (request ListIotDomainGroupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListIotDomainGroupsRequest) HTTPRequest

func (request ListIotDomainGroupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListIotDomainGroupsRequest) RetryPolicy

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

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

func (ListIotDomainGroupsRequest) String

func (request ListIotDomainGroupsRequest) String() string

func (ListIotDomainGroupsRequest) ValidateEnumValue

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

type ListIotDomainGroupsResponse

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

ListIotDomainGroupsResponse wrapper for the ListIotDomainGroups operation

func (ListIotDomainGroupsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListIotDomainGroupsResponse) String

func (response ListIotDomainGroupsResponse) String() string

type ListIotDomainGroupsSortByEnum

type ListIotDomainGroupsSortByEnum string

ListIotDomainGroupsSortByEnum Enum with underlying type: string

const (
	ListIotDomainGroupsSortByTimecreated ListIotDomainGroupsSortByEnum = "timeCreated"
	ListIotDomainGroupsSortByDisplayname ListIotDomainGroupsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListIotDomainGroupsSortByEnum

func GetListIotDomainGroupsSortByEnumValues

func GetListIotDomainGroupsSortByEnumValues() []ListIotDomainGroupsSortByEnum

GetListIotDomainGroupsSortByEnumValues Enumerates the set of values for ListIotDomainGroupsSortByEnum

func GetMappingListIotDomainGroupsSortByEnum

func GetMappingListIotDomainGroupsSortByEnum(val string) (ListIotDomainGroupsSortByEnum, bool)

GetMappingListIotDomainGroupsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListIotDomainGroupsSortOrderEnum

type ListIotDomainGroupsSortOrderEnum string

ListIotDomainGroupsSortOrderEnum Enum with underlying type: string

const (
	ListIotDomainGroupsSortOrderAsc  ListIotDomainGroupsSortOrderEnum = "ASC"
	ListIotDomainGroupsSortOrderDesc ListIotDomainGroupsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListIotDomainGroupsSortOrderEnum

func GetListIotDomainGroupsSortOrderEnumValues

func GetListIotDomainGroupsSortOrderEnumValues() []ListIotDomainGroupsSortOrderEnum

GetListIotDomainGroupsSortOrderEnumValues Enumerates the set of values for ListIotDomainGroupsSortOrderEnum

func GetMappingListIotDomainGroupsSortOrderEnum

func GetMappingListIotDomainGroupsSortOrderEnum(val string) (ListIotDomainGroupsSortOrderEnum, bool)

GetMappingListIotDomainGroupsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListIotDomainsRequest wrapper for the ListIotDomains operation

See also

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.

func (ListIotDomainsRequest) BinaryRequestBody

func (request ListIotDomainsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListIotDomainsRequest) HTTPRequest

func (request ListIotDomainsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListIotDomainsRequest) RetryPolicy

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

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

func (ListIotDomainsRequest) String

func (request ListIotDomainsRequest) String() string

func (ListIotDomainsRequest) ValidateEnumValue

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

type ListIotDomainsResponse

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

ListIotDomainsResponse wrapper for the ListIotDomains operation

func (ListIotDomainsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListIotDomainsResponse) String

func (response ListIotDomainsResponse) String() string

type ListIotDomainsSortByEnum

type ListIotDomainsSortByEnum string

ListIotDomainsSortByEnum Enum with underlying type: string

const (
	ListIotDomainsSortByTimecreated ListIotDomainsSortByEnum = "timeCreated"
	ListIotDomainsSortByDisplayname ListIotDomainsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListIotDomainsSortByEnum

func GetListIotDomainsSortByEnumValues

func GetListIotDomainsSortByEnumValues() []ListIotDomainsSortByEnum

GetListIotDomainsSortByEnumValues Enumerates the set of values for ListIotDomainsSortByEnum

func GetMappingListIotDomainsSortByEnum

func GetMappingListIotDomainsSortByEnum(val string) (ListIotDomainsSortByEnum, bool)

GetMappingListIotDomainsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListIotDomainsSortOrderEnum

type ListIotDomainsSortOrderEnum string

ListIotDomainsSortOrderEnum Enum with underlying type: string

const (
	ListIotDomainsSortOrderAsc  ListIotDomainsSortOrderEnum = "ASC"
	ListIotDomainsSortOrderDesc ListIotDomainsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListIotDomainsSortOrderEnum

func GetListIotDomainsSortOrderEnumValues

func GetListIotDomainsSortOrderEnumValues() []ListIotDomainsSortOrderEnum

GetListIotDomainsSortOrderEnumValues Enumerates the set of values for ListIotDomainsSortOrderEnum

func GetMappingListIotDomainsSortOrderEnum

func GetMappingListIotDomainsSortOrderEnum(val string) (ListIotDomainsSortOrderEnum, bool)

GetMappingListIotDomainsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

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.

func (ListWorkRequestErrorsRequest) BinaryRequestBody

func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest

func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy

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

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

func (ListWorkRequestErrorsRequest) String

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue

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

type ListWorkRequestErrorsResponse

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

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestErrorsSortByTimecreated ListWorkRequestErrorsSortByEnum = "timeCreated"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestErrorsSortOrderEnum

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string

const (
	ListWorkRequestErrorsSortOrderAsc  ListWorkRequestErrorsSortOrderEnum = "ASC"
	ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

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.

func (ListWorkRequestLogsRequest) BinaryRequestBody

func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest

func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy

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

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

func (ListWorkRequestLogsRequest) String

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue

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

type ListWorkRequestLogsResponse

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

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestLogsSortByTimecreated ListWorkRequestLogsSortByEnum = "timeCreated"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestLogsSortOrderEnum

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string

const (
	ListWorkRequestLogsSortOrderAsc  ListWorkRequestLogsSortOrderEnum = "ASC"
	ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

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.

func (ListWorkRequestsRequest) BinaryRequestBody

func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest

func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy

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

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

func (ListWorkRequestsRequest) String

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue

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

type ListWorkRequestsResponse

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

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestsSortOrderEnum

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string

const (
	ListWorkRequestsSortOrderAsc  ListWorkRequestsSortOrderEnum = "ASC"
	ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestsStatusEnum

type ListWorkRequestsStatusEnum string

ListWorkRequestsStatusEnum Enum with underlying type: string

const (
	ListWorkRequestsStatusAccepted       ListWorkRequestsStatusEnum = "ACCEPTED"
	ListWorkRequestsStatusInProgress     ListWorkRequestsStatusEnum = "IN_PROGRESS"
	ListWorkRequestsStatusWaiting        ListWorkRequestsStatusEnum = "WAITING"
	ListWorkRequestsStatusNeedsAttention ListWorkRequestsStatusEnum = "NEEDS_ATTENTION"
	ListWorkRequestsStatusFailed         ListWorkRequestsStatusEnum = "FAILED"
	ListWorkRequestsStatusSucceeded      ListWorkRequestsStatusEnum = "SUCCEEDED"
)

Set of constants representing the allowable values for ListWorkRequestsStatusEnum

func GetListWorkRequestsStatusEnumValues

func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum

GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)

GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum

type OperationStatusEnum

type OperationStatusEnum string

OperationStatusEnum Enum with underlying type: string

const (
	OperationStatusAccepted       OperationStatusEnum = "ACCEPTED"
	OperationStatusInProgress     OperationStatusEnum = "IN_PROGRESS"
	OperationStatusWaiting        OperationStatusEnum = "WAITING"
	OperationStatusNeedsAttention OperationStatusEnum = "NEEDS_ATTENTION"
	OperationStatusFailed         OperationStatusEnum = "FAILED"
	OperationStatusSucceeded      OperationStatusEnum = "SUCCEEDED"
)

Set of constants representing the allowable values for OperationStatusEnum

func GetMappingOperationStatusEnum

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOperationStatusEnumValues

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum

type OperationTypeEnum string

OperationTypeEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for OperationTypeEnum

func GetMappingOperationTypeEnum

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOperationTypeEnumValues

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type OrdsDataAccessDetails

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

OrdsDataAccessDetails This contains configuration for ORDS data access.

func (OrdsDataAccessDetails) MarshalJSON

func (m OrdsDataAccessDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (OrdsDataAccessDetails) String

func (m OrdsDataAccessDetails) String() string

func (OrdsDataAccessDetails) ValidateEnumValue

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

type UpdateDigitalTwinAdapterDetails

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

UpdateDigitalTwinAdapterDetails The information to be updated for the given digital twin adapter.

func (UpdateDigitalTwinAdapterDetails) String

func (UpdateDigitalTwinAdapterDetails) ValidateEnumValue

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

type 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
}

UpdateDigitalTwinAdapterRequest wrapper for the UpdateDigitalTwinAdapter operation

See also

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.

func (UpdateDigitalTwinAdapterRequest) BinaryRequestBody

func (request UpdateDigitalTwinAdapterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateDigitalTwinAdapterRequest) HTTPRequest

func (request UpdateDigitalTwinAdapterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateDigitalTwinAdapterRequest) RetryPolicy

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

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

func (UpdateDigitalTwinAdapterRequest) String

func (request UpdateDigitalTwinAdapterRequest) String() string

func (UpdateDigitalTwinAdapterRequest) ValidateEnumValue

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

type UpdateDigitalTwinAdapterResponse

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

UpdateDigitalTwinAdapterResponse wrapper for the UpdateDigitalTwinAdapter operation

func (UpdateDigitalTwinAdapterResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateDigitalTwinAdapterResponse) String

func (response UpdateDigitalTwinAdapterResponse) String() string

type UpdateDigitalTwinInstanceDetails

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

UpdateDigitalTwinInstanceDetails The information to be updated for the given digital twin instance.

func (UpdateDigitalTwinInstanceDetails) String

func (UpdateDigitalTwinInstanceDetails) ValidateEnumValue

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

type 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
}

UpdateDigitalTwinInstanceRequest wrapper for the UpdateDigitalTwinInstance operation

See also

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.

func (UpdateDigitalTwinInstanceRequest) BinaryRequestBody

func (request UpdateDigitalTwinInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateDigitalTwinInstanceRequest) HTTPRequest

func (request UpdateDigitalTwinInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateDigitalTwinInstanceRequest) RetryPolicy

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

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

func (UpdateDigitalTwinInstanceRequest) String

func (request UpdateDigitalTwinInstanceRequest) String() string

func (UpdateDigitalTwinInstanceRequest) ValidateEnumValue

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

type UpdateDigitalTwinInstanceResponse

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

UpdateDigitalTwinInstanceResponse wrapper for the UpdateDigitalTwinInstance operation

func (UpdateDigitalTwinInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateDigitalTwinInstanceResponse) String

func (response UpdateDigitalTwinInstanceResponse) String() string

type UpdateDigitalTwinModelDetails

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

UpdateDigitalTwinModelDetails The information to be updated for the given digital twin model.

func (UpdateDigitalTwinModelDetails) String

func (UpdateDigitalTwinModelDetails) ValidateEnumValue

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

type 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
}

UpdateDigitalTwinModelRequest wrapper for the UpdateDigitalTwinModel operation

See also

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.

func (UpdateDigitalTwinModelRequest) BinaryRequestBody

func (request UpdateDigitalTwinModelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateDigitalTwinModelRequest) HTTPRequest

func (request UpdateDigitalTwinModelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateDigitalTwinModelRequest) RetryPolicy

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

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

func (UpdateDigitalTwinModelRequest) String

func (request UpdateDigitalTwinModelRequest) String() string

func (UpdateDigitalTwinModelRequest) ValidateEnumValue

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

type UpdateDigitalTwinModelResponse

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

UpdateDigitalTwinModelResponse wrapper for the UpdateDigitalTwinModel operation

func (UpdateDigitalTwinModelResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateDigitalTwinModelResponse) String

func (response UpdateDigitalTwinModelResponse) String() string

type UpdateDigitalTwinRelationshipDetails

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

UpdateDigitalTwinRelationshipDetails The information to be updated for the given digital twin relationship.

func (UpdateDigitalTwinRelationshipDetails) String

func (UpdateDigitalTwinRelationshipDetails) ValidateEnumValue

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

type 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
}

UpdateDigitalTwinRelationshipRequest wrapper for the UpdateDigitalTwinRelationship operation

See also

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.

func (UpdateDigitalTwinRelationshipRequest) BinaryRequestBody

func (request UpdateDigitalTwinRelationshipRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateDigitalTwinRelationshipRequest) HTTPRequest

func (request UpdateDigitalTwinRelationshipRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateDigitalTwinRelationshipRequest) RetryPolicy

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

func (UpdateDigitalTwinRelationshipRequest) String

func (UpdateDigitalTwinRelationshipRequest) ValidateEnumValue

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

type UpdateDigitalTwinRelationshipResponse

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

UpdateDigitalTwinRelationshipResponse wrapper for the UpdateDigitalTwinRelationship operation

func (UpdateDigitalTwinRelationshipResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateDigitalTwinRelationshipResponse) String

type UpdateIotDomainDetails

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

UpdateIotDomainDetails The information to be updated for the given IoT domain.

func (UpdateIotDomainDetails) String

func (m UpdateIotDomainDetails) String() string

func (UpdateIotDomainDetails) ValidateEnumValue

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

type UpdateIotDomainGroupDetails

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

UpdateIotDomainGroupDetails The information to be updated for the given IoT domain group.

func (UpdateIotDomainGroupDetails) String

func (UpdateIotDomainGroupDetails) ValidateEnumValue

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

type 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
}

UpdateIotDomainGroupRequest wrapper for the UpdateIotDomainGroup operation

See also

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.

func (UpdateIotDomainGroupRequest) BinaryRequestBody

func (request UpdateIotDomainGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateIotDomainGroupRequest) HTTPRequest

func (request UpdateIotDomainGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateIotDomainGroupRequest) RetryPolicy

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

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

func (UpdateIotDomainGroupRequest) String

func (request UpdateIotDomainGroupRequest) String() string

func (UpdateIotDomainGroupRequest) ValidateEnumValue

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

type UpdateIotDomainGroupResponse

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

UpdateIotDomainGroupResponse wrapper for the UpdateIotDomainGroup operation

func (UpdateIotDomainGroupResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateIotDomainGroupResponse) String

func (response UpdateIotDomainGroupResponse) String() string

type 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
}

UpdateIotDomainRequest wrapper for the UpdateIotDomain operation

See also

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.

func (UpdateIotDomainRequest) BinaryRequestBody

func (request UpdateIotDomainRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateIotDomainRequest) HTTPRequest

func (request UpdateIotDomainRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateIotDomainRequest) RetryPolicy

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

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

func (UpdateIotDomainRequest) String

func (request UpdateIotDomainRequest) String() string

func (UpdateIotDomainRequest) ValidateEnumValue

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

type UpdateIotDomainResponse

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

UpdateIotDomainResponse wrapper for the UpdateIotDomain operation

func (UpdateIotDomainResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateIotDomainResponse) String

func (response UpdateIotDomainResponse) String() string

type WorkRequest

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

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.

func (WorkRequest) String

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue

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

type WorkRequestError

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

WorkRequestError An error encountered while performing an operation that is tracked by a work request.

func (WorkRequestError) String

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue

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

type WorkRequestErrorCollection

type WorkRequestErrorCollection struct {

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

WorkRequestErrorCollection A list of work request errors. Can contain both errors and other information, such as metadata.

func (WorkRequestErrorCollection) String

func (WorkRequestErrorCollection) ValidateEnumValue

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

type WorkRequestLogEntry

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

WorkRequestLogEntry A log message from performing an operation that is tracked by a work request.

func (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue

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

type WorkRequestLogEntryCollection

type WorkRequestLogEntryCollection struct {

	// A list of work request log entries.
	Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}

WorkRequestLogEntryCollection A list of work request logs. Can contain both logs and other information, such as metadata.

func (WorkRequestLogEntryCollection) String

func (WorkRequestLogEntryCollection) ValidateEnumValue

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

type WorkRequestResource

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

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

func (WorkRequestResource) String

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue

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

type WorkRequestResourceMetadataKeyEnum

type WorkRequestResourceMetadataKeyEnum string

WorkRequestResourceMetadataKeyEnum Enum with underlying type: string

const (
	WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)

Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)

GetMappingWorkRequestResourceMetadataKeyEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestResourceMetadataKeyEnumValues

func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum

GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum

type WorkRequestSummary

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

WorkRequestSummary Summary information about an asynchronous work request.

func (WorkRequestSummary) String

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue

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

type WorkRequestSummaryCollection

type WorkRequestSummaryCollection struct {

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

WorkRequestSummaryCollection A list of work requests. Can contain both work requests and other information, such as metadata.

func (WorkRequestSummaryCollection) String

func (WorkRequestSummaryCollection) ValidateEnumValue

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

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL