func GetActionTypesEnumStringValues() []string
GetActionTypesEnumStringValues Enumerates the set of values in String for ActionTypesEnum
func GetArchitectureTypesEnumStringValues() []string
GetArchitectureTypesEnumStringValues Enumerates the set of values in String for ArchitectureTypesEnum
func GetAvailabilityStatusEnumStringValues() []string
GetAvailabilityStatusEnumStringValues Enumerates the set of values in String for AvailabilityStatusEnum
func GetDataSourceTypesEnumStringValues() []string
GetDataSourceTypesEnumStringValues Enumerates the set of values in String for DataSourceTypesEnum
func GetInstallTypesEnumStringValues() []string
GetInstallTypesEnumStringValues Enumerates the set of values in String for InstallTypesEnum
func GetLifecycleStatesEnumStringValues() []string
GetLifecycleStatesEnumStringValues Enumerates the set of values in String for LifecycleStatesEnum
func GetListAvailabilityHistoriesSortByEnumStringValues() []string
GetListAvailabilityHistoriesSortByEnumStringValues Enumerates the set of values in String for ListAvailabilityHistoriesSortByEnum
func GetListAvailabilityHistoriesSortOrderEnumStringValues() []string
GetListAvailabilityHistoriesSortOrderEnumStringValues Enumerates the set of values in String for ListAvailabilityHistoriesSortOrderEnum
func GetListDataSourcesSortByEnumStringValues() []string
GetListDataSourcesSortByEnumStringValues Enumerates the set of values in String for ListDataSourcesSortByEnum
func GetListDataSourcesSortOrderEnumStringValues() []string
GetListDataSourcesSortOrderEnumStringValues Enumerates the set of values in String for ListDataSourcesSortOrderEnum
func GetListManagementAgentImagesInstallTypeEnumStringValues() []string
GetListManagementAgentImagesInstallTypeEnumStringValues Enumerates the set of values in String for ListManagementAgentImagesInstallTypeEnum
func GetListManagementAgentImagesLifecycleStateEnumStringValues() []string
GetListManagementAgentImagesLifecycleStateEnumStringValues Enumerates the set of values in String for ListManagementAgentImagesLifecycleStateEnum
func GetListManagementAgentImagesSortByEnumStringValues() []string
GetListManagementAgentImagesSortByEnumStringValues Enumerates the set of values in String for ListManagementAgentImagesSortByEnum
func GetListManagementAgentImagesSortOrderEnumStringValues() []string
GetListManagementAgentImagesSortOrderEnumStringValues Enumerates the set of values in String for ListManagementAgentImagesSortOrderEnum
func GetListManagementAgentInstallKeysLifecycleStateEnumStringValues() []string
GetListManagementAgentInstallKeysLifecycleStateEnumStringValues Enumerates the set of values in String for ListManagementAgentInstallKeysLifecycleStateEnum
func GetListManagementAgentInstallKeysSortByEnumStringValues() []string
GetListManagementAgentInstallKeysSortByEnumStringValues Enumerates the set of values in String for ListManagementAgentInstallKeysSortByEnum
func GetListManagementAgentInstallKeysSortOrderEnumStringValues() []string
GetListManagementAgentInstallKeysSortOrderEnumStringValues Enumerates the set of values in String for ListManagementAgentInstallKeysSortOrderEnum
func GetListManagementAgentPluginsLifecycleStateEnumStringValues() []string
GetListManagementAgentPluginsLifecycleStateEnumStringValues Enumerates the set of values in String for ListManagementAgentPluginsLifecycleStateEnum
func GetListManagementAgentPluginsSortByEnumStringValues() []string
GetListManagementAgentPluginsSortByEnumStringValues Enumerates the set of values in String for ListManagementAgentPluginsSortByEnum
func GetListManagementAgentPluginsSortOrderEnumStringValues() []string
GetListManagementAgentPluginsSortOrderEnumStringValues Enumerates the set of values in String for ListManagementAgentPluginsSortOrderEnum
func GetListManagementAgentsAvailabilityStatusEnumStringValues() []string
GetListManagementAgentsAvailabilityStatusEnumStringValues Enumerates the set of values in String for ListManagementAgentsAvailabilityStatusEnum
func GetListManagementAgentsDataSourceTypeEnumStringValues() []string
GetListManagementAgentsDataSourceTypeEnumStringValues Enumerates the set of values in String for ListManagementAgentsDataSourceTypeEnum
func GetListManagementAgentsInstallTypeEnumStringValues() []string
GetListManagementAgentsInstallTypeEnumStringValues Enumerates the set of values in String for ListManagementAgentsInstallTypeEnum
func GetListManagementAgentsLifecycleStateEnumStringValues() []string
GetListManagementAgentsLifecycleStateEnumStringValues Enumerates the set of values in String for ListManagementAgentsLifecycleStateEnum
func GetListManagementAgentsSortByEnumStringValues() []string
GetListManagementAgentsSortByEnumStringValues Enumerates the set of values in String for ListManagementAgentsSortByEnum
func GetListManagementAgentsSortOrderEnumStringValues() []string
GetListManagementAgentsSortOrderEnumStringValues Enumerates the set of values in String for ListManagementAgentsSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetManagementAgentGroupByEnumStringValues() []string
GetManagementAgentGroupByEnumStringValues Enumerates the set of values in String for ManagementAgentGroupByEnum
func GetManagementAgentPluginGroupByEnumStringValues() []string
GetManagementAgentPluginGroupByEnumStringValues Enumerates the set of values in String for ManagementAgentPluginGroupByEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypesEnumStringValues() []string
GetOperationTypesEnumStringValues Enumerates the set of values in String for OperationTypesEnum
func GetPackageTypesEnumStringValues() []string
GetPackageTypesEnumStringValues Enumerates the set of values in String for PackageTypesEnum
func GetPlatformTypesEnumStringValues() []string
GetPlatformTypesEnumStringValues Enumerates the set of values in String for PlatformTypesEnum
func GetPluginStatusEnumStringValues() []string
GetPluginStatusEnumStringValues Enumerates the set of values in String for PluginStatusEnum
func GetPropertyUnitsEnumStringValues() []string
GetPropertyUnitsEnumStringValues Enumerates the set of values in String for PropertyUnitsEnum
func GetSummarizeManagementAgentCountsInstallTypeEnumStringValues() []string
GetSummarizeManagementAgentCountsInstallTypeEnumStringValues Enumerates the set of values in String for SummarizeManagementAgentCountsInstallTypeEnum
func GetSummarizeManagementAgentPluginCountsGroupByEnumStringValues() []string
GetSummarizeManagementAgentPluginCountsGroupByEnumStringValues Enumerates the set of values in String for SummarizeManagementAgentPluginCountsGroupByEnum
func GetWorkDeliveryStatusEnumStringValues() []string
GetWorkDeliveryStatusEnumStringValues Enumerates the set of values in String for WorkDeliveryStatusEnum
ActionTypesEnum Enum with underlying type: string
type ActionTypesEnum string
Set of constants representing the allowable values for ActionTypesEnum
const (
ActionTypesCreated ActionTypesEnum = "CREATED"
ActionTypesUpdated ActionTypesEnum = "UPDATED"
ActionTypesDeleted ActionTypesEnum = "DELETED"
ActionTypesInProgress ActionTypesEnum = "IN_PROGRESS"
ActionTypesRelated ActionTypesEnum = "RELATED"
)
func GetActionTypesEnumValues() []ActionTypesEnum
GetActionTypesEnumValues Enumerates the set of values for ActionTypesEnum
func GetMappingActionTypesEnum(val string) (ActionTypesEnum, bool)
GetMappingActionTypesEnum performs case Insensitive comparison on enum value and return the desired enum
ArchitectureTypesEnum Enum with underlying type: string
type ArchitectureTypesEnum string
Set of constants representing the allowable values for ArchitectureTypesEnum
const (
ArchitectureTypesX8664 ArchitectureTypesEnum = "X86_64"
ArchitectureTypesSparc ArchitectureTypesEnum = "SPARC"
ArchitectureTypesX86 ArchitectureTypesEnum = "X86"
ArchitectureTypesM1 ArchitectureTypesEnum = "M1"
ArchitectureTypesAarch64 ArchitectureTypesEnum = "AARCH64"
)
func GetArchitectureTypesEnumValues() []ArchitectureTypesEnum
GetArchitectureTypesEnumValues Enumerates the set of values for ArchitectureTypesEnum
func GetMappingArchitectureTypesEnum(val string) (ArchitectureTypesEnum, bool)
GetMappingArchitectureTypesEnum performs case Insensitive comparison on enum value and return the desired enum
AutoUpgradableConfig The tenancy-level agent AutoUpgradable configuration.
type AutoUpgradableConfig struct {
// true if the agents can be upgraded automatically; false if they must be upgraded manually.
IsAgentAutoUpgradable *bool `mandatory:"true" json:"isAgentAutoUpgradable"`
}
func (m AutoUpgradableConfig) String() string
func (m AutoUpgradableConfig) 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
AvailabilityHistorySummary Availability history of Management Agent.
type AvailabilityHistorySummary struct {
// agent identifier
ManagementAgentId *string `mandatory:"true" json:"managementAgentId"`
// The availability status of managementAgent
AvailabilityStatus AvailabilityStatusEnum `mandatory:"true" json:"availabilityStatus"`
// The time at which the Management Agent moved to the availability status. An RFC3339 formatted datetime string
TimeAvailabilityStatusStarted *common.SDKTime `mandatory:"false" json:"timeAvailabilityStatusStarted"`
// The time till which the Management Agent was known to be in the availability status. An RFC3339 formatted datetime string
TimeAvailabilityStatusEnded *common.SDKTime `mandatory:"false" json:"timeAvailabilityStatusEnded"`
}
func (m AvailabilityHistorySummary) String() string
func (m AvailabilityHistorySummary) 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
AvailabilityStatusEnum Enum with underlying type: string
type AvailabilityStatusEnum string
Set of constants representing the allowable values for AvailabilityStatusEnum
const (
AvailabilityStatusActive AvailabilityStatusEnum = "ACTIVE"
AvailabilityStatusSilent AvailabilityStatusEnum = "SILENT"
AvailabilityStatusNotAvailable AvailabilityStatusEnum = "NOT_AVAILABLE"
)
func GetAvailabilityStatusEnumValues() []AvailabilityStatusEnum
GetAvailabilityStatusEnumValues Enumerates the set of values for AvailabilityStatusEnum
func GetMappingAvailabilityStatusEnum(val string) (AvailabilityStatusEnum, bool)
GetMappingAvailabilityStatusEnum performs case Insensitive comparison on enum value and return the desired enum
CreateDataSourceDetails A new data source.
type CreateDataSourceDetails interface {
// Unique name of the DataSource.
GetName() *string
// Compartment owning this DataSource.
GetCompartmentId() *string
}
CreateDataSourceRequest wrapper for the CreateDataSource operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/CreateDataSource.go.html to see an example of how to use CreateDataSourceRequest.
type CreateDataSourceRequest struct {
// Unique Management Agent identifier
ManagementAgentId *string `mandatory:"true" contributesTo:"path" name:"managementAgentId"`
// Details of DataSource to be created for the given Management Agent.
CreateDataSourceDetails `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"`
// 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"`
// 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 CreateDataSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDataSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDataSourceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDataSourceRequest) String() string
func (request CreateDataSourceRequest) 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
CreateDataSourceResponse wrapper for the CreateDataSource operation
type CreateDataSourceResponse 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 CreateDataSourceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDataSourceResponse) String() string
CreateManagementAgentInstallKeyDetails The information about new Management Agent install Key.
type CreateManagementAgentInstallKeyDetails struct {
// Management Agent install Key Name
DisplayName *string `mandatory:"true" json:"displayName"`
// Compartment Identifier
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Total number of install for this keys
AllowedKeyInstallCount *int `mandatory:"false" json:"allowedKeyInstallCount"`
// date after which key would expire after creation
TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`
// If set to true, the install key has no expiration date or usage limit. Defaults to false
IsUnlimited *bool `mandatory:"false" json:"isUnlimited"`
}
func (m CreateManagementAgentInstallKeyDetails) String() string
func (m CreateManagementAgentInstallKeyDetails) 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
CreateManagementAgentInstallKeyRequest wrapper for the CreateManagementAgentInstallKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/CreateManagementAgentInstallKey.go.html to see an example of how to use CreateManagementAgentInstallKeyRequest.
type CreateManagementAgentInstallKeyRequest struct {
// Details of the Agent install Key
CreateManagementAgentInstallKeyDetails `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 CreateManagementAgentInstallKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateManagementAgentInstallKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateManagementAgentInstallKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateManagementAgentInstallKeyRequest) String() string
func (request CreateManagementAgentInstallKeyRequest) 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
CreateManagementAgentInstallKeyResponse wrapper for the CreateManagementAgentInstallKey operation
type CreateManagementAgentInstallKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The ManagementAgentInstallKey instance
ManagementAgentInstallKey `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateManagementAgentInstallKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateManagementAgentInstallKeyResponse) String() string
CreatePrometheusEmitterDataSourceDetails A Prometheus emitter data source.
type CreatePrometheusEmitterDataSourceDetails struct {
// Unique name of the DataSource.
Name *string `mandatory:"true" json:"name"`
// Compartment owning this DataSource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The url through which the Prometheus Exporter publishes its metrics. (http only)
Url *string `mandatory:"true" json:"url"`
// The OCI monitoring namespace to which scraped metrics should be uploaded.
Namespace *string `mandatory:"true" json:"namespace"`
// Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.
AllowMetrics *string `mandatory:"false" json:"allowMetrics"`
// The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property).
ProxyUrl *string `mandatory:"false" json:"proxyUrl"`
// Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
ConnectionTimeout *int `mandatory:"false" json:"connectionTimeout"`
// Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
ReadTimeout *int `mandatory:"false" json:"readTimeout"`
// Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
ReadDataLimitInKilobytes *int `mandatory:"false" json:"readDataLimitInKilobytes"`
// Number in minutes. The scraping occurs at the specified interval.
ScheduleMins *int `mandatory:"false" json:"scheduleMins"`
// OCI monitoring resource group to assign the metric to.
ResourceGroup *string `mandatory:"false" json:"resourceGroup"`
// The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
MetricDimensions []MetricDimension `mandatory:"false" json:"metricDimensions"`
}
func (m CreatePrometheusEmitterDataSourceDetails) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m CreatePrometheusEmitterDataSourceDetails) GetName() *string
GetName returns Name
func (m CreatePrometheusEmitterDataSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreatePrometheusEmitterDataSourceDetails) String() string
func (m CreatePrometheusEmitterDataSourceDetails) 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
DataSource A representation of a source configuration setup in the Management Agent.
type DataSource interface {
// Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
GetKey() *string
// Unique name of the DataSource.
GetName() *string
// Compartment owning this DataSource.
GetCompartmentId() *string
// State of the DataSource.
GetState() LifecycleStatesEnum
// The time the DataSource was created. An RFC3339 formatted datetime string
GetTimeCreated() *common.SDKTime
// The time the DataSource data was last received. An RFC3339 formatted datetime string
GetTimeUpdated() *common.SDKTime
}
DataSourceSummary The information about the dataSources that agent is associated to.
type DataSourceSummary interface {
// Data source type and name identifier.
GetKey() *string
// Unique name of the dataSource.
GetName() *string
}
DataSourceSummaryItem The information about the dataSources that agent is associated to.
type DataSourceSummaryItem interface {
// Data source type and name identifier.
GetKey() *string
// Unique name of the dataSource.
GetName() *string
}
DataSourceTypesEnum Enum with underlying type: string
type DataSourceTypesEnum string
Set of constants representing the allowable values for DataSourceTypesEnum
const (
DataSourceTypesKubernetesCluster DataSourceTypesEnum = "KUBERNETES_CLUSTER"
DataSourceTypesPrometheusEmitter DataSourceTypesEnum = "PROMETHEUS_EMITTER"
)
func GetDataSourceTypesEnumValues() []DataSourceTypesEnum
GetDataSourceTypesEnumValues Enumerates the set of values for DataSourceTypesEnum
func GetMappingDataSourceTypesEnum(val string) (DataSourceTypesEnum, bool)
GetMappingDataSourceTypesEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteDataSourceRequest wrapper for the DeleteDataSource operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/DeleteDataSource.go.html to see an example of how to use DeleteDataSourceRequest.
type DeleteDataSourceRequest struct {
// Unique Management Agent identifier
ManagementAgentId *string `mandatory:"true" contributesTo:"path" name:"managementAgentId"`
// Data source type and name identifier.
DataSourceKey *string `mandatory:"true" contributesTo:"path" name:"dataSourceKey"`
// 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 DeleteDataSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDataSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDataSourceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDataSourceRequest) String() string
func (request DeleteDataSourceRequest) 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
DeleteDataSourceResponse wrapper for the DeleteDataSource operation
type DeleteDataSourceResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// 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 DeleteDataSourceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDataSourceResponse) String() string
DeleteManagementAgentInstallKeyRequest wrapper for the DeleteManagementAgentInstallKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/DeleteManagementAgentInstallKey.go.html to see an example of how to use DeleteManagementAgentInstallKeyRequest.
type DeleteManagementAgentInstallKeyRequest struct {
// Unique Management Agent Install Key identifier
ManagementAgentInstallKeyId *string `mandatory:"true" contributesTo:"path" name:"managementAgentInstallKeyId"`
// 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 DeleteManagementAgentInstallKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteManagementAgentInstallKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteManagementAgentInstallKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteManagementAgentInstallKeyRequest) String() string
func (request DeleteManagementAgentInstallKeyRequest) 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
DeleteManagementAgentInstallKeyResponse wrapper for the DeleteManagementAgentInstallKey operation
type DeleteManagementAgentInstallKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteManagementAgentInstallKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteManagementAgentInstallKeyResponse) String() string
DeleteManagementAgentRequest wrapper for the DeleteManagementAgent operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/DeleteManagementAgent.go.html to see an example of how to use DeleteManagementAgentRequest.
type DeleteManagementAgentRequest struct {
// Unique Management Agent identifier
ManagementAgentId *string `mandatory:"true" contributesTo:"path" name:"managementAgentId"`
// 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 DeleteManagementAgentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteManagementAgentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteManagementAgentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteManagementAgentRequest) String() string
func (request DeleteManagementAgentRequest) 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
DeleteManagementAgentResponse wrapper for the DeleteManagementAgent operation
type DeleteManagementAgentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteManagementAgentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteManagementAgentResponse) String() string
DeleteWorkRequestRequest wrapper for the DeleteWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/DeleteWorkRequest.go.html to see an example of how to use DeleteWorkRequestRequest.
type DeleteWorkRequestRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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"`
// 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 DeleteWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteWorkRequestRequest) String() string
func (request DeleteWorkRequestRequest) 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
DeleteWorkRequestResponse wrapper for the DeleteWorkRequest operation
type DeleteWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteWorkRequestResponse) String() string
DeployPluginsDetails The information required to deploy new Management Agent Plugins.
type DeployPluginsDetails struct {
// Plugin Id
PluginIds []string `mandatory:"true" json:"pluginIds"`
// Management Agent Compartment Identifier
AgentCompartmentId *string `mandatory:"true" json:"agentCompartmentId"`
// List of Agent identifiers
AgentIds []string `mandatory:"true" json:"agentIds"`
}
func (m DeployPluginsDetails) String() string
func (m DeployPluginsDetails) 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
DeployPluginsRequest wrapper for the DeployPlugins operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/DeployPlugins.go.html to see an example of how to use DeployPluginsRequest.
type DeployPluginsRequest struct {
// Details of Plugins to be deployed for a given list of Management Agents.
DeployPluginsDetails `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 DeployPluginsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeployPluginsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeployPluginsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeployPluginsRequest) String() string
func (request DeployPluginsRequest) 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
DeployPluginsResponse wrapper for the DeployPlugins operation
type DeployPluginsResponse 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 DeployPluginsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeployPluginsResponse) String() string
GetAutoUpgradableConfigRequest wrapper for the GetAutoUpgradableConfig operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/GetAutoUpgradableConfig.go.html to see an example of how to use GetAutoUpgradableConfigRequest.
type GetAutoUpgradableConfigRequest struct {
// The OCID of the compartment to which a request will be scoped.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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 GetAutoUpgradableConfigRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAutoUpgradableConfigRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAutoUpgradableConfigRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAutoUpgradableConfigRequest) String() string
func (request GetAutoUpgradableConfigRequest) 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
GetAutoUpgradableConfigResponse wrapper for the GetAutoUpgradableConfig operation
type GetAutoUpgradableConfigResponse struct {
// The underlying http response
RawResponse *http.Response
// The AutoUpgradableConfig instance
AutoUpgradableConfig `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"`
}
func (response GetAutoUpgradableConfigResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAutoUpgradableConfigResponse) String() string
GetDataSourceRequest wrapper for the GetDataSource operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/GetDataSource.go.html to see an example of how to use GetDataSourceRequest.
type GetDataSourceRequest struct {
// Unique Management Agent identifier
ManagementAgentId *string `mandatory:"true" contributesTo:"path" name:"managementAgentId"`
// Data source type and name identifier.
DataSourceKey *string `mandatory:"true" contributesTo:"path" name:"dataSourceKey"`
// 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 GetDataSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDataSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDataSourceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDataSourceRequest) String() string
func (request GetDataSourceRequest) 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
GetDataSourceResponse wrapper for the GetDataSource operation
type GetDataSourceResponse struct {
// The underlying http response
RawResponse *http.Response
// The DataSource instance
DataSource `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 optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetDataSourceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDataSourceResponse) String() string
GetManagementAgentInstallKeyContentRequest wrapper for the GetManagementAgentInstallKeyContent operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/GetManagementAgentInstallKeyContent.go.html to see an example of how to use GetManagementAgentInstallKeyContentRequest.
type GetManagementAgentInstallKeyContentRequest struct {
// Unique Management Agent Install Key identifier
ManagementAgentInstallKeyId *string `mandatory:"true" contributesTo:"path" name:"managementAgentInstallKeyId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Filter to return input plugin names uncommented in the output.
PluginName []string `contributesTo:"query" name:"pluginName" collectionFormat:"multi"`
// 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 GetManagementAgentInstallKeyContentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetManagementAgentInstallKeyContentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetManagementAgentInstallKeyContentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetManagementAgentInstallKeyContentRequest) String() string
func (request GetManagementAgentInstallKeyContentRequest) 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
GetManagementAgentInstallKeyContentResponse wrapper for the GetManagementAgentInstallKeyContent operation
type GetManagementAgentInstallKeyContentResponse struct {
// The underlying http response
RawResponse *http.Response
// The io.ReadCloser instance
Content io.ReadCloser `presentIn:"body" encoding:"binary"`
// 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"`
// The content size of the body in bytes.
ContentLength *int64 `presentIn:"header" name:"content-length"`
// The content type of the body.
ContentType *string `presentIn:"header" name:"content-type"`
}
func (response GetManagementAgentInstallKeyContentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetManagementAgentInstallKeyContentResponse) String() string
GetManagementAgentInstallKeyRequest wrapper for the GetManagementAgentInstallKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/GetManagementAgentInstallKey.go.html to see an example of how to use GetManagementAgentInstallKeyRequest.
type GetManagementAgentInstallKeyRequest struct {
// Unique Management Agent Install Key identifier
ManagementAgentInstallKeyId *string `mandatory:"true" contributesTo:"path" name:"managementAgentInstallKeyId"`
// 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 GetManagementAgentInstallKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetManagementAgentInstallKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetManagementAgentInstallKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetManagementAgentInstallKeyRequest) String() string
func (request GetManagementAgentInstallKeyRequest) 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
GetManagementAgentInstallKeyResponse wrapper for the GetManagementAgentInstallKey operation
type GetManagementAgentInstallKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The ManagementAgentInstallKey instance
ManagementAgentInstallKey `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetManagementAgentInstallKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetManagementAgentInstallKeyResponse) String() string
GetManagementAgentRequest wrapper for the GetManagementAgent operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/GetManagementAgent.go.html to see an example of how to use GetManagementAgentRequest.
type GetManagementAgentRequest struct {
// Unique Management Agent identifier
ManagementAgentId *string `mandatory:"true" contributesTo:"path" name:"managementAgentId"`
// 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 GetManagementAgentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetManagementAgentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetManagementAgentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetManagementAgentRequest) String() string
func (request GetManagementAgentRequest) 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
GetManagementAgentResponse wrapper for the GetManagementAgent operation
type GetManagementAgentResponse struct {
// The underlying http response
RawResponse *http.Response
// The ManagementAgent instance
ManagementAgent `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetManagementAgentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetManagementAgentResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// 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 GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `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"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *float32 `presentIn:"header" name:"retry-after"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
InstallTypesEnum Enum with underlying type: string
type InstallTypesEnum string
Set of constants representing the allowable values for InstallTypesEnum
const (
InstallTypesAgent InstallTypesEnum = "AGENT"
InstallTypesGateway InstallTypesEnum = "GATEWAY"
)
func GetInstallTypesEnumValues() []InstallTypesEnum
GetInstallTypesEnumValues Enumerates the set of values for InstallTypesEnum
func GetMappingInstallTypesEnum(val string) (InstallTypesEnum, bool)
GetMappingInstallTypesEnum performs case Insensitive comparison on enum value and return the desired enum
KubernetesClusterDataSource A Kubernetes cluster data source.
type KubernetesClusterDataSource struct {
// Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
Key *string `mandatory:"true" json:"key"`
// Unique name of the DataSource.
Name *string `mandatory:"true" json:"name"`
// Compartment owning this DataSource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the DataSource was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the DataSource data was last received. An RFC3339 formatted datetime string
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The Kubernetes namespace
Namespace *string `mandatory:"true" json:"namespace"`
// If the Kubernetes cluster type is Daemon set then this will be set to true.
IsDaemonSet *bool `mandatory:"false" json:"isDaemonSet"`
// State of the DataSource.
State LifecycleStatesEnum `mandatory:"true" json:"state"`
}
func (m KubernetesClusterDataSource) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m KubernetesClusterDataSource) GetKey() *string
GetKey returns Key
func (m KubernetesClusterDataSource) GetName() *string
GetName returns Name
func (m KubernetesClusterDataSource) GetState() LifecycleStatesEnum
GetState returns State
func (m KubernetesClusterDataSource) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m KubernetesClusterDataSource) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m KubernetesClusterDataSource) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m KubernetesClusterDataSource) String() string
func (m KubernetesClusterDataSource) 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
KubernetesClusterDataSourceSummary A Kubernetes collection data source summary.
type KubernetesClusterDataSourceSummary struct {
// Data source type and name identifier.
Key *string `mandatory:"true" json:"key"`
// Unique name of the dataSource.
Name *string `mandatory:"true" json:"name"`
// true if the Kubernetes cluster type is Daemon set
IsDaemonSet *bool `mandatory:"false" json:"isDaemonSet"`
}
func (m KubernetesClusterDataSourceSummary) GetKey() *string
GetKey returns Key
func (m KubernetesClusterDataSourceSummary) GetName() *string
GetName returns Name
func (m KubernetesClusterDataSourceSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m KubernetesClusterDataSourceSummary) String() string
func (m KubernetesClusterDataSourceSummary) 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
KubernetesClusterDataSourceSummaryItem A Kubernetes collection data source summary.
type KubernetesClusterDataSourceSummaryItem struct {
// Data source type and name identifier.
Key *string `mandatory:"true" json:"key"`
// Unique name of the dataSource.
Name *string `mandatory:"true" json:"name"`
// true if the Kubernetes cluster type is Daemon set
IsDaemonSet *bool `mandatory:"false" json:"isDaemonSet"`
}
func (m KubernetesClusterDataSourceSummaryItem) GetKey() *string
GetKey returns Key
func (m KubernetesClusterDataSourceSummaryItem) GetName() *string
GetName returns Name
func (m KubernetesClusterDataSourceSummaryItem) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m KubernetesClusterDataSourceSummaryItem) String() string
func (m KubernetesClusterDataSourceSummaryItem) 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
LifecycleStatesEnum Enum with underlying type: string
type LifecycleStatesEnum string
Set of constants representing the allowable values for LifecycleStatesEnum
const (
LifecycleStatesCreating LifecycleStatesEnum = "CREATING"
LifecycleStatesUpdating LifecycleStatesEnum = "UPDATING"
LifecycleStatesActive LifecycleStatesEnum = "ACTIVE"
LifecycleStatesInactive LifecycleStatesEnum = "INACTIVE"
LifecycleStatesTerminated LifecycleStatesEnum = "TERMINATED"
LifecycleStatesDeleting LifecycleStatesEnum = "DELETING"
LifecycleStatesDeleted LifecycleStatesEnum = "DELETED"
LifecycleStatesFailed LifecycleStatesEnum = "FAILED"
)
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
ListAvailabilityHistoriesRequest wrapper for the ListAvailabilityHistories operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/ListAvailabilityHistories.go.html to see an example of how to use ListAvailabilityHistoriesRequest.
type ListAvailabilityHistoriesRequest struct {
// Unique Management Agent identifier
ManagementAgentId *string `mandatory:"true" contributesTo:"path" name:"managementAgentId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Filter to limit the availability history results to that of time after the input time including the boundary record.
// Defaulted to current date minus one year.
// The date and time to be given as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 5.6.
TimeAvailabilityStatusEndedGreaterThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeAvailabilityStatusEndedGreaterThan"`
// Filter to limit the availability history results to that of time before the input time including the boundary record
// Defaulted to current date.
// The date and time to be given as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 5.6.
TimeAvailabilityStatusStartedLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeAvailabilityStatusStartedLessThan"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This 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 ListAvailabilityHistoriesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Default order for timeAvailabilityStatusStarted is descending.
SortBy ListAvailabilityHistoriesSortByEnum `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 ListAvailabilityHistoriesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAvailabilityHistoriesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAvailabilityHistoriesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAvailabilityHistoriesRequest) String() string
func (request ListAvailabilityHistoriesRequest) 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
ListAvailabilityHistoriesResponse wrapper for the ListAvailabilityHistories operation
type ListAvailabilityHistoriesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []AvailabilityHistorySummary instances
Items []AvailabilityHistorySummary `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 ListAvailabilityHistoriesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAvailabilityHistoriesResponse) String() string
ListAvailabilityHistoriesSortByEnum Enum with underlying type: string
type ListAvailabilityHistoriesSortByEnum string
Set of constants representing the allowable values for ListAvailabilityHistoriesSortByEnum
const (
ListAvailabilityHistoriesSortByTimeavailabilitystatusstarted ListAvailabilityHistoriesSortByEnum = "timeAvailabilityStatusStarted"
)
func GetListAvailabilityHistoriesSortByEnumValues() []ListAvailabilityHistoriesSortByEnum
GetListAvailabilityHistoriesSortByEnumValues Enumerates the set of values for ListAvailabilityHistoriesSortByEnum
func GetMappingListAvailabilityHistoriesSortByEnum(val string) (ListAvailabilityHistoriesSortByEnum, bool)
GetMappingListAvailabilityHistoriesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAvailabilityHistoriesSortOrderEnum Enum with underlying type: string
type ListAvailabilityHistoriesSortOrderEnum string
Set of constants representing the allowable values for ListAvailabilityHistoriesSortOrderEnum
const (
ListAvailabilityHistoriesSortOrderAsc ListAvailabilityHistoriesSortOrderEnum = "ASC"
ListAvailabilityHistoriesSortOrderDesc ListAvailabilityHistoriesSortOrderEnum = "DESC"
)
func GetListAvailabilityHistoriesSortOrderEnumValues() []ListAvailabilityHistoriesSortOrderEnum
GetListAvailabilityHistoriesSortOrderEnumValues Enumerates the set of values for ListAvailabilityHistoriesSortOrderEnum
func GetMappingListAvailabilityHistoriesSortOrderEnum(val string) (ListAvailabilityHistoriesSortOrderEnum, bool)
GetMappingListAvailabilityHistoriesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDataSourcesRequest wrapper for the ListDataSources operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/ListDataSources.go.html to see an example of how to use ListDataSourcesRequest.
type ListDataSourcesRequest struct {
// Unique Management Agent identifier
ManagementAgentId *string `mandatory:"true" contributesTo:"path" name:"managementAgentId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListDataSourcesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. If no value is specified dataSourceName is default.
SortBy ListDataSourcesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique name of the dataSource.
Name []string `contributesTo:"query" name:"name" collectionFormat:"multi"`
// 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 ListDataSourcesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDataSourcesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDataSourcesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDataSourcesRequest) String() string
func (request ListDataSourcesRequest) 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
ListDataSourcesResponse wrapper for the ListDataSources operation
type ListDataSourcesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []DataSourceSummary instances
Items []DataSourceSummary `presentIn:"body"`
// 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"`
// 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 ListDataSourcesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDataSourcesResponse) String() string
ListDataSourcesSortByEnum Enum with underlying type: string
type ListDataSourcesSortByEnum string
Set of constants representing the allowable values for ListDataSourcesSortByEnum
const (
ListDataSourcesSortByDatasourcename ListDataSourcesSortByEnum = "dataSourceName"
ListDataSourcesSortByDatasourcetype ListDataSourcesSortByEnum = "dataSourceType"
)
func GetListDataSourcesSortByEnumValues() []ListDataSourcesSortByEnum
GetListDataSourcesSortByEnumValues Enumerates the set of values for ListDataSourcesSortByEnum
func GetMappingListDataSourcesSortByEnum(val string) (ListDataSourcesSortByEnum, bool)
GetMappingListDataSourcesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDataSourcesSortOrderEnum Enum with underlying type: string
type ListDataSourcesSortOrderEnum string
Set of constants representing the allowable values for ListDataSourcesSortOrderEnum
const (
ListDataSourcesSortOrderAsc ListDataSourcesSortOrderEnum = "ASC"
ListDataSourcesSortOrderDesc ListDataSourcesSortOrderEnum = "DESC"
)
func GetListDataSourcesSortOrderEnumValues() []ListDataSourcesSortOrderEnum
GetListDataSourcesSortOrderEnumValues Enumerates the set of values for ListDataSourcesSortOrderEnum
func GetMappingListDataSourcesSortOrderEnum(val string) (ListDataSourcesSortOrderEnum, bool)
GetMappingListDataSourcesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementAgentImagesInstallTypeEnum Enum with underlying type: string
type ListManagementAgentImagesInstallTypeEnum string
Set of constants representing the allowable values for ListManagementAgentImagesInstallTypeEnum
const (
ListManagementAgentImagesInstallTypeAgent ListManagementAgentImagesInstallTypeEnum = "AGENT"
ListManagementAgentImagesInstallTypeGateway ListManagementAgentImagesInstallTypeEnum = "GATEWAY"
)
func GetListManagementAgentImagesInstallTypeEnumValues() []ListManagementAgentImagesInstallTypeEnum
GetListManagementAgentImagesInstallTypeEnumValues Enumerates the set of values for ListManagementAgentImagesInstallTypeEnum
func GetMappingListManagementAgentImagesInstallTypeEnum(val string) (ListManagementAgentImagesInstallTypeEnum, bool)
GetMappingListManagementAgentImagesInstallTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementAgentImagesLifecycleStateEnum Enum with underlying type: string
type ListManagementAgentImagesLifecycleStateEnum string
Set of constants representing the allowable values for ListManagementAgentImagesLifecycleStateEnum
const (
ListManagementAgentImagesLifecycleStateCreating ListManagementAgentImagesLifecycleStateEnum = "CREATING"
ListManagementAgentImagesLifecycleStateUpdating ListManagementAgentImagesLifecycleStateEnum = "UPDATING"
ListManagementAgentImagesLifecycleStateActive ListManagementAgentImagesLifecycleStateEnum = "ACTIVE"
ListManagementAgentImagesLifecycleStateInactive ListManagementAgentImagesLifecycleStateEnum = "INACTIVE"
ListManagementAgentImagesLifecycleStateTerminated ListManagementAgentImagesLifecycleStateEnum = "TERMINATED"
ListManagementAgentImagesLifecycleStateDeleting ListManagementAgentImagesLifecycleStateEnum = "DELETING"
ListManagementAgentImagesLifecycleStateDeleted ListManagementAgentImagesLifecycleStateEnum = "DELETED"
ListManagementAgentImagesLifecycleStateFailed ListManagementAgentImagesLifecycleStateEnum = "FAILED"
)
func GetListManagementAgentImagesLifecycleStateEnumValues() []ListManagementAgentImagesLifecycleStateEnum
GetListManagementAgentImagesLifecycleStateEnumValues Enumerates the set of values for ListManagementAgentImagesLifecycleStateEnum
func GetMappingListManagementAgentImagesLifecycleStateEnum(val string) (ListManagementAgentImagesLifecycleStateEnum, bool)
GetMappingListManagementAgentImagesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementAgentImagesRequest wrapper for the ListManagementAgentImages operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/ListManagementAgentImages.go.html to see an example of how to use ListManagementAgentImagesRequest.
type ListManagementAgentImagesRequest struct {
// The OCID of the compartment to which a request will be scoped.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This 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 ListManagementAgentImagesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for platformType is descending. Default order for version is descending. If no value is specified platformType is default.
SortBy ListManagementAgentImagesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// A filter to return only resources that match the entire platform name given.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// Filter to return only Management Agents in the particular lifecycle state.
LifecycleState ListManagementAgentImagesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.
InstallType ListManagementAgentImagesInstallTypeEnum `mandatory:"false" contributesTo:"query" name:"installType" 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 ListManagementAgentImagesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListManagementAgentImagesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListManagementAgentImagesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListManagementAgentImagesRequest) String() string
func (request ListManagementAgentImagesRequest) 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
ListManagementAgentImagesResponse wrapper for the ListManagementAgentImages operation
type ListManagementAgentImagesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ManagementAgentImageSummary instances
Items []ManagementAgentImageSummary `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 ListManagementAgentImagesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListManagementAgentImagesResponse) String() string
ListManagementAgentImagesSortByEnum Enum with underlying type: string
type ListManagementAgentImagesSortByEnum string
Set of constants representing the allowable values for ListManagementAgentImagesSortByEnum
const (
ListManagementAgentImagesSortByPlatformtype ListManagementAgentImagesSortByEnum = "platformType"
ListManagementAgentImagesSortByVersion ListManagementAgentImagesSortByEnum = "version"
)
func GetListManagementAgentImagesSortByEnumValues() []ListManagementAgentImagesSortByEnum
GetListManagementAgentImagesSortByEnumValues Enumerates the set of values for ListManagementAgentImagesSortByEnum
func GetMappingListManagementAgentImagesSortByEnum(val string) (ListManagementAgentImagesSortByEnum, bool)
GetMappingListManagementAgentImagesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementAgentImagesSortOrderEnum Enum with underlying type: string
type ListManagementAgentImagesSortOrderEnum string
Set of constants representing the allowable values for ListManagementAgentImagesSortOrderEnum
const (
ListManagementAgentImagesSortOrderAsc ListManagementAgentImagesSortOrderEnum = "ASC"
ListManagementAgentImagesSortOrderDesc ListManagementAgentImagesSortOrderEnum = "DESC"
)
func GetListManagementAgentImagesSortOrderEnumValues() []ListManagementAgentImagesSortOrderEnum
GetListManagementAgentImagesSortOrderEnumValues Enumerates the set of values for ListManagementAgentImagesSortOrderEnum
func GetMappingListManagementAgentImagesSortOrderEnum(val string) (ListManagementAgentImagesSortOrderEnum, bool)
GetMappingListManagementAgentImagesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementAgentInstallKeysLifecycleStateEnum Enum with underlying type: string
type ListManagementAgentInstallKeysLifecycleStateEnum string
Set of constants representing the allowable values for ListManagementAgentInstallKeysLifecycleStateEnum
const (
ListManagementAgentInstallKeysLifecycleStateCreating ListManagementAgentInstallKeysLifecycleStateEnum = "CREATING"
ListManagementAgentInstallKeysLifecycleStateUpdating ListManagementAgentInstallKeysLifecycleStateEnum = "UPDATING"
ListManagementAgentInstallKeysLifecycleStateActive ListManagementAgentInstallKeysLifecycleStateEnum = "ACTIVE"
ListManagementAgentInstallKeysLifecycleStateInactive ListManagementAgentInstallKeysLifecycleStateEnum = "INACTIVE"
ListManagementAgentInstallKeysLifecycleStateTerminated ListManagementAgentInstallKeysLifecycleStateEnum = "TERMINATED"
ListManagementAgentInstallKeysLifecycleStateDeleting ListManagementAgentInstallKeysLifecycleStateEnum = "DELETING"
ListManagementAgentInstallKeysLifecycleStateDeleted ListManagementAgentInstallKeysLifecycleStateEnum = "DELETED"
ListManagementAgentInstallKeysLifecycleStateFailed ListManagementAgentInstallKeysLifecycleStateEnum = "FAILED"
)
func GetListManagementAgentInstallKeysLifecycleStateEnumValues() []ListManagementAgentInstallKeysLifecycleStateEnum
GetListManagementAgentInstallKeysLifecycleStateEnumValues Enumerates the set of values for ListManagementAgentInstallKeysLifecycleStateEnum
func GetMappingListManagementAgentInstallKeysLifecycleStateEnum(val string) (ListManagementAgentInstallKeysLifecycleStateEnum, bool)
GetMappingListManagementAgentInstallKeysLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementAgentInstallKeysRequest wrapper for the ListManagementAgentInstallKeys operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/ListManagementAgentInstallKeys.go.html to see an example of how to use ListManagementAgentInstallKeysRequest.
type ListManagementAgentInstallKeysRequest struct {
// The OCID of the compartment to which a request will be scoped.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
CompartmentIdInSubtree *bool `mandatory:"false" contributesTo:"query" name:"compartmentIdInSubtree"`
// Value of this is always "ACCESSIBLE" and any other value is not supported.
AccessLevel *string `mandatory:"false" contributesTo:"query" name:"accessLevel"`
// Filter to return only Management Agents in the particular lifecycle state.
LifecycleState ListManagementAgentInstallKeysLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The display name for which the Key needs to be listed.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The page token representing the page at 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 ListManagementAgentInstallKeysSortOrderEnum `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 default.
SortBy ListManagementAgentInstallKeysSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListManagementAgentInstallKeysRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListManagementAgentInstallKeysRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListManagementAgentInstallKeysRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListManagementAgentInstallKeysRequest) String() string
func (request ListManagementAgentInstallKeysRequest) 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
ListManagementAgentInstallKeysResponse wrapper for the ListManagementAgentInstallKeys operation
type ListManagementAgentInstallKeysResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ManagementAgentInstallKeySummary instances
Items []ManagementAgentInstallKeySummary `presentIn:"body"`
// 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"`
// 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 ListManagementAgentInstallKeysResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListManagementAgentInstallKeysResponse) String() string
ListManagementAgentInstallKeysSortByEnum Enum with underlying type: string
type ListManagementAgentInstallKeysSortByEnum string
Set of constants representing the allowable values for ListManagementAgentInstallKeysSortByEnum
const (
ListManagementAgentInstallKeysSortByTimecreated ListManagementAgentInstallKeysSortByEnum = "timeCreated"
ListManagementAgentInstallKeysSortByDisplayname ListManagementAgentInstallKeysSortByEnum = "displayName"
)
func GetListManagementAgentInstallKeysSortByEnumValues() []ListManagementAgentInstallKeysSortByEnum
GetListManagementAgentInstallKeysSortByEnumValues Enumerates the set of values for ListManagementAgentInstallKeysSortByEnum
func GetMappingListManagementAgentInstallKeysSortByEnum(val string) (ListManagementAgentInstallKeysSortByEnum, bool)
GetMappingListManagementAgentInstallKeysSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementAgentInstallKeysSortOrderEnum Enum with underlying type: string
type ListManagementAgentInstallKeysSortOrderEnum string
Set of constants representing the allowable values for ListManagementAgentInstallKeysSortOrderEnum
const (
ListManagementAgentInstallKeysSortOrderAsc ListManagementAgentInstallKeysSortOrderEnum = "ASC"
ListManagementAgentInstallKeysSortOrderDesc ListManagementAgentInstallKeysSortOrderEnum = "DESC"
)
func GetListManagementAgentInstallKeysSortOrderEnumValues() []ListManagementAgentInstallKeysSortOrderEnum
GetListManagementAgentInstallKeysSortOrderEnumValues Enumerates the set of values for ListManagementAgentInstallKeysSortOrderEnum
func GetMappingListManagementAgentInstallKeysSortOrderEnum(val string) (ListManagementAgentInstallKeysSortOrderEnum, bool)
GetMappingListManagementAgentInstallKeysSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementAgentPluginsLifecycleStateEnum Enum with underlying type: string
type ListManagementAgentPluginsLifecycleStateEnum string
Set of constants representing the allowable values for ListManagementAgentPluginsLifecycleStateEnum
const (
ListManagementAgentPluginsLifecycleStateCreating ListManagementAgentPluginsLifecycleStateEnum = "CREATING"
ListManagementAgentPluginsLifecycleStateUpdating ListManagementAgentPluginsLifecycleStateEnum = "UPDATING"
ListManagementAgentPluginsLifecycleStateActive ListManagementAgentPluginsLifecycleStateEnum = "ACTIVE"
ListManagementAgentPluginsLifecycleStateInactive ListManagementAgentPluginsLifecycleStateEnum = "INACTIVE"
ListManagementAgentPluginsLifecycleStateTerminated ListManagementAgentPluginsLifecycleStateEnum = "TERMINATED"
ListManagementAgentPluginsLifecycleStateDeleting ListManagementAgentPluginsLifecycleStateEnum = "DELETING"
ListManagementAgentPluginsLifecycleStateDeleted ListManagementAgentPluginsLifecycleStateEnum = "DELETED"
ListManagementAgentPluginsLifecycleStateFailed ListManagementAgentPluginsLifecycleStateEnum = "FAILED"
)
func GetListManagementAgentPluginsLifecycleStateEnumValues() []ListManagementAgentPluginsLifecycleStateEnum
GetListManagementAgentPluginsLifecycleStateEnumValues Enumerates the set of values for ListManagementAgentPluginsLifecycleStateEnum
func GetMappingListManagementAgentPluginsLifecycleStateEnum(val string) (ListManagementAgentPluginsLifecycleStateEnum, bool)
GetMappingListManagementAgentPluginsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementAgentPluginsRequest wrapper for the ListManagementAgentPlugins operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/ListManagementAgentPlugins.go.html to see an example of how to use ListManagementAgentPluginsRequest.
type ListManagementAgentPluginsRequest struct {
// The OCID of the compartment to which a request will be scoped.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Filter to return only Management Agent Plugins having the particular display name.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This 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 ListManagementAgentPluginsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Default order for displayName is ascending. If no value is specified displayName is default.
SortBy ListManagementAgentPluginsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Filter to return only Management Agents in the particular lifecycle state.
LifecycleState ListManagementAgentPluginsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Filter to return only results having the particular platform type.
PlatformType []PlatformTypesEnum `contributesTo:"query" name:"platformType" omitEmpty:"true" collectionFormat:"multi"`
// The ManagementAgentID of the agent from which the Management Agents to be filtered.
AgentId *string `mandatory:"false" contributesTo:"query" name:"agentId"`
// 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 ListManagementAgentPluginsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListManagementAgentPluginsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListManagementAgentPluginsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListManagementAgentPluginsRequest) String() string
func (request ListManagementAgentPluginsRequest) 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
ListManagementAgentPluginsResponse wrapper for the ListManagementAgentPlugins operation
type ListManagementAgentPluginsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ManagementAgentPluginSummary instances
Items []ManagementAgentPluginSummary `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 ListManagementAgentPluginsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListManagementAgentPluginsResponse) String() string
ListManagementAgentPluginsSortByEnum Enum with underlying type: string
type ListManagementAgentPluginsSortByEnum string
Set of constants representing the allowable values for ListManagementAgentPluginsSortByEnum
const (
ListManagementAgentPluginsSortByDisplayname ListManagementAgentPluginsSortByEnum = "displayName"
)
func GetListManagementAgentPluginsSortByEnumValues() []ListManagementAgentPluginsSortByEnum
GetListManagementAgentPluginsSortByEnumValues Enumerates the set of values for ListManagementAgentPluginsSortByEnum
func GetMappingListManagementAgentPluginsSortByEnum(val string) (ListManagementAgentPluginsSortByEnum, bool)
GetMappingListManagementAgentPluginsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementAgentPluginsSortOrderEnum Enum with underlying type: string
type ListManagementAgentPluginsSortOrderEnum string
Set of constants representing the allowable values for ListManagementAgentPluginsSortOrderEnum
const (
ListManagementAgentPluginsSortOrderAsc ListManagementAgentPluginsSortOrderEnum = "ASC"
ListManagementAgentPluginsSortOrderDesc ListManagementAgentPluginsSortOrderEnum = "DESC"
)
func GetListManagementAgentPluginsSortOrderEnumValues() []ListManagementAgentPluginsSortOrderEnum
GetListManagementAgentPluginsSortOrderEnumValues Enumerates the set of values for ListManagementAgentPluginsSortOrderEnum
func GetMappingListManagementAgentPluginsSortOrderEnum(val string) (ListManagementAgentPluginsSortOrderEnum, bool)
GetMappingListManagementAgentPluginsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementAgentsAvailabilityStatusEnum Enum with underlying type: string
type ListManagementAgentsAvailabilityStatusEnum string
Set of constants representing the allowable values for ListManagementAgentsAvailabilityStatusEnum
const (
ListManagementAgentsAvailabilityStatusActive ListManagementAgentsAvailabilityStatusEnum = "ACTIVE"
ListManagementAgentsAvailabilityStatusSilent ListManagementAgentsAvailabilityStatusEnum = "SILENT"
ListManagementAgentsAvailabilityStatusNotAvailable ListManagementAgentsAvailabilityStatusEnum = "NOT_AVAILABLE"
)
func GetListManagementAgentsAvailabilityStatusEnumValues() []ListManagementAgentsAvailabilityStatusEnum
GetListManagementAgentsAvailabilityStatusEnumValues Enumerates the set of values for ListManagementAgentsAvailabilityStatusEnum
func GetMappingListManagementAgentsAvailabilityStatusEnum(val string) (ListManagementAgentsAvailabilityStatusEnum, bool)
GetMappingListManagementAgentsAvailabilityStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementAgentsDataSourceTypeEnum Enum with underlying type: string
type ListManagementAgentsDataSourceTypeEnum string
Set of constants representing the allowable values for ListManagementAgentsDataSourceTypeEnum
const (
ListManagementAgentsDataSourceTypeKubernetesCluster ListManagementAgentsDataSourceTypeEnum = "KUBERNETES_CLUSTER"
ListManagementAgentsDataSourceTypePrometheusEmitter ListManagementAgentsDataSourceTypeEnum = "PROMETHEUS_EMITTER"
)
func GetListManagementAgentsDataSourceTypeEnumValues() []ListManagementAgentsDataSourceTypeEnum
GetListManagementAgentsDataSourceTypeEnumValues Enumerates the set of values for ListManagementAgentsDataSourceTypeEnum
func GetMappingListManagementAgentsDataSourceTypeEnum(val string) (ListManagementAgentsDataSourceTypeEnum, bool)
GetMappingListManagementAgentsDataSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementAgentsInstallTypeEnum Enum with underlying type: string
type ListManagementAgentsInstallTypeEnum string
Set of constants representing the allowable values for ListManagementAgentsInstallTypeEnum
const (
ListManagementAgentsInstallTypeAgent ListManagementAgentsInstallTypeEnum = "AGENT"
ListManagementAgentsInstallTypeGateway ListManagementAgentsInstallTypeEnum = "GATEWAY"
)
func GetListManagementAgentsInstallTypeEnumValues() []ListManagementAgentsInstallTypeEnum
GetListManagementAgentsInstallTypeEnumValues Enumerates the set of values for ListManagementAgentsInstallTypeEnum
func GetMappingListManagementAgentsInstallTypeEnum(val string) (ListManagementAgentsInstallTypeEnum, bool)
GetMappingListManagementAgentsInstallTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementAgentsLifecycleStateEnum Enum with underlying type: string
type ListManagementAgentsLifecycleStateEnum string
Set of constants representing the allowable values for ListManagementAgentsLifecycleStateEnum
const (
ListManagementAgentsLifecycleStateCreating ListManagementAgentsLifecycleStateEnum = "CREATING"
ListManagementAgentsLifecycleStateUpdating ListManagementAgentsLifecycleStateEnum = "UPDATING"
ListManagementAgentsLifecycleStateActive ListManagementAgentsLifecycleStateEnum = "ACTIVE"
ListManagementAgentsLifecycleStateInactive ListManagementAgentsLifecycleStateEnum = "INACTIVE"
ListManagementAgentsLifecycleStateTerminated ListManagementAgentsLifecycleStateEnum = "TERMINATED"
ListManagementAgentsLifecycleStateDeleting ListManagementAgentsLifecycleStateEnum = "DELETING"
ListManagementAgentsLifecycleStateDeleted ListManagementAgentsLifecycleStateEnum = "DELETED"
ListManagementAgentsLifecycleStateFailed ListManagementAgentsLifecycleStateEnum = "FAILED"
)
func GetListManagementAgentsLifecycleStateEnumValues() []ListManagementAgentsLifecycleStateEnum
GetListManagementAgentsLifecycleStateEnumValues Enumerates the set of values for ListManagementAgentsLifecycleStateEnum
func GetMappingListManagementAgentsLifecycleStateEnum(val string) (ListManagementAgentsLifecycleStateEnum, bool)
GetMappingListManagementAgentsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementAgentsRequest wrapper for the ListManagementAgents operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/ListManagementAgents.go.html to see an example of how to use ListManagementAgentsRequest.
type ListManagementAgentsRequest struct {
// The OCID of the compartment to which a request will be scoped.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Filter to return only Management Agents having the particular Plugin installed. A special pluginName of 'None' can be provided and this will return only Management Agents having no plugin installed.
PluginName []string `contributesTo:"query" name:"pluginName" collectionFormat:"multi"`
// Filter to return only Management Agents having the particular agent version.
Version []string `contributesTo:"query" name:"version" collectionFormat:"multi"`
// Filter to return only Management Agents having the particular display name.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Filter to return only Management Agents in the particular lifecycle state.
LifecycleState ListManagementAgentsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Filter to return only Management Agents in the particular availability status.
AvailabilityStatus ListManagementAgentsAvailabilityStatusEnum `mandatory:"false" contributesTo:"query" name:"availabilityStatus" omitEmpty:"true"`
// Filter to return only Management Agents having the particular agent host id.
HostId *string `mandatory:"false" contributesTo:"query" name:"hostId"`
// Filter to return only results having the particular platform type.
PlatformType []PlatformTypesEnum `contributesTo:"query" name:"platformType" omitEmpty:"true" collectionFormat:"multi"`
// true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
IsCustomerDeployed *bool `mandatory:"false" contributesTo:"query" name:"isCustomerDeployed"`
// A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.
InstallType ListManagementAgentsInstallTypeEnum `mandatory:"false" contributesTo:"query" name:"installType" omitEmpty:"true"`
// Filter to return only results having the particular gatewayId.
GatewayId []string `contributesTo:"query" name:"gatewayId" collectionFormat:"multi"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This 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 ListManagementAgentsSortOrderEnum `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 default.
SortBy ListManagementAgentsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
CompartmentIdInSubtree *bool `mandatory:"false" contributesTo:"query" name:"compartmentIdInSubtree"`
// When the value is "ACCESSIBLE", insufficient permissions for a compartment will filter out resources in that compartment without rejecting the request.
AccessLevel *string `mandatory:"false" contributesTo:"query" name:"accessLevel"`
// The type of the dataSource.
DataSourceType ListManagementAgentsDataSourceTypeEnum `mandatory:"false" contributesTo:"query" name:"dataSourceType" omitEmpty:"true"`
// Unique name of the dataSource.
DataSourceName []string `contributesTo:"query" name:"dataSourceName" collectionFormat:"multi"`
// 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 ListManagementAgentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListManagementAgentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListManagementAgentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListManagementAgentsRequest) String() string
func (request ListManagementAgentsRequest) 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
ListManagementAgentsResponse wrapper for the ListManagementAgents operation
type ListManagementAgentsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ManagementAgentSummary instances
Items []ManagementAgentSummary `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 ListManagementAgentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListManagementAgentsResponse) String() string
ListManagementAgentsSortByEnum Enum with underlying type: string
type ListManagementAgentsSortByEnum string
Set of constants representing the allowable values for ListManagementAgentsSortByEnum
const (
ListManagementAgentsSortByTimecreated ListManagementAgentsSortByEnum = "timeCreated"
ListManagementAgentsSortByDisplayname ListManagementAgentsSortByEnum = "displayName"
ListManagementAgentsSortByHost ListManagementAgentsSortByEnum = "host"
ListManagementAgentsSortByAvailabilitystatus ListManagementAgentsSortByEnum = "availabilityStatus"
ListManagementAgentsSortByPlatformtype ListManagementAgentsSortByEnum = "platformType"
ListManagementAgentsSortByPlugindisplaynames ListManagementAgentsSortByEnum = "pluginDisplayNames"
ListManagementAgentsSortByVersion ListManagementAgentsSortByEnum = "version"
)
func GetListManagementAgentsSortByEnumValues() []ListManagementAgentsSortByEnum
GetListManagementAgentsSortByEnumValues Enumerates the set of values for ListManagementAgentsSortByEnum
func GetMappingListManagementAgentsSortByEnum(val string) (ListManagementAgentsSortByEnum, bool)
GetMappingListManagementAgentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListManagementAgentsSortOrderEnum Enum with underlying type: string
type ListManagementAgentsSortOrderEnum string
Set of constants representing the allowable values for ListManagementAgentsSortOrderEnum
const (
ListManagementAgentsSortOrderAsc ListManagementAgentsSortOrderEnum = "ASC"
ListManagementAgentsSortOrderDesc ListManagementAgentsSortOrderEnum = "DESC"
)
func GetListManagementAgentsSortOrderEnumValues() []ListManagementAgentsSortOrderEnum
GetListManagementAgentsSortOrderEnumValues Enumerates the set of values for ListManagementAgentsSortOrderEnum
func GetMappingListManagementAgentsSortOrderEnum(val string) (ListManagementAgentsSortOrderEnum, bool)
GetMappingListManagementAgentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may
SortBy ListWorkRequestErrorsSortByEnum `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 ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequestError instances
Items []WorkRequestError `presentIn:"body"`
// 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"`
// 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 ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may
SortBy ListWorkRequestLogsSortByEnum `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 ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequestLogEntry instances
Items []WorkRequestLogEntry `presentIn:"body"`
// 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"`
// 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 ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID of the compartment to which a request will be scoped.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The ManagementAgentID of the agent from which the Management Agents to be filtered.
AgentId *string `mandatory:"false" contributesTo:"query" name:"agentId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The OperationStatus of the workRequest
Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// The OperationType of the workRequest
Type []OperationTypesEnum `contributesTo:"query" name:"type" omitEmpty:"true" collectionFormat:"multi"`
// Filter for items with timeCreated greater or equal to provided value.
// given `timeCreatedGreaterThanOrEqualTo` to the current time, in "YYYY-MM-ddThh:mmZ" format with a
// Z offset, as defined by RFC 3339.
TimeCreatedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedGreaterThanOrEqualTo"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. If no value is specified timeAccepted is default.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequestSummary instances
Items []WorkRequestSummary `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 ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const (
ListWorkRequestsStatusCreated ListWorkRequestsStatusEnum = "CREATED"
ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING"
ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ManagementAgent The details of the Management Agent inventory including the associated plugins.
type ManagementAgent struct {
// agent identifier
Id *string `mandatory:"true" json:"id"`
// Management Agent Version
Version *string `mandatory:"true" json:"version"`
// Compartment Identifier
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// agent install key identifier
InstallKeyId *string `mandatory:"false" json:"installKeyId"`
// Management Agent Name
DisplayName *string `mandatory:"false" json:"displayName"`
// Platform Type
PlatformType PlatformTypesEnum `mandatory:"false" json:"platformType,omitempty"`
// Platform Name
PlatformName *string `mandatory:"false" json:"platformName"`
// Platform Version
PlatformVersion *string `mandatory:"false" json:"platformVersion"`
// Version of the deployment artifact instantiated by this Management Agent.
// The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes
// (whose artifacts are based upon Standalone but can advance independently)
// is YYMMDD.HHMM.VVVVVVVVVVVV.
// VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999
ResourceArtifactVersion *string `mandatory:"false" json:"resourceArtifactVersion"`
// Management Agent host machine name
Host *string `mandatory:"false" json:"host"`
// Host resource ocid
HostId *string `mandatory:"false" json:"hostId"`
// Path where Management Agent is installed
InstallPath *string `mandatory:"false" json:"installPath"`
// list of managementAgentPlugins associated with the agent
PluginList []ManagementAgentPluginDetails `mandatory:"false" json:"pluginList"`
// true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference.
IsAgentAutoUpgradable *bool `mandatory:"false" json:"isAgentAutoUpgradable"`
// The time the Management Agent was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the Management Agent was updated. An RFC3339 formatted datetime string
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The time the Management Agent has last recorded its health status in telemetry. This value will be null if the agent has not recorded its health status in last 7 days. An RFC3339 formatted datetime string
TimeLastHeartbeat *common.SDKTime `mandatory:"false" json:"timeLastHeartbeat"`
// The current availability status of managementAgent
AvailabilityStatus AvailabilityStatusEnum `mandatory:"false" json:"availabilityStatus,omitempty"`
// The current state of managementAgent
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
IsCustomerDeployed *bool `mandatory:"false" json:"isCustomerDeployed"`
// The install type, either AGENT or GATEWAY
InstallType InstallTypesEnum `mandatory:"false" json:"installType,omitempty"`
// Additional properties for this Management Agent
ManagementAgentProperties []ManagementAgentProperty `mandatory:"false" json:"managementAgentProperties"`
// list of dataSources associated with the agent
DataSourceList []DataSource `mandatory:"false" json:"dataSourceList"`
// 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 ManagementAgent) String() string
func (m *ManagementAgent) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ManagementAgent) 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
ManagementAgentAggregation A count of Management Agents sharing the values for specified dimensions.
type ManagementAgentAggregation struct {
Dimensions *ManagementAgentAggregationDimensions `mandatory:"false" json:"dimensions"`
// The number of Management Agents in this group
Count *int `mandatory:"false" json:"count"`
}
func (m ManagementAgentAggregation) String() string
func (m ManagementAgentAggregation) 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
ManagementAgentAggregationCollection The summary of Management Agent count items
type ManagementAgentAggregationCollection struct {
// List in which each item describes an aggregation of Managment Agents
Items []ManagementAgentAggregation `mandatory:"true" json:"items"`
}
func (m ManagementAgentAggregationCollection) String() string
func (m ManagementAgentAggregationCollection) 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
ManagementAgentAggregationDimensions The Aggregation of Management Agent Dimensions
type ManagementAgentAggregationDimensions struct {
// The availability status of managementAgent
AvailabilityStatus AvailabilityStatusEnum `mandatory:"false" json:"availabilityStatus,omitempty"`
// Platform Type
PlatformType PlatformTypesEnum `mandatory:"false" json:"platformType,omitempty"`
// Agent image version
Version *string `mandatory:"false" json:"version"`
// Whether or not a managementAgent has at least one plugin
HasPlugins *bool `mandatory:"false" json:"hasPlugins"`
// The install type, either AGENT or GATEWAY
InstallType InstallTypesEnum `mandatory:"false" json:"installType,omitempty"`
}
func (m ManagementAgentAggregationDimensions) String() string
func (m ManagementAgentAggregationDimensions) 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
ManagementAgentClient a client for ManagementAgent
type ManagementAgentClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewManagementAgentClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ManagementAgentClient, err error)
NewManagementAgentClientWithConfigurationProvider Creates a new default ManagementAgent client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewManagementAgentClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ManagementAgentClient, err error)
NewManagementAgentClientWithOboToken Creates a new default ManagementAgent 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 *ManagementAgentClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ManagementAgentClient) CreateDataSource(ctx context.Context, request CreateDataSourceRequest) (response CreateDataSourceResponse, err error)
CreateDataSource Datasource creation request to given Management Agent.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/CreateDataSource.go.html to see an example of how to use CreateDataSource API.
func (client ManagementAgentClient) CreateManagementAgentInstallKey(ctx context.Context, request CreateManagementAgentInstallKeyRequest) (response CreateManagementAgentInstallKeyResponse, err error)
CreateManagementAgentInstallKey User creates a new install key as part of this API.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/CreateManagementAgentInstallKey.go.html to see an example of how to use CreateManagementAgentInstallKey API.
func (client ManagementAgentClient) DeleteDataSource(ctx context.Context, request DeleteDataSourceRequest) (response DeleteDataSourceResponse, err error)
DeleteDataSource Datasource delete request to given Management Agent.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/DeleteDataSource.go.html to see an example of how to use DeleteDataSource API.
func (client ManagementAgentClient) DeleteManagementAgent(ctx context.Context, request DeleteManagementAgentRequest) (response DeleteManagementAgentResponse, err error)
DeleteManagementAgent Deletes a Management Agent resource by identifier
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/DeleteManagementAgent.go.html to see an example of how to use DeleteManagementAgent API.
func (client ManagementAgentClient) DeleteManagementAgentInstallKey(ctx context.Context, request DeleteManagementAgentInstallKeyRequest) (response DeleteManagementAgentInstallKeyResponse, err error)
DeleteManagementAgentInstallKey Deletes a Management Agent install Key resource by identifier
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/DeleteManagementAgentInstallKey.go.html to see an example of how to use DeleteManagementAgentInstallKey API.
func (client ManagementAgentClient) DeleteWorkRequest(ctx context.Context, request DeleteWorkRequestRequest) (response DeleteWorkRequestResponse, err error)
DeleteWorkRequest Cancel the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/DeleteWorkRequest.go.html to see an example of how to use DeleteWorkRequest API.
func (client ManagementAgentClient) DeployPlugins(ctx context.Context, request DeployPluginsRequest) (response DeployPluginsResponse, err error)
DeployPlugins Deploys Plugins to a given list of agentIds.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/DeployPlugins.go.html to see an example of how to use DeployPlugins API.
func (client ManagementAgentClient) GetAutoUpgradableConfig(ctx context.Context, request GetAutoUpgradableConfigRequest) (response GetAutoUpgradableConfigResponse, err error)
GetAutoUpgradableConfig Get the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/GetAutoUpgradableConfig.go.html to see an example of how to use GetAutoUpgradableConfig API.
func (client ManagementAgentClient) GetDataSource(ctx context.Context, request GetDataSourceRequest) (response GetDataSourceResponse, err error)
GetDataSource Get Datasource details for given Id and given Management Agent.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/GetDataSource.go.html to see an example of how to use GetDataSource API.
func (client ManagementAgentClient) GetManagementAgent(ctx context.Context, request GetManagementAgentRequest) (response GetManagementAgentResponse, err error)
GetManagementAgent Gets complete details of the inventory of a given agent id
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/GetManagementAgent.go.html to see an example of how to use GetManagementAgent API.
func (client ManagementAgentClient) GetManagementAgentInstallKey(ctx context.Context, request GetManagementAgentInstallKeyRequest) (response GetManagementAgentInstallKeyResponse, err error)
GetManagementAgentInstallKey Gets complete details of the Agent install Key for a given key id
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/GetManagementAgentInstallKey.go.html to see an example of how to use GetManagementAgentInstallKey API.
func (client ManagementAgentClient) GetManagementAgentInstallKeyContent(ctx context.Context, request GetManagementAgentInstallKeyContentRequest) (response GetManagementAgentInstallKeyContentResponse, err error)
GetManagementAgentInstallKeyContent Returns a file with Management Agent install Key in it
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/GetManagementAgentInstallKeyContent.go.html to see an example of how to use GetManagementAgentInstallKeyContent API.
func (client ManagementAgentClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API.
func (client ManagementAgentClient) ListAvailabilityHistories(ctx context.Context, request ListAvailabilityHistoriesRequest) (response ListAvailabilityHistoriesResponse, err error)
ListAvailabilityHistories Lists the availability history records of Management Agent
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/ListAvailabilityHistories.go.html to see an example of how to use ListAvailabilityHistories API.
func (client ManagementAgentClient) ListDataSources(ctx context.Context, request ListDataSourcesRequest) (response ListDataSourcesResponse, err error)
ListDataSources A list of Management Agent Data Sources for the given Management Agent Id.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/ListDataSources.go.html to see an example of how to use ListDataSources API.
func (client ManagementAgentClient) ListManagementAgentImages(ctx context.Context, request ListManagementAgentImagesRequest) (response ListManagementAgentImagesResponse, err error)
ListManagementAgentImages Get supported agent image information
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/ListManagementAgentImages.go.html to see an example of how to use ListManagementAgentImages API.
func (client ManagementAgentClient) ListManagementAgentInstallKeys(ctx context.Context, request ListManagementAgentInstallKeysRequest) (response ListManagementAgentInstallKeysResponse, err error)
ListManagementAgentInstallKeys Returns a list of Management Agent installed Keys.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/ListManagementAgentInstallKeys.go.html to see an example of how to use ListManagementAgentInstallKeys API.
func (client ManagementAgentClient) ListManagementAgentPlugins(ctx context.Context, request ListManagementAgentPluginsRequest) (response ListManagementAgentPluginsResponse, err error)
ListManagementAgentPlugins Returns a list of managementAgentPlugins.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/ListManagementAgentPlugins.go.html to see an example of how to use ListManagementAgentPlugins API.
func (client ManagementAgentClient) ListManagementAgents(ctx context.Context, request ListManagementAgentsRequest) (response ListManagementAgentsResponse, err error)
ListManagementAgents Returns a list of Management Agents. If no explicit page size limit is specified, it will default to 1000 when compartmentIdInSubtree is true and 5000 otherwise. The response is limited to maximum 1000 records when compartmentIdInSubtree is true.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/ListManagementAgents.go.html to see an example of how to use ListManagementAgents API.
func (client ManagementAgentClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Return a (paginated) list of errors for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API.
func (client ManagementAgentClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Return a (paginated) list of logs for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API.
func (client ManagementAgentClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.
func (client ManagementAgentClient) SetAutoUpgradableConfig(ctx context.Context, request SetAutoUpgradableConfigRequest) (response SetAutoUpgradableConfigResponse, err error)
SetAutoUpgradableConfig Sets the AutoUpgradable configuration for all agents in a tenancy. The supplied compartmentId must be a tenancy root.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/SetAutoUpgradableConfig.go.html to see an example of how to use SetAutoUpgradableConfig API.
func (client *ManagementAgentClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client ManagementAgentClient) SummarizeManagementAgentCounts(ctx context.Context, request SummarizeManagementAgentCountsRequest) (response SummarizeManagementAgentCountsResponse, err error)
SummarizeManagementAgentCounts Gets count of the inventory of agents for a given compartment id, group by, and isPluginDeployed parameters. Supported groupBy parameters: availabilityStatus, platformType, version
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/SummarizeManagementAgentCounts.go.html to see an example of how to use SummarizeManagementAgentCounts API.
func (client ManagementAgentClient) SummarizeManagementAgentPluginCounts(ctx context.Context, request SummarizeManagementAgentPluginCountsRequest) (response SummarizeManagementAgentPluginCountsResponse, err error)
SummarizeManagementAgentPluginCounts Gets count of the inventory of management agent plugins for a given compartment id and group by parameter. Supported groupBy parameter: pluginName
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/SummarizeManagementAgentPluginCounts.go.html to see an example of how to use SummarizeManagementAgentPluginCounts API.
func (client ManagementAgentClient) UpdateDataSource(ctx context.Context, request UpdateDataSourceRequest) (response UpdateDataSourceResponse, err error)
UpdateDataSource Datasource update request to given Management Agent.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/UpdateDataSource.go.html to see an example of how to use UpdateDataSource API.
func (client ManagementAgentClient) UpdateManagementAgent(ctx context.Context, request UpdateManagementAgentRequest) (response UpdateManagementAgentResponse, err error)
UpdateManagementAgent API to update the console managed properties of the Management Agent.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/UpdateManagementAgent.go.html to see an example of how to use UpdateManagementAgent API.
func (client ManagementAgentClient) UpdateManagementAgentInstallKey(ctx context.Context, request UpdateManagementAgentInstallKeyRequest) (response UpdateManagementAgentInstallKeyResponse, err error)
UpdateManagementAgentInstallKey API to update the modifiable properties of the Management Agent install key.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/UpdateManagementAgentInstallKey.go.html to see an example of how to use UpdateManagementAgentInstallKey API.
ManagementAgentError Error Information.
type ManagementAgentError struct {
// A short error code that defines the error, meant for programmatic parsing.
Code *string `mandatory:"true" json:"code"`
// A human-readable error string.
Message *string `mandatory:"true" json:"message"`
}
func (m ManagementAgentError) String() string
func (m ManagementAgentError) 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
ManagementAgentGroupByEnum Enum with underlying type: string
type ManagementAgentGroupByEnum string
Set of constants representing the allowable values for ManagementAgentGroupByEnum
const (
ManagementAgentGroupByAvailabilityStatus ManagementAgentGroupByEnum = "availabilityStatus"
ManagementAgentGroupByPlatformType ManagementAgentGroupByEnum = "platformType"
ManagementAgentGroupByVersion ManagementAgentGroupByEnum = "version"
)
func GetManagementAgentGroupByEnumValues() []ManagementAgentGroupByEnum
GetManagementAgentGroupByEnumValues Enumerates the set of values for ManagementAgentGroupByEnum
func GetMappingManagementAgentGroupByEnum(val string) (ManagementAgentGroupByEnum, bool)
GetMappingManagementAgentGroupByEnum performs case Insensitive comparison on enum value and return the desired enum
ManagementAgentImage Supported Agent downloads
type ManagementAgentImage struct {
// Agent image resource id
Id *string `mandatory:"true" json:"id"`
// Agent image platform type
PlatformType PlatformTypesEnum `mandatory:"true" json:"platformType"`
// Agent image version
Version *string `mandatory:"true" json:"version"`
// Agent image platform display name
PlatformName *string `mandatory:"false" json:"platformName"`
// The installation package type
PackageType PackageTypesEnum `mandatory:"false" json:"packageType,omitempty"`
// The installation package target architecture type
PackageArchitectureType ArchitectureTypesEnum `mandatory:"false" json:"packageArchitectureType,omitempty"`
// Agent image size in bytes
Size *float32 `mandatory:"false" json:"size"`
// Agent image content SHA256 Hash
Checksum *string `mandatory:"false" json:"checksum"`
// Object storage URL for download
ObjectUrl *string `mandatory:"false" json:"objectUrl"`
ImageObjectStorageDetails *ObjectDetails `mandatory:"false" json:"imageObjectStorageDetails"`
// The current state of Management Agent Image
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}
func (m ManagementAgentImage) String() string
func (m ManagementAgentImage) 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
ManagementAgentImageSummary Supported Agent downloads
type ManagementAgentImageSummary struct {
// Agent image resource id
Id *string `mandatory:"true" json:"id"`
// Agent image platform type
PlatformType PlatformTypesEnum `mandatory:"true" json:"platformType"`
// Agent image version
Version *string `mandatory:"true" json:"version"`
// Agent image platform display name
PlatformName *string `mandatory:"false" json:"platformName"`
// The installation package type
PackageType PackageTypesEnum `mandatory:"false" json:"packageType,omitempty"`
// The installation package target architecture type
PackageArchitectureType ArchitectureTypesEnum `mandatory:"false" json:"packageArchitectureType,omitempty"`
// Agent image size in bytes
Size *float32 `mandatory:"false" json:"size"`
// Agent image content SHA256 Hash
Checksum *string `mandatory:"false" json:"checksum"`
// Object storage URL for download
ObjectUrl *string `mandatory:"false" json:"objectUrl"`
ImageObjectStorageDetails *ObjectDetails `mandatory:"false" json:"imageObjectStorageDetails"`
// The current state of Management Agent Image
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}
func (m ManagementAgentImageSummary) String() string
func (m ManagementAgentImageSummary) 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
ManagementAgentInstallKey The details of the Agent install Key
type ManagementAgentInstallKey struct {
// Agent install Key identifier
Id *string `mandatory:"true" json:"id"`
// Compartment Identifier
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Management Agent Install Key Name
DisplayName *string `mandatory:"false" json:"displayName"`
// Management Agent Install Key
Key *string `mandatory:"false" json:"key"`
// Principal id of user who created the Agent Install key
CreatedByPrincipalId *string `mandatory:"false" json:"createdByPrincipalId"`
// Total number of install for this keys
AllowedKeyInstallCount *int `mandatory:"false" json:"allowedKeyInstallCount"`
// Total number of install for this keys
CurrentKeyInstallCount *int `mandatory:"false" json:"currentKeyInstallCount"`
// Status of Key
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// date after which key would expire after creation
TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`
// The time when Management Agent install Key was created. An RFC3339 formatted date time string
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time when Management Agent install Key was updated. An RFC3339 formatted date time string
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// If set to true, the install key has no expiration date or usage limit. Defaults to false
IsUnlimited *bool `mandatory:"false" json:"isUnlimited"`
}
func (m ManagementAgentInstallKey) String() string
func (m ManagementAgentInstallKey) 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
ManagementAgentInstallKeySummary The summary of the Agent Install Key details.
type ManagementAgentInstallKeySummary struct {
// Agent Install Key identifier
Id *string `mandatory:"true" json:"id"`
// Compartment Identifier
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Management Agent Install Key Name
DisplayName *string `mandatory:"false" json:"displayName"`
// Principal id of user who created the Agent Install key
CreatedByPrincipalId *string `mandatory:"false" json:"createdByPrincipalId"`
// Total number of install for this keys
AllowedKeyInstallCount *int `mandatory:"false" json:"allowedKeyInstallCount"`
// Total number of install for this keys
CurrentKeyInstallCount *int `mandatory:"false" json:"currentKeyInstallCount"`
// Status of Key
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The time when Management Agent install Key was created. An RFC3339 formatted date time string
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// date after which key would expire after creation
TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`
// If set to true, the install key has no expiration date or usage limit. Properties allowedKeyInstallCount and timeExpires are ignored if set to true. Defaults to false.
IsUnlimited *bool `mandatory:"false" json:"isUnlimited"`
}
func (m ManagementAgentInstallKeySummary) String() string
func (m ManagementAgentInstallKeySummary) 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
ManagementAgentPlugin Summary of the ManagementAgentPlugin.
type ManagementAgentPlugin struct {
// Management Agent Plugin Id
Id *string `mandatory:"true" json:"id"`
// Management Agent Plugin Name
Name *string `mandatory:"true" json:"name"`
// The current state of Management Agent Plugin
LifecycleState LifecycleStatesEnum `mandatory:"true" json:"lifecycleState"`
// Management Agent Plugin Version
Version *int `mandatory:"false" json:"version"`
// Supported Platform Types
SupportedPlatformTypes []PlatformTypesEnum `mandatory:"false" json:"supportedPlatformTypes,omitempty"`
// Management Agent Plugin Display Name
DisplayName *string `mandatory:"false" json:"displayName"`
// Management Agent Plugin description
Description *string `mandatory:"false" json:"description"`
// A flag to indicate whether a given plugin can be deployed from Agent Console UI or not.
IsConsoleDeployable *bool `mandatory:"false" json:"isConsoleDeployable"`
}
func (m ManagementAgentPlugin) String() string
func (m ManagementAgentPlugin) 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
ManagementAgentPluginAggregation A count of Management Agents Plugins sharing the values for specified dimensions.
type ManagementAgentPluginAggregation struct {
Dimensions *ManagementAgentPluginAggregationDimensions `mandatory:"false" json:"dimensions"`
// The number of Management Agent Plugins in this group
Count *int `mandatory:"false" json:"count"`
}
func (m ManagementAgentPluginAggregation) String() string
func (m ManagementAgentPluginAggregation) 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
ManagementAgentPluginAggregationCollection The summary of Management Agent Plugin count items
type ManagementAgentPluginAggregationCollection struct {
// List in which each item describes an aggregation of Managment Agent Plugins
Items []ManagementAgentPluginAggregation `mandatory:"true" json:"items"`
}
func (m ManagementAgentPluginAggregationCollection) String() string
func (m ManagementAgentPluginAggregationCollection) 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
ManagementAgentPluginAggregationDimensions The Aggregation of Management Agent Plugin Dimensions
type ManagementAgentPluginAggregationDimensions struct {
// Management Agent Plugin Name
PluginName *string `mandatory:"false" json:"pluginName"`
// Management Agent Plugin Display Name
PluginDisplayName *string `mandatory:"false" json:"pluginDisplayName"`
}
func (m ManagementAgentPluginAggregationDimensions) String() string
func (m ManagementAgentPluginAggregationDimensions) 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
ManagementAgentPluginDetails The information about the current management agent plugins that agent is having.
type ManagementAgentPluginDetails struct {
// Management Agent Plugin Name
PluginName *string `mandatory:"true" json:"pluginName"`
// Plugin Id
PluginId *string `mandatory:"false" json:"pluginId"`
// Management Agent Plugin Identifier, can be renamed
PluginDisplayName *string `mandatory:"false" json:"pluginDisplayName"`
// Plugin Version
PluginVersion *string `mandatory:"false" json:"pluginVersion"`
// Plugin Status
PluginStatus PluginStatusEnum `mandatory:"false" json:"pluginStatus,omitempty"`
// Status message of the Plugin
PluginStatusMessage *string `mandatory:"false" json:"pluginStatusMessage"`
// flag indicating whether the plugin is in enabled mode or disabled mode.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
}
func (m ManagementAgentPluginDetails) String() string
func (m ManagementAgentPluginDetails) 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
ManagementAgentPluginGroupByEnum Enum with underlying type: string
type ManagementAgentPluginGroupByEnum string
Set of constants representing the allowable values for ManagementAgentPluginGroupByEnum
const (
ManagementAgentPluginGroupByPluginName ManagementAgentPluginGroupByEnum = "pluginName"
)
func GetManagementAgentPluginGroupByEnumValues() []ManagementAgentPluginGroupByEnum
GetManagementAgentPluginGroupByEnumValues Enumerates the set of values for ManagementAgentPluginGroupByEnum
func GetMappingManagementAgentPluginGroupByEnum(val string) (ManagementAgentPluginGroupByEnum, bool)
GetMappingManagementAgentPluginGroupByEnum performs case Insensitive comparison on enum value and return the desired enum
ManagementAgentPluginSummary Summary of the ManagementAgentPlugin.
type ManagementAgentPluginSummary struct {
// Management Agent Plugin Id
Id *string `mandatory:"true" json:"id"`
// Management Agent Plugin Name
Name *string `mandatory:"true" json:"name"`
// The current state of Management Agent Plugin
LifecycleState LifecycleStatesEnum `mandatory:"true" json:"lifecycleState"`
// Management Agent Plugin Version
Version *int `mandatory:"false" json:"version"`
// Supported Platform Types
SupportedPlatformTypes []PlatformTypesEnum `mandatory:"false" json:"supportedPlatformTypes,omitempty"`
// Management Agent Plugin Display Name
DisplayName *string `mandatory:"false" json:"displayName"`
// Management Agent Plugin description
Description *string `mandatory:"false" json:"description"`
// A flag to indicate whether a given plugin can be deployed from Agent Console UI or not.
IsConsoleDeployable *bool `mandatory:"false" json:"isConsoleDeployable"`
}
func (m ManagementAgentPluginSummary) String() string
func (m ManagementAgentPluginSummary) 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
ManagementAgentProperty Property item in name/value pair, with optional unit type.
type ManagementAgentProperty struct {
// Name of the property
Name *string `mandatory:"true" json:"name"`
// Values of the property
Values []string `mandatory:"true" json:"values"`
// Unit for the property
Units PropertyUnitsEnum `mandatory:"false" json:"units,omitempty"`
}
func (m ManagementAgentProperty) String() string
func (m ManagementAgentProperty) 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
ManagementAgentSummary The summary of the Management Agent inventory including the associated plugins.
type ManagementAgentSummary struct {
// agent identifier
Id *string `mandatory:"true" json:"id"`
// Management Agent Version
Version *string `mandatory:"true" json:"version"`
// Compartment Identifier
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// agent install key identifier
InstallKeyId *string `mandatory:"false" json:"installKeyId"`
// Management Agent Name
DisplayName *string `mandatory:"false" json:"displayName"`
// Platform Type
PlatformType PlatformTypesEnum `mandatory:"false" json:"platformType,omitempty"`
// Platform Name
PlatformName *string `mandatory:"false" json:"platformName"`
// Platform Version
PlatformVersion *string `mandatory:"false" json:"platformVersion"`
// Version of the deployment artifact instantiated by this Management Agent.
// The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes
// (whose artifacts are based upon Standalone but can advance independently)
// is YYMMDD.HHMM.VVVVVVVVVVVV.
// VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999
ResourceArtifactVersion *string `mandatory:"false" json:"resourceArtifactVersion"`
// true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference.
IsAgentAutoUpgradable *bool `mandatory:"false" json:"isAgentAutoUpgradable"`
// The time the Management Agent was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the Management Agent was last updated. An RFC3339 formatted datetime string
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Management Agent host machine name
Host *string `mandatory:"false" json:"host"`
// Host resource ocid
HostId *string `mandatory:"false" json:"hostId"`
// list of managementAgentPlugins associated with the agent
PluginList []ManagementAgentPluginDetails `mandatory:"false" json:"pluginList"`
// The time the Management Agent has last recorded its heartbeat. An RFC3339 formatted datetime string
TimeLastHeartbeat *common.SDKTime `mandatory:"false" json:"timeLastHeartbeat"`
// The current availability status of managementAgent
AvailabilityStatus AvailabilityStatusEnum `mandatory:"false" json:"availabilityStatus,omitempty"`
// The current state of managementAgent
LifecycleState LifecycleStatesEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
IsCustomerDeployed *bool `mandatory:"false" json:"isCustomerDeployed"`
// The install type, either AGENT or GATEWAY
InstallType InstallTypesEnum `mandatory:"false" json:"installType,omitempty"`
// list of dataSources summaries associated with the agent
DataSourceSummaryList []DataSourceSummaryItem `mandatory:"false" json:"dataSourceSummaryList"`
// 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 ManagementAgentSummary) String() string
func (m *ManagementAgentSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ManagementAgentSummary) 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
MetricDimension Metric Dimension item in name/value pair
type MetricDimension struct {
// Name of the metric dimension
Name *string `mandatory:"true" json:"name"`
// Value of the metric dimension
Value *string `mandatory:"true" json:"value"`
}
func (m MetricDimension) String() string
func (m MetricDimension) 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
ObjectDetails Details of the Objectstorage object
type ObjectDetails struct {
// Objectstorage namespace reference providing the original location of this object
ObjectNamespace *string `mandatory:"true" json:"objectNamespace"`
// Objectstorage bucket reference providing the original location of this object
ObjectBucket *string `mandatory:"true" json:"objectBucket"`
// Objectstorage object name reference providing the original location of this object
ObjectName *string `mandatory:"true" json:"objectName"`
// Object storage URL for download
ObjectUrl *string `mandatory:"false" json:"objectUrl"`
// Object content SHA256 Hash
Checksum *string `mandatory:"false" json:"checksum"`
}
func (m ObjectDetails) String() string
func (m ObjectDetails) 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
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusCreated OperationStatusEnum = "CREATED"
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypesEnum Enum with underlying type: string
type OperationTypesEnum string
Set of constants representing the allowable values for OperationTypesEnum
const (
OperationTypesDeployPlugin OperationTypesEnum = "DEPLOY_PLUGIN"
OperationTypesUpgradePlugin OperationTypesEnum = "UPGRADE_PLUGIN"
OperationTypesCreateUpgradePlugins OperationTypesEnum = "CREATE_UPGRADE_PLUGINS"
OperationTypesAgentimageUpgrade OperationTypesEnum = "AGENTIMAGE_UPGRADE"
OperationTypesCreateDataSource OperationTypesEnum = "CREATE_DATA_SOURCE"
OperationTypesUpdateDataSource OperationTypesEnum = "UPDATE_DATA_SOURCE"
OperationTypesDeleteDataSource OperationTypesEnum = "DELETE_DATA_SOURCE"
)
func GetMappingOperationTypesEnum(val string) (OperationTypesEnum, bool)
GetMappingOperationTypesEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypesEnumValues() []OperationTypesEnum
GetOperationTypesEnumValues Enumerates the set of values for OperationTypesEnum
PackageTypesEnum Enum with underlying type: string
type PackageTypesEnum string
Set of constants representing the allowable values for PackageTypesEnum
const (
PackageTypesRpm PackageTypesEnum = "RPM"
PackageTypesZip PackageTypesEnum = "ZIP"
)
func GetMappingPackageTypesEnum(val string) (PackageTypesEnum, bool)
GetMappingPackageTypesEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPackageTypesEnumValues() []PackageTypesEnum
GetPackageTypesEnumValues Enumerates the set of values for PackageTypesEnum
PlatformTypesEnum Enum with underlying type: string
type PlatformTypesEnum string
Set of constants representing the allowable values for PlatformTypesEnum
const (
PlatformTypesLinux PlatformTypesEnum = "LINUX"
PlatformTypesWindows PlatformTypesEnum = "WINDOWS"
PlatformTypesSolaris PlatformTypesEnum = "SOLARIS"
PlatformTypesMacosx PlatformTypesEnum = "MACOSX"
)
func GetMappingPlatformTypesEnum(val string) (PlatformTypesEnum, bool)
GetMappingPlatformTypesEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPlatformTypesEnumValues() []PlatformTypesEnum
GetPlatformTypesEnumValues Enumerates the set of values for PlatformTypesEnum
PluginStatusEnum Enum with underlying type: string
type PluginStatusEnum string
Set of constants representing the allowable values for PluginStatusEnum
const (
PluginStatusRunning PluginStatusEnum = "RUNNING"
PluginStatusStopped PluginStatusEnum = "STOPPED"
PluginStatusInvalid PluginStatusEnum = "INVALID"
PluginStatusFailed PluginStatusEnum = "FAILED"
)
func GetMappingPluginStatusEnum(val string) (PluginStatusEnum, bool)
GetMappingPluginStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPluginStatusEnumValues() []PluginStatusEnum
GetPluginStatusEnumValues Enumerates the set of values for PluginStatusEnum
PrometheusEmitterDataSource A Prometheus data source.
type PrometheusEmitterDataSource struct {
// Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
Key *string `mandatory:"true" json:"key"`
// Unique name of the DataSource.
Name *string `mandatory:"true" json:"name"`
// Compartment owning this DataSource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the DataSource was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time the DataSource data was last received. An RFC3339 formatted datetime string
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The url through which the Prometheus Exporter publishes its metrics. (http only)
Url *string `mandatory:"true" json:"url"`
// The OCI monitoring namespace to which scraped metrics should be uploaded.
Namespace *string `mandatory:"true" json:"namespace"`
// Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.
AllowMetrics *string `mandatory:"false" json:"allowMetrics"`
// The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property).
ProxyUrl *string `mandatory:"false" json:"proxyUrl"`
// Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
ConnectionTimeout *int `mandatory:"false" json:"connectionTimeout"`
// Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
ReadTimeout *int `mandatory:"false" json:"readTimeout"`
// Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
ReadDataLimit *int `mandatory:"false" json:"readDataLimit"`
// Number in minutes. The scraping occurs at the specified interval.
ScheduleMins *int `mandatory:"false" json:"scheduleMins"`
// OCI monitoring resource group to assign the metric to.
ResourceGroup *string `mandatory:"false" json:"resourceGroup"`
// The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
MetricDimensions []MetricDimension `mandatory:"false" json:"metricDimensions"`
// State of the DataSource.
State LifecycleStatesEnum `mandatory:"true" json:"state"`
}
func (m PrometheusEmitterDataSource) GetCompartmentId() *string
GetCompartmentId returns CompartmentId
func (m PrometheusEmitterDataSource) GetKey() *string
GetKey returns Key
func (m PrometheusEmitterDataSource) GetName() *string
GetName returns Name
func (m PrometheusEmitterDataSource) GetState() LifecycleStatesEnum
GetState returns State
func (m PrometheusEmitterDataSource) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m PrometheusEmitterDataSource) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m PrometheusEmitterDataSource) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PrometheusEmitterDataSource) String() string
func (m PrometheusEmitterDataSource) 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
PrometheusEmitterDataSourceSummary A Prometheus emitter data source summary.
type PrometheusEmitterDataSourceSummary struct {
// Data source type and name identifier.
Key *string `mandatory:"true" json:"key"`
// Unique name of the dataSource.
Name *string `mandatory:"true" json:"name"`
}
func (m PrometheusEmitterDataSourceSummary) GetKey() *string
GetKey returns Key
func (m PrometheusEmitterDataSourceSummary) GetName() *string
GetName returns Name
func (m PrometheusEmitterDataSourceSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PrometheusEmitterDataSourceSummary) String() string
func (m PrometheusEmitterDataSourceSummary) 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
PrometheusEmitterDataSourceSummaryItem A Prometheus emitter data source summary.
type PrometheusEmitterDataSourceSummaryItem struct {
// Data source type and name identifier.
Key *string `mandatory:"true" json:"key"`
// Unique name of the dataSource.
Name *string `mandatory:"true" json:"name"`
}
func (m PrometheusEmitterDataSourceSummaryItem) GetKey() *string
GetKey returns Key
func (m PrometheusEmitterDataSourceSummaryItem) GetName() *string
GetName returns Name
func (m PrometheusEmitterDataSourceSummaryItem) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PrometheusEmitterDataSourceSummaryItem) String() string
func (m PrometheusEmitterDataSourceSummaryItem) 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
PropertyUnitsEnum Enum with underlying type: string
type PropertyUnitsEnum string
Set of constants representing the allowable values for PropertyUnitsEnum
const (
PropertyUnitsPercentage PropertyUnitsEnum = "PERCENTAGE"
PropertyUnitsMb PropertyUnitsEnum = "MB"
)
func GetMappingPropertyUnitsEnum(val string) (PropertyUnitsEnum, bool)
GetMappingPropertyUnitsEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPropertyUnitsEnumValues() []PropertyUnitsEnum
GetPropertyUnitsEnumValues Enumerates the set of values for PropertyUnitsEnum
SetAutoUpgradableConfigDetails Details for configuring tenancy-level agent AutoUpgradable configuration.
type SetAutoUpgradableConfigDetails struct {
// Tenancy identifier i.e, Root compartment identifier
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// true if the agents can be upgraded automatically; false if they must be upgraded manually.
IsAgentAutoUpgradable *bool `mandatory:"true" json:"isAgentAutoUpgradable"`
}
func (m SetAutoUpgradableConfigDetails) String() string
func (m SetAutoUpgradableConfigDetails) 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
SetAutoUpgradableConfigRequest wrapper for the SetAutoUpgradableConfig operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/SetAutoUpgradableConfig.go.html to see an example of how to use SetAutoUpgradableConfigRequest.
type SetAutoUpgradableConfigRequest struct {
// Details of the AutoUpgradable configuration for agents of the tenancy.
SetAutoUpgradableConfigDetails `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 SetAutoUpgradableConfigRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SetAutoUpgradableConfigRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SetAutoUpgradableConfigRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SetAutoUpgradableConfigRequest) String() string
func (request SetAutoUpgradableConfigRequest) 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
SetAutoUpgradableConfigResponse wrapper for the SetAutoUpgradableConfig operation
type SetAutoUpgradableConfigResponse struct {
// The underlying http response
RawResponse *http.Response
// The AutoUpgradableConfig instance
AutoUpgradableConfig `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"`
}
func (response SetAutoUpgradableConfigResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SetAutoUpgradableConfigResponse) String() string
SummarizeManagementAgentCountsInstallTypeEnum Enum with underlying type: string
type SummarizeManagementAgentCountsInstallTypeEnum string
Set of constants representing the allowable values for SummarizeManagementAgentCountsInstallTypeEnum
const (
SummarizeManagementAgentCountsInstallTypeAgent SummarizeManagementAgentCountsInstallTypeEnum = "AGENT"
SummarizeManagementAgentCountsInstallTypeGateway SummarizeManagementAgentCountsInstallTypeEnum = "GATEWAY"
)
func GetMappingSummarizeManagementAgentCountsInstallTypeEnum(val string) (SummarizeManagementAgentCountsInstallTypeEnum, bool)
GetMappingSummarizeManagementAgentCountsInstallTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSummarizeManagementAgentCountsInstallTypeEnumValues() []SummarizeManagementAgentCountsInstallTypeEnum
GetSummarizeManagementAgentCountsInstallTypeEnumValues Enumerates the set of values for SummarizeManagementAgentCountsInstallTypeEnum
SummarizeManagementAgentCountsRequest wrapper for the SummarizeManagementAgentCounts operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/SummarizeManagementAgentCounts.go.html to see an example of how to use SummarizeManagementAgentCountsRequest.
type SummarizeManagementAgentCountsRequest struct {
// The OCID of the compartment to which a request will be scoped.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The field by which to group Management Agents. Currently, only one groupBy dimension is supported at a time.
GroupBy []ManagementAgentGroupByEnum `contributesTo:"query" name:"groupBy" omitEmpty:"true" collectionFormat:"multi"`
// When set to true then agents that have at least one plugin deployed will be returned. When set to false only agents that have no plugins deployed will be returned.
HasPlugins *bool `mandatory:"false" contributesTo:"query" name:"hasPlugins"`
// A filter to return either agents or gateway types depending upon install type selected by user. By default both install type will be returned.
InstallType SummarizeManagementAgentCountsInstallTypeEnum `mandatory:"false" contributesTo:"query" name:"installType" omitEmpty:"true"`
// if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
CompartmentIdInSubtree *bool `mandatory:"false" contributesTo:"query" name:"compartmentIdInSubtree"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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 SummarizeManagementAgentCountsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SummarizeManagementAgentCountsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SummarizeManagementAgentCountsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SummarizeManagementAgentCountsRequest) String() string
func (request SummarizeManagementAgentCountsRequest) 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
SummarizeManagementAgentCountsResponse wrapper for the SummarizeManagementAgentCounts operation
type SummarizeManagementAgentCountsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ManagementAgentAggregationCollection instances
ManagementAgentAggregationCollection `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 SummarizeManagementAgentCountsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SummarizeManagementAgentCountsResponse) String() string
SummarizeManagementAgentPluginCountsGroupByEnum Enum with underlying type: string
type SummarizeManagementAgentPluginCountsGroupByEnum string
Set of constants representing the allowable values for SummarizeManagementAgentPluginCountsGroupByEnum
const (
SummarizeManagementAgentPluginCountsGroupByPluginname SummarizeManagementAgentPluginCountsGroupByEnum = "pluginName"
)
func GetMappingSummarizeManagementAgentPluginCountsGroupByEnum(val string) (SummarizeManagementAgentPluginCountsGroupByEnum, bool)
GetMappingSummarizeManagementAgentPluginCountsGroupByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSummarizeManagementAgentPluginCountsGroupByEnumValues() []SummarizeManagementAgentPluginCountsGroupByEnum
GetSummarizeManagementAgentPluginCountsGroupByEnumValues Enumerates the set of values for SummarizeManagementAgentPluginCountsGroupByEnum
SummarizeManagementAgentPluginCountsRequest wrapper for the SummarizeManagementAgentPluginCounts operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/SummarizeManagementAgentPluginCounts.go.html to see an example of how to use SummarizeManagementAgentPluginCountsRequest.
type SummarizeManagementAgentPluginCountsRequest struct {
// The OCID of the compartment to which a request will be scoped.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The field by which to group Management Agent Plugins
GroupBy SummarizeManagementAgentPluginCountsGroupByEnum `mandatory:"true" contributesTo:"query" name:"groupBy" omitEmpty:"true"`
// if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
CompartmentIdInSubtree *bool `mandatory:"false" contributesTo:"query" name:"compartmentIdInSubtree"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// 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 SummarizeManagementAgentPluginCountsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SummarizeManagementAgentPluginCountsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SummarizeManagementAgentPluginCountsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SummarizeManagementAgentPluginCountsRequest) String() string
func (request SummarizeManagementAgentPluginCountsRequest) 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
SummarizeManagementAgentPluginCountsResponse wrapper for the SummarizeManagementAgentPluginCounts operation
type SummarizeManagementAgentPluginCountsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ManagementAgentPluginAggregationCollection instances
ManagementAgentPluginAggregationCollection `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 SummarizeManagementAgentPluginCountsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SummarizeManagementAgentPluginCountsResponse) String() string
UpdateDataSourceDetails A request to change the data source.
type UpdateDataSourceDetails interface {
}
UpdateDataSourceRequest wrapper for the UpdateDataSource operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/UpdateDataSource.go.html to see an example of how to use UpdateDataSourceRequest.
type UpdateDataSourceRequest struct {
// Unique Management Agent identifier
ManagementAgentId *string `mandatory:"true" contributesTo:"path" name:"managementAgentId"`
// Data source type and name identifier.
DataSourceKey *string `mandatory:"true" contributesTo:"path" name:"dataSourceKey"`
// Details of DataSource to be update for the given Management Agent.
UpdateDataSourceDetails `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"`
// 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"`
// 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 UpdateDataSourceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDataSourceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDataSourceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDataSourceRequest) String() string
func (request UpdateDataSourceRequest) 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
UpdateDataSourceResponse wrapper for the UpdateDataSource operation
type UpdateDataSourceResponse 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 UpdateDataSourceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDataSourceResponse) String() string
UpdateManagementAgentDetails Details required to update console-managed properties of the Management Agent.
type UpdateManagementAgentDetails struct {
// New displayName of Agent.
DisplayName *string `mandatory:"false" json:"displayName"`
// 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 UpdateManagementAgentDetails) String() string
func (m UpdateManagementAgentDetails) 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
UpdateManagementAgentInstallKeyDetails Details required to change Management Agent install key.
type UpdateManagementAgentInstallKeyDetails struct {
// if set to true the install key state would be set to Active and if false to Inactive
IsKeyActive *bool `mandatory:"false" json:"isKeyActive"`
// New displayName of Agent install key.
DisplayName *string `mandatory:"false" json:"displayName"`
}
func (m UpdateManagementAgentInstallKeyDetails) String() string
func (m UpdateManagementAgentInstallKeyDetails) 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
UpdateManagementAgentInstallKeyRequest wrapper for the UpdateManagementAgentInstallKey operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/UpdateManagementAgentInstallKey.go.html to see an example of how to use UpdateManagementAgentInstallKeyRequest.
type UpdateManagementAgentInstallKeyRequest struct {
// Unique Management Agent Install Key identifier
ManagementAgentInstallKeyId *string `mandatory:"true" contributesTo:"path" name:"managementAgentInstallKeyId"`
// Details required for changing the modifiable properties of the Management Agent install key.
UpdateManagementAgentInstallKeyDetails `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"`
// 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"`
// 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 UpdateManagementAgentInstallKeyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateManagementAgentInstallKeyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateManagementAgentInstallKeyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateManagementAgentInstallKeyRequest) String() string
func (request UpdateManagementAgentInstallKeyRequest) 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
UpdateManagementAgentInstallKeyResponse wrapper for the UpdateManagementAgentInstallKey operation
type UpdateManagementAgentInstallKeyResponse struct {
// The underlying http response
RawResponse *http.Response
// The ManagementAgentInstallKey instance
ManagementAgentInstallKey `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateManagementAgentInstallKeyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateManagementAgentInstallKeyResponse) String() string
UpdateManagementAgentRequest wrapper for the UpdateManagementAgent operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/managementagent/UpdateManagementAgent.go.html to see an example of how to use UpdateManagementAgentRequest.
type UpdateManagementAgentRequest struct {
// Unique Management Agent identifier
ManagementAgentId *string `mandatory:"true" contributesTo:"path" name:"managementAgentId"`
// Details required for changing the console managed properties of the Management Agent.
UpdateManagementAgentDetails `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"`
// 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"`
// 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 UpdateManagementAgentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateManagementAgentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateManagementAgentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateManagementAgentRequest) String() string
func (request UpdateManagementAgentRequest) 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
UpdateManagementAgentResponse wrapper for the UpdateManagementAgent operation
type UpdateManagementAgentResponse struct {
// The underlying http response
RawResponse *http.Response
// The ManagementAgent instance
ManagementAgent `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateManagementAgentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateManagementAgentResponse) String() string
UpdatePrometheusEmitterDataSourceDetails A Prometheus data source.
type UpdatePrometheusEmitterDataSourceDetails struct {
// The url through which the Prometheus Exporter publishes its metrics. (http only)
Url *string `mandatory:"true" json:"url"`
// Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.
AllowMetrics *string `mandatory:"false" json:"allowMetrics"`
// The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property).
ProxyUrl *string `mandatory:"false" json:"proxyUrl"`
// Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
ConnectionTimeout *int `mandatory:"false" json:"connectionTimeout"`
// Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
ReadTimeout *int `mandatory:"false" json:"readTimeout"`
// Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
ReadDataLimitInKilobytes *int `mandatory:"false" json:"readDataLimitInKilobytes"`
// Number in minutes. The scraping occurs at the specified interval.
ScheduleMins *int `mandatory:"false" json:"scheduleMins"`
// OCI monitoring resource group to assign the metric to.
ResourceGroup *string `mandatory:"false" json:"resourceGroup"`
// The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
MetricDimensions []MetricDimension `mandatory:"false" json:"metricDimensions"`
}
func (m UpdatePrometheusEmitterDataSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdatePrometheusEmitterDataSourceDetails) String() string
func (m UpdatePrometheusEmitterDataSourceDetails) 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
WorkDeliveryStatusEnum Enum with underlying type: string
type WorkDeliveryStatusEnum string
Set of constants representing the allowable values for WorkDeliveryStatusEnum
const (
WorkDeliveryStatusAccepted WorkDeliveryStatusEnum = "ACCEPTED"
WorkDeliveryStatusInProgress WorkDeliveryStatusEnum = "IN_PROGRESS"
WorkDeliveryStatusFailed WorkDeliveryStatusEnum = "FAILED"
WorkDeliveryStatusSucceeded WorkDeliveryStatusEnum = "SUCCEEDED"
WorkDeliveryStatusCanceling WorkDeliveryStatusEnum = "CANCELING"
WorkDeliveryStatusCanceled WorkDeliveryStatusEnum = "CANCELED"
)
func GetMappingWorkDeliveryStatusEnum(val string) (WorkDeliveryStatusEnum, bool)
GetMappingWorkDeliveryStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkDeliveryStatusEnumValues() []WorkDeliveryStatusEnum
GetWorkDeliveryStatusEnumValues Enumerates the set of values for WorkDeliveryStatusEnum
WorkRequest A description of workrequest status
type WorkRequest struct {
// Type of the work request
OperationType OperationTypesEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The id of the work request.
Id *string `mandatory:"true" json:"id"`
// The ocid of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 5.6.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 5.6.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. Error codes are listed on
// (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm)
Code *string `mandatory:"true" json:"code"`
// A human readable description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The time the error occured. An RFC3339 formatted datetime string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntry A log message from the execution of a work request.
type WorkRequestLogEntry struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The time the log message was written. An RFC3339 formatted datetime string
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request.
// A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
// work is complete for that resource at which point it will transition to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypesEnum `mandatory:"true" json:"actionType"`
// The identifier of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The identifier of the source the work request is requesting.
SourceId *string `mandatory:"false" json:"sourceId"`
// The name of the source the work request is requesting.
SourceName *string `mandatory:"false" json:"sourceName"`
// The version of the source the work request is requesting.
SourceVersion *string `mandatory:"false" json:"sourceVersion"`
// The URI path that the user can do a GET on to access the resource metadata
EntityUri *string `mandatory:"false" json:"entityUri"`
// The date and time the request was created, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 5.6.
TimeAccepted *common.SDKTime `mandatory:"false" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 5.6.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the request was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 5.6.
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// Additional metadata about the resource that has been operated upon by
// this work request. For WorkRequests operationType WORK_DELIVERY the metadata will contain: workDeliveryStatus
// indicating the status of the work delivery item as a WorkDeliveryStatus value, workSubmissionKey the WorkSubmission request id,
// and workSubmissionDetails containing any details of result
Metadata *interface{} `mandatory:"false" json:"metadata"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestSummary A description of workrequest status
type WorkRequestSummary struct {
// Type of the work request
OperationType OperationTypesEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The id of the work request.
Id *string `mandatory:"true" json:"id"`
// The ocid of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 5.6.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"false" json:"resources"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 5.6.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkSubmissionKey Work Submission Identifier
type WorkSubmissionKey struct {
// Work Submission Identifier
WorkSubmissionKey *string `mandatory:"true" json:"workSubmissionKey"`
}
func (m WorkSubmissionKey) String() string
func (m WorkSubmissionKey) 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