demandsignal

package
v65.73.0 Latest Latest
Warning

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

 Go to latest Published: Aug 27, 2024 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 GetListOccDemandSignalsSortByEnumStringValues 

func GetListOccDemandSignalsSortByEnumStringValues() []string

GetListOccDemandSignalsSortByEnumStringValues Enumerates the set of values in String for ListOccDemandSignalsSortByEnum

func GetListOccDemandSignalsSortOrderEnumStringValues 

func GetListOccDemandSignalsSortOrderEnumStringValues() []string

GetListOccDemandSignalsSortOrderEnumStringValues Enumerates the set of values in String for ListOccDemandSignalsSortOrderEnum

func GetOccDemandSignalLifecycleStateEnumStringValues 

func GetOccDemandSignalLifecycleStateEnumStringValues() []string

GetOccDemandSignalLifecycleStateEnumStringValues Enumerates the set of values in String for OccDemandSignalLifecycleStateEnum

func GetPatchInsertInstructionPositionEnumStringValues 

func GetPatchInsertInstructionPositionEnumStringValues() []string

GetPatchInsertInstructionPositionEnumStringValues Enumerates the set of values in String for PatchInsertInstructionPositionEnum

func GetPatchInsertMultipleInstructionPositionEnumStringValues 

func GetPatchInsertMultipleInstructionPositionEnumStringValues() []string

GetPatchInsertMultipleInstructionPositionEnumStringValues Enumerates the set of values in String for PatchInsertMultipleInstructionPositionEnum

func GetPatchInstructionOperationEnumStringValues 

func GetPatchInstructionOperationEnumStringValues() []string

GetPatchInstructionOperationEnumStringValues Enumerates the set of values in String for PatchInstructionOperationEnum

func GetPatchMoveInstructionPositionEnumStringValues 

func GetPatchMoveInstructionPositionEnumStringValues() []string

GetPatchMoveInstructionPositionEnumStringValues Enumerates the set of values in String for PatchMoveInstructionPositionEnum

func GetSortOrderEnumStringValues 

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

Types

type ChangeOccDemandSignalCompartmentDetails 

type ChangeOccDemandSignalCompartmentDetails struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the OccDemandSignal to.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeOccDemandSignalCompartmentDetails The configuration details for the move operation.

func (ChangeOccDemandSignalCompartmentDetails) String 

func (m ChangeOccDemandSignalCompartmentDetails) String() string

func (ChangeOccDemandSignalCompartmentDetails) ValidateEnumValue 

func (m ChangeOccDemandSignalCompartmentDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 ChangeOccDemandSignalCompartmentRequest 

type ChangeOccDemandSignalCompartmentRequest struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OccDemandSignal.
	OccDemandSignalId *string `mandatory:"true" contributesTo:"path" name:"occDemandSignalId"`

	// The information to be updated.
	ChangeOccDemandSignalCompartmentDetails `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, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

ChangeOccDemandSignalCompartmentRequest wrapper for the ChangeOccDemandSignalCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/demandsignal/ChangeOccDemandSignalCompartment.go.html to see an example of how to use ChangeOccDemandSignalCompartmentRequest.

func (ChangeOccDemandSignalCompartmentRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeOccDemandSignalCompartmentRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ChangeOccDemandSignalCompartmentRequest) RetryPolicy 

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

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

func (ChangeOccDemandSignalCompartmentRequest) String 

func (request ChangeOccDemandSignalCompartmentRequest) String() string

func (ChangeOccDemandSignalCompartmentRequest) ValidateEnumValue 

func (request ChangeOccDemandSignalCompartmentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 ChangeOccDemandSignalCompartmentResponse 

type ChangeOccDemandSignalCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.cloud.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"`
}

ChangeOccDemandSignalCompartmentResponse wrapper for the ChangeOccDemandSignalCompartment operation

func (ChangeOccDemandSignalCompartmentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ChangeOccDemandSignalCompartmentResponse) String 

func (response ChangeOccDemandSignalCompartmentResponse) String() string

type CreateOccDemandSignalDetails 

type CreateOccDemandSignalDetails struct {

	// The OccDemandSignal data.
	OccDemandSignals []OccDemandSignalData `mandatory:"true" json:"occDemandSignals"`

	// Indicator of whether to share the data with Oracle.
	IsActive *bool `mandatory:"true" json:"isActive"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the OccDemandSignal in.
	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"`

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

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

CreateOccDemandSignalDetails The data to create a OccDemandSignal.

func (CreateOccDemandSignalDetails) String 

func (m CreateOccDemandSignalDetails) String() string

func (CreateOccDemandSignalDetails) ValidateEnumValue 

func (m CreateOccDemandSignalDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 CreateOccDemandSignalRequest 

type CreateOccDemandSignalRequest struct {

	// Details for the new OccDemandSignal.
	CreateOccDemandSignalDetails `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 running 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 removed 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, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

CreateOccDemandSignalRequest wrapper for the CreateOccDemandSignal operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/demandsignal/CreateOccDemandSignal.go.html to see an example of how to use CreateOccDemandSignalRequest.

func (CreateOccDemandSignalRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateOccDemandSignalRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CreateOccDemandSignalRequest) RetryPolicy 

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

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

func (CreateOccDemandSignalRequest) String 

func (request CreateOccDemandSignalRequest) String() string

func (CreateOccDemandSignalRequest) ValidateEnumValue 

func (request CreateOccDemandSignalRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 CreateOccDemandSignalResponse 

type CreateOccDemandSignalResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
	RetryAfter *int `presentIn:"header" name:"retry-after"`

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

CreateOccDemandSignalResponse wrapper for the CreateOccDemandSignal operation

func (CreateOccDemandSignalResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateOccDemandSignalResponse) String 

func (response CreateOccDemandSignalResponse) String() string

type DeleteOccDemandSignalRequest 

type DeleteOccDemandSignalRequest struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OccDemandSignal.
	OccDemandSignalId *string `mandatory:"true" contributesTo:"path" name:"occDemandSignalId"`

	// 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, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

DeleteOccDemandSignalRequest wrapper for the DeleteOccDemandSignal operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/demandsignal/DeleteOccDemandSignal.go.html to see an example of how to use DeleteOccDemandSignalRequest.

func (DeleteOccDemandSignalRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteOccDemandSignalRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DeleteOccDemandSignalRequest) RetryPolicy 

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

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

func (DeleteOccDemandSignalRequest) String 

func (request DeleteOccDemandSignalRequest) String() string

func (DeleteOccDemandSignalRequest) ValidateEnumValue 

func (request DeleteOccDemandSignalRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 DeleteOccDemandSignalResponse 

type DeleteOccDemandSignalResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.cloud.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"`
}

DeleteOccDemandSignalResponse wrapper for the DeleteOccDemandSignal operation

func (DeleteOccDemandSignalResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteOccDemandSignalResponse) String 

func (response DeleteOccDemandSignalResponse) String() string

type GetOccDemandSignalRequest 

type GetOccDemandSignalRequest struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OccDemandSignal.
	OccDemandSignalId *string `mandatory:"true" contributesTo:"path" name:"occDemandSignalId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

GetOccDemandSignalRequest wrapper for the GetOccDemandSignal operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/demandsignal/GetOccDemandSignal.go.html to see an example of how to use GetOccDemandSignalRequest.

func (GetOccDemandSignalRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetOccDemandSignalRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetOccDemandSignalRequest) RetryPolicy 

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

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

func (GetOccDemandSignalRequest) String 

func (request GetOccDemandSignalRequest) String() string

func (GetOccDemandSignalRequest) ValidateEnumValue 

func (request GetOccDemandSignalRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 GetOccDemandSignalResponse 

type GetOccDemandSignalResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OccDemandSignal instance
	OccDemandSignal `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"`
}

GetOccDemandSignalResponse wrapper for the GetOccDemandSignal operation

func (GetOccDemandSignalResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetOccDemandSignalResponse) String 

func (response GetOccDemandSignalResponse) String() string

type ListOccDemandSignalsRequest 

type ListOccDemandSignalsRequest struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// A filter to return only resources that match the given lifecycle state. The
	// state value is case-insensitive.
	LifecycleState OccDemandSignalLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OccDemandSignal.
	Id *string `mandatory:"false" contributesTo:"query" name:"id"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListOccDemandSignalsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
	// is descending. Default order for `displayName` is ascending.
	SortBy ListOccDemandSignalsSortByEnum `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, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

ListOccDemandSignalsRequest wrapper for the ListOccDemandSignals operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/demandsignal/ListOccDemandSignals.go.html to see an example of how to use ListOccDemandSignalsRequest.

func (ListOccDemandSignalsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListOccDemandSignalsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListOccDemandSignalsRequest) RetryPolicy 

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

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

func (ListOccDemandSignalsRequest) String 

func (request ListOccDemandSignalsRequest) String() string

func (ListOccDemandSignalsRequest) ValidateEnumValue 

func (request ListOccDemandSignalsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 ListOccDemandSignalsResponse 

type ListOccDemandSignalsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

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

ListOccDemandSignalsResponse wrapper for the ListOccDemandSignals operation

func (ListOccDemandSignalsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListOccDemandSignalsResponse) String 

func (response ListOccDemandSignalsResponse) String() string

type ListOccDemandSignalsSortByEnum 

type ListOccDemandSignalsSortByEnum string

ListOccDemandSignalsSortByEnum Enum with underlying type: string 

const (
	ListOccDemandSignalsSortByTimecreated ListOccDemandSignalsSortByEnum = "timeCreated"
	ListOccDemandSignalsSortByDisplayname ListOccDemandSignalsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListOccDemandSignalsSortByEnum

func GetListOccDemandSignalsSortByEnumValues 

func GetListOccDemandSignalsSortByEnumValues() []ListOccDemandSignalsSortByEnum

GetListOccDemandSignalsSortByEnumValues Enumerates the set of values for ListOccDemandSignalsSortByEnum

func GetMappingListOccDemandSignalsSortByEnum 

func GetMappingListOccDemandSignalsSortByEnum(val string) (ListOccDemandSignalsSortByEnum, bool)

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

type ListOccDemandSignalsSortOrderEnum 

type ListOccDemandSignalsSortOrderEnum string

ListOccDemandSignalsSortOrderEnum Enum with underlying type: string 

const (
	ListOccDemandSignalsSortOrderAsc  ListOccDemandSignalsSortOrderEnum = "ASC"
	ListOccDemandSignalsSortOrderDesc ListOccDemandSignalsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListOccDemandSignalsSortOrderEnum

func GetListOccDemandSignalsSortOrderEnumValues 

func GetListOccDemandSignalsSortOrderEnumValues() []ListOccDemandSignalsSortOrderEnum

GetListOccDemandSignalsSortOrderEnumValues Enumerates the set of values for ListOccDemandSignalsSortOrderEnum

func GetMappingListOccDemandSignalsSortOrderEnum 

func GetMappingListOccDemandSignalsSortOrderEnum(val string) (ListOccDemandSignalsSortOrderEnum, bool)

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

type OccDemandSignal 

type OccDemandSignal struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OccDemandSignal.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The OccDemandSignal data.
	OccDemandSignals []OccDemandSignalData `mandatory:"true" json:"occDemandSignals"`

	// Indicator of whether to share the data with Oracle.
	IsActive *bool `mandatory:"true" json:"isActive"`

	// The current state of the OccDemandSignal.
	LifecycleState OccDemandSignalLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The date and time the OccDemandSignal 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"`

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

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

	// The date and time the OccDemandSignal was 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"`

	// A message that describes the current state of the OccDemandSignal in more detail. For example,
	// can be used to provide actionable information for a resource in the Failed state.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

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

OccDemandSignal An OccDemandSignal is a forecast created for different Resource Types. 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.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).

func (OccDemandSignal) String 

func (m OccDemandSignal) String() string

func (OccDemandSignal) ValidateEnumValue 

func (m OccDemandSignal) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 OccDemandSignalClient 

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

OccDemandSignalClient a client for OccDemandSignal

func NewOccDemandSignalClientWithConfigurationProvider 

func NewOccDemandSignalClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OccDemandSignalClient, err error)

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

func NewOccDemandSignalClientWithOboToken 

func NewOccDemandSignalClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OccDemandSignalClient, err error)

NewOccDemandSignalClientWithOboToken Creates a new default OccDemandSignal 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 (OccDemandSignalClient) ChangeOccDemandSignalCompartment 

func (client OccDemandSignalClient) ChangeOccDemandSignalCompartment(ctx context.Context, request ChangeOccDemandSignalCompartmentRequest) (response ChangeOccDemandSignalCompartmentResponse, err error)

ChangeOccDemandSignalCompartment Moves a OccDemandSignal into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/demandsignal/ChangeOccDemandSignalCompartment.go.html to see an example of how to use ChangeOccDemandSignalCompartment API. A default retry strategy applies to this operation ChangeOccDemandSignalCompartment()

func (*OccDemandSignalClient) ConfigurationProvider 

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

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

func (OccDemandSignalClient) CreateOccDemandSignal 

func (client OccDemandSignalClient) CreateOccDemandSignal(ctx context.Context, request CreateOccDemandSignalRequest) (response CreateOccDemandSignalResponse, err error)

CreateOccDemandSignal Creates a OccDemandSignal.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/demandsignal/CreateOccDemandSignal.go.html to see an example of how to use CreateOccDemandSignal API. A default retry strategy applies to this operation CreateOccDemandSignal()

func (OccDemandSignalClient) DeleteOccDemandSignal 

func (client OccDemandSignalClient) DeleteOccDemandSignal(ctx context.Context, request DeleteOccDemandSignalRequest) (response DeleteOccDemandSignalResponse, err error)

DeleteOccDemandSignal Deletes a OccDemandSignal.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/demandsignal/DeleteOccDemandSignal.go.html to see an example of how to use DeleteOccDemandSignal API. A default retry strategy applies to this operation DeleteOccDemandSignal()

func (OccDemandSignalClient) GetOccDemandSignal 

func (client OccDemandSignalClient) GetOccDemandSignal(ctx context.Context, request GetOccDemandSignalRequest) (response GetOccDemandSignalResponse, err error)

GetOccDemandSignal Gets information about a OccDemandSignal.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/demandsignal/GetOccDemandSignal.go.html to see an example of how to use GetOccDemandSignal API. A default retry strategy applies to this operation GetOccDemandSignal()

func (OccDemandSignalClient) ListOccDemandSignals 

func (client OccDemandSignalClient) ListOccDemandSignals(ctx context.Context, request ListOccDemandSignalsRequest) (response ListOccDemandSignalsResponse, err error)

ListOccDemandSignals Gets a list of OccDemandSignals.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/demandsignal/ListOccDemandSignals.go.html to see an example of how to use ListOccDemandSignals API. A default retry strategy applies to this operation ListOccDemandSignals()

func (OccDemandSignalClient) PatchOccDemandSignal 

func (client OccDemandSignalClient) PatchOccDemandSignal(ctx context.Context, request PatchOccDemandSignalRequest) (response PatchOccDemandSignalResponse, err error)

PatchOccDemandSignal Updates the data of an OccDemandSignal.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/demandsignal/PatchOccDemandSignal.go.html to see an example of how to use PatchOccDemandSignal API. A default retry strategy applies to this operation PatchOccDemandSignal()

func (*OccDemandSignalClient) SetRegion 

func (client *OccDemandSignalClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (OccDemandSignalClient) UpdateOccDemandSignal 

func (client OccDemandSignalClient) UpdateOccDemandSignal(ctx context.Context, request UpdateOccDemandSignalRequest) (response UpdateOccDemandSignalResponse, err error)

UpdateOccDemandSignal Updates a OccDemandSignal.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/demandsignal/UpdateOccDemandSignal.go.html to see an example of how to use UpdateOccDemandSignal API. A default retry strategy applies to this operation UpdateOccDemandSignal()

type OccDemandSignalCollection 

type OccDemandSignalCollection struct {

	// List of occDemandSignals.
	Items []OccDemandSignalSummary `mandatory:"true" json:"items"`
}

OccDemandSignalCollection Results of a occDemandSignal search. Contains both OccDemandSignalSummary items and other information, such as metadata.

func (OccDemandSignalCollection) String 

func (m OccDemandSignalCollection) String() string

func (OccDemandSignalCollection) ValidateEnumValue 

func (m OccDemandSignalCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 OccDemandSignalData 

type OccDemandSignalData struct {

	// The name of the resource for the data.
	ResourceType *string `mandatory:"true" json:"resourceType"`

	// The units of the data.
	Units *string `mandatory:"true" json:"units"`

	// The values of forecast.
	Values []OccDemandSignalValue `mandatory:"true" json:"values"`
}

OccDemandSignalData The Data Object For Demand Signal.

func (OccDemandSignalData) String 

func (m OccDemandSignalData) String() string

func (OccDemandSignalData) ValidateEnumValue 

func (m OccDemandSignalData) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 OccDemandSignalLifecycleStateEnum 

type OccDemandSignalLifecycleStateEnum string

OccDemandSignalLifecycleStateEnum Enum with underlying type: string 

const (
	OccDemandSignalLifecycleStateCreating OccDemandSignalLifecycleStateEnum = "CREATING"
	OccDemandSignalLifecycleStateUpdating OccDemandSignalLifecycleStateEnum = "UPDATING"
	OccDemandSignalLifecycleStateActive   OccDemandSignalLifecycleStateEnum = "ACTIVE"
	OccDemandSignalLifecycleStateDeleting OccDemandSignalLifecycleStateEnum = "DELETING"
	OccDemandSignalLifecycleStateDeleted  OccDemandSignalLifecycleStateEnum = "DELETED"
	OccDemandSignalLifecycleStateFailed   OccDemandSignalLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for OccDemandSignalLifecycleStateEnum

func GetMappingOccDemandSignalLifecycleStateEnum 

func GetMappingOccDemandSignalLifecycleStateEnum(val string) (OccDemandSignalLifecycleStateEnum, bool)

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

func GetOccDemandSignalLifecycleStateEnumValues 

func GetOccDemandSignalLifecycleStateEnumValues() []OccDemandSignalLifecycleStateEnum

GetOccDemandSignalLifecycleStateEnumValues Enumerates the set of values for OccDemandSignalLifecycleStateEnum

type OccDemandSignalSummary 

type OccDemandSignalSummary struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OccDemandSignal.
	Id *string `mandatory:"true" json:"id"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Indicator of whether to share the data with Oracle.
	IsActive *bool `mandatory:"true" json:"isActive"`

	// The date and time the OccDemandSignal 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 current state of the OccDemandSignal.
	LifecycleState OccDemandSignalLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

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

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

	// The date and time the OccDemandSignal was 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"`

	// A message that describes the current state of the OccDemandSignal in more detail. For example,
	// can be used to provide actionable information for a resource in the Failed state.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

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

OccDemandSignalSummary Summary information about a OccDemandSignal.

func (OccDemandSignalSummary) String 

func (m OccDemandSignalSummary) String() string

func (OccDemandSignalSummary) ValidateEnumValue 

func (m OccDemandSignalSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 OccDemandSignalValue 

type OccDemandSignalValue struct {

	// The date of the Demand Signal Value.
	TimeExpected *common.SDKTime `mandatory:"true" json:"timeExpected"`

	// The Demand Signal Value.
	Value *float32 `mandatory:"true" json:"value"`

	// Space provided for users to make comments regarding the value.
	Comments *string `mandatory:"false" json:"comments"`
}

OccDemandSignalValue The Value of Demand Signal for particular month.

func (OccDemandSignalValue) String 

func (m OccDemandSignalValue) String() string

func (OccDemandSignalValue) ValidateEnumValue 

func (m OccDemandSignalValue) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 PatchInsertInstruction 

type PatchInsertInstruction struct {

	// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
	// An operation fails if the selection yields an exception, except as otherwise specified.
	// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
	Selection *string `mandatory:"true" json:"selection"`

	// A value to be inserted into the target.
	Value *interface{} `mandatory:"true" json:"value"`

	// A selection to be evaluated against the array for identifying a particular reference item within it, with the same format and semantics as `selection`.
	SelectedItem *string `mandatory:"false" json:"selectedItem"`

	// Where to insert the value, relative to the first item matched by `selectedItem`.
	// If `selectedItem` is unspecified, then "BEFORE" specifies insertion at the first position in an array and "AFTER" specifies insertion at the last position.
	// If `selectedItem` is specified but results in an empty selection, then both values specify insertion at the last position.
	Position PatchInsertInstructionPositionEnum `mandatory:"false" json:"position,omitempty"`
}

PatchInsertInstruction An operation that inserts a value into an array, shifting array items as necessary and handling NOT_FOUND exceptions by creating the implied containing structure.

func (PatchInsertInstruction) GetSelection 

func (m PatchInsertInstruction) GetSelection() *string

GetSelection returns Selection

func (PatchInsertInstruction) MarshalJSON 

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

MarshalJSON marshals to json representation

func (PatchInsertInstruction) String 

func (m PatchInsertInstruction) String() string

func (PatchInsertInstruction) ValidateEnumValue 

func (m PatchInsertInstruction) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 PatchInsertInstructionPositionEnum 

type PatchInsertInstructionPositionEnum string

PatchInsertInstructionPositionEnum Enum with underlying type: string 

const (
	PatchInsertInstructionPositionBefore PatchInsertInstructionPositionEnum = "BEFORE"
	PatchInsertInstructionPositionAfter  PatchInsertInstructionPositionEnum = "AFTER"
)

Set of constants representing the allowable values for PatchInsertInstructionPositionEnum

func GetMappingPatchInsertInstructionPositionEnum 

func GetMappingPatchInsertInstructionPositionEnum(val string) (PatchInsertInstructionPositionEnum, bool)

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

func GetPatchInsertInstructionPositionEnumValues 

func GetPatchInsertInstructionPositionEnumValues() []PatchInsertInstructionPositionEnum

GetPatchInsertInstructionPositionEnumValues Enumerates the set of values for PatchInsertInstructionPositionEnum

type PatchInsertMultipleInstruction 

type PatchInsertMultipleInstruction struct {

	// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
	// An operation fails if the selection yields an exception, except as otherwise specified.
	// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
	Selection *string `mandatory:"true" json:"selection"`

	// A list of consecutive values to be inserted into the target.
	Values []interface{} `mandatory:"true" json:"values"`

	// A selection to be evaluated against the array for identifying a particular reference item within it, with the same format and semantics as `selection`.
	SelectedItem *string `mandatory:"false" json:"selectedItem"`

	// Where to insert the values, relative to the first item matched by `selectedItem`.
	// If `selectedItem` is unspecified, then "BEFORE" specifies insertion at the first position in an array and "AFTER" specifies insertion at the last position.
	// If `selectedItem` is specified but results in an empty selection, then both values specify insertion at the last position.
	Position PatchInsertMultipleInstructionPositionEnum `mandatory:"false" json:"position,omitempty"`
}

PatchInsertMultipleInstruction An operation that inserts multiple consecutive values into an array, shifting array items as necessary and handling NOT_FOUND exceptions by creating the implied containing structure.

func (PatchInsertMultipleInstruction) GetSelection 

func (m PatchInsertMultipleInstruction) GetSelection() *string

GetSelection returns Selection

func (PatchInsertMultipleInstruction) MarshalJSON 

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

MarshalJSON marshals to json representation

func (PatchInsertMultipleInstruction) String 

func (m PatchInsertMultipleInstruction) String() string

func (PatchInsertMultipleInstruction) ValidateEnumValue 

func (m PatchInsertMultipleInstruction) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 PatchInsertMultipleInstructionPositionEnum 

type PatchInsertMultipleInstructionPositionEnum string

PatchInsertMultipleInstructionPositionEnum Enum with underlying type: string 

const (
	PatchInsertMultipleInstructionPositionBefore PatchInsertMultipleInstructionPositionEnum = "BEFORE"
	PatchInsertMultipleInstructionPositionAfter  PatchInsertMultipleInstructionPositionEnum = "AFTER"
)

Set of constants representing the allowable values for PatchInsertMultipleInstructionPositionEnum

func GetMappingPatchInsertMultipleInstructionPositionEnum 

func GetMappingPatchInsertMultipleInstructionPositionEnum(val string) (PatchInsertMultipleInstructionPositionEnum, bool)

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

func GetPatchInsertMultipleInstructionPositionEnumValues 

func GetPatchInsertMultipleInstructionPositionEnumValues() []PatchInsertMultipleInstructionPositionEnum

GetPatchInsertMultipleInstructionPositionEnumValues Enumerates the set of values for PatchInsertMultipleInstructionPositionEnum

type PatchInstruction 

type PatchInstruction interface {

	// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
	// An operation fails if the selection yields an exception, except as otherwise specified.
	// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
	GetSelection() *string
}

PatchInstruction A single instruction to be included as part of Patch request content.

type PatchInstructionOperationEnum 

type PatchInstructionOperationEnum string

PatchInstructionOperationEnum Enum with underlying type: string 

const (
	PatchInstructionOperationRequire  PatchInstructionOperationEnum = "REQUIRE"
	PatchInstructionOperationProhibit PatchInstructionOperationEnum = "PROHIBIT"
	PatchInstructionOperationReplace  PatchInstructionOperationEnum = "REPLACE"
	PatchInstructionOperationInsert   PatchInstructionOperationEnum = "INSERT"
	PatchInstructionOperationRemove   PatchInstructionOperationEnum = "REMOVE"
	PatchInstructionOperationMove     PatchInstructionOperationEnum = "MOVE"
	PatchInstructionOperationMerge    PatchInstructionOperationEnum = "MERGE"
)

Set of constants representing the allowable values for PatchInstructionOperationEnum

func GetMappingPatchInstructionOperationEnum 

func GetMappingPatchInstructionOperationEnum(val string) (PatchInstructionOperationEnum, bool)

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

func GetPatchInstructionOperationEnumValues 

func GetPatchInstructionOperationEnumValues() []PatchInstructionOperationEnum

GetPatchInstructionOperationEnumValues Enumerates the set of values for PatchInstructionOperationEnum

type PatchMergeInstruction 

type PatchMergeInstruction struct {

	// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
	// An operation fails if the selection yields an exception, except as otherwise specified.
	// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
	Selection *string `mandatory:"true" json:"selection"`

	// A value to be merged into the target.
	Value *interface{} `mandatory:"false" json:"value"`
}

PatchMergeInstruction An operation that recursively updates items of the selection, or adding the value if the selection is empty. If the value is not an object, it is used directly, otherwise each key-value member is used to create or update a member of the same name in the target and the same process is applied recursively for each object-typed value (similar to RFC 7396 (https://tools.ietf.org/html/rfc7396#section-2) JSON Merge Patch, except that null values are copied rather than transformed into deletions). NOT_FOUND exceptions are handled by creating the implied containing structure. To avoid referential errors if an item's descendant is also in the selection, items of the selection are processed in order of decreasing depth.

func (PatchMergeInstruction) GetSelection 

func (m PatchMergeInstruction) GetSelection() *string

GetSelection returns Selection

func (PatchMergeInstruction) MarshalJSON 

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

MarshalJSON marshals to json representation

func (PatchMergeInstruction) String 

func (m PatchMergeInstruction) String() string

func (PatchMergeInstruction) ValidateEnumValue 

func (m PatchMergeInstruction) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 PatchMoveInstruction 

type PatchMoveInstruction struct {

	// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
	// An operation fails if the selection yields an exception, except as otherwise specified.
	// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
	Selection *string `mandatory:"true" json:"selection"`

	// The selection that is to be moved, with the same format and semantics as `selection`.
	From *string `mandatory:"true" json:"from"`

	// Where to insert the value in an array, relative to the first item in the selection.
	// If there is no such item, then "BEFORE" specifies insertion at the first position in an array and "AFTER" specifies insertion at the last position.
	// If the first item in the selection is not the child of an array, then this field has no effect.
	Position PatchMoveInstructionPositionEnum `mandatory:"false" json:"position,omitempty"`
}

PatchMoveInstruction An operation that "puts" values from elsewhere in the target, functionally equivalent to a single add and then a remove. The first item of the selection is replaced, or created if the selection is empty. NOT_FOUND exceptions in the selection are handled by creating the implied containing structure. This operation fails if the `from` selection yields any exceptions, or if an item is moved to any of its descendants.

func (PatchMoveInstruction) GetSelection 

func (m PatchMoveInstruction) GetSelection() *string

GetSelection returns Selection

func (PatchMoveInstruction) MarshalJSON 

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

MarshalJSON marshals to json representation

func (PatchMoveInstruction) String 

func (m PatchMoveInstruction) String() string

func (PatchMoveInstruction) ValidateEnumValue 

func (m PatchMoveInstruction) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 PatchMoveInstructionPositionEnum 

type PatchMoveInstructionPositionEnum string

PatchMoveInstructionPositionEnum Enum with underlying type: string 

const (
	PatchMoveInstructionPositionAt     PatchMoveInstructionPositionEnum = "AT"
	PatchMoveInstructionPositionBefore PatchMoveInstructionPositionEnum = "BEFORE"
	PatchMoveInstructionPositionAfter  PatchMoveInstructionPositionEnum = "AFTER"
)

Set of constants representing the allowable values for PatchMoveInstructionPositionEnum

func GetMappingPatchMoveInstructionPositionEnum 

func GetMappingPatchMoveInstructionPositionEnum(val string) (PatchMoveInstructionPositionEnum, bool)

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

func GetPatchMoveInstructionPositionEnumValues 

func GetPatchMoveInstructionPositionEnumValues() []PatchMoveInstructionPositionEnum

GetPatchMoveInstructionPositionEnumValues Enumerates the set of values for PatchMoveInstructionPositionEnum

type PatchOccDemandSignalDetails 

type PatchOccDemandSignalDetails struct {

	// List of patch instructions.
	Items []PatchInstruction `mandatory:"false" json:"items"`
}

PatchOccDemandSignalDetails Demand Signal details to patch.

func (PatchOccDemandSignalDetails) String 

func (m PatchOccDemandSignalDetails) String() string

func (*PatchOccDemandSignalDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (PatchOccDemandSignalDetails) ValidateEnumValue 

func (m PatchOccDemandSignalDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 PatchOccDemandSignalRequest 

type PatchOccDemandSignalRequest struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OccDemandSignal.
	OccDemandSignalId *string `mandatory:"true" contributesTo:"path" name:"occDemandSignalId"`

	// The information to be updated.
	PatchOccDemandSignalDetails `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, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

PatchOccDemandSignalRequest wrapper for the PatchOccDemandSignal operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/demandsignal/PatchOccDemandSignal.go.html to see an example of how to use PatchOccDemandSignalRequest.

func (PatchOccDemandSignalRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (PatchOccDemandSignalRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (PatchOccDemandSignalRequest) RetryPolicy 

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

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

func (PatchOccDemandSignalRequest) String 

func (request PatchOccDemandSignalRequest) String() string

func (PatchOccDemandSignalRequest) ValidateEnumValue 

func (request PatchOccDemandSignalRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 PatchOccDemandSignalResponse 

type PatchOccDemandSignalResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
	RetryAfter *int `presentIn:"header" name:"retry-after"`

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

PatchOccDemandSignalResponse wrapper for the PatchOccDemandSignal operation

func (PatchOccDemandSignalResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (PatchOccDemandSignalResponse) String 

func (response PatchOccDemandSignalResponse) String() string

type PatchProhibitInstruction 

type PatchProhibitInstruction struct {

	// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
	// An operation fails if the selection yields an exception, except as otherwise specified.
	// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
	Selection *string `mandatory:"true" json:"selection"`

	// A value to be compared against each item of the selection.
	// If this value is an object, then it matches any item that would be unaffected by applying this value as a merge operation.
	// Otherwise, it matches any item to which it is equal according to the rules of JSON Schema (https://tools.ietf.org/html/draft-handrews-json-schema-00#section-4.2.3).
	Value *interface{} `mandatory:"false" json:"value"`
}

PatchProhibitInstruction A precondition operation that requires a selection to be empty, or optionally to be non-empty but include no item with a specified value (useful for asserting that a value does not exist before attempting to create it, avoiding accidental update). It fails if value is provided and the selection includes an item matching it, or if value is not provided and the selection is not empty, but ignores NOT_FOUND exceptions.

func (PatchProhibitInstruction) GetSelection 

func (m PatchProhibitInstruction) GetSelection() *string

GetSelection returns Selection

func (PatchProhibitInstruction) MarshalJSON 

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

MarshalJSON marshals to json representation

func (PatchProhibitInstruction) String 

func (m PatchProhibitInstruction) String() string

func (PatchProhibitInstruction) ValidateEnumValue 

func (m PatchProhibitInstruction) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 PatchRemoveInstruction 

type PatchRemoveInstruction struct {

	// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
	// An operation fails if the selection yields an exception, except as otherwise specified.
	// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
	Selection *string `mandatory:"true" json:"selection"`
}

PatchRemoveInstruction An operation that deletes items, ignoring NOT_FOUND exceptions. To avoid referential errors if an item's descendant is also in the selection, items of the selection are processed in order of decreasing depth.

func (PatchRemoveInstruction) GetSelection 

func (m PatchRemoveInstruction) GetSelection() *string

GetSelection returns Selection

func (PatchRemoveInstruction) MarshalJSON 

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

MarshalJSON marshals to json representation

func (PatchRemoveInstruction) String 

func (m PatchRemoveInstruction) String() string

func (PatchRemoveInstruction) ValidateEnumValue 

func (m PatchRemoveInstruction) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 PatchReplaceInstruction 

type PatchReplaceInstruction struct {

	// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
	// An operation fails if the selection yields an exception, except as otherwise specified.
	// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
	Selection *string `mandatory:"true" json:"selection"`

	// A value to be added into the target.
	Value *interface{} `mandatory:"true" json:"value"`
}

PatchReplaceInstruction An operation that "puts" a value, replacing every item of the selection with it, or creating it if the selection is empty. NOT_FOUND exceptions are handled by creating the implied containing structure (but note that this may put the target in an invalid state, which can be prevented by use of precondition operations). To avoid referential errors if an item's descendant is also in the selection, items of the selection are processed in order of decreasing depth.

func (PatchReplaceInstruction) GetSelection 

func (m PatchReplaceInstruction) GetSelection() *string

GetSelection returns Selection

func (PatchReplaceInstruction) MarshalJSON 

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

MarshalJSON marshals to json representation

func (PatchReplaceInstruction) String 

func (m PatchReplaceInstruction) String() string

func (PatchReplaceInstruction) ValidateEnumValue 

func (m PatchReplaceInstruction) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 PatchRequireInstruction 

type PatchRequireInstruction struct {

	// The set of values to which the operation applies as a JMESPath expression (https://jmespath.org/specification.html) for evaluation against the context resource.
	// An operation fails if the selection yields an exception, except as otherwise specified.
	// Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
	Selection *string `mandatory:"true" json:"selection"`

	// A value to be compared against each item of the selection.
	// If this value is an object, then it matches any item that would be unaffected by applying this value as a merge operation.
	// Otherwise, it matches any item to which it is equal according to the rules of JSON Schema (https://tools.ietf.org/html/draft-handrews-json-schema-00#section-4.2.3).
	Value *interface{} `mandatory:"false" json:"value"`
}

PatchRequireInstruction A precondition operation that requires a selection to be non-empty, and optionally to include an item with a specified value (useful for asserting that a value exists before attempting to update it, avoiding accidental creation). It fails if the selection is empty, or if value is provided and no item of the selection matches it.

func (PatchRequireInstruction) GetSelection 

func (m PatchRequireInstruction) GetSelection() *string

GetSelection returns Selection

func (PatchRequireInstruction) MarshalJSON 

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

MarshalJSON marshals to json representation

func (PatchRequireInstruction) String 

func (m PatchRequireInstruction) String() string

func (PatchRequireInstruction) ValidateEnumValue 

func (m PatchRequireInstruction) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 SortOrderEnum 

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string 

const (
	SortOrderAsc  SortOrderEnum = "ASC"
	SortOrderDesc SortOrderEnum = "DESC"
)

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum 

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

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

func GetSortOrderEnumValues 

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type UpdateOccDemandSignalDetails 

type UpdateOccDemandSignalDetails 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"`

	// Indicator of whether to share the data with Oracle.
	IsActive *bool `mandatory:"false" json:"isActive"`

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

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

UpdateOccDemandSignalDetails The data to update a OccDemandSignal.

func (UpdateOccDemandSignalDetails) String 

func (m UpdateOccDemandSignalDetails) String() string

func (UpdateOccDemandSignalDetails) ValidateEnumValue 

func (m UpdateOccDemandSignalDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 UpdateOccDemandSignalRequest 

type UpdateOccDemandSignalRequest struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OccDemandSignal.
	OccDemandSignalId *string `mandatory:"true" contributesTo:"path" name:"occDemandSignalId"`

	// The information to be updated.
	UpdateOccDemandSignalDetails `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, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	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
}

UpdateOccDemandSignalRequest wrapper for the UpdateOccDemandSignal operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/demandsignal/UpdateOccDemandSignal.go.html to see an example of how to use UpdateOccDemandSignalRequest.

func (UpdateOccDemandSignalRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateOccDemandSignalRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (UpdateOccDemandSignalRequest) RetryPolicy 

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

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

func (UpdateOccDemandSignalRequest) String 

func (request UpdateOccDemandSignalRequest) String() string

func (UpdateOccDemandSignalRequest) ValidateEnumValue 

func (request UpdateOccDemandSignalRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an 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 UpdateOccDemandSignalResponse 

type UpdateOccDemandSignalResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

	// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
	RetryAfter *int `presentIn:"header" name:"retry-after"`

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

UpdateOccDemandSignalResponse wrapper for the UpdateOccDemandSignal operation

func (UpdateOccDemandSignalResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateOccDemandSignalResponse) String 

func (response UpdateOccDemandSignalResponse) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.