func GetLifecycleStatesEnumStringValues() []string
GetLifecycleStatesEnumStringValues Enumerates the set of values in String for LifecycleStatesEnum
func GetListManagementDashboardsSortByEnumStringValues() []string
GetListManagementDashboardsSortByEnumStringValues Enumerates the set of values in String for ListManagementDashboardsSortByEnum
func GetListManagementDashboardsSortOrderEnumStringValues() []string
GetListManagementDashboardsSortOrderEnumStringValues Enumerates the set of values in String for ListManagementDashboardsSortOrderEnum
func GetListManagementSavedSearchesSortByEnumStringValues() []string
GetListManagementSavedSearchesSortByEnumStringValues Enumerates the set of values in String for ListManagementSavedSearchesSortByEnum
func GetListManagementSavedSearchesSortOrderEnumStringValues() []string
GetListManagementSavedSearchesSortOrderEnumStringValues Enumerates the set of values in String for ListManagementSavedSearchesSortOrderEnum
func GetManagementDashboardTileDetailsStateEnumStringValues() []string
GetManagementDashboardTileDetailsStateEnumStringValues Enumerates the set of values in String for ManagementDashboardTileDetailsStateEnum
func GetSavedSearchTypesEnumStringValues() []string
GetSavedSearchTypesEnumStringValues Enumerates the set of values in String for SavedSearchTypesEnum
func GetSortOrdersEnumStringValues() []string
GetSortOrdersEnumStringValues Enumerates the set of values in String for SortOrdersEnum
ChangeManagementDashboardsCompartmentDetails Compartment to which the dashboard is being moved.
type ChangeManagementDashboardsCompartmentDetails struct {
// OCID of the compartment to which the dashboard is being moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeManagementDashboardsCompartmentDetails) String() string
func (m ChangeManagementDashboardsCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeManagementDashboardsCompartmentRequest wrapper for the ChangeManagementDashboardsCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/ChangeManagementDashboardsCompartment.go.html to see an example of how to use ChangeManagementDashboardsCompartmentRequest.
type ChangeManagementDashboardsCompartmentRequest struct {
// A unique dashboard identifier.
ManagementDashboardId *string `mandatory:"true" contributesTo:"path" name:"managementDashboardId"`
// ID of the dashboard that is being moved.
ChangeManagementDashboardsCompartmentDetails `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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
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 ChangeManagementDashboardsCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeManagementDashboardsCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeManagementDashboardsCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeManagementDashboardsCompartmentRequest) String() string
func (request ChangeManagementDashboardsCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeManagementDashboardsCompartmentResponse wrapper for the ChangeManagementDashboardsCompartment operation
type ChangeManagementDashboardsCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The ManagementDashboard instance
ManagementDashboard `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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response ChangeManagementDashboardsCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeManagementDashboardsCompartmentResponse) String() string
ChangeManagementSavedSearchesCompartmentDetails Compartment to which the saved search is being moved.
type ChangeManagementSavedSearchesCompartmentDetails struct {
// OCID of the compartment to which the saved search is being moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeManagementSavedSearchesCompartmentDetails) String() string
func (m ChangeManagementSavedSearchesCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeManagementSavedSearchesCompartmentRequest wrapper for the ChangeManagementSavedSearchesCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/ChangeManagementSavedSearchesCompartment.go.html to see an example of how to use ChangeManagementSavedSearchesCompartmentRequest.
type ChangeManagementSavedSearchesCompartmentRequest struct {
// A unique saved search identifier.
ManagementSavedSearchId *string `mandatory:"true" contributesTo:"path" name:"managementSavedSearchId"`
// ID of the saved search that is being moved.
ChangeManagementSavedSearchesCompartmentDetails `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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
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 ChangeManagementSavedSearchesCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeManagementSavedSearchesCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeManagementSavedSearchesCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeManagementSavedSearchesCompartmentRequest) String() string
func (request ChangeManagementSavedSearchesCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeManagementSavedSearchesCompartmentResponse wrapper for the ChangeManagementSavedSearchesCompartment operation
type ChangeManagementSavedSearchesCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The ManagementSavedSearch instance
ManagementSavedSearch `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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response ChangeManagementSavedSearchesCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeManagementSavedSearchesCompartmentResponse) String() string
CreateManagementDashboardDetails Properties of a dashboard. ID of the dashboard must only be provided for Out-of-the-Box (OOB) dashboards.
type CreateManagementDashboardDetails struct {
// ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID.
ProviderId *string `mandatory:"true" json:"providerId"`
// The user friendly name of the service (for example, Logging Analytics) that owns the dashboard.
ProviderName *string `mandatory:"true" json:"providerName"`
// The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.
ProviderVersion *string `mandatory:"true" json:"providerVersion"`
// Array of dashboard tiles.
Tiles []ManagementDashboardTileDetails `mandatory:"true" json:"tiles"`
// Display name of the dashboard.
DisplayName *string `mandatory:"true" json:"displayName"`
// Description of the dashboard.
Description *string `mandatory:"true" json:"description"`
// OCID of the compartment in which the dashboard resides.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified.
IsOobDashboard *bool `mandatory:"true" json:"isOobDashboard"`
// Determines whether the dashboard will be displayed in Dashboard Home.
IsShowInHome *bool `mandatory:"true" json:"isShowInHome"`
// The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.
MetadataVersion *string `mandatory:"true" json:"metadataVersion"`
// Determines whether the description of the dashboard is displayed.
IsShowDescription *bool `mandatory:"true" json:"isShowDescription"`
// Screen image of the dashboard.
ScreenImage *string `mandatory:"true" json:"screenImage"`
// JSON that contains internationalization options.
Nls *interface{} `mandatory:"true" json:"nls"`
// JSON that contains user interface options.
UiConfig *interface{} `mandatory:"true" json:"uiConfig"`
// Array of JSON that contain data source options.
DataConfig []interface{} `mandatory:"true" json:"dataConfig"`
// Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.
Type *string `mandatory:"true" json:"type"`
// Determines whether the dashboard is set as favorite.
IsFavorite *bool `mandatory:"true" json:"isFavorite"`
// ID of the dashboard, which must only be provided for Out-of-the-Box (OOB) dashboards.
DashboardId *string `mandatory:"false" json:"dashboardId"`
// Defines parameters for the dashboard.
ParametersConfig []interface{} `mandatory:"false" json:"parametersConfig"`
// Contains configuration for enabling features.
FeaturesConfig *interface{} `mandatory:"false" json:"featuresConfig"`
// Drill-down configuration to define the destination of a drill-down action.
DrilldownConfig []interface{} `mandatory:"false" json:"drilldownConfig"`
// 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 CreateManagementDashboardDetails) String() string
func (m CreateManagementDashboardDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateManagementDashboardRequest wrapper for the CreateManagementDashboard operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/CreateManagementDashboard.go.html to see an example of how to use CreateManagementDashboardRequest.
type CreateManagementDashboardRequest struct {
// JSON metadata for creating a new dashboard.
CreateManagementDashboardDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
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 CreateManagementDashboardRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateManagementDashboardRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateManagementDashboardRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateManagementDashboardRequest) String() string
func (request CreateManagementDashboardRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateManagementDashboardResponse wrapper for the CreateManagementDashboard operation
type CreateManagementDashboardResponse struct {
// The underlying http response
RawResponse *http.Response
// The ManagementDashboard instance
ManagementDashboard `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateManagementDashboardResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateManagementDashboardResponse) String() string
CreateManagementSavedSearchDetails Properties of a saved search.
type CreateManagementSavedSearchDetails struct {
// Display name of the saved search.
DisplayName *string `mandatory:"true" json:"displayName"`
// ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID.
ProviderId *string `mandatory:"true" json:"providerId"`
// The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.
ProviderVersion *string `mandatory:"true" json:"providerVersion"`
// The user friendly name of the service (for example, Logging Analytics) that owns the saved search.
ProviderName *string `mandatory:"true" json:"providerName"`
// OCID of the compartment in which the saved search resides.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified.
IsOobSavedSearch *bool `mandatory:"true" json:"isOobSavedSearch"`
// Description of the saved search.
Description *string `mandatory:"true" json:"description"`
// JSON that contains internationalization options.
Nls *interface{} `mandatory:"true" json:"nls"`
// Determines how the saved search is displayed in a dashboard.
Type SavedSearchTypesEnum `mandatory:"true" json:"type"`
// It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.
UiConfig *interface{} `mandatory:"true" json:"uiConfig"`
// It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.
DataConfig []interface{} `mandatory:"true" json:"dataConfig"`
// Screen image of the saved search.
ScreenImage *string `mandatory:"true" json:"screenImage"`
// The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.
MetadataVersion *string `mandatory:"true" json:"metadataVersion"`
// The UI template that the saved search uses to render itself.
WidgetTemplate *string `mandatory:"true" json:"widgetTemplate"`
// The View Model that the saved search uses to render itself.
WidgetVM *string `mandatory:"true" json:"widgetVM"`
// ID of the saved search, which must only be provided for Out-of-the-Box (OOB) saved search.
Id *string `mandatory:"false" json:"id"`
// Defines parameters for the saved search.
ParametersConfig []interface{} `mandatory:"false" json:"parametersConfig"`
// Contains configuration for enabling features.
FeaturesConfig *interface{} `mandatory:"false" json:"featuresConfig"`
// Drill-down configuration to define the destination of a drill-down action.
DrilldownConfig []interface{} `mandatory:"false" json:"drilldownConfig"`
// 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 CreateManagementSavedSearchDetails) String() string
func (m CreateManagementSavedSearchDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateManagementSavedSearchRequest wrapper for the CreateManagementSavedSearch operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/CreateManagementSavedSearch.go.html to see an example of how to use CreateManagementSavedSearchRequest.
type CreateManagementSavedSearchRequest struct {
// JSON metadata for the saved search.
CreateManagementSavedSearchDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
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 CreateManagementSavedSearchRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateManagementSavedSearchRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateManagementSavedSearchRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateManagementSavedSearchRequest) String() string
func (request CreateManagementSavedSearchRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateManagementSavedSearchResponse wrapper for the CreateManagementSavedSearch operation
type CreateManagementSavedSearchResponse struct {
// The underlying http response
RawResponse *http.Response
// The ManagementSavedSearch instance
ManagementSavedSearch `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateManagementSavedSearchResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateManagementSavedSearchResponse) String() string
DashxApisClient a client for DashxApis
type DashxApisClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewDashxApisClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DashxApisClient, err error)
NewDashxApisClientWithConfigurationProvider Creates a new default DashxApis client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewDashxApisClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DashxApisClient, err error)
NewDashxApisClientWithOboToken Creates a new default DashxApis 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 DashxApisClient) ChangeManagementDashboardsCompartment(ctx context.Context, request ChangeManagementDashboardsCompartmentRequest) (response ChangeManagementDashboardsCompartmentResponse, err error)
ChangeManagementDashboardsCompartment Moves the dashboard from the existing compartment to a new compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/ChangeManagementDashboardsCompartment.go.html to see an example of how to use ChangeManagementDashboardsCompartment API.
func (client DashxApisClient) ChangeManagementSavedSearchesCompartment(ctx context.Context, request ChangeManagementSavedSearchesCompartmentRequest) (response ChangeManagementSavedSearchesCompartmentResponse, err error)
ChangeManagementSavedSearchesCompartment Moves the saved search from the existing compartment to a new compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/ChangeManagementSavedSearchesCompartment.go.html to see an example of how to use ChangeManagementSavedSearchesCompartment API.
func (client *DashxApisClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client DashxApisClient) CreateManagementDashboard(ctx context.Context, request CreateManagementDashboardRequest) (response CreateManagementDashboardResponse, err error)
CreateManagementDashboard Creates a new dashboard. Limit for number of saved searches in a dashboard is 20. Here's an example of how you can use CLI to create a dashboard. For information on the details that must be passed to CREATE, you can use the GET API to obtain the Create.json file: `oci management-dashboard dashboard get --management-dashboard-id "ocid1.managementdashboard.oc1..dashboardId1" --query data > Create.json.` You can then modify the Create.json file by removing the `id` attribute and making other required changes, and use the `oci management-dashboard dashboard create` command.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/CreateManagementDashboard.go.html to see an example of how to use CreateManagementDashboard API.
func (client DashxApisClient) CreateManagementSavedSearch(ctx context.Context, request CreateManagementSavedSearchRequest) (response CreateManagementSavedSearchResponse, err error)
CreateManagementSavedSearch Creates a new saved search. Here's an example of how you can use CLI to create a saved search. For information on the details that must be passed to CREATE, you can use the GET API to obtain the Create.json file: `oci management-dashboard saved-search get --management-saved-search-id ocid1.managementsavedsearch.oc1..savedsearchId1 --query data > Create.json`. You can then modify the Create.json file by removing the `id` attribute and making other required changes, and use the `oci management-dashboard saved-search create` command.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/CreateManagementSavedSearch.go.html to see an example of how to use CreateManagementSavedSearch API.
func (client DashxApisClient) DeleteManagementDashboard(ctx context.Context, request DeleteManagementDashboardRequest) (response DeleteManagementDashboardResponse, err error)
DeleteManagementDashboard Deletes a Dashboard by ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/DeleteManagementDashboard.go.html to see an example of how to use DeleteManagementDashboard API.
func (client DashxApisClient) DeleteManagementSavedSearch(ctx context.Context, request DeleteManagementSavedSearchRequest) (response DeleteManagementSavedSearchResponse, err error)
DeleteManagementSavedSearch Deletes a saved search by ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/DeleteManagementSavedSearch.go.html to see an example of how to use DeleteManagementSavedSearch API.
func (client DashxApisClient) ExportDashboard(ctx context.Context, request ExportDashboardRequest) (response ExportDashboardResponse, err error)
ExportDashboard Exports an array of dashboards and their saved searches. Export is designed to work with importDashboard. Here's an example of how you can use CLI to export a dashboard: `$oci management-dashboard dashboard export --query data --export-dashboard-id "{\"dashboardIds\":[\"ocid1.managementdashboard.oc1..dashboardId1\"]}" > dashboards.json`
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/ExportDashboard.go.html to see an example of how to use ExportDashboard API.
func (client DashxApisClient) GetManagementDashboard(ctx context.Context, request GetManagementDashboardRequest) (response GetManagementDashboardResponse, err error)
GetManagementDashboard Gets a dashboard and its saved searches by ID. Deleted or unauthorized saved searches are marked by tile's state property.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/GetManagementDashboard.go.html to see an example of how to use GetManagementDashboard API.
func (client DashxApisClient) GetManagementSavedSearch(ctx context.Context, request GetManagementSavedSearchRequest) (response GetManagementSavedSearchResponse, err error)
GetManagementSavedSearch Gets a saved search by ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/GetManagementSavedSearch.go.html to see an example of how to use GetManagementSavedSearch API.
func (client DashxApisClient) ImportDashboard(ctx context.Context, request ImportDashboardRequest) (response ImportDashboardResponse, err error)
ImportDashboard Imports an array of dashboards and their saved searches. Here's an example of how you can use CLI to import a dashboard. For information on the details that must be passed to IMPORT, you can use the EXPORT API to obtain the Import.json file: `oci management-dashboard dashboard export --query data --export-dashboard-id "{\"dashboardIds\":[\"ocid1.managementdashboard.oc1..dashboardId1\"]}" > Import.json`. Note that import API updates the resource if it already exists, and creates a new resource if it does not exist. To import to a different compartment, edit and change the compartmentId to the desired compartment OCID. Here's an example of how you can use CLI to import: `oci management-dashboard dashboard import --from-json file://Import.json`
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/ImportDashboard.go.html to see an example of how to use ImportDashboard API.
func (client DashxApisClient) ListManagementDashboards(ctx context.Context, request ListManagementDashboardsRequest) (response ListManagementDashboardsResponse, err error)
ListManagementDashboards Gets the list of dashboards in a compartment with pagination. Returned properties are the summary.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/ListManagementDashboards.go.html to see an example of how to use ListManagementDashboards API.
func (client DashxApisClient) ListManagementSavedSearches(ctx context.Context, request ListManagementSavedSearchesRequest) (response ListManagementSavedSearchesResponse, err error)
ListManagementSavedSearches Gets the list of saved searches in a compartment with pagination. Returned properties are the summary.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/ListManagementSavedSearches.go.html to see an example of how to use ListManagementSavedSearches API.
func (client *DashxApisClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client DashxApisClient) UpdateManagementDashboard(ctx context.Context, request UpdateManagementDashboardRequest) (response UpdateManagementDashboardResponse, err error)
UpdateManagementDashboard Updates an existing dashboard identified by ID path parameter. CompartmentId can be modified only by the changeCompartment API. Limit for number of saved searches in a dashboard is 20.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/UpdateManagementDashboard.go.html to see an example of how to use UpdateManagementDashboard API.
func (client DashxApisClient) UpdateManagementSavedSearch(ctx context.Context, request UpdateManagementSavedSearchRequest) (response UpdateManagementSavedSearchResponse, err error)
UpdateManagementSavedSearch Updates an existing saved search identified by ID path parameter. CompartmentId can be modified only by the changeCompartment API.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/UpdateManagementSavedSearch.go.html to see an example of how to use UpdateManagementSavedSearch API.
DeleteManagementDashboardRequest wrapper for the DeleteManagementDashboard operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/DeleteManagementDashboard.go.html to see an example of how to use DeleteManagementDashboardRequest.
type DeleteManagementDashboardRequest struct {
// A unique dashboard identifier.
ManagementDashboardId *string `mandatory:"true" contributesTo:"path" name:"managementDashboardId"`
// 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"`
// The client request ID for tracing.
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 DeleteManagementDashboardRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteManagementDashboardRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteManagementDashboardRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteManagementDashboardRequest) String() string
func (request DeleteManagementDashboardRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteManagementDashboardResponse wrapper for the DeleteManagementDashboard operation
type DeleteManagementDashboardResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteManagementDashboardResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteManagementDashboardResponse) String() string
DeleteManagementSavedSearchRequest wrapper for the DeleteManagementSavedSearch operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/DeleteManagementSavedSearch.go.html to see an example of how to use DeleteManagementSavedSearchRequest.
type DeleteManagementSavedSearchRequest struct {
// A unique saved search identifier.
ManagementSavedSearchId *string `mandatory:"true" contributesTo:"path" name:"managementSavedSearchId"`
// 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"`
// The client request ID for tracing.
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 DeleteManagementSavedSearchRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteManagementSavedSearchRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteManagementSavedSearchRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteManagementSavedSearchRequest) String() string
func (request DeleteManagementSavedSearchRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteManagementSavedSearchResponse wrapper for the DeleteManagementSavedSearch operation
type DeleteManagementSavedSearchResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteManagementSavedSearchResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteManagementSavedSearchResponse) String() string
ExportDashboardRequest wrapper for the ExportDashboard operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/ExportDashboard.go.html to see an example of how to use ExportDashboardRequest.
type ExportDashboardRequest struct {
// List of dashboardIds in plain text. The syntax is '{"dashboardIds":["dashboardId1", "dashboardId2", ...]}'. Escaping is needed when using in OCI CLI. For example, "{\"dashboardIds\":[\"ocid1.managementdashboard.oc1..dashboardId1\"]}" .
ExportDashboardId *string `mandatory:"true" contributesTo:"path" name:"exportDashboardId"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
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 ExportDashboardRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ExportDashboardRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ExportDashboardRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ExportDashboardRequest) String() string
func (request ExportDashboardRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ExportDashboardResponse wrapper for the ExportDashboard operation
type ExportDashboardResponse struct {
// The underlying http response
RawResponse *http.Response
// The ManagementDashboardExportDetails instance
ManagementDashboardExportDetails `presentIn:"body"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ExportDashboardResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ExportDashboardResponse) String() string
GetManagementDashboardRequest wrapper for the GetManagementDashboard operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/GetManagementDashboard.go.html to see an example of how to use GetManagementDashboardRequest.
type GetManagementDashboardRequest struct {
// A unique dashboard identifier.
ManagementDashboardId *string `mandatory:"true" contributesTo:"path" name:"managementDashboardId"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
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 GetManagementDashboardRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetManagementDashboardRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetManagementDashboardRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetManagementDashboardRequest) String() string
func (request GetManagementDashboardRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetManagementDashboardResponse wrapper for the GetManagementDashboard operation
type GetManagementDashboardResponse struct {
// The underlying http response
RawResponse *http.Response
// The ManagementDashboard instance
ManagementDashboard `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetManagementDashboardResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetManagementDashboardResponse) String() string
GetManagementSavedSearchRequest wrapper for the GetManagementSavedSearch operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/GetManagementSavedSearch.go.html to see an example of how to use GetManagementSavedSearchRequest.
type GetManagementSavedSearchRequest struct {
// A unique saved search identifier.
ManagementSavedSearchId *string `mandatory:"true" contributesTo:"path" name:"managementSavedSearchId"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
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 GetManagementSavedSearchRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetManagementSavedSearchRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetManagementSavedSearchRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetManagementSavedSearchRequest) String() string
func (request GetManagementSavedSearchRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetManagementSavedSearchResponse wrapper for the GetManagementSavedSearch operation
type GetManagementSavedSearchResponse struct {
// The underlying http response
RawResponse *http.Response
// The ManagementSavedSearch instance
ManagementSavedSearch `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetManagementSavedSearchResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetManagementSavedSearchResponse) String() string
ImportDashboardRequest wrapper for the ImportDashboard operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/ImportDashboard.go.html to see an example of how to use ImportDashboardRequest.
type ImportDashboardRequest struct {
// JSON metadata for importing dashboards and their saved searches.
ManagementDashboardImportDetails `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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
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 ImportDashboardRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ImportDashboardRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ImportDashboardRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ImportDashboardRequest) String() string
func (request ImportDashboardRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ImportDashboardResponse wrapper for the ImportDashboard operation
type ImportDashboardResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ImportDashboardResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ImportDashboardResponse) String() string
LifecycleStatesEnum Enum with underlying type: string
type LifecycleStatesEnum string
Set of constants representing the allowable values for LifecycleStatesEnum
const (
LifecycleStatesActive LifecycleStatesEnum = "ACTIVE"
)
func GetLifecycleStatesEnumValues() []LifecycleStatesEnum
GetLifecycleStatesEnumValues Enumerates the set of values for LifecycleStatesEnum
func GetMappingLifecycleStatesEnum(val string) (LifecycleStatesEnum, bool)
GetMappingLifecycleStatesEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementDashboardsRequest wrapper for the ListManagementDashboards operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/ListManagementDashboards.go.html to see an example of how to use ListManagementDashboardsRequest.
type ListManagementDashboardsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page on which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListManagementDashboardsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is the default.
SortBy ListManagementDashboardsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListManagementDashboardsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListManagementDashboardsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListManagementDashboardsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListManagementDashboardsRequest) String() string
func (request ListManagementDashboardsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListManagementDashboardsResponse wrapper for the ListManagementDashboards operation
type ListManagementDashboardsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ManagementDashboardCollection instances
ManagementDashboardCollection `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 ListManagementDashboardsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListManagementDashboardsResponse) String() string
ListManagementDashboardsSortByEnum Enum with underlying type: string
type ListManagementDashboardsSortByEnum string
Set of constants representing the allowable values for ListManagementDashboardsSortByEnum
const (
ListManagementDashboardsSortByTimecreated ListManagementDashboardsSortByEnum = "timeCreated"
ListManagementDashboardsSortByDisplayname ListManagementDashboardsSortByEnum = "displayName"
)
func GetListManagementDashboardsSortByEnumValues() []ListManagementDashboardsSortByEnum
GetListManagementDashboardsSortByEnumValues Enumerates the set of values for ListManagementDashboardsSortByEnum
func GetMappingListManagementDashboardsSortByEnum(val string) (ListManagementDashboardsSortByEnum, bool)
GetMappingListManagementDashboardsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementDashboardsSortOrderEnum Enum with underlying type: string
type ListManagementDashboardsSortOrderEnum string
Set of constants representing the allowable values for ListManagementDashboardsSortOrderEnum
const (
ListManagementDashboardsSortOrderAsc ListManagementDashboardsSortOrderEnum = "ASC"
ListManagementDashboardsSortOrderDesc ListManagementDashboardsSortOrderEnum = "DESC"
)
func GetListManagementDashboardsSortOrderEnumValues() []ListManagementDashboardsSortOrderEnum
GetListManagementDashboardsSortOrderEnumValues Enumerates the set of values for ListManagementDashboardsSortOrderEnum
func GetMappingListManagementDashboardsSortOrderEnum(val string) (ListManagementDashboardsSortOrderEnum, bool)
GetMappingListManagementDashboardsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementSavedSearchesRequest wrapper for the ListManagementSavedSearches operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/ListManagementSavedSearches.go.html to see an example of how to use ListManagementSavedSearchesRequest.
type ListManagementSavedSearchesRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page on which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListManagementSavedSearchesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is the default.
SortBy ListManagementSavedSearchesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListManagementSavedSearchesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListManagementSavedSearchesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListManagementSavedSearchesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListManagementSavedSearchesRequest) String() string
func (request ListManagementSavedSearchesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListManagementSavedSearchesResponse wrapper for the ListManagementSavedSearches operation
type ListManagementSavedSearchesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ManagementSavedSearchCollection instances
ManagementSavedSearchCollection `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 ListManagementSavedSearchesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListManagementSavedSearchesResponse) String() string
ListManagementSavedSearchesSortByEnum Enum with underlying type: string
type ListManagementSavedSearchesSortByEnum string
Set of constants representing the allowable values for ListManagementSavedSearchesSortByEnum
const (
ListManagementSavedSearchesSortByTimecreated ListManagementSavedSearchesSortByEnum = "timeCreated"
ListManagementSavedSearchesSortByDisplayname ListManagementSavedSearchesSortByEnum = "displayName"
)
func GetListManagementSavedSearchesSortByEnumValues() []ListManagementSavedSearchesSortByEnum
GetListManagementSavedSearchesSortByEnumValues Enumerates the set of values for ListManagementSavedSearchesSortByEnum
func GetMappingListManagementSavedSearchesSortByEnum(val string) (ListManagementSavedSearchesSortByEnum, bool)
GetMappingListManagementSavedSearchesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementSavedSearchesSortOrderEnum Enum with underlying type: string
type ListManagementSavedSearchesSortOrderEnum string
Set of constants representing the allowable values for ListManagementSavedSearchesSortOrderEnum
const (
ListManagementSavedSearchesSortOrderAsc ListManagementSavedSearchesSortOrderEnum = "ASC"
ListManagementSavedSearchesSortOrderDesc ListManagementSavedSearchesSortOrderEnum = "DESC"
)
func GetListManagementSavedSearchesSortOrderEnumValues() []ListManagementSavedSearchesSortOrderEnum
GetListManagementSavedSearchesSortOrderEnumValues Enumerates the set of values for ListManagementSavedSearchesSortOrderEnum
func GetMappingListManagementSavedSearchesSortOrderEnum(val string) (ListManagementSavedSearchesSortOrderEnum, bool)
GetMappingListManagementSavedSearchesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ManagementDashboard Properties of a dashboard, including dashboard ID.
type ManagementDashboard struct {
// ID of the dashboard. Same as id.
DashboardId *string `mandatory:"true" json:"dashboardId"`
// ID of the dashboard. Same as dashboardId.
Id *string `mandatory:"true" json:"id"`
// ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID.
ProviderId *string `mandatory:"true" json:"providerId"`
// Name of the service (for example, Logging Analytics) that owns the dashboard.
ProviderName *string `mandatory:"true" json:"providerName"`
// Version of the service that owns the dashboard.
ProviderVersion *string `mandatory:"true" json:"providerVersion"`
// Array of dashboard tiles.
Tiles []ManagementDashboardTileDetails `mandatory:"true" json:"tiles"`
// Display name of the dashboard.
DisplayName *string `mandatory:"true" json:"displayName"`
// Description of the dashboard.
Description *string `mandatory:"true" json:"description"`
// OCID of the compartment in which the dashboard resides.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified.
IsOobDashboard *bool `mandatory:"true" json:"isOobDashboard"`
// Determines whether the dashboard will be displayed in Dashboard Home.
IsShowInHome *bool `mandatory:"true" json:"isShowInHome"`
// User who created the dashboard.
CreatedBy *string `mandatory:"true" json:"createdBy"`
// Date and time the dashboard was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// User who updated the dashboard.
UpdatedBy *string `mandatory:"true" json:"updatedBy"`
// Date and time the dashboard was updated.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.
MetadataVersion *string `mandatory:"true" json:"metadataVersion"`
// Determines whether the description of the dashboard is displayed.
IsShowDescription *bool `mandatory:"true" json:"isShowDescription"`
// Screen image of the dashboard.
ScreenImage *string `mandatory:"true" json:"screenImage"`
// JSON that contains internationalization options.
Nls *interface{} `mandatory:"true" json:"nls"`
// JSON that contains user interface options.
UiConfig *interface{} `mandatory:"true" json:"uiConfig"`
// Array of JSON that contain data source options.
DataConfig []interface{} `mandatory:"true" json:"dataConfig"`
// Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.
Type *string `mandatory:"true" json:"type"`
// Determines whether the dashboard is set as favorite.
IsFavorite *bool `mandatory:"true" json:"isFavorite"`
// Array of saved searches in the dashboard.
SavedSearches []ManagementSavedSearch `mandatory:"true" json:"savedSearches"`
// State of dashboard.
LifecycleState LifecycleStatesEnum `mandatory:"true" json:"lifecycleState"`
// Defines parameters for the dashboard.
ParametersConfig []interface{} `mandatory:"false" json:"parametersConfig"`
// Drill-down configuration to define the destination of a drill-down action.
DrilldownConfig []interface{} `mandatory:"false" json:"drilldownConfig"`
// Contains configuration for enabling features.
FeaturesConfig *interface{} `mandatory:"false" json:"featuresConfig"`
// 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 ManagementDashboard) String() string
func (m ManagementDashboard) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ManagementDashboardCollection List of dashboards.
type ManagementDashboardCollection struct {
// Array of dashboard summaries.
Items []ManagementDashboardSummary `mandatory:"true" json:"items"`
}
func (m ManagementDashboardCollection) String() string
func (m ManagementDashboardCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ManagementDashboardExportDetails Array of dashboards to export. Response from export must be directly acceptable to import (compartmentIds may have to be changed).
type ManagementDashboardExportDetails struct {
// Array of dashboards.
Dashboards []ManagementDashboardForImportExportDetails `mandatory:"true" json:"dashboards"`
}
func (m ManagementDashboardExportDetails) String() string
func (m ManagementDashboardExportDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ManagementDashboardForImportExportDetails Properties of a dashboard, including dashboard ID and saved searches, for import purposes.
type ManagementDashboardForImportExportDetails struct {
// ID of the dashboard.
DashboardId *string `mandatory:"true" json:"dashboardId"`
// ID of the service (for example log-analytics) that owns the dashboard. Each service has a unique ID.
ProviderId *string `mandatory:"true" json:"providerId"`
// The user friendly name of the service (for example, Logging Analytics) that owns the dashboard.
ProviderName *string `mandatory:"true" json:"providerName"`
// The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.
ProviderVersion *string `mandatory:"true" json:"providerVersion"`
// Array of dashboard tiles.
Tiles []ManagementDashboardTileDetails `mandatory:"true" json:"tiles"`
// Display name of the dashboard.
DisplayName *string `mandatory:"true" json:"displayName"`
// Description of the dashboard.
Description *string `mandatory:"true" json:"description"`
// OCID of the compartment in which the dashboard resides.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified.
IsOobDashboard *bool `mandatory:"true" json:"isOobDashboard"`
// Determines whether the dashboard will be displayed in Dashboard Home.
IsShowInHome *bool `mandatory:"true" json:"isShowInHome"`
// The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.
MetadataVersion *string `mandatory:"true" json:"metadataVersion"`
// Determines whether the description of the dashboard is displayed.
IsShowDescription *bool `mandatory:"true" json:"isShowDescription"`
// Screen image of the dashboard.
ScreenImage *string `mandatory:"true" json:"screenImage"`
// JSON that contains internationalization options.
Nls *interface{} `mandatory:"true" json:"nls"`
// It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.
UiConfig *interface{} `mandatory:"true" json:"uiConfig"`
// It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.
DataConfig []interface{} `mandatory:"true" json:"dataConfig"`
// Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.
Type *string `mandatory:"true" json:"type"`
// Determines whether the dashboard is set as favorite.
IsFavorite *bool `mandatory:"true" json:"isFavorite"`
// Array of saved searches in the dashboard.
SavedSearches []ManagementSavedSearchForImportDetails `mandatory:"true" json:"savedSearches"`
// Defines parameters for the dashboard.
ParametersConfig []interface{} `mandatory:"false" json:"parametersConfig"`
// Contains configuration for enabling features.
FeaturesConfig *interface{} `mandatory:"false" json:"featuresConfig"`
// Drill-down configuration to define the destination of a drill-down action.
DrilldownConfig []interface{} `mandatory:"false" json:"drilldownConfig"`
// 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 ManagementDashboardForImportExportDetails) String() string
func (m ManagementDashboardForImportExportDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ManagementDashboardImportDetails Array of dashboards to import.
type ManagementDashboardImportDetails struct {
// Array of dashboards.
Dashboards []ManagementDashboardForImportExportDetails `mandatory:"true" json:"dashboards"`
// 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 ManagementDashboardImportDetails) String() string
func (m ManagementDashboardImportDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ManagementDashboardSummary Summary of the properties of a dashboard.
type ManagementDashboardSummary struct {
// ID of the dashboard. Same as id.
DashboardId *string `mandatory:"true" json:"dashboardId"`
// ID of the dashboard. Same as dashboardId.
Id *string `mandatory:"true" json:"id"`
// Display name of the dashboard.
DisplayName *string `mandatory:"true" json:"displayName"`
// Description of the dashboard.
Description *string `mandatory:"true" json:"description"`
// OCID of the compartment in which the dashboard resides.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID.
ProviderId *string `mandatory:"true" json:"providerId"`
// The user friendly name of the service (for example, Logging Analytics) that owns the dashboard.
ProviderName *string `mandatory:"true" json:"providerName"`
// The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.
ProviderVersion *string `mandatory:"true" json:"providerVersion"`
// Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified.
IsOobDashboard *bool `mandatory:"true" json:"isOobDashboard"`
// User who created the dashboard.
CreatedBy *string `mandatory:"true" json:"createdBy"`
// Date and time the dashboard was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// User who updated the dashboard.
UpdatedBy *string `mandatory:"true" json:"updatedBy"`
// Date and time the dashboard was updated.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.
MetadataVersion *string `mandatory:"true" json:"metadataVersion"`
// Screen image of the dashboard.
ScreenImage *string `mandatory:"true" json:"screenImage"`
// JSON that contains internationalization options.
Nls *interface{} `mandatory:"true" json:"nls"`
// Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.
Type *string `mandatory:"true" json:"type"`
// Current lifecycle state of the dashboard.
LifecycleState LifecycleStatesEnum `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"`
// Contains configuration for enabling features.
FeaturesConfig *interface{} `mandatory:"false" json:"featuresConfig"`
}
func (m ManagementDashboardSummary) String() string
func (m ManagementDashboardSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ManagementDashboardTileDetails Properties of the dashboard tile representing a saved search. Tiles are laid out in a twelve column grid system with (0,0) at upper left corner.
type ManagementDashboardTileDetails struct {
// Display name of the saved search.
DisplayName *string `mandatory:"true" json:"displayName"`
// ID of the saved search.
SavedSearchId *string `mandatory:"true" json:"savedSearchId"`
// Tile's row number.
Row *int `mandatory:"true" json:"row"`
// Tile's column number.
Column *int `mandatory:"true" json:"column"`
// The number of rows the tile occupies.
Height *int `mandatory:"true" json:"height"`
// The number of columns the tile occupies.
Width *int `mandatory:"true" json:"width"`
// JSON that contains internationalization options.
Nls *interface{} `mandatory:"true" json:"nls"`
// It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.
UiConfig *interface{} `mandatory:"true" json:"uiConfig"`
// It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.
DataConfig []interface{} `mandatory:"true" json:"dataConfig"`
// Current state of the saved search.
State ManagementDashboardTileDetailsStateEnum `mandatory:"true" json:"state"`
// Drill-down configuration to define the destination of a drill-down action.
DrilldownConfig *interface{} `mandatory:"true" json:"drilldownConfig"`
// Specifies the saved search parameters values
ParametersMap *interface{} `mandatory:"false" json:"parametersMap"`
}
func (m ManagementDashboardTileDetails) String() string
func (m ManagementDashboardTileDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ManagementDashboardTileDetailsStateEnum Enum with underlying type: string
type ManagementDashboardTileDetailsStateEnum string
Set of constants representing the allowable values for ManagementDashboardTileDetailsStateEnum
const (
ManagementDashboardTileDetailsStateDeleted ManagementDashboardTileDetailsStateEnum = "DELETED"
ManagementDashboardTileDetailsStateEnum = "UNAUTHORIZED"
ManagementDashboardTileDetailsStateDefault ManagementDashboardTileDetailsStateEnum = "DEFAULT"
)
func GetManagementDashboardTileDetailsStateEnumValues() []ManagementDashboardTileDetailsStateEnum
GetManagementDashboardTileDetailsStateEnumValues Enumerates the set of values for ManagementDashboardTileDetailsStateEnum
func GetMappingManagementDashboardTileDetailsStateEnum(val string) (ManagementDashboardTileDetailsStateEnum, bool)
GetMappingManagementDashboardTileDetailsStateEnum performs case Insensitive comparison on enum value and return the desired enum
ManagementSavedSearch Properties of a saved search.
type ManagementSavedSearch struct {
// ID of the saved search.
Id *string `mandatory:"true" json:"id"`
// Display name of the saved search.
DisplayName *string `mandatory:"true" json:"displayName"`
// ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID.
ProviderId *string `mandatory:"true" json:"providerId"`
// Version of the service that owns this saved search.
ProviderVersion *string `mandatory:"true" json:"providerVersion"`
// Name of the service (for example, Logging Analytics) that owns the saved search.
ProviderName *string `mandatory:"true" json:"providerName"`
// OCID of the compartment in which the saved search resides.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified.
IsOobSavedSearch *bool `mandatory:"true" json:"isOobSavedSearch"`
// Description of the saved search.
Description *string `mandatory:"true" json:"description"`
// JSON that contains internationalization options.
Nls *interface{} `mandatory:"true" json:"nls"`
// Determines how the saved search is displayed in a dashboard.
Type SavedSearchTypesEnum `mandatory:"true" json:"type"`
// It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.
UiConfig *interface{} `mandatory:"true" json:"uiConfig"`
// It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.
DataConfig []interface{} `mandatory:"true" json:"dataConfig"`
// The principle id of the user that created this saved search. This is automatically managed by the system. In OCI the value is ignored. In EM it can skipped or otherwise it is ignored in both create and update API and system automatically sets its value.
CreatedBy *string `mandatory:"true" json:"createdBy"`
// The principle id of the user that updated this saved search.
UpdatedBy *string `mandatory:"true" json:"updatedBy"`
// Date and time the saved search was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Date and time the saved search was updated.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Screen image of the saved search.
ScreenImage *string `mandatory:"true" json:"screenImage"`
// The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.
MetadataVersion *string `mandatory:"true" json:"metadataVersion"`
// The UI template that the saved search uses to render itself.
WidgetTemplate *string `mandatory:"true" json:"widgetTemplate"`
// The View Model that the saved search uses to render itself.
WidgetVM *string `mandatory:"true" json:"widgetVM"`
// OCI lifecycle status. This is automatically managed by the system.
LifecycleState LifecycleStatesEnum `mandatory:"true" json:"lifecycleState"`
// Defines parameters for the saved search.
ParametersConfig []interface{} `mandatory:"false" json:"parametersConfig"`
// Contains configuration for enabling features.
FeaturesConfig *interface{} `mandatory:"false" json:"featuresConfig"`
// Drill-down configuration to define the destination of a drill-down action.
DrilldownConfig []interface{} `mandatory:"false" json:"drilldownConfig"`
// 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 ManagementSavedSearch) String() string
func (m ManagementSavedSearch) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ManagementSavedSearchCollection List of saved searches.
type ManagementSavedSearchCollection struct {
// Array of saved search summaries.
Items []ManagementSavedSearchSummary `mandatory:"true" json:"items"`
}
func (m ManagementSavedSearchCollection) String() string
func (m ManagementSavedSearchCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ManagementSavedSearchForImportDetails Properties of a saved search.
type ManagementSavedSearchForImportDetails struct {
// ID of the saved search.
Id *string `mandatory:"true" json:"id"`
// Display name of the saved search.
DisplayName *string `mandatory:"true" json:"displayName"`
// ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID.
ProviderId *string `mandatory:"true" json:"providerId"`
// The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.
ProviderVersion *string `mandatory:"true" json:"providerVersion"`
// The user friendly name of the service (for example, Logging Analytics) that owns the saved search.
ProviderName *string `mandatory:"true" json:"providerName"`
// OCID of the compartment in which the saved search resides.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified.
IsOobSavedSearch *bool `mandatory:"true" json:"isOobSavedSearch"`
// Description of the saved search.
Description *string `mandatory:"true" json:"description"`
// JSON that contains internationalization options.
Nls *interface{} `mandatory:"true" json:"nls"`
// Determines how the saved search is displayed in a dashboard.
Type SavedSearchTypesEnum `mandatory:"true" json:"type"`
// It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.
UiConfig *interface{} `mandatory:"true" json:"uiConfig"`
// It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.
DataConfig []interface{} `mandatory:"true" json:"dataConfig"`
// Screen image of the saved search.
ScreenImage *string `mandatory:"true" json:"screenImage"`
// The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.
MetadataVersion *string `mandatory:"true" json:"metadataVersion"`
// The UI template that the saved search uses to render itself.
WidgetTemplate *string `mandatory:"true" json:"widgetTemplate"`
// The View Model that the saved search uses to render itself.
WidgetVM *string `mandatory:"true" json:"widgetVM"`
// 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"`
// Defines parameters for the saved search.
ParametersConfig []interface{} `mandatory:"false" json:"parametersConfig"`
// Contains configuration for enabling features.
FeaturesConfig *interface{} `mandatory:"false" json:"featuresConfig"`
// Drill-down configuration to define the destination of a drill-down action.
DrilldownConfig []interface{} `mandatory:"false" json:"drilldownConfig"`
}
func (m ManagementSavedSearchForImportDetails) String() string
func (m ManagementSavedSearchForImportDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ManagementSavedSearchSummary Summary of the properties of a saved search.
type ManagementSavedSearchSummary struct {
// ID of the saved search.
Id *string `mandatory:"true" json:"id"`
// Display name of the saved search.
DisplayName *string `mandatory:"true" json:"displayName"`
// Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified.
IsOobSavedSearch *bool `mandatory:"true" json:"isOobSavedSearch"`
// OCID of the compartment in which the saved search resides.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID.
ProviderId *string `mandatory:"true" json:"providerId"`
// The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.
ProviderVersion *string `mandatory:"true" json:"providerVersion"`
// The user friendly name of the service (for example, Logging Analytics) that owns the saved search.
ProviderName *string `mandatory:"true" json:"providerName"`
// Description of the saved search.
Description *string `mandatory:"true" json:"description"`
// JSON that contains internationalization options.
Nls *interface{} `mandatory:"true" json:"nls"`
// Determines how the saved search is displayed in a dashboard.
Type SavedSearchTypesEnum `mandatory:"true" json:"type"`
// It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.
UiConfig *interface{} `mandatory:"true" json:"uiConfig"`
// It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.
DataConfig []interface{} `mandatory:"true" json:"dataConfig"`
// The principle id of the user that created this saved search. This is automatically managed by the system. In OCI the value is ignored. In EM it can skipped or otherwise it is ignored in both create and update API and system automatically sets its value.
CreatedBy *string `mandatory:"true" json:"createdBy"`
// The principle id of the user that updated this saved search
UpdatedBy *string `mandatory:"true" json:"updatedBy"`
// Date and time the saved search was created.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Date and time the saved search was updated.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Screen image of the saved search.
ScreenImage *string `mandatory:"true" json:"screenImage"`
// The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.
MetadataVersion *string `mandatory:"true" json:"metadataVersion"`
// The UI template that the saved search uses to render itself.
WidgetTemplate *string `mandatory:"true" json:"widgetTemplate"`
// The View Model that the saved search uses to render itself.
WidgetVM *string `mandatory:"true" json:"widgetVM"`
// OCI lifecycle status. This is automatically managed by the system.
LifecycleState LifecycleStatesEnum `mandatory:"true" json:"lifecycleState"`
// Defines parameters for the saved search.
ParametersConfig []interface{} `mandatory:"false" json:"parametersConfig"`
// Contains configuration for enabling features.
FeaturesConfig *interface{} `mandatory:"false" json:"featuresConfig"`
// 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 ManagementSavedSearchSummary) String() string
func (m ManagementSavedSearchSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SavedSearchTypesEnum Enum with underlying type: string
type SavedSearchTypesEnum string
Set of constants representing the allowable values for SavedSearchTypesEnum
const (
SavedSearchTypesSearchShowInDashboard SavedSearchTypesEnum = "SEARCH_SHOW_IN_DASHBOARD"
SavedSearchTypesSearchDontShowInDashboard SavedSearchTypesEnum = "SEARCH_DONT_SHOW_IN_DASHBOARD"
SavedSearchTypesWidgetShowInDashboard SavedSearchTypesEnum = "WIDGET_SHOW_IN_DASHBOARD"
SavedSearchTypesWidgetDontShowInDashboard SavedSearchTypesEnum = "WIDGET_DONT_SHOW_IN_DASHBOARD"
SavedSearchTypesFilterShowInDashboard SavedSearchTypesEnum = "FILTER_SHOW_IN_DASHBOARD"
SavedSearchTypesFilterDontShowInDashboard SavedSearchTypesEnum = "FILTER_DONT_SHOW_IN_DASHBOARD"
)
func GetMappingSavedSearchTypesEnum(val string) (SavedSearchTypesEnum, bool)
GetMappingSavedSearchTypesEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSavedSearchTypesEnumValues() []SavedSearchTypesEnum
GetSavedSearchTypesEnumValues Enumerates the set of values for SavedSearchTypesEnum
SortOrdersEnum Enum with underlying type: string
type SortOrdersEnum string
Set of constants representing the allowable values for SortOrdersEnum
const (
SortOrdersAsc SortOrdersEnum = "ASC"
SortOrdersDesc SortOrdersEnum = "DESC"
)
func GetMappingSortOrdersEnum(val string) (SortOrdersEnum, bool)
GetMappingSortOrdersEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrdersEnumValues() []SortOrdersEnum
GetSortOrdersEnumValues Enumerates the set of values for SortOrdersEnum
UpdateManagementDashboardDetails Properties of a dashboard. Dashboard ID must not be provided.
type UpdateManagementDashboardDetails struct {
// ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID.
ProviderId *string `mandatory:"false" json:"providerId"`
// The user friendly name of the service (for example, Logging Analytics) that owns the dashboard.
ProviderName *string `mandatory:"false" json:"providerName"`
// The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.
ProviderVersion *string `mandatory:"false" json:"providerVersion"`
// Array of dashboard tiles.
Tiles []ManagementDashboardTileDetails `mandatory:"false" json:"tiles"`
// Display name of the dashboard.
DisplayName *string `mandatory:"false" json:"displayName"`
// Description of the dashboard.
Description *string `mandatory:"false" json:"description"`
// OCID of the compartment in which the dashboard resides.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified.
IsOobDashboard *bool `mandatory:"false" json:"isOobDashboard"`
// Determines whether the dashboard will be displayed in Dashboard Home.
IsShowInHome *bool `mandatory:"false" json:"isShowInHome"`
// The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.
MetadataVersion *string `mandatory:"false" json:"metadataVersion"`
// Determines whether the description of the dashboard is displayed.
IsShowDescription *bool `mandatory:"false" json:"isShowDescription"`
// Screen image of the dashboard.
ScreenImage *string `mandatory:"false" json:"screenImage"`
// JSON that contains internationalization options.
Nls *interface{} `mandatory:"false" json:"nls"`
// JSON that contains user interface options.
UiConfig *interface{} `mandatory:"false" json:"uiConfig"`
// Array of JSON that contain data source options.
DataConfig []interface{} `mandatory:"false" json:"dataConfig"`
// Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.
Type *string `mandatory:"false" json:"type"`
// Determines whether the dashboard is set as favorite.
IsFavorite *bool `mandatory:"false" json:"isFavorite"`
// Defines parameters for the dashboard.
ParametersConfig []interface{} `mandatory:"false" json:"parametersConfig"`
// Contains configuration for enabling features.
FeaturesConfig *interface{} `mandatory:"false" json:"featuresConfig"`
// Drill-down configuration to define the destination of a drill-down action.
DrilldownConfig []interface{} `mandatory:"false" json:"drilldownConfig"`
// 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 UpdateManagementDashboardDetails) String() string
func (m UpdateManagementDashboardDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateManagementDashboardRequest wrapper for the UpdateManagementDashboard operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/UpdateManagementDashboard.go.html to see an example of how to use UpdateManagementDashboardRequest.
type UpdateManagementDashboardRequest struct {
// A unique dashboard identifier.
ManagementDashboardId *string `mandatory:"true" contributesTo:"path" name:"managementDashboardId"`
// JSON metadata for changed dashboard properties.
UpdateManagementDashboardDetails `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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
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 UpdateManagementDashboardRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateManagementDashboardRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateManagementDashboardRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateManagementDashboardRequest) String() string
func (request UpdateManagementDashboardRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateManagementDashboardResponse wrapper for the UpdateManagementDashboard operation
type UpdateManagementDashboardResponse struct {
// The underlying http response
RawResponse *http.Response
// The ManagementDashboard instance
ManagementDashboard `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateManagementDashboardResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateManagementDashboardResponse) String() string
UpdateManagementSavedSearchDetails Properties of a saved search. Saved search ID must not be provided.
type UpdateManagementSavedSearchDetails struct {
// Display name of the saved search.
DisplayName *string `mandatory:"false" json:"displayName"`
// ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID.
ProviderId *string `mandatory:"false" json:"providerId"`
// The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.
ProviderVersion *string `mandatory:"false" json:"providerVersion"`
// The user friendly name of the service (for example, Logging Analytics) that owns the saved search.
ProviderName *string `mandatory:"false" json:"providerName"`
// OCID of the compartment in which the saved search resides.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified.
IsOobSavedSearch *bool `mandatory:"false" json:"isOobSavedSearch"`
// Description of the saved search.
Description *string `mandatory:"false" json:"description"`
// JSON that contains internationalization options.
Nls *interface{} `mandatory:"false" json:"nls"`
// Determines how the saved search is displayed in a dashboard.
Type SavedSearchTypesEnum `mandatory:"false" json:"type,omitempty"`
// It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.
UiConfig *interface{} `mandatory:"false" json:"uiConfig"`
// It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.
DataConfig []interface{} `mandatory:"false" json:"dataConfig"`
// Screen image of the saved search.
ScreenImage *string `mandatory:"false" json:"screenImage"`
// The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.
MetadataVersion *string `mandatory:"false" json:"metadataVersion"`
// The UI template that the saved search uses to render itself.
WidgetTemplate *string `mandatory:"false" json:"widgetTemplate"`
// The View Model that the saved search uses to render itself.
WidgetVM *string `mandatory:"false" json:"widgetVM"`
// Defines parameters for the saved search.
ParametersConfig []interface{} `mandatory:"false" json:"parametersConfig"`
// Contains configuration for enabling features.
FeaturesConfig *interface{} `mandatory:"false" json:"featuresConfig"`
// Drill-down configuration to define the destination of a drill-down action.
DrilldownConfig []interface{} `mandatory:"false" json:"drilldownConfig"`
// 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 UpdateManagementSavedSearchDetails) String() string
func (m UpdateManagementSavedSearchDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateManagementSavedSearchRequest wrapper for the UpdateManagementSavedSearch operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.64.0/managementdashboard/UpdateManagementSavedSearch.go.html to see an example of how to use UpdateManagementSavedSearchRequest.
type UpdateManagementSavedSearchRequest struct {
// A unique saved search identifier.
ManagementSavedSearchId *string `mandatory:"true" contributesTo:"path" name:"managementSavedSearchId"`
// JSON metadata for changed saved search properties.
UpdateManagementSavedSearchDetails `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"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
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 UpdateManagementSavedSearchRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateManagementSavedSearchRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateManagementSavedSearchRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateManagementSavedSearchRequest) String() string
func (request UpdateManagementSavedSearchRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateManagementSavedSearchResponse wrapper for the UpdateManagementSavedSearch operation
type UpdateManagementSavedSearchResponse struct {
// The underlying http response
RawResponse *http.Response
// The ManagementSavedSearch instance
ManagementSavedSearch `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateManagementSavedSearchResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateManagementSavedSearchResponse) String() string