dashboardservice

package
v65.63.2 Latest Latest
Warning

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

 Go to latest Published: Apr 16, 2024 License: Apache-2.0, UPL-1.0 Imports: 7 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetDashboardGroupLifecycleStateEnumStringValues 

func GetDashboardGroupLifecycleStateEnumStringValues() []string

GetDashboardGroupLifecycleStateEnumStringValues Enumerates the set of values in String for DashboardGroupLifecycleStateEnum

func GetDashboardLifecycleStateEnumStringValues 

func GetDashboardLifecycleStateEnumStringValues() []string

GetDashboardLifecycleStateEnumStringValues Enumerates the set of values in String for DashboardLifecycleStateEnum

func GetDashboardSchemaVersionEnumStringValues 

func GetDashboardSchemaVersionEnumStringValues() []string

GetDashboardSchemaVersionEnumStringValues Enumerates the set of values in String for DashboardSchemaVersionEnum

func GetListDashboardGroupsSortByEnumStringValues 

func GetListDashboardGroupsSortByEnumStringValues() []string

GetListDashboardGroupsSortByEnumStringValues Enumerates the set of values in String for ListDashboardGroupsSortByEnum

func GetListDashboardGroupsSortOrderEnumStringValues 

func GetListDashboardGroupsSortOrderEnumStringValues() []string

GetListDashboardGroupsSortOrderEnumStringValues Enumerates the set of values in String for ListDashboardGroupsSortOrderEnum

func GetListDashboardsSortByEnumStringValues 

func GetListDashboardsSortByEnumStringValues() []string

GetListDashboardsSortByEnumStringValues Enumerates the set of values in String for ListDashboardsSortByEnum

func GetListDashboardsSortOrderEnumStringValues 

func GetListDashboardsSortOrderEnumStringValues() []string

GetListDashboardsSortOrderEnumStringValues Enumerates the set of values in String for ListDashboardsSortOrderEnum

func GetSortOrderEnumStringValues 

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

Types

type ChangeDashboardGroupCompartmentDetails added in v65.16.0 

type ChangeDashboardGroupCompartmentDetails struct {

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
	// into which the resource should be moved.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeDashboardGroupCompartmentDetails The information to be updated.

func (ChangeDashboardGroupCompartmentDetails) String added in v65.16.0 

func (m ChangeDashboardGroupCompartmentDetails) String() string

func (ChangeDashboardGroupCompartmentDetails) ValidateEnumValue added in v65.16.0 

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

ValidateEnumValue returns an 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 ChangeDashboardGroupCompartmentRequest added in v65.16.0 

type ChangeDashboardGroupCompartmentRequest struct {

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

	// The information to be updated.
	ChangeDashboardGroupCompartmentDetails `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.
	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
}

ChangeDashboardGroupCompartmentRequest wrapper for the ChangeDashboardGroupCompartment operation

See also

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

func (ChangeDashboardGroupCompartmentRequest) BinaryRequestBody added in v65.16.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeDashboardGroupCompartmentRequest) HTTPRequest added in v65.16.0 

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

HTTPRequest implements the OCIRequest interface

func (ChangeDashboardGroupCompartmentRequest) RetryPolicy added in v65.16.0 

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

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

func (ChangeDashboardGroupCompartmentRequest) String added in v65.16.0 

func (request ChangeDashboardGroupCompartmentRequest) String() string

func (ChangeDashboardGroupCompartmentRequest) ValidateEnumValue added in v65.16.0 

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

ValidateEnumValue returns an 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 ChangeDashboardGroupCompartmentResponse added in v65.16.0 

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

ChangeDashboardGroupCompartmentResponse wrapper for the ChangeDashboardGroupCompartment operation

func (ChangeDashboardGroupCompartmentResponse) HTTPResponse added in v65.16.0 

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

HTTPResponse implements the OCIResponse interface

func (ChangeDashboardGroupCompartmentResponse) String added in v65.16.0 

func (response ChangeDashboardGroupCompartmentResponse) String() string

type ChangeDashboardGroupDetails added in v65.16.0 

type ChangeDashboardGroupDetails struct {

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the dashboardGroup
	// into which the resource should be moved.
	DashboardGroupId *string `mandatory:"true" json:"dashboardGroupId"`
}

ChangeDashboardGroupDetails The information to be updated.

func (ChangeDashboardGroupDetails) String added in v65.16.0 

func (m ChangeDashboardGroupDetails) String() string

func (ChangeDashboardGroupDetails) ValidateEnumValue added in v65.16.0 

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

ValidateEnumValue returns an 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 ChangeDashboardGroupRequest added in v65.16.0 

type ChangeDashboardGroupRequest struct {

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

	// The information to be updated.
	ChangeDashboardGroupDetails `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.
	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
}

ChangeDashboardGroupRequest wrapper for the ChangeDashboardGroup operation

See also

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

func (ChangeDashboardGroupRequest) BinaryRequestBody added in v65.16.0 

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeDashboardGroupRequest) HTTPRequest added in v65.16.0 

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

HTTPRequest implements the OCIRequest interface

func (ChangeDashboardGroupRequest) RetryPolicy added in v65.16.0 

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

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

func (ChangeDashboardGroupRequest) String added in v65.16.0 

func (request ChangeDashboardGroupRequest) String() string

func (ChangeDashboardGroupRequest) ValidateEnumValue added in v65.16.0 

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

ValidateEnumValue returns an 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 ChangeDashboardGroupResponse added in v65.16.0 

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

ChangeDashboardGroupResponse wrapper for the ChangeDashboardGroup operation

func (ChangeDashboardGroupResponse) HTTPResponse added in v65.16.0 

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

HTTPResponse implements the OCIResponse interface

func (ChangeDashboardGroupResponse) String added in v65.16.0 

func (response ChangeDashboardGroupResponse) String() string

type CreateDashboardDetails 

type CreateDashboardDetails interface {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dashboard group that the dashbaord is associated with.
	GetDashboardGroupId() *string

	// A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information.
	// Leading and trailing spaces and the following special characters are not allowed: <>()=/'"&\
	GetDisplayName() *string

	// A short description of the dashboard. It can be changed. Avoid entering confidential information.
	// The following special characters are not allowed: <>()=/'"&\
	GetDescription() *string

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	GetFreeformTags() map[string]string

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	GetDefinedTags() map[string]map[string]interface{}
}

CreateDashboardDetails The base schema for creating a dashboard. Derived schemas have configurations and widgets specific to the `schemaVersion`.

type CreateDashboardGroupDetails 

type CreateDashboardGroupDetails struct {

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

	// A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information.
	// Leading and trailing spaces and the following special characters are not allowed: <>()=/'"&\
	DisplayName *string `mandatory:"false" json:"displayName"`

	// A short description of the dashboard group. It can be changed. Avoid entering confidential information.
	// The following special characters are not allowed: <>()=/'"&\
	Description *string `mandatory:"false" json:"description"`

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateDashboardGroupDetails The data to create a new dashboard group.

func (CreateDashboardGroupDetails) String 

func (m CreateDashboardGroupDetails) String() string

func (CreateDashboardGroupDetails) ValidateEnumValue 

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

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

type CreateDashboardGroupRequest struct {

	// Details about the dashboard group being created.
	CreateDashboardGroupDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or server
	// error without risk of executing that same action again.
	// Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
	// (for example, if a resource has been deleted and purged from the system,
	// then a retry of the original creation request may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

	// To identify if the call is cross-regional. In CRUD calls for a resource, to
	// identify that the call originates from different region, set the
	// `CrossRegionIdentifierHeader` parameter to a region name (ex - `US-ASHBURN-1`)
	// The call will be served from a Replicated bucket.
	// For same-region calls, the value is unassigned.
	OpcCrossRegion *string `mandatory:"false" contributesTo:"header" name:"opc-cross-region"`

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

CreateDashboardGroupRequest wrapper for the CreateDashboardGroup operation

See also

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

func (CreateDashboardGroupRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateDashboardGroupRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CreateDashboardGroupRequest) RetryPolicy 

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

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

func (CreateDashboardGroupRequest) String 

func (request CreateDashboardGroupRequest) String() string

func (CreateDashboardGroupRequest) ValidateEnumValue 

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

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

type CreateDashboardGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

CreateDashboardGroupResponse wrapper for the CreateDashboardGroup operation

func (CreateDashboardGroupResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateDashboardGroupResponse) String 

func (response CreateDashboardGroupResponse) String() string

type CreateDashboardRequest 

type CreateDashboardRequest struct {

	// Details about the dashboard being created.
	CreateDashboardDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or server
	// error without risk of executing that same action again.
	// Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations
	// (for example, if a resource has been deleted and purged from the system,
	// then a retry of the original creation request may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

	// To identify if the call is cross-regional. In CRUD calls for a resource, to
	// identify that the call originates from different region, set the
	// `CrossRegionIdentifierHeader` parameter to a region name (ex - `US-ASHBURN-1`)
	// The call will be served from a Replicated bucket.
	// For same-region calls, the value is unassigned.
	OpcCrossRegion *string `mandatory:"false" contributesTo:"header" name:"opc-cross-region"`

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

CreateDashboardRequest wrapper for the CreateDashboard operation

See also

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

func (CreateDashboardRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateDashboardRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CreateDashboardRequest) RetryPolicy 

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

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

func (CreateDashboardRequest) String 

func (request CreateDashboardRequest) String() string

func (CreateDashboardRequest) ValidateEnumValue 

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

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

type CreateDashboardResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

CreateDashboardResponse wrapper for the CreateDashboard operation

func (CreateDashboardResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateDashboardResponse) String 

func (response CreateDashboardResponse) String() string

type CreateV1DashboardDetails 

type CreateV1DashboardDetails struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dashboard group that the dashbaord is associated with.
	DashboardGroupId *string `mandatory:"true" json:"dashboardGroupId"`

	// The basic visualization building blocks of a dashboard.
	Widgets []interface{} `mandatory:"true" json:"widgets"`

	// A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information.
	// Leading and trailing spaces and the following special characters are not allowed: <>()=/'"&\
	DisplayName *string `mandatory:"false" json:"displayName"`

	// A short description of the dashboard. It can be changed. Avoid entering confidential information.
	// The following special characters are not allowed: <>()=/'"&\
	Description *string `mandatory:"false" json:"description"`

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// The layout and widget placement for the dashboard.
	Config *interface{} `mandatory:"false" json:"config"`
}

CreateV1DashboardDetails Details for creating a version 1 dashboard. The interpretation of the `config` and `widgets` fields depends on the runtime behavior of the Oracle Cloud Infrastructure Console. The sum of the `config` and `widget` fields JSON text representation cannot exceed 200 KB.

func (CreateV1DashboardDetails) GetDashboardGroupId 

func (m CreateV1DashboardDetails) GetDashboardGroupId() *string

GetDashboardGroupId returns DashboardGroupId

func (CreateV1DashboardDetails) GetDefinedTags 

func (m CreateV1DashboardDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateV1DashboardDetails) GetDescription 

func (m CreateV1DashboardDetails) GetDescription() *string

GetDescription returns Description

func (CreateV1DashboardDetails) GetDisplayName 

func (m CreateV1DashboardDetails) GetDisplayName() *string

GetDisplayName returns DisplayName

func (CreateV1DashboardDetails) GetFreeformTags 

func (m CreateV1DashboardDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateV1DashboardDetails) MarshalJSON 

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

MarshalJSON marshals to json representation

func (CreateV1DashboardDetails) String 

func (m CreateV1DashboardDetails) String() string

func (CreateV1DashboardDetails) ValidateEnumValue 

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

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

type Dashboard interface {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dashboard resource.
	GetId() *string

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dashboard group that the dashboard belongs to.
	GetDashboardGroupId() *string

	// A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information.
	// Leading and trailing spaces and the following special characters are not allowed: <>()=/'"&\
	GetDisplayName() *string

	// A short description of the dashboard. It can be changed. Avoid entering confidential information.
	// The following special characters are not allowed: <>()=/'"&\
	GetDescription() *string

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the dashboard. A dashboard is always in the same compartment as its dashboard group.
	GetCompartmentId() *string

	// The date and time the dashboard was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
	//  Example: `2016-08-25T21:10:29.600Z`
	GetTimeCreated() *common.SDKTime

	// The date and time the dashboard was updated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	GetTimeUpdated() *common.SDKTime

	// The current state of the dashboard.
	GetLifecycleState() DashboardLifecycleStateEnum

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	GetFreeformTags() map[string]string

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	GetDefinedTags() map[string]map[string]interface{}

	// Usage of system tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	GetSystemTags() map[string]map[string]interface{}
}

Dashboard The base schema for a dashboard. Derived schemas have configurations and widgets specific to the `schemaVersion`.

type DashboardClient 

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

DashboardClient a client for Dashboard

func NewDashboardClientWithConfigurationProvider 

func NewDashboardClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DashboardClient, err error)

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

func NewDashboardClientWithOboToken 

func NewDashboardClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DashboardClient, err error)

NewDashboardClientWithOboToken Creates a new default Dashboard 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 (DashboardClient) ChangeDashboardGroup added in v65.16.0 

func (client DashboardClient) ChangeDashboardGroup(ctx context.Context, request ChangeDashboardGroupRequest) (response ChangeDashboardGroupResponse, err error)

ChangeDashboardGroup Moves a Dashboard resource from one dashboardGroup identifier to another. When provided, If-Match is checked against ETag values of the resource.

See also

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

func (*DashboardClient) ConfigurationProvider 

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

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

func (DashboardClient) CreateDashboard 

func (client DashboardClient) CreateDashboard(ctx context.Context, request CreateDashboardRequest) (response CreateDashboardResponse, err error)

CreateDashboard Creates a new dashboard in the dashboard group's compartment using the details provided in request body. **Caution:** Resources for the Dashboard service are created in the tenacy's home region. Although it is possible to create dashboard resource in regions other than the home region, you won't be able to view those resources in the Console. Therefore, creating resources outside of the home region is not recommended.

See also

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

func (DashboardClient) DeleteDashboard 

func (client DashboardClient) DeleteDashboard(ctx context.Context, request DeleteDashboardRequest) (response DeleteDashboardResponse, err error)

DeleteDashboard Deletes the specified dashboard. Uses the dashboard's OCID to determine which dashboard to delete.

See also

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

func (DashboardClient) GetDashboard 

func (client DashboardClient) GetDashboard(ctx context.Context, request GetDashboardRequest) (response GetDashboardResponse, err error)

GetDashboard Gets the specified dashboard's information. Uses the dashboard's OCID to determine which dashboard to retrieve.

See also

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

func (DashboardClient) ListDashboards 

func (client DashboardClient) ListDashboards(ctx context.Context, request ListDashboardsRequest) (response ListDashboardsResponse, err error)

ListDashboards Returns a list of dashboards with a specific dashboard group ID.

See also

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

func (*DashboardClient) SetRegion 

func (client *DashboardClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (DashboardClient) UpdateDashboard 

func (client DashboardClient) UpdateDashboard(ctx context.Context, request UpdateDashboardRequest) (response UpdateDashboardResponse, err error)

UpdateDashboard Updates the specified dashboard. Uses the dashboard's OCID to determine which dashboard to update.

See also

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

type DashboardCollection 

type DashboardCollection struct {

	// A list of dashboards.
	Items []DashboardSummary `mandatory:"true" json:"items"`
}

DashboardCollection Results of a dashboard search. Contains `DashboardSummary` items.

func (DashboardCollection) String 

func (m DashboardCollection) String() string

func (DashboardCollection) ValidateEnumValue 

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

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

type DashboardGroup struct {

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

	// A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information.
	// Leading and trailing spaces and the following special characters are not allowed: <>()=/'"&\
	DisplayName *string `mandatory:"true" json:"displayName"`

	// A short description of the dashboard group. It can be changed. Avoid entering confidential information.
	// The following special characters are not allowed: <>()=/'"&\
	Description *string `mandatory:"true" json:"description"`

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

	// The date and time the dashboard group was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The date and time the dashboard group was updated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

	// The current state of the `DashboardGroup` resource.
	LifecycleState DashboardGroupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

	// Usage of system tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

DashboardGroup The base schema for a dashboard group.

func (DashboardGroup) String 

func (m DashboardGroup) String() string

func (DashboardGroup) ValidateEnumValue 

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

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

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

DashboardGroupClient a client for DashboardGroup

func NewDashboardGroupClientWithConfigurationProvider 

func NewDashboardGroupClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DashboardGroupClient, err error)

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

func NewDashboardGroupClientWithOboToken 

func NewDashboardGroupClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DashboardGroupClient, err error)

NewDashboardGroupClientWithOboToken Creates a new default DashboardGroup 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 (DashboardGroupClient) ChangeDashboardGroupCompartment added in v65.16.0 

func (client DashboardGroupClient) ChangeDashboardGroupCompartment(ctx context.Context, request ChangeDashboardGroupCompartmentRequest) (response ChangeDashboardGroupCompartmentResponse, err error)

ChangeDashboardGroupCompartment Moves a DashboardGroup resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

See also

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

func (*DashboardGroupClient) ConfigurationProvider 

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

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

func (DashboardGroupClient) CreateDashboardGroup 

func (client DashboardGroupClient) CreateDashboardGroup(ctx context.Context, request CreateDashboardGroupRequest) (response CreateDashboardGroupResponse, err error)

CreateDashboardGroup Creates a new dashboard group using the details provided in request body. **Caution:** Resources for the Dashboard service are created in the tenacy's home region. Although it is possible to create dashboard group resource in regions other than the home region, you won't be able to view those resources in the Console. Therefore, creating resources outside of the home region is not recommended.

See also

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

func (DashboardGroupClient) DeleteDashboardGroup 

func (client DashboardGroupClient) DeleteDashboardGroup(ctx context.Context, request DeleteDashboardGroupRequest) (response DeleteDashboardGroupResponse, err error)

DeleteDashboardGroup Deletes the specified dashboard group. Uses the dashboard group's OCID to determine which dashboard group to delete.

See also

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

func (DashboardGroupClient) GetDashboardGroup 

func (client DashboardGroupClient) GetDashboardGroup(ctx context.Context, request GetDashboardGroupRequest) (response GetDashboardGroupResponse, err error)

GetDashboardGroup Gets the specified dashboard group's information. Uses the dashboard group's OCID to determine which dashboard to retrieve.

See also

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

func (DashboardGroupClient) ListDashboardGroups 

func (client DashboardGroupClient) ListDashboardGroups(ctx context.Context, request ListDashboardGroupsRequest) (response ListDashboardGroupsResponse, err error)

ListDashboardGroups Returns a list of dashboard groups with a specific compartment ID.

See also

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

func (*DashboardGroupClient) SetRegion 

func (client *DashboardGroupClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (DashboardGroupClient) UpdateDashboardGroup 

func (client DashboardGroupClient) UpdateDashboardGroup(ctx context.Context, request UpdateDashboardGroupRequest) (response UpdateDashboardGroupResponse, err error)

UpdateDashboardGroup Updates the specified dashboard group. Uses the dashboard group's OCID to determine which dashboard group to update.

See also

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

type DashboardGroupCollection 

type DashboardGroupCollection struct {

	// A list of dashboard groups.
	Items []DashboardGroupSummary `mandatory:"true" json:"items"`
}

DashboardGroupCollection A list of dashboard groups that match filter criteria, if any. Results contain `DashboardGroupSummary` objects.

func (DashboardGroupCollection) String 

func (m DashboardGroupCollection) String() string

func (DashboardGroupCollection) ValidateEnumValue 

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

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

type DashboardGroupLifecycleStateEnum string

DashboardGroupLifecycleStateEnum Enum with underlying type: string 

const (
	DashboardGroupLifecycleStateCreating DashboardGroupLifecycleStateEnum = "CREATING"
	DashboardGroupLifecycleStateUpdating DashboardGroupLifecycleStateEnum = "UPDATING"
	DashboardGroupLifecycleStateActive   DashboardGroupLifecycleStateEnum = "ACTIVE"
	DashboardGroupLifecycleStateDeleting DashboardGroupLifecycleStateEnum = "DELETING"
	DashboardGroupLifecycleStateDeleted  DashboardGroupLifecycleStateEnum = "DELETED"
	DashboardGroupLifecycleStateFailed   DashboardGroupLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for DashboardGroupLifecycleStateEnum

func GetDashboardGroupLifecycleStateEnumValues 

func GetDashboardGroupLifecycleStateEnumValues() []DashboardGroupLifecycleStateEnum

GetDashboardGroupLifecycleStateEnumValues Enumerates the set of values for DashboardGroupLifecycleStateEnum

func GetMappingDashboardGroupLifecycleStateEnum 

func GetMappingDashboardGroupLifecycleStateEnum(val string) (DashboardGroupLifecycleStateEnum, bool)

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

type DashboardGroupSummary 

type DashboardGroupSummary struct {

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

	// A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information.
	// Leading and trailing spaces and the following special characters are not allowed: <>()=/'"&\
	DisplayName *string `mandatory:"true" json:"displayName"`

	// A short description of the dashboard group. It can be changed. Avoid entering confidential information.
	// The following special characters are not allowed: <>()=/'"&\
	Description *string `mandatory:"true" json:"description"`

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

	// The date and time the dashboard group was created, in the format defined by RFC3339 (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 `DashboardGroup` resource.
	LifecycleState DashboardGroupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

	// The date and time the dashboard group was updated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// Usage of system tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

DashboardGroupSummary Summary information for the dashboard group.

func (DashboardGroupSummary) String 

func (m DashboardGroupSummary) String() string

func (DashboardGroupSummary) ValidateEnumValue 

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

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

type DashboardLifecycleStateEnum string

DashboardLifecycleStateEnum Enum with underlying type: string 

const (
	DashboardLifecycleStateCreating DashboardLifecycleStateEnum = "CREATING"
	DashboardLifecycleStateUpdating DashboardLifecycleStateEnum = "UPDATING"
	DashboardLifecycleStateActive   DashboardLifecycleStateEnum = "ACTIVE"
	DashboardLifecycleStateDeleting DashboardLifecycleStateEnum = "DELETING"
	DashboardLifecycleStateDeleted  DashboardLifecycleStateEnum = "DELETED"
	DashboardLifecycleStateFailed   DashboardLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for DashboardLifecycleStateEnum

func GetDashboardLifecycleStateEnumValues 

func GetDashboardLifecycleStateEnumValues() []DashboardLifecycleStateEnum

GetDashboardLifecycleStateEnumValues Enumerates the set of values for DashboardLifecycleStateEnum

func GetMappingDashboardLifecycleStateEnum 

func GetMappingDashboardLifecycleStateEnum(val string) (DashboardLifecycleStateEnum, bool)

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

type DashboardSchemaVersionEnum 

type DashboardSchemaVersionEnum string

DashboardSchemaVersionEnum Enum with underlying type: string 

const (
	DashboardSchemaVersionV1 DashboardSchemaVersionEnum = "V1"
)

Set of constants representing the allowable values for DashboardSchemaVersionEnum

func GetDashboardSchemaVersionEnumValues 

func GetDashboardSchemaVersionEnumValues() []DashboardSchemaVersionEnum

GetDashboardSchemaVersionEnumValues Enumerates the set of values for DashboardSchemaVersionEnum

func GetMappingDashboardSchemaVersionEnum 

func GetMappingDashboardSchemaVersionEnum(val string) (DashboardSchemaVersionEnum, bool)

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

type DashboardSummary 

type DashboardSummary struct {

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

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dashboard group that the dashboard belongs to.
	DashboardGroupId *string `mandatory:"true" json:"dashboardGroupId"`

	// A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information.
	// Leading and trailing spaces and the following special characters are not allowed: <>()=/'"&\
	DisplayName *string `mandatory:"true" json:"displayName"`

	// A short description of the dashboard. It can be changed. Avoid entering confidential information.
	// The following special characters are not allowed: <>()=/'"&\
	Description *string `mandatory:"true" json:"description"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the dashboard. A dashboard is always in the same compartment as its dashboard group.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The date and time the dashboard was created, in the format defined by RFC3339 (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 Dashboard.
	LifecycleState DashboardLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

	// The date and time the dashboard was updated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// Usage of system tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

DashboardSummary Summary information about the dashboard.

func (DashboardSummary) String 

func (m DashboardSummary) String() string

func (DashboardSummary) ValidateEnumValue 

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

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

type DeleteDashboardGroupRequest struct {

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

	// 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.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// To identify if the call is cross-regional. In CRUD calls for a resource, to
	// identify that the call originates from different region, set the
	// `CrossRegionIdentifierHeader` parameter to a region name (ex - `US-ASHBURN-1`)
	// The call will be served from a Replicated bucket.
	// For same-region calls, the value is unassigned.
	OpcCrossRegion *string `mandatory:"false" contributesTo:"header" name:"opc-cross-region"`

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

DeleteDashboardGroupRequest wrapper for the DeleteDashboardGroup operation

See also

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

func (DeleteDashboardGroupRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteDashboardGroupRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DeleteDashboardGroupRequest) RetryPolicy 

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

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

func (DeleteDashboardGroupRequest) String 

func (request DeleteDashboardGroupRequest) String() string

func (DeleteDashboardGroupRequest) ValidateEnumValue 

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

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

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

DeleteDashboardGroupResponse wrapper for the DeleteDashboardGroup operation

func (DeleteDashboardGroupResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteDashboardGroupResponse) String 

func (response DeleteDashboardGroupResponse) String() string

type DeleteDashboardRequest 

type DeleteDashboardRequest struct {

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

	// 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.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// To identify if the call is cross-regional. In CRUD calls for a resource, to
	// identify that the call originates from different region, set the
	// `CrossRegionIdentifierHeader` parameter to a region name (ex - `US-ASHBURN-1`)
	// The call will be served from a Replicated bucket.
	// For same-region calls, the value is unassigned.
	OpcCrossRegion *string `mandatory:"false" contributesTo:"header" name:"opc-cross-region"`

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

DeleteDashboardRequest wrapper for the DeleteDashboard operation

See also

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

func (DeleteDashboardRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteDashboardRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DeleteDashboardRequest) RetryPolicy 

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

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

func (DeleteDashboardRequest) String 

func (request DeleteDashboardRequest) String() string

func (DeleteDashboardRequest) ValidateEnumValue 

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

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

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

DeleteDashboardResponse wrapper for the DeleteDashboard operation

func (DeleteDashboardResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteDashboardResponse) String 

func (response DeleteDashboardResponse) String() string

type GetDashboardGroupRequest 

type GetDashboardGroupRequest struct {

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

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

	// To identify if the call is cross-regional. In CRUD calls for a resource, to
	// identify that the call originates from different region, set the
	// `CrossRegionIdentifierHeader` parameter to a region name (ex - `US-ASHBURN-1`)
	// The call will be served from a Replicated bucket.
	// For same-region calls, the value is unassigned.
	OpcCrossRegion *string `mandatory:"false" contributesTo:"header" name:"opc-cross-region"`

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

GetDashboardGroupRequest wrapper for the GetDashboardGroup operation

See also

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

func (GetDashboardGroupRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetDashboardGroupRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetDashboardGroupRequest) RetryPolicy 

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

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

func (GetDashboardGroupRequest) String 

func (request GetDashboardGroupRequest) String() string

func (GetDashboardGroupRequest) ValidateEnumValue 

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

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

type GetDashboardGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

GetDashboardGroupResponse wrapper for the GetDashboardGroup operation

func (GetDashboardGroupResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetDashboardGroupResponse) String 

func (response GetDashboardGroupResponse) String() string

type GetDashboardRequest 

type GetDashboardRequest struct {

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

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

	// To identify if the call is cross-regional. In CRUD calls for a resource, to
	// identify that the call originates from different region, set the
	// `CrossRegionIdentifierHeader` parameter to a region name (ex - `US-ASHBURN-1`)
	// The call will be served from a Replicated bucket.
	// For same-region calls, the value is unassigned.
	OpcCrossRegion *string `mandatory:"false" contributesTo:"header" name:"opc-cross-region"`

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

GetDashboardRequest wrapper for the GetDashboard operation

See also

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

func (GetDashboardRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetDashboardRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetDashboardRequest) RetryPolicy 

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

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

func (GetDashboardRequest) String 

func (request GetDashboardRequest) String() string

func (GetDashboardRequest) ValidateEnumValue 

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

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

type GetDashboardResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

GetDashboardResponse wrapper for the GetDashboard operation

func (GetDashboardResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetDashboardResponse) String 

func (response GetDashboardResponse) String() string

type ListDashboardGroupsRequest 

type ListDashboardGroupsRequest 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:"true" contributesTo:"query" name:"compartmentId"`

	// A filter that returns dashboard groups that match the lifecycle state specified.
	LifecycleState DashboardGroupLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// A case-sensitive filter that returns resources that match the entire display name specified.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

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

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The page token representing the page at which to start retrieving results. This value is usually retrieved from a previous list call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

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

	// The field to sort by. You can provide one sort order (`sortOrder`).
	// Default order for TIMECREATED is descending.
	// Default order for DISPLAYNAME is ascending.
	// The DISPLAYNAME sort order is case sensitive.
	SortBy ListDashboardGroupsSortByEnum `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.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// To identify if the call is cross-regional. In CRUD calls for a resource, to
	// identify that the call originates from different region, set the
	// `CrossRegionIdentifierHeader` parameter to a region name (ex - `US-ASHBURN-1`)
	// The call will be served from a Replicated bucket.
	// For same-region calls, the value is unassigned.
	OpcCrossRegion *string `mandatory:"false" contributesTo:"header" name:"opc-cross-region"`

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

ListDashboardGroupsRequest wrapper for the ListDashboardGroups operation

See also

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

func (ListDashboardGroupsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListDashboardGroupsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListDashboardGroupsRequest) RetryPolicy 

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

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

func (ListDashboardGroupsRequest) String 

func (request ListDashboardGroupsRequest) String() string

func (ListDashboardGroupsRequest) ValidateEnumValue 

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

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

type ListDashboardGroupsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of DashboardGroupCollection instances
	DashboardGroupCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListDashboardGroupsResponse wrapper for the ListDashboardGroups operation

func (ListDashboardGroupsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListDashboardGroupsResponse) String 

func (response ListDashboardGroupsResponse) String() string

type ListDashboardGroupsSortByEnum 

type ListDashboardGroupsSortByEnum string

ListDashboardGroupsSortByEnum Enum with underlying type: string 

const (
	ListDashboardGroupsSortByTimecreated ListDashboardGroupsSortByEnum = "timeCreated"
	ListDashboardGroupsSortByDisplayname ListDashboardGroupsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListDashboardGroupsSortByEnum

func GetListDashboardGroupsSortByEnumValues 

func GetListDashboardGroupsSortByEnumValues() []ListDashboardGroupsSortByEnum

GetListDashboardGroupsSortByEnumValues Enumerates the set of values for ListDashboardGroupsSortByEnum

func GetMappingListDashboardGroupsSortByEnum 

func GetMappingListDashboardGroupsSortByEnum(val string) (ListDashboardGroupsSortByEnum, bool)

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

type ListDashboardGroupsSortOrderEnum 

type ListDashboardGroupsSortOrderEnum string

ListDashboardGroupsSortOrderEnum Enum with underlying type: string 

const (
	ListDashboardGroupsSortOrderAsc  ListDashboardGroupsSortOrderEnum = "ASC"
	ListDashboardGroupsSortOrderDesc ListDashboardGroupsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDashboardGroupsSortOrderEnum

func GetListDashboardGroupsSortOrderEnumValues 

func GetListDashboardGroupsSortOrderEnumValues() []ListDashboardGroupsSortOrderEnum

GetListDashboardGroupsSortOrderEnumValues Enumerates the set of values for ListDashboardGroupsSortOrderEnum

func GetMappingListDashboardGroupsSortOrderEnum 

func GetMappingListDashboardGroupsSortOrderEnum(val string) (ListDashboardGroupsSortOrderEnum, bool)

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

type ListDashboardsRequest 

type ListDashboardsRequest struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dashboard group that the dashboard belongs to.
	DashboardGroupId *string `mandatory:"true" contributesTo:"query" name:"dashboardGroupId"`

	// A filter that returns dashboard resources that match the lifecycle state specified.
	LifecycleState DashboardLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// A case-sensitive filter that returns resources that match the entire display name specified.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

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

	// The maximum number of items to return.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The page token representing the page at which to start retrieving results. This value is usually retrieved from a previous list call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

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

	// The field to sort by. You can provide one sort order (`sortOrder`).
	// Default order for TIMECREATED is descending.
	// Default order for DISPLAYNAME is ascending.
	// The DISPLAYNAME sort order is case sensitive.
	SortBy ListDashboardsSortByEnum `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.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// To identify if the call is cross-regional. In CRUD calls for a resource, to
	// identify that the call originates from different region, set the
	// `CrossRegionIdentifierHeader` parameter to a region name (ex - `US-ASHBURN-1`)
	// The call will be served from a Replicated bucket.
	// For same-region calls, the value is unassigned.
	OpcCrossRegion *string `mandatory:"false" contributesTo:"header" name:"opc-cross-region"`

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

ListDashboardsRequest wrapper for the ListDashboards operation

See also

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

func (ListDashboardsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListDashboardsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListDashboardsRequest) RetryPolicy 

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

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

func (ListDashboardsRequest) String 

func (request ListDashboardsRequest) String() string

func (ListDashboardsRequest) ValidateEnumValue 

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

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

type ListDashboardsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of DashboardCollection instances
	DashboardCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
	// then a partial list might have been returned. Include this value as the `page` parameter for the
	// subsequent GET request to get the next batch of items.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListDashboardsResponse wrapper for the ListDashboards operation

func (ListDashboardsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListDashboardsResponse) String 

func (response ListDashboardsResponse) String() string

type ListDashboardsSortByEnum 

type ListDashboardsSortByEnum string

ListDashboardsSortByEnum Enum with underlying type: string 

const (
	ListDashboardsSortByTimecreated ListDashboardsSortByEnum = "timeCreated"
	ListDashboardsSortByDisplayname ListDashboardsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListDashboardsSortByEnum

func GetListDashboardsSortByEnumValues 

func GetListDashboardsSortByEnumValues() []ListDashboardsSortByEnum

GetListDashboardsSortByEnumValues Enumerates the set of values for ListDashboardsSortByEnum

func GetMappingListDashboardsSortByEnum 

func GetMappingListDashboardsSortByEnum(val string) (ListDashboardsSortByEnum, bool)

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

type ListDashboardsSortOrderEnum 

type ListDashboardsSortOrderEnum string

ListDashboardsSortOrderEnum Enum with underlying type: string 

const (
	ListDashboardsSortOrderAsc  ListDashboardsSortOrderEnum = "ASC"
	ListDashboardsSortOrderDesc ListDashboardsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDashboardsSortOrderEnum

func GetListDashboardsSortOrderEnumValues 

func GetListDashboardsSortOrderEnumValues() []ListDashboardsSortOrderEnum

GetListDashboardsSortOrderEnumValues Enumerates the set of values for ListDashboardsSortOrderEnum

func GetMappingListDashboardsSortOrderEnum 

func GetMappingListDashboardsSortOrderEnum(val string) (ListDashboardsSortOrderEnum, bool)

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

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 UpdateDashboardDetails 

type UpdateDashboardDetails interface {

	// A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information.
	// Leading and trailing spaces and the following special characters are not allowed: <>()=/'"&\
	GetDisplayName() *string

	// A short description of the dashboard. It can be changed. Avoid entering confidential information.
	// The following special characters are not allowed: <>()=/'"&\
	GetDescription() *string

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	GetFreeformTags() map[string]string

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	GetDefinedTags() map[string]map[string]interface{}
}

UpdateDashboardDetails The base schema for updating a dashboard. Derived schemas have configurations and widgets specific to the `schemaVersion`.

type UpdateDashboardGroupDetails 

type UpdateDashboardGroupDetails struct {

	// A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information.
	// Leading and trailing spaces and the following special characters are not allowed: <>()=/'"&\
	DisplayName *string `mandatory:"false" json:"displayName"`

	// A short description of the dashboard group. It can be changed. Avoid entering confidential information.
	// The following special characters are not allowed: <>()=/'"&\
	Description *string `mandatory:"false" json:"description"`

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateDashboardGroupDetails The data to update a dashboard group.

func (UpdateDashboardGroupDetails) String 

func (m UpdateDashboardGroupDetails) String() string

func (UpdateDashboardGroupDetails) ValidateEnumValue 

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

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

type UpdateDashboardGroupRequest struct {

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

	// The dashboard group details to be updated.
	UpdateDashboardGroupDetails `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.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// To identify if the call is cross-regional. In CRUD calls for a resource, to
	// identify that the call originates from different region, set the
	// `CrossRegionIdentifierHeader` parameter to a region name (ex - `US-ASHBURN-1`)
	// The call will be served from a Replicated bucket.
	// For same-region calls, the value is unassigned.
	OpcCrossRegion *string `mandatory:"false" contributesTo:"header" name:"opc-cross-region"`

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

UpdateDashboardGroupRequest wrapper for the UpdateDashboardGroup operation

See also

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

func (UpdateDashboardGroupRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateDashboardGroupRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (UpdateDashboardGroupRequest) RetryPolicy 

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

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

func (UpdateDashboardGroupRequest) String 

func (request UpdateDashboardGroupRequest) String() string

func (UpdateDashboardGroupRequest) ValidateEnumValue 

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

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

type UpdateDashboardGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

UpdateDashboardGroupResponse wrapper for the UpdateDashboardGroup operation

func (UpdateDashboardGroupResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateDashboardGroupResponse) String 

func (response UpdateDashboardGroupResponse) String() string

type UpdateDashboardRequest 

type UpdateDashboardRequest struct {

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

	// The dashboard details to be updated.
	UpdateDashboardDetails `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.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// To identify if the call is cross-regional. In CRUD calls for a resource, to
	// identify that the call originates from different region, set the
	// `CrossRegionIdentifierHeader` parameter to a region name (ex - `US-ASHBURN-1`)
	// The call will be served from a Replicated bucket.
	// For same-region calls, the value is unassigned.
	OpcCrossRegion *string `mandatory:"false" contributesTo:"header" name:"opc-cross-region"`

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

UpdateDashboardRequest wrapper for the UpdateDashboard operation

See also

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

func (UpdateDashboardRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateDashboardRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (UpdateDashboardRequest) RetryPolicy 

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

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

func (UpdateDashboardRequest) String 

func (request UpdateDashboardRequest) String() string

func (UpdateDashboardRequest) ValidateEnumValue 

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

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

type UpdateDashboardResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

UpdateDashboardResponse wrapper for the UpdateDashboard operation

func (UpdateDashboardResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateDashboardResponse) String 

func (response UpdateDashboardResponse) String() string

type UpdateV1DashboardDetails 

type UpdateV1DashboardDetails struct {

	// A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information.
	// Leading and trailing spaces and the following special characters are not allowed: <>()=/'"&\
	DisplayName *string `mandatory:"false" json:"displayName"`

	// A short description of the dashboard. It can be changed. Avoid entering confidential information.
	// The following special characters are not allowed: <>()=/'"&\
	Description *string `mandatory:"false" json:"description"`

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// The layout and widget placement for the dashboard.
	Config *interface{} `mandatory:"false" json:"config"`

	// The basic visualization building blocks of a dashboard.
	Widgets []interface{} `mandatory:"false" json:"widgets"`
}

UpdateV1DashboardDetails Details for updating a version 1 dashboard. The interpretation of the `config` and `widgets` fields depends on the runtime behavior of the Oracle Cloud Infrastructure Console. The sum of the `config` and `widget` fields JSON text representation cannot exceed 200 KB.

func (UpdateV1DashboardDetails) GetDefinedTags 

func (m UpdateV1DashboardDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (UpdateV1DashboardDetails) GetDescription 

func (m UpdateV1DashboardDetails) GetDescription() *string

GetDescription returns Description

func (UpdateV1DashboardDetails) GetDisplayName 

func (m UpdateV1DashboardDetails) GetDisplayName() *string

GetDisplayName returns DisplayName

func (UpdateV1DashboardDetails) GetFreeformTags 

func (m UpdateV1DashboardDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (UpdateV1DashboardDetails) MarshalJSON 

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

MarshalJSON marshals to json representation

func (UpdateV1DashboardDetails) String 

func (m UpdateV1DashboardDetails) String() string

func (UpdateV1DashboardDetails) ValidateEnumValue 

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

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

type V1Dashboard struct {

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

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dashboard group that the dashboard belongs to.
	DashboardGroupId *string `mandatory:"true" json:"dashboardGroupId"`

	// A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information.
	// Leading and trailing spaces and the following special characters are not allowed: <>()=/'"&\
	DisplayName *string `mandatory:"true" json:"displayName"`

	// A short description of the dashboard. It can be changed. Avoid entering confidential information.
	// The following special characters are not allowed: <>()=/'"&\
	Description *string `mandatory:"true" json:"description"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the dashboard. A dashboard is always in the same compartment as its dashboard group.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The date and time the dashboard was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
	//  Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The date and time the dashboard was updated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

	// The visualization building blocks of the dashboard.
	Widgets []interface{} `mandatory:"true" json:"widgets"`

	// Usage of system tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`

	// The dashboard configuration. For example, the layout and widget placement.
	Config *interface{} `mandatory:"false" json:"config"`

	// The current state of the dashboard.
	LifecycleState DashboardLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}

V1Dashboard A version 1 dashboard. The interpretation of the `config` and `widgets` fields depends on the runtime behavior of the Oracle Cloud Infrastructure Console. The sum of the `config` and `widget` fields JSON text representation cannot exceed 200 KB.

func (V1Dashboard) GetCompartmentId 

func (m V1Dashboard) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (V1Dashboard) GetDashboardGroupId 

func (m V1Dashboard) GetDashboardGroupId() *string

GetDashboardGroupId returns DashboardGroupId

func (V1Dashboard) GetDefinedTags 

func (m V1Dashboard) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (V1Dashboard) GetDescription 

func (m V1Dashboard) GetDescription() *string

GetDescription returns Description

func (V1Dashboard) GetDisplayName 

func (m V1Dashboard) GetDisplayName() *string

GetDisplayName returns DisplayName

func (V1Dashboard) GetFreeformTags 

func (m V1Dashboard) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (V1Dashboard) GetId 

func (m V1Dashboard) GetId() *string

GetId returns Id

func (V1Dashboard) GetLifecycleState 

func (m V1Dashboard) GetLifecycleState() DashboardLifecycleStateEnum

GetLifecycleState returns LifecycleState

func (V1Dashboard) GetSystemTags 

func (m V1Dashboard) GetSystemTags() map[string]map[string]interface{}

GetSystemTags returns SystemTags

func (V1Dashboard) GetTimeCreated 

func (m V1Dashboard) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (V1Dashboard) GetTimeUpdated 

func (m V1Dashboard) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (V1Dashboard) MarshalJSON 

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

MarshalJSON marshals to json representation

func (V1Dashboard) String 

func (m V1Dashboard) String() string

func (V1Dashboard) ValidateEnumValue 

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

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

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.