func GetDashboardGroupLifecycleStateEnumStringValues() []string
GetDashboardGroupLifecycleStateEnumStringValues Enumerates the set of values in String for DashboardGroupLifecycleStateEnum
func GetDashboardLifecycleStateEnumStringValues() []string
GetDashboardLifecycleStateEnumStringValues Enumerates the set of values in String for DashboardLifecycleStateEnum
func GetDashboardSchemaVersionEnumStringValues() []string
GetDashboardSchemaVersionEnumStringValues Enumerates the set of values in String for DashboardSchemaVersionEnum
func GetListDashboardGroupsSortByEnumStringValues() []string
GetListDashboardGroupsSortByEnumStringValues Enumerates the set of values in String for ListDashboardGroupsSortByEnum
func GetListDashboardGroupsSortOrderEnumStringValues() []string
GetListDashboardGroupsSortOrderEnumStringValues Enumerates the set of values in String for ListDashboardGroupsSortOrderEnum
func GetListDashboardsSortByEnumStringValues() []string
GetListDashboardsSortByEnumStringValues Enumerates the set of values in String for ListDashboardsSortByEnum
func GetListDashboardsSortOrderEnumStringValues() []string
GetListDashboardsSortOrderEnumStringValues Enumerates the set of values in String for ListDashboardsSortOrderEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
ChangeDashboardGroupCompartmentDetails The information to be updated.
type ChangeDashboardGroupCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment
// into which the resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeDashboardGroupCompartmentDetails) String() string
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
ChangeDashboardGroupCompartmentRequest wrapper for the ChangeDashboardGroupCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dashboardservice/ChangeDashboardGroupCompartment.go.html to see an example of how to use ChangeDashboardGroupCompartmentRequest.
type ChangeDashboardGroupCompartmentRequest struct {
// The OCID (https://docs.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
}
func (request ChangeDashboardGroupCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeDashboardGroupCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeDashboardGroupCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeDashboardGroupCompartmentRequest) String() string
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
ChangeDashboardGroupCompartmentResponse wrapper for the ChangeDashboardGroupCompartment operation
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"`
}
func (response ChangeDashboardGroupCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeDashboardGroupCompartmentResponse) String() string
ChangeDashboardGroupDetails The information to be updated.
type ChangeDashboardGroupDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dashboardGroup
// into which the resource should be moved.
DashboardGroupId *string `mandatory:"true" json:"dashboardGroupId"`
}
func (m ChangeDashboardGroupDetails) String() string
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
ChangeDashboardGroupRequest wrapper for the ChangeDashboardGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dashboardservice/ChangeDashboardGroup.go.html to see an example of how to use ChangeDashboardGroupRequest.
type ChangeDashboardGroupRequest struct {
// The OCID (https://docs.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
}
func (request ChangeDashboardGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeDashboardGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeDashboardGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeDashboardGroupRequest) String() string
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
ChangeDashboardGroupResponse wrapper for the ChangeDashboardGroup operation
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"`
}
func (response ChangeDashboardGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeDashboardGroupResponse) String() string
CreateDashboardDetails The base schema for creating a dashboard. Derived schemas have configurations and widgets specific to the `schemaVersion`.
type CreateDashboardDetails interface {
// The OCID (https://docs.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{}
}
CreateDashboardGroupDetails The data to create a new dashboard group.
type CreateDashboardGroupDetails struct {
// The OCID (https://docs.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"`
}
func (m CreateDashboardGroupDetails) String() string
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
CreateDashboardGroupRequest wrapper for the CreateDashboardGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dashboardservice/CreateDashboardGroup.go.html to see an example of how to use 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
}
func (request CreateDashboardGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDashboardGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDashboardGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDashboardGroupRequest) String() string
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
CreateDashboardGroupResponse wrapper for the CreateDashboardGroup operation
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"`
}
func (response CreateDashboardGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDashboardGroupResponse) String() string
CreateDashboardRequest wrapper for the CreateDashboard operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dashboardservice/CreateDashboard.go.html to see an example of how to use 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
}
func (request CreateDashboardRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDashboardRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDashboardRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDashboardRequest) String() string
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
CreateDashboardResponse wrapper for the CreateDashboard operation
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"`
}
func (response CreateDashboardResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDashboardResponse) String() string
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.
type CreateV1DashboardDetails struct {
// The OCID (https://docs.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"`
}
func (m CreateV1DashboardDetails) GetDashboardGroupId() *string
GetDashboardGroupId returns DashboardGroupId
func (m CreateV1DashboardDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateV1DashboardDetails) GetDescription() *string
GetDescription returns Description
func (m CreateV1DashboardDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m CreateV1DashboardDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateV1DashboardDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateV1DashboardDetails) String() string
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
Dashboard The base schema for a dashboard. Derived schemas have configurations and widgets specific to the `schemaVersion`.
type Dashboard interface {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dashboard resource.
GetId() *string
// The OCID (https://docs.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.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{}
}
DashboardClient a client for Dashboard
type DashboardClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (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.
Click https://docs.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 (client *DashboardClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (client DashboardClient) ListDashboards(ctx context.Context, request ListDashboardsRequest) (response ListDashboardsResponse, err error)
ListDashboards Returns a list of dashboards with a specific dashboard group ID.
Click https://docs.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 (client *DashboardClient) SetRegion(region string)
SetRegion overrides the region of this client.
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dashboardservice/UpdateDashboard.go.html to see an example of how to use UpdateDashboard API.
DashboardCollection Results of a dashboard search. Contains `DashboardSummary` items.
type DashboardCollection struct {
// A list of dashboards.
Items []DashboardSummary `mandatory:"true" json:"items"`
}
func (m DashboardCollection) String() string
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
DashboardGroup The base schema for a dashboard group.
type DashboardGroup struct {
// The OCID (https://docs.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.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"`
}
func (m DashboardGroup) String() string
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
DashboardGroupClient a client for DashboardGroup
type DashboardGroupClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (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.
Click https://docs.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 (client *DashboardGroupClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
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.
Click https://docs.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 (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.
Click https://docs.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 (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.
Click https://docs.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 (client DashboardGroupClient) ListDashboardGroups(ctx context.Context, request ListDashboardGroupsRequest) (response ListDashboardGroupsResponse, err error)
ListDashboardGroups Returns a list of dashboard groups with a specific compartment ID.
Click https://docs.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 (client *DashboardGroupClient) SetRegion(region string)
SetRegion overrides the region of this client.
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dashboardservice/UpdateDashboardGroup.go.html to see an example of how to use UpdateDashboardGroup API.
DashboardGroupCollection A list of dashboard groups that match filter criteria, if any. Results contain `DashboardGroupSummary` objects.
type DashboardGroupCollection struct {
// A list of dashboard groups.
Items []DashboardGroupSummary `mandatory:"true" json:"items"`
}
func (m DashboardGroupCollection) String() string
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
DashboardGroupLifecycleStateEnum Enum with underlying type: string
type DashboardGroupLifecycleStateEnum string
Set of constants representing the allowable values for DashboardGroupLifecycleStateEnum
const (
DashboardGroupLifecycleStateCreating DashboardGroupLifecycleStateEnum = "CREATING"
DashboardGroupLifecycleStateUpdating DashboardGroupLifecycleStateEnum = "UPDATING"
DashboardGroupLifecycleStateActive DashboardGroupLifecycleStateEnum = "ACTIVE"
DashboardGroupLifecycleStateDeleting DashboardGroupLifecycleStateEnum = "DELETING"
DashboardGroupLifecycleStateDeleted DashboardGroupLifecycleStateEnum = "DELETED"
DashboardGroupLifecycleStateFailed DashboardGroupLifecycleStateEnum = "FAILED"
)
func GetDashboardGroupLifecycleStateEnumValues() []DashboardGroupLifecycleStateEnum
GetDashboardGroupLifecycleStateEnumValues Enumerates the set of values for DashboardGroupLifecycleStateEnum
func GetMappingDashboardGroupLifecycleStateEnum(val string) (DashboardGroupLifecycleStateEnum, bool)
GetMappingDashboardGroupLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DashboardGroupSummary Summary information for the dashboard group.
type DashboardGroupSummary struct {
// The OCID (https://docs.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.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"`
}
func (m DashboardGroupSummary) String() string
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
DashboardLifecycleStateEnum Enum with underlying type: string
type DashboardLifecycleStateEnum string
Set of constants representing the allowable values for DashboardLifecycleStateEnum
const (
DashboardLifecycleStateCreating DashboardLifecycleStateEnum = "CREATING"
DashboardLifecycleStateUpdating DashboardLifecycleStateEnum = "UPDATING"
DashboardLifecycleStateActive DashboardLifecycleStateEnum = "ACTIVE"
DashboardLifecycleStateDeleting DashboardLifecycleStateEnum = "DELETING"
DashboardLifecycleStateDeleted DashboardLifecycleStateEnum = "DELETED"
DashboardLifecycleStateFailed DashboardLifecycleStateEnum = "FAILED"
)
func GetDashboardLifecycleStateEnumValues() []DashboardLifecycleStateEnum
GetDashboardLifecycleStateEnumValues Enumerates the set of values for DashboardLifecycleStateEnum
func GetMappingDashboardLifecycleStateEnum(val string) (DashboardLifecycleStateEnum, bool)
GetMappingDashboardLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DashboardSchemaVersionEnum Enum with underlying type: string
type DashboardSchemaVersionEnum string
Set of constants representing the allowable values for DashboardSchemaVersionEnum
const (
DashboardSchemaVersionV1 DashboardSchemaVersionEnum = "V1"
)
func GetDashboardSchemaVersionEnumValues() []DashboardSchemaVersionEnum
GetDashboardSchemaVersionEnumValues Enumerates the set of values for DashboardSchemaVersionEnum
func GetMappingDashboardSchemaVersionEnum(val string) (DashboardSchemaVersionEnum, bool)
GetMappingDashboardSchemaVersionEnum performs case Insensitive comparison on enum value and return the desired enum
DashboardSummary Summary information about the dashboard.
type DashboardSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dashboard resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.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.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"`
}
func (m DashboardSummary) String() string
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
DeleteDashboardGroupRequest wrapper for the DeleteDashboardGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dashboardservice/DeleteDashboardGroup.go.html to see an example of how to use DeleteDashboardGroupRequest.
type DeleteDashboardGroupRequest struct {
// The OCID (https://docs.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
}
func (request DeleteDashboardGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDashboardGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDashboardGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDashboardGroupRequest) String() string
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
DeleteDashboardGroupResponse wrapper for the DeleteDashboardGroup operation
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"`
}
func (response DeleteDashboardGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDashboardGroupResponse) String() string
DeleteDashboardRequest wrapper for the DeleteDashboard operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dashboardservice/DeleteDashboard.go.html to see an example of how to use DeleteDashboardRequest.
type DeleteDashboardRequest struct {
// The OCID (https://docs.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
}
func (request DeleteDashboardRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDashboardRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDashboardRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDashboardRequest) String() string
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
DeleteDashboardResponse wrapper for the DeleteDashboard operation
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"`
}
func (response DeleteDashboardResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDashboardResponse) String() string
GetDashboardGroupRequest wrapper for the GetDashboardGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dashboardservice/GetDashboardGroup.go.html to see an example of how to use GetDashboardGroupRequest.
type GetDashboardGroupRequest struct {
// The OCID (https://docs.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
}
func (request GetDashboardGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDashboardGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDashboardGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDashboardGroupRequest) String() string
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
GetDashboardGroupResponse wrapper for the GetDashboardGroup operation
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"`
}
func (response GetDashboardGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDashboardGroupResponse) String() string
GetDashboardRequest wrapper for the GetDashboard operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dashboardservice/GetDashboard.go.html to see an example of how to use GetDashboardRequest.
type GetDashboardRequest struct {
// The OCID (https://docs.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
}
func (request GetDashboardRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDashboardRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDashboardRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDashboardRequest) String() string
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
GetDashboardResponse wrapper for the GetDashboard operation
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"`
}
func (response GetDashboardResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDashboardResponse) String() string
ListDashboardGroupsRequest wrapper for the ListDashboardGroups operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dashboardservice/ListDashboardGroups.go.html to see an example of how to use ListDashboardGroupsRequest.
type ListDashboardGroupsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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.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
}
func (request ListDashboardGroupsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDashboardGroupsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDashboardGroupsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDashboardGroupsRequest) String() string
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
ListDashboardGroupsResponse wrapper for the ListDashboardGroups operation
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"`
}
func (response ListDashboardGroupsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDashboardGroupsResponse) String() string
ListDashboardGroupsSortByEnum Enum with underlying type: string
type ListDashboardGroupsSortByEnum string
Set of constants representing the allowable values for ListDashboardGroupsSortByEnum
const (
ListDashboardGroupsSortByTimecreated ListDashboardGroupsSortByEnum = "timeCreated"
ListDashboardGroupsSortByDisplayname ListDashboardGroupsSortByEnum = "displayName"
)
func GetListDashboardGroupsSortByEnumValues() []ListDashboardGroupsSortByEnum
GetListDashboardGroupsSortByEnumValues Enumerates the set of values for ListDashboardGroupsSortByEnum
func GetMappingListDashboardGroupsSortByEnum(val string) (ListDashboardGroupsSortByEnum, bool)
GetMappingListDashboardGroupsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDashboardGroupsSortOrderEnum Enum with underlying type: string
type ListDashboardGroupsSortOrderEnum string
Set of constants representing the allowable values for ListDashboardGroupsSortOrderEnum
const (
ListDashboardGroupsSortOrderAsc ListDashboardGroupsSortOrderEnum = "ASC"
ListDashboardGroupsSortOrderDesc ListDashboardGroupsSortOrderEnum = "DESC"
)
func GetListDashboardGroupsSortOrderEnumValues() []ListDashboardGroupsSortOrderEnum
GetListDashboardGroupsSortOrderEnumValues Enumerates the set of values for ListDashboardGroupsSortOrderEnum
func GetMappingListDashboardGroupsSortOrderEnum(val string) (ListDashboardGroupsSortOrderEnum, bool)
GetMappingListDashboardGroupsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDashboardsRequest wrapper for the ListDashboards operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dashboardservice/ListDashboards.go.html to see an example of how to use ListDashboardsRequest.
type ListDashboardsRequest struct {
// The OCID (https://docs.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.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
}
func (request ListDashboardsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDashboardsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDashboardsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDashboardsRequest) String() string
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
ListDashboardsResponse wrapper for the ListDashboards operation
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"`
}
func (response ListDashboardsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDashboardsResponse) String() string
ListDashboardsSortByEnum Enum with underlying type: string
type ListDashboardsSortByEnum string
Set of constants representing the allowable values for ListDashboardsSortByEnum
const (
ListDashboardsSortByTimecreated ListDashboardsSortByEnum = "timeCreated"
ListDashboardsSortByDisplayname ListDashboardsSortByEnum = "displayName"
)
func GetListDashboardsSortByEnumValues() []ListDashboardsSortByEnum
GetListDashboardsSortByEnumValues Enumerates the set of values for ListDashboardsSortByEnum
func GetMappingListDashboardsSortByEnum(val string) (ListDashboardsSortByEnum, bool)
GetMappingListDashboardsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDashboardsSortOrderEnum Enum with underlying type: string
type ListDashboardsSortOrderEnum string
Set of constants representing the allowable values for ListDashboardsSortOrderEnum
const (
ListDashboardsSortOrderAsc ListDashboardsSortOrderEnum = "ASC"
ListDashboardsSortOrderDesc ListDashboardsSortOrderEnum = "DESC"
)
func GetListDashboardsSortOrderEnumValues() []ListDashboardsSortOrderEnum
GetListDashboardsSortOrderEnumValues Enumerates the set of values for ListDashboardsSortOrderEnum
func GetMappingListDashboardsSortOrderEnum(val string) (ListDashboardsSortOrderEnum, bool)
GetMappingListDashboardsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
UpdateDashboardDetails The base schema for updating a dashboard. Derived schemas have configurations and widgets specific to the `schemaVersion`.
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{}
}
UpdateDashboardGroupDetails The data to update a dashboard group.
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"`
}
func (m UpdateDashboardGroupDetails) String() string
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
UpdateDashboardGroupRequest wrapper for the UpdateDashboardGroup operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dashboardservice/UpdateDashboardGroup.go.html to see an example of how to use UpdateDashboardGroupRequest.
type UpdateDashboardGroupRequest struct {
// The OCID (https://docs.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
}
func (request UpdateDashboardGroupRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDashboardGroupRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDashboardGroupRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDashboardGroupRequest) String() string
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
UpdateDashboardGroupResponse wrapper for the UpdateDashboardGroup operation
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"`
}
func (response UpdateDashboardGroupResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDashboardGroupResponse) String() string
UpdateDashboardRequest wrapper for the UpdateDashboard operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/dashboardservice/UpdateDashboard.go.html to see an example of how to use UpdateDashboardRequest.
type UpdateDashboardRequest struct {
// The OCID (https://docs.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
}
func (request UpdateDashboardRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDashboardRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDashboardRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDashboardRequest) String() string
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
UpdateDashboardResponse wrapper for the UpdateDashboard operation
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"`
}
func (response UpdateDashboardResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDashboardResponse) String() string
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.
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"`
}
func (m UpdateV1DashboardDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateV1DashboardDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateV1DashboardDetails) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m UpdateV1DashboardDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateV1DashboardDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateV1DashboardDetails) String() string
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
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.
type V1Dashboard struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dashboard resource.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.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.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"`
}
func (m V1Dashboard) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m V1Dashboard) GetDashboardGroupId() *string
GetDashboardGroupId returns DashboardGroupId
func (m V1Dashboard) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m V1Dashboard) GetDescription() *string
GetDescription returns Description
func (m V1Dashboard) GetDisplayName() *string
GetDisplayName returns DisplayName
func (m V1Dashboard) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m V1Dashboard) GetId() *string
GetId returns Id
func (m V1Dashboard) GetLifecycleState() DashboardLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m V1Dashboard) GetSystemTags() map[string]map[string]interface{}
GetSystemTags returns SystemTags
func (m V1Dashboard) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m V1Dashboard) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m V1Dashboard) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m V1Dashboard) String() string
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