func GetInstanceAgentCommandExecutionDeliveryStateEnumStringValues() []string
GetInstanceAgentCommandExecutionDeliveryStateEnumStringValues Enumerates the set of values in String for InstanceAgentCommandExecutionDeliveryStateEnum
func GetInstanceAgentCommandExecutionLifecycleStateEnumStringValues() []string
GetInstanceAgentCommandExecutionLifecycleStateEnumStringValues Enumerates the set of values in String for InstanceAgentCommandExecutionLifecycleStateEnum
func GetInstanceAgentCommandExecutionOutputContentOutputTypeEnumStringValues() []string
GetInstanceAgentCommandExecutionOutputContentOutputTypeEnumStringValues Enumerates the set of values in String for InstanceAgentCommandExecutionOutputContentOutputTypeEnum
func GetInstanceAgentCommandExecutionSummaryDeliveryStateEnumStringValues() []string
GetInstanceAgentCommandExecutionSummaryDeliveryStateEnumStringValues Enumerates the set of values in String for InstanceAgentCommandExecutionSummaryDeliveryStateEnum
func GetInstanceAgentCommandExecutionSummaryLifecycleStateEnumStringValues() []string
GetInstanceAgentCommandExecutionSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for InstanceAgentCommandExecutionSummaryLifecycleStateEnum
func GetInstanceAgentCommandOutputDetailsOutputTypeEnumStringValues() []string
GetInstanceAgentCommandOutputDetailsOutputTypeEnumStringValues Enumerates the set of values in String for InstanceAgentCommandOutputDetailsOutputTypeEnum
func GetInstanceAgentCommandSourceDetailsSourceTypeEnumStringValues() []string
GetInstanceAgentCommandSourceDetailsSourceTypeEnumStringValues Enumerates the set of values in String for InstanceAgentCommandSourceDetailsSourceTypeEnum
func GetInstanceAgentPluginStatusEnumStringValues() []string
GetInstanceAgentPluginStatusEnumStringValues Enumerates the set of values in String for InstanceAgentPluginStatusEnum
func GetInstanceAgentPluginSummaryStatusEnumStringValues() []string
GetInstanceAgentPluginSummaryStatusEnumStringValues Enumerates the set of values in String for InstanceAgentPluginSummaryStatusEnum
func GetListInstanceAgentCommandExecutionsSortByEnumStringValues() []string
GetListInstanceAgentCommandExecutionsSortByEnumStringValues Enumerates the set of values in String for ListInstanceAgentCommandExecutionsSortByEnum
func GetListInstanceAgentCommandExecutionsSortOrderEnumStringValues() []string
GetListInstanceAgentCommandExecutionsSortOrderEnumStringValues Enumerates the set of values in String for ListInstanceAgentCommandExecutionsSortOrderEnum
func GetListInstanceAgentCommandsSortByEnumStringValues() []string
GetListInstanceAgentCommandsSortByEnumStringValues Enumerates the set of values in String for ListInstanceAgentCommandsSortByEnum
func GetListInstanceAgentCommandsSortOrderEnumStringValues() []string
GetListInstanceAgentCommandsSortOrderEnumStringValues Enumerates the set of values in String for ListInstanceAgentCommandsSortOrderEnum
func GetListInstanceAgentPluginsSortByEnumStringValues() []string
GetListInstanceAgentPluginsSortByEnumStringValues Enumerates the set of values in String for ListInstanceAgentPluginsSortByEnum
func GetListInstanceAgentPluginsSortOrderEnumStringValues() []string
GetListInstanceAgentPluginsSortOrderEnumStringValues Enumerates the set of values in String for ListInstanceAgentPluginsSortOrderEnum
func GetListInstanceAgentPluginsStatusEnumStringValues() []string
GetListInstanceAgentPluginsStatusEnumStringValues Enumerates the set of values in String for ListInstanceAgentPluginsStatusEnum
func GetListInstanceagentAvailablePluginsSortByEnumStringValues() []string
GetListInstanceagentAvailablePluginsSortByEnumStringValues Enumerates the set of values in String for ListInstanceagentAvailablePluginsSortByEnum
func GetListInstanceagentAvailablePluginsSortOrderEnumStringValues() []string
GetListInstanceagentAvailablePluginsSortOrderEnumStringValues Enumerates the set of values in String for ListInstanceagentAvailablePluginsSortOrderEnum
AvailablePluginSummary Describes where the plugin is supported
type AvailablePluginSummary struct {
// The plugin name
Name *string `mandatory:"true" json:"name"`
// Is the plugin supported or not
IsSupported *bool `mandatory:"true" json:"isSupported"`
// Is the plugin enabled or disabled by default
IsEnabledByDefault *bool `mandatory:"true" json:"isEnabledByDefault"`
// A brief description of the plugin functionality
Summary *string `mandatory:"false" json:"summary"`
}
func (m AvailablePluginSummary) String() string
func (m AvailablePluginSummary) 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
CancelInstanceAgentCommandRequest wrapper for the CancelInstanceAgentCommand operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/CancelInstanceAgentCommand.go.html to see an example of how to use CancelInstanceAgentCommandRequest.
type CancelInstanceAgentCommandRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the command.
InstanceAgentCommandId *string `mandatory:"true" contributesTo:"path" name:"instanceAgentCommandId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// 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 CancelInstanceAgentCommandRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelInstanceAgentCommandRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelInstanceAgentCommandRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelInstanceAgentCommandRequest) String() string
func (request CancelInstanceAgentCommandRequest) 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
CancelInstanceAgentCommandResponse wrapper for the CancelInstanceAgentCommand operation
type CancelInstanceAgentCommandResponse 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 CancelInstanceAgentCommandResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelInstanceAgentCommandResponse) String() string
ComputeInstanceAgentClient a client for ComputeInstanceAgent
type ComputeInstanceAgentClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewComputeInstanceAgentClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ComputeInstanceAgentClient, err error)
NewComputeInstanceAgentClientWithConfigurationProvider Creates a new default ComputeInstanceAgent client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewComputeInstanceAgentClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ComputeInstanceAgentClient, err error)
NewComputeInstanceAgentClientWithOboToken Creates a new default ComputeInstanceAgent 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 ComputeInstanceAgentClient) CancelInstanceAgentCommand(ctx context.Context, request CancelInstanceAgentCommandRequest) (response CancelInstanceAgentCommandResponse, err error)
CancelInstanceAgentCommand Cancels a command that is scheduled to run on a compute instance that is managed by Oracle Cloud Agent. Canceling a command is a best-effort attempt. If the command has already completed, it will not be canceled.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/CancelInstanceAgentCommand.go.html to see an example of how to use CancelInstanceAgentCommand API.
func (client *ComputeInstanceAgentClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ComputeInstanceAgentClient) CreateInstanceAgentCommand(ctx context.Context, request CreateInstanceAgentCommandRequest) (response CreateInstanceAgentCommandResponse, err error)
CreateInstanceAgentCommand Creates a command or script to run on a compute instance that is managed by Oracle Cloud Agent. On Linux instances, the script runs in a bash shell. On Windows instances, the script runs in a batch shell. Commands that require administrator privileges will run only if Oracle Cloud Agent is running with administrator privileges.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/CreateInstanceAgentCommand.go.html to see an example of how to use CreateInstanceAgentCommand API.
func (client ComputeInstanceAgentClient) GetInstanceAgentCommand(ctx context.Context, request GetInstanceAgentCommandRequest) (response GetInstanceAgentCommandResponse, err error)
GetInstanceAgentCommand Gets information about an Oracle Cloud Agent command.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/GetInstanceAgentCommand.go.html to see an example of how to use GetInstanceAgentCommand API.
func (client ComputeInstanceAgentClient) GetInstanceAgentCommandExecution(ctx context.Context, request GetInstanceAgentCommandExecutionRequest) (response GetInstanceAgentCommandExecutionResponse, err error)
GetInstanceAgentCommandExecution Gets information about the status of specified instance agent commandId for the given instanceId.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/GetInstanceAgentCommandExecution.go.html to see an example of how to use GetInstanceAgentCommandExecution API.
func (client ComputeInstanceAgentClient) ListInstanceAgentCommandExecutions(ctx context.Context, request ListInstanceAgentCommandExecutionsRequest) (response ListInstanceAgentCommandExecutionsResponse, err error)
ListInstanceAgentCommandExecutions Lists the execution details for Oracle Cloud Agent commands that run on the specified compute instance.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/ListInstanceAgentCommandExecutions.go.html to see an example of how to use ListInstanceAgentCommandExecutions API.
func (client ComputeInstanceAgentClient) ListInstanceAgentCommands(ctx context.Context, request ListInstanceAgentCommandsRequest) (response ListInstanceAgentCommandsResponse, err error)
ListInstanceAgentCommands Lists the Oracle Cloud Agent commands issued in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/ListInstanceAgentCommands.go.html to see an example of how to use ListInstanceAgentCommands API.
func (client *ComputeInstanceAgentClient) SetRegion(region string)
SetRegion overrides the region of this client.
CreateInstanceAgentCommandDetails Creation details for an Oracle Cloud Agent command.
type CreateInstanceAgentCommandDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the command in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The amount of time that Oracle Cloud Agent is given to run the command on the instance before timing
// out. The timer starts when Oracle Cloud Agent starts the command. Zero means no timeout.
ExecutionTimeOutInSeconds *int `mandatory:"true" json:"executionTimeOutInSeconds"`
// The target instance to run the command on.
Target *InstanceAgentCommandTarget `mandatory:"true" json:"target"`
// The contents of the command.
Content *InstanceAgentCommandContent `mandatory:"true" json:"content"`
// A user-friendly name for the command. It does not have to be unique.
// Avoid entering confidential information.
// Example: `Database Backup Script`
DisplayName *string `mandatory:"false" json:"displayName"`
}
func (m CreateInstanceAgentCommandDetails) String() string
func (m CreateInstanceAgentCommandDetails) 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
CreateInstanceAgentCommandRequest wrapper for the CreateInstanceAgentCommand operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/CreateInstanceAgentCommand.go.html to see an example of how to use CreateInstanceAgentCommandRequest.
type CreateInstanceAgentCommandRequest struct {
// Create Instance agent command details
CreateInstanceAgentCommandDetails `contributesTo:"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 `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 CreateInstanceAgentCommandRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateInstanceAgentCommandRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateInstanceAgentCommandRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateInstanceAgentCommandRequest) String() string
func (request CreateInstanceAgentCommandRequest) 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
CreateInstanceAgentCommandResponse wrapper for the CreateInstanceAgentCommand operation
type CreateInstanceAgentCommandResponse struct {
// The underlying http response
RawResponse *http.Response
// The InstanceAgentCommand instance
InstanceAgentCommand `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 CreateInstanceAgentCommandResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateInstanceAgentCommandResponse) String() string
GetInstanceAgentCommandExecutionRequest wrapper for the GetInstanceAgentCommandExecution operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/GetInstanceAgentCommandExecution.go.html to see an example of how to use GetInstanceAgentCommandExecutionRequest.
type GetInstanceAgentCommandExecutionRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the command.
InstanceAgentCommandId *string `mandatory:"true" contributesTo:"path" name:"instanceAgentCommandId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance.
InstanceId *string `mandatory:"true" contributesTo:"query" name:"instanceId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetInstanceAgentCommandExecutionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetInstanceAgentCommandExecutionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetInstanceAgentCommandExecutionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetInstanceAgentCommandExecutionRequest) String() string
func (request GetInstanceAgentCommandExecutionRequest) 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
GetInstanceAgentCommandExecutionResponse wrapper for the GetInstanceAgentCommandExecution operation
type GetInstanceAgentCommandExecutionResponse struct {
// The underlying http response
RawResponse *http.Response
// The InstanceAgentCommandExecution instance
InstanceAgentCommandExecution `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 GetInstanceAgentCommandExecutionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetInstanceAgentCommandExecutionResponse) String() string
GetInstanceAgentCommandRequest wrapper for the GetInstanceAgentCommand operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/GetInstanceAgentCommand.go.html to see an example of how to use GetInstanceAgentCommandRequest.
type GetInstanceAgentCommandRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the command.
InstanceAgentCommandId *string `mandatory:"true" contributesTo:"path" name:"instanceAgentCommandId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetInstanceAgentCommandRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetInstanceAgentCommandRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetInstanceAgentCommandRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetInstanceAgentCommandRequest) String() string
func (request GetInstanceAgentCommandRequest) 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
GetInstanceAgentCommandResponse wrapper for the GetInstanceAgentCommand operation
type GetInstanceAgentCommandResponse struct {
// The underlying http response
RawResponse *http.Response
// The InstanceAgentCommand instance
InstanceAgentCommand `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 GetInstanceAgentCommandResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetInstanceAgentCommandResponse) String() string
GetInstanceAgentPluginRequest wrapper for the GetInstanceAgentPlugin operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/GetInstanceAgentPlugin.go.html to see an example of how to use GetInstanceAgentPluginRequest.
type GetInstanceAgentPluginRequest struct {
// The OCID of the instance.
InstanceagentId *string `mandatory:"true" contributesTo:"path" name:"instanceagentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The name of the plugin.
PluginName *string `mandatory:"true" contributesTo:"path" name:"pluginName"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetInstanceAgentPluginRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetInstanceAgentPluginRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetInstanceAgentPluginRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetInstanceAgentPluginRequest) String() string
func (request GetInstanceAgentPluginRequest) 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
GetInstanceAgentPluginResponse wrapper for the GetInstanceAgentPlugin operation
type GetInstanceAgentPluginResponse struct {
// The underlying http response
RawResponse *http.Response
// The InstanceAgentPlugin instance
InstanceAgentPlugin `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 GetInstanceAgentPluginResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetInstanceAgentPluginResponse) String() string
InstanceAgentCommand The command payload.
type InstanceAgentCommand struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the command.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the command.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The target instance that the command runs on.
Target *InstanceAgentCommandTarget `mandatory:"true" json:"target"`
// The contents of the command.
Content *InstanceAgentCommandContent `mandatory:"true" json:"content"`
// A user-friendly name. Does not have to be unique. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The date and time the command was created, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the command was last updated, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Whether a request was made to cancel the command. Canceling a command is a best-effort attempt.
IsCanceled *bool `mandatory:"false" json:"isCanceled"`
// The amount of time that Oracle Cloud Agent is given to run the command on the instance before timing
// out. The timer starts when Oracle Cloud Agent starts the command. Zero means no timeout.
ExecutionTimeOutInSeconds *int `mandatory:"false" json:"executionTimeOutInSeconds"`
}
func (m InstanceAgentCommand) String() string
func (m InstanceAgentCommand) 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
InstanceAgentCommandContent The contents of the command.
type InstanceAgentCommandContent struct {
// The source of the command.
Source InstanceAgentCommandSourceDetails `mandatory:"true" json:"source"`
// The output destination for the command.
Output InstanceAgentCommandOutputDetails `mandatory:"false" json:"output"`
}
func (m InstanceAgentCommandContent) String() string
func (m *InstanceAgentCommandContent) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m InstanceAgentCommandContent) 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
InstanceAgentCommandExecution A command's execution summary.
type InstanceAgentCommandExecution struct {
// The OCID of the command
InstanceAgentCommandId *string `mandatory:"true" json:"instanceAgentCommandId"`
// The OCID of the instance
InstanceId *string `mandatory:"true" json:"instanceId"`
// Specifies the command delivery state.
// * `VISIBLE` - The command is visible to instance.
// * `PENDING` - The command is pending ack from the instance.
// * `ACKED` - The command has been received and acked by the instance.
// * `ACKED_CANCELED` - The canceled command has been received and acked by the instance.
// * `EXPIRED` - The instance has not requested for commands and its delivery has expired.
DeliveryState InstanceAgentCommandExecutionDeliveryStateEnum `mandatory:"true" json:"deliveryState"`
// command execution life cycle state.
// * `ACCEPTED` - The command execution has been accepted to run.
// * `IN_PROGRESS` - The command execution is in progress.
// * `SUCCEEDED` - The command execution is successful.
// * `FAILED` - The command execution has failed.
// * `TIMED_OUT` - The command execution has timedout.
// * `CANCELED` - The command execution has canceled.
LifecycleState InstanceAgentCommandExecutionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The command creation date
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The command last updated at date.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The large non-consecutive number that Run Command Service assigns to each created command.
SequenceNumber *int64 `mandatory:"true" json:"sequenceNumber"`
Content InstanceAgentCommandExecutionOutputContent `mandatory:"true" json:"content"`
// The user friendly display name of the command.
DisplayName *string `mandatory:"false" json:"displayName"`
}
func (m InstanceAgentCommandExecution) String() string
func (m *InstanceAgentCommandExecution) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m InstanceAgentCommandExecution) 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
InstanceAgentCommandExecutionDeliveryStateEnum Enum with underlying type: string
type InstanceAgentCommandExecutionDeliveryStateEnum string
Set of constants representing the allowable values for InstanceAgentCommandExecutionDeliveryStateEnum
const (
InstanceAgentCommandExecutionDeliveryStateVisible InstanceAgentCommandExecutionDeliveryStateEnum = "VISIBLE"
InstanceAgentCommandExecutionDeliveryStatePending InstanceAgentCommandExecutionDeliveryStateEnum = "PENDING"
InstanceAgentCommandExecutionDeliveryStateAcked InstanceAgentCommandExecutionDeliveryStateEnum = "ACKED"
InstanceAgentCommandExecutionDeliveryStateAckedCanceled InstanceAgentCommandExecutionDeliveryStateEnum = "ACKED_CANCELED"
InstanceAgentCommandExecutionDeliveryStateExpired InstanceAgentCommandExecutionDeliveryStateEnum = "EXPIRED"
)
func GetInstanceAgentCommandExecutionDeliveryStateEnumValues() []InstanceAgentCommandExecutionDeliveryStateEnum
GetInstanceAgentCommandExecutionDeliveryStateEnumValues Enumerates the set of values for InstanceAgentCommandExecutionDeliveryStateEnum
func GetMappingInstanceAgentCommandExecutionDeliveryStateEnum(val string) (InstanceAgentCommandExecutionDeliveryStateEnum, bool)
GetMappingInstanceAgentCommandExecutionDeliveryStateEnum performs case Insensitive comparison on enum value and return the desired enum
InstanceAgentCommandExecutionLifecycleStateEnum Enum with underlying type: string
type InstanceAgentCommandExecutionLifecycleStateEnum string
Set of constants representing the allowable values for InstanceAgentCommandExecutionLifecycleStateEnum
const (
InstanceAgentCommandExecutionLifecycleStateAccepted InstanceAgentCommandExecutionLifecycleStateEnum = "ACCEPTED"
InstanceAgentCommandExecutionLifecycleStateInProgress InstanceAgentCommandExecutionLifecycleStateEnum = "IN_PROGRESS"
InstanceAgentCommandExecutionLifecycleStateSucceeded InstanceAgentCommandExecutionLifecycleStateEnum = "SUCCEEDED"
InstanceAgentCommandExecutionLifecycleStateFailed InstanceAgentCommandExecutionLifecycleStateEnum = "FAILED"
InstanceAgentCommandExecutionLifecycleStateTimedOut InstanceAgentCommandExecutionLifecycleStateEnum = "TIMED_OUT"
InstanceAgentCommandExecutionLifecycleStateCanceled InstanceAgentCommandExecutionLifecycleStateEnum = "CANCELED"
)
func GetInstanceAgentCommandExecutionLifecycleStateEnumValues() []InstanceAgentCommandExecutionLifecycleStateEnum
GetInstanceAgentCommandExecutionLifecycleStateEnumValues Enumerates the set of values for InstanceAgentCommandExecutionLifecycleStateEnum
func GetMappingInstanceAgentCommandExecutionLifecycleStateEnum(val string) (InstanceAgentCommandExecutionLifecycleStateEnum, bool)
GetMappingInstanceAgentCommandExecutionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
InstanceAgentCommandExecutionOutputContent The execution output from a command.
type InstanceAgentCommandExecutionOutputContent interface {
// The exit code for the command. Exit code `0` indicates success.
GetExitCode() *int
// An optional status message that Oracle Cloud Agent can populate for additional troubleshooting.
GetMessage() *string
}
InstanceAgentCommandExecutionOutputContentOutputTypeEnum Enum with underlying type: string
type InstanceAgentCommandExecutionOutputContentOutputTypeEnum string
Set of constants representing the allowable values for InstanceAgentCommandExecutionOutputContentOutputTypeEnum
const (
InstanceAgentCommandExecutionOutputContentOutputTypeText InstanceAgentCommandExecutionOutputContentOutputTypeEnum = "TEXT"
InstanceAgentCommandExecutionOutputContentOutputTypeObjectStorageUri InstanceAgentCommandExecutionOutputContentOutputTypeEnum = "OBJECT_STORAGE_URI"
InstanceAgentCommandExecutionOutputContentOutputTypeObjectStorageTuple InstanceAgentCommandExecutionOutputContentOutputTypeEnum = "OBJECT_STORAGE_TUPLE"
)
func GetInstanceAgentCommandExecutionOutputContentOutputTypeEnumValues() []InstanceAgentCommandExecutionOutputContentOutputTypeEnum
GetInstanceAgentCommandExecutionOutputContentOutputTypeEnumValues Enumerates the set of values for InstanceAgentCommandExecutionOutputContentOutputTypeEnum
func GetMappingInstanceAgentCommandExecutionOutputContentOutputTypeEnum(val string) (InstanceAgentCommandExecutionOutputContentOutputTypeEnum, bool)
GetMappingInstanceAgentCommandExecutionOutputContentOutputTypeEnum performs case Insensitive comparison on enum value and return the desired enum
InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails The execution output from a command when saved to an Object Storage bucket.
type InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails struct {
// The exit code for the command. Exit code `0` indicates success.
ExitCode *int `mandatory:"true" json:"exitCode"`
// The Object Storage bucket for the command output.
BucketName *string `mandatory:"true" json:"bucketName"`
// The Object Storage namespace for the command output.
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// The Object Storage object name for the command output.
ObjectName *string `mandatory:"true" json:"objectName"`
// An optional status message that Oracle Cloud Agent can populate for additional troubleshooting.
Message *string `mandatory:"false" json:"message"`
}
func (m InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails) GetExitCode() *int
GetExitCode returns ExitCode
func (m InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails) GetMessage() *string
GetMessage returns Message
func (m InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails) String() string
func (m InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails) 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
InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails The execution output from a command when saved to an Object Storage URL.
type InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails struct {
// The exit code for the command. Exit code `0` indicates success.
ExitCode *int `mandatory:"true" json:"exitCode"`
// The Object Storage URL or pre-authenticated request (PAR) for the command output.
OutputUri *string `mandatory:"true" json:"outputUri"`
// An optional status message that Oracle Cloud Agent can populate for additional troubleshooting.
Message *string `mandatory:"false" json:"message"`
}
func (m InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails) GetExitCode() *int
GetExitCode returns ExitCode
func (m InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails) GetMessage() *string
GetMessage returns Message
func (m InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails) String() string
func (m InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails) 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
InstanceAgentCommandExecutionOutputViaTextDetails The execution output from a command when returned in plain text.
type InstanceAgentCommandExecutionOutputViaTextDetails struct {
// The exit code for the command. Exit code `0` indicates success.
ExitCode *int `mandatory:"true" json:"exitCode"`
// An optional status message that Oracle Cloud Agent can populate for additional troubleshooting.
Message *string `mandatory:"false" json:"message"`
// The command output.
Text *string `mandatory:"false" json:"text"`
// SHA-256 checksum value of the text content.
TextSha256 *string `mandatory:"false" json:"textSha256"`
}
func (m InstanceAgentCommandExecutionOutputViaTextDetails) GetExitCode() *int
GetExitCode returns ExitCode
func (m InstanceAgentCommandExecutionOutputViaTextDetails) GetMessage() *string
GetMessage returns Message
func (m InstanceAgentCommandExecutionOutputViaTextDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m InstanceAgentCommandExecutionOutputViaTextDetails) String() string
func (m InstanceAgentCommandExecutionOutputViaTextDetails) 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
InstanceAgentCommandExecutionSummary Execution details for a command.
type InstanceAgentCommandExecutionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the command.
InstanceAgentCommandId *string `mandatory:"true" json:"instanceAgentCommandId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance.
InstanceId *string `mandatory:"true" json:"instanceId"`
// The command delivery state.
// * `VISIBLE` - The command is visible to the instance.
// * `PENDING` - The command is pending acknowledgment from the instance.
// * `ACKED` - The command has been received and acknowledged by the instance.
// * `ACKED_CANCELED` - The canceled command has been received and acknowledged by the instance.
// * `EXPIRED` - The instance has not requested for commands and the command's delivery has expired.
DeliveryState InstanceAgentCommandExecutionSummaryDeliveryStateEnum `mandatory:"true" json:"deliveryState"`
// The command execution lifecycle state.
// * `ACCEPTED` - The command has been accepted to run.
// * `IN_PROGRESS` - The command is in progress.
// * `SUCCEEDED` - The command was successfully executed.
// * `FAILED` - The command failed to execute.
// * `TIMED_OUT` - The command execution timed out.
// * `CANCELED` - The command execution was canceled.
LifecycleState InstanceAgentCommandExecutionSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the command was created, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the command was last updated, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// A large, non-consecutive number that Oracle Cloud Agent assigns to each created command.
SequenceNumber *int64 `mandatory:"true" json:"sequenceNumber"`
// The execution output from a command.
Content InstanceAgentCommandExecutionOutputContent `mandatory:"true" json:"content"`
// A user-friendly name. Does not have to be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
}
func (m InstanceAgentCommandExecutionSummary) String() string
func (m *InstanceAgentCommandExecutionSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m InstanceAgentCommandExecutionSummary) 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
InstanceAgentCommandExecutionSummaryDeliveryStateEnum Enum with underlying type: string
type InstanceAgentCommandExecutionSummaryDeliveryStateEnum string
Set of constants representing the allowable values for InstanceAgentCommandExecutionSummaryDeliveryStateEnum
const (
InstanceAgentCommandExecutionSummaryDeliveryStateVisible InstanceAgentCommandExecutionSummaryDeliveryStateEnum = "VISIBLE"
InstanceAgentCommandExecutionSummaryDeliveryStatePending InstanceAgentCommandExecutionSummaryDeliveryStateEnum = "PENDING"
InstanceAgentCommandExecutionSummaryDeliveryStateAcked InstanceAgentCommandExecutionSummaryDeliveryStateEnum = "ACKED"
InstanceAgentCommandExecutionSummaryDeliveryStateAckedCanceled InstanceAgentCommandExecutionSummaryDeliveryStateEnum = "ACKED_CANCELED"
InstanceAgentCommandExecutionSummaryDeliveryStateExpired InstanceAgentCommandExecutionSummaryDeliveryStateEnum = "EXPIRED"
)
func GetInstanceAgentCommandExecutionSummaryDeliveryStateEnumValues() []InstanceAgentCommandExecutionSummaryDeliveryStateEnum
GetInstanceAgentCommandExecutionSummaryDeliveryStateEnumValues Enumerates the set of values for InstanceAgentCommandExecutionSummaryDeliveryStateEnum
func GetMappingInstanceAgentCommandExecutionSummaryDeliveryStateEnum(val string) (InstanceAgentCommandExecutionSummaryDeliveryStateEnum, bool)
GetMappingInstanceAgentCommandExecutionSummaryDeliveryStateEnum performs case Insensitive comparison on enum value and return the desired enum
InstanceAgentCommandExecutionSummaryLifecycleStateEnum Enum with underlying type: string
type InstanceAgentCommandExecutionSummaryLifecycleStateEnum string
Set of constants representing the allowable values for InstanceAgentCommandExecutionSummaryLifecycleStateEnum
const (
InstanceAgentCommandExecutionSummaryLifecycleStateAccepted InstanceAgentCommandExecutionSummaryLifecycleStateEnum = "ACCEPTED"
InstanceAgentCommandExecutionSummaryLifecycleStateInProgress InstanceAgentCommandExecutionSummaryLifecycleStateEnum = "IN_PROGRESS"
InstanceAgentCommandExecutionSummaryLifecycleStateSucceeded InstanceAgentCommandExecutionSummaryLifecycleStateEnum = "SUCCEEDED"
InstanceAgentCommandExecutionSummaryLifecycleStateFailed InstanceAgentCommandExecutionSummaryLifecycleStateEnum = "FAILED"
InstanceAgentCommandExecutionSummaryLifecycleStateTimedOut InstanceAgentCommandExecutionSummaryLifecycleStateEnum = "TIMED_OUT"
InstanceAgentCommandExecutionSummaryLifecycleStateCanceled InstanceAgentCommandExecutionSummaryLifecycleStateEnum = "CANCELED"
)
func GetInstanceAgentCommandExecutionSummaryLifecycleStateEnumValues() []InstanceAgentCommandExecutionSummaryLifecycleStateEnum
GetInstanceAgentCommandExecutionSummaryLifecycleStateEnumValues Enumerates the set of values for InstanceAgentCommandExecutionSummaryLifecycleStateEnum
func GetMappingInstanceAgentCommandExecutionSummaryLifecycleStateEnum(val string) (InstanceAgentCommandExecutionSummaryLifecycleStateEnum, bool)
GetMappingInstanceAgentCommandExecutionSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
InstanceAgentCommandOutputDetails The output destination for the command.
type InstanceAgentCommandOutputDetails interface {
}
InstanceAgentCommandOutputDetailsOutputTypeEnum Enum with underlying type: string
type InstanceAgentCommandOutputDetailsOutputTypeEnum string
Set of constants representing the allowable values for InstanceAgentCommandOutputDetailsOutputTypeEnum
const (
InstanceAgentCommandOutputDetailsOutputTypeText InstanceAgentCommandOutputDetailsOutputTypeEnum = "TEXT"
InstanceAgentCommandOutputDetailsOutputTypeObjectStorageUri InstanceAgentCommandOutputDetailsOutputTypeEnum = "OBJECT_STORAGE_URI"
InstanceAgentCommandOutputDetailsOutputTypeObjectStorageTuple InstanceAgentCommandOutputDetailsOutputTypeEnum = "OBJECT_STORAGE_TUPLE"
)
func GetInstanceAgentCommandOutputDetailsOutputTypeEnumValues() []InstanceAgentCommandOutputDetailsOutputTypeEnum
GetInstanceAgentCommandOutputDetailsOutputTypeEnumValues Enumerates the set of values for InstanceAgentCommandOutputDetailsOutputTypeEnum
func GetMappingInstanceAgentCommandOutputDetailsOutputTypeEnum(val string) (InstanceAgentCommandOutputDetailsOutputTypeEnum, bool)
GetMappingInstanceAgentCommandOutputDetailsOutputTypeEnum performs case Insensitive comparison on enum value and return the desired enum
InstanceAgentCommandOutputViaObjectStorageTupleDetails The command output destination when saved to an Object Storage bucket.
type InstanceAgentCommandOutputViaObjectStorageTupleDetails struct {
// The Object Storage bucket for the command output.
BucketName *string `mandatory:"true" json:"bucketName"`
// The Object Storage namespace for the command output.
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// The Object Storage object name for the command output.
ObjectName *string `mandatory:"true" json:"objectName"`
}
func (m InstanceAgentCommandOutputViaObjectStorageTupleDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m InstanceAgentCommandOutputViaObjectStorageTupleDetails) String() string
func (m InstanceAgentCommandOutputViaObjectStorageTupleDetails) 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
InstanceAgentCommandOutputViaObjectStorageUriDetails The command output destination when saved to an Object Storage URL.
type InstanceAgentCommandOutputViaObjectStorageUriDetails struct {
// The Object Storage URL or pre-authenticated request (PAR) for the command output.
OutputUri *string `mandatory:"true" json:"outputUri"`
}
func (m InstanceAgentCommandOutputViaObjectStorageUriDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m InstanceAgentCommandOutputViaObjectStorageUriDetails) String() string
func (m InstanceAgentCommandOutputViaObjectStorageUriDetails) 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
InstanceAgentCommandOutputViaTextDetails The command output destination when returned in plain text.
type InstanceAgentCommandOutputViaTextDetails struct {
}
func (m InstanceAgentCommandOutputViaTextDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m InstanceAgentCommandOutputViaTextDetails) String() string
func (m InstanceAgentCommandOutputViaTextDetails) 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
InstanceAgentCommandSourceDetails The source of the command.
type InstanceAgentCommandSourceDetails interface {
}
InstanceAgentCommandSourceDetailsSourceTypeEnum Enum with underlying type: string
type InstanceAgentCommandSourceDetailsSourceTypeEnum string
Set of constants representing the allowable values for InstanceAgentCommandSourceDetailsSourceTypeEnum
const (
InstanceAgentCommandSourceDetailsSourceTypeText InstanceAgentCommandSourceDetailsSourceTypeEnum = "TEXT"
InstanceAgentCommandSourceDetailsSourceTypeObjectStorageUri InstanceAgentCommandSourceDetailsSourceTypeEnum = "OBJECT_STORAGE_URI"
InstanceAgentCommandSourceDetailsSourceTypeObjectStorageTuple InstanceAgentCommandSourceDetailsSourceTypeEnum = "OBJECT_STORAGE_TUPLE"
)
func GetInstanceAgentCommandSourceDetailsSourceTypeEnumValues() []InstanceAgentCommandSourceDetailsSourceTypeEnum
GetInstanceAgentCommandSourceDetailsSourceTypeEnumValues Enumerates the set of values for InstanceAgentCommandSourceDetailsSourceTypeEnum
func GetMappingInstanceAgentCommandSourceDetailsSourceTypeEnum(val string) (InstanceAgentCommandSourceDetailsSourceTypeEnum, bool)
GetMappingInstanceAgentCommandSourceDetailsSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
InstanceAgentCommandSourceViaObjectStorageTupleDetails The source of the command when imported from an Object Storage bucket.
type InstanceAgentCommandSourceViaObjectStorageTupleDetails struct {
// The Object Storage bucket for the command.
BucketName *string `mandatory:"true" json:"bucketName"`
// The Object Storage namespace for the command.
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// The Object Storage object name for the command.
ObjectName *string `mandatory:"true" json:"objectName"`
}
func (m InstanceAgentCommandSourceViaObjectStorageTupleDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m InstanceAgentCommandSourceViaObjectStorageTupleDetails) String() string
func (m InstanceAgentCommandSourceViaObjectStorageTupleDetails) 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
InstanceAgentCommandSourceViaObjectStorageUriDetails The source of the command when imported from an Object Storage URL.
type InstanceAgentCommandSourceViaObjectStorageUriDetails struct {
// The Object Storage URL or pre-authenticated request (PAR) for the command.
SourceUri *string `mandatory:"true" json:"sourceUri"`
}
func (m InstanceAgentCommandSourceViaObjectStorageUriDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m InstanceAgentCommandSourceViaObjectStorageUriDetails) String() string
func (m InstanceAgentCommandSourceViaObjectStorageUriDetails) 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
InstanceAgentCommandSourceViaTextDetails The source of the command when provided using plain text.
type InstanceAgentCommandSourceViaTextDetails struct {
// The plain text command.
Text *string `mandatory:"true" json:"text"`
// SHA-256 checksum value of the text content.
TextSha256 *string `mandatory:"false" json:"textSha256"`
}
func (m InstanceAgentCommandSourceViaTextDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m InstanceAgentCommandSourceViaTextDetails) String() string
func (m InstanceAgentCommandSourceViaTextDetails) 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
InstanceAgentCommandSummary Summary information for a command.
type InstanceAgentCommandSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the command.
InstanceAgentCommandId *string `mandatory:"true" json:"instanceAgentCommandId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the command.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the command was created, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the command was last updated, in the format defined by
// RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// A user-friendly name. Does not have to be unique.
DisplayName *string `mandatory:"false" json:"displayName"`
// Whether a request was made to cancel the command. Canceling a command is a best-effort attempt.
IsCanceled *bool `mandatory:"false" json:"isCanceled"`
}
func (m InstanceAgentCommandSummary) String() string
func (m InstanceAgentCommandSummary) 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
InstanceAgentCommandTarget The target instance that the command runs on.
type InstanceAgentCommandTarget struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target instance.
InstanceId *string `mandatory:"false" json:"instanceId"`
}
func (m InstanceAgentCommandTarget) String() string
func (m InstanceAgentCommandTarget) 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
InstanceAgentPlugin The agent plugin
type InstanceAgentPlugin struct {
// The plugin name
Name *string `mandatory:"true" json:"name"`
// The plugin status Specified the plugin state on the instance * `RUNNING` - The plugin is in running state * `STOPPED` - The plugin is in stopped state * `NOT_SUPPORTED` - The plugin is not supported on this platform * `INVALID` - The plugin state is not recognizable by the service
Status InstanceAgentPluginStatusEnum `mandatory:"true" json:"status"`
// The last update time of the plugin in UTC
TimeLastUpdatedUtc *common.SDKTime `mandatory:"true" json:"timeLastUpdatedUtc"`
// The optional message from the agent plugin
Message *string `mandatory:"false" json:"message"`
}
func (m InstanceAgentPlugin) String() string
func (m InstanceAgentPlugin) 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
InstanceAgentPluginStatusEnum Enum with underlying type: string
type InstanceAgentPluginStatusEnum string
Set of constants representing the allowable values for InstanceAgentPluginStatusEnum
const (
InstanceAgentPluginStatusRunning InstanceAgentPluginStatusEnum = "RUNNING"
InstanceAgentPluginStatusStopped InstanceAgentPluginStatusEnum = "STOPPED"
InstanceAgentPluginStatusNotSupported InstanceAgentPluginStatusEnum = "NOT_SUPPORTED"
InstanceAgentPluginStatusInvalid InstanceAgentPluginStatusEnum = "INVALID"
)
func GetInstanceAgentPluginStatusEnumValues() []InstanceAgentPluginStatusEnum
GetInstanceAgentPluginStatusEnumValues Enumerates the set of values for InstanceAgentPluginStatusEnum
func GetMappingInstanceAgentPluginStatusEnum(val string) (InstanceAgentPluginStatusEnum, bool)
GetMappingInstanceAgentPluginStatusEnum performs case Insensitive comparison on enum value and return the desired enum
InstanceAgentPluginSummary The agent plugin information
type InstanceAgentPluginSummary struct {
// The plugin name
Name *string `mandatory:"true" json:"name"`
// The plugin status Specified the plugin state on the instance * `RUNNING` - The plugin is in running state * `STOPPED` - The plugin is in stopped state * `NOT_SUPPORTED` - The plugin is not supported on this platform * `INVALID` - The plugin state is not recognizable by the service
Status InstanceAgentPluginSummaryStatusEnum `mandatory:"true" json:"status"`
// The last update time of the plugin in UTC
TimeLastUpdatedUtc *common.SDKTime `mandatory:"true" json:"timeLastUpdatedUtc"`
}
func (m InstanceAgentPluginSummary) String() string
func (m InstanceAgentPluginSummary) 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
InstanceAgentPluginSummaryStatusEnum Enum with underlying type: string
type InstanceAgentPluginSummaryStatusEnum string
Set of constants representing the allowable values for InstanceAgentPluginSummaryStatusEnum
const (
InstanceAgentPluginSummaryStatusRunning InstanceAgentPluginSummaryStatusEnum = "RUNNING"
InstanceAgentPluginSummaryStatusStopped InstanceAgentPluginSummaryStatusEnum = "STOPPED"
InstanceAgentPluginSummaryStatusNotSupported InstanceAgentPluginSummaryStatusEnum = "NOT_SUPPORTED"
InstanceAgentPluginSummaryStatusInvalid InstanceAgentPluginSummaryStatusEnum = "INVALID"
)
func GetInstanceAgentPluginSummaryStatusEnumValues() []InstanceAgentPluginSummaryStatusEnum
GetInstanceAgentPluginSummaryStatusEnumValues Enumerates the set of values for InstanceAgentPluginSummaryStatusEnum
func GetMappingInstanceAgentPluginSummaryStatusEnum(val string) (InstanceAgentPluginSummaryStatusEnum, bool)
GetMappingInstanceAgentPluginSummaryStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ListInstanceAgentCommandExecutionsRequest wrapper for the ListInstanceAgentCommandExecutions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/ListInstanceAgentCommandExecutions.go.html to see an example of how to use ListInstanceAgentCommandExecutionsRequest.
type ListInstanceAgentCommandExecutionsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance.
InstanceId *string `mandatory:"true" contributesTo:"query" name:"instanceId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List"
// call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
// `TIMECREATED` is descending.
// **Note:** In general, some "List" operations (for example, `ListInstances`) let you
// optionally filter by availability domain if the scope of the resource type is within a
// single availability domain. If you call one of these "List" operations without specifying
// an availability domain, the resources are grouped by availability domain, then sorted.
SortBy ListInstanceAgentCommandExecutionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The `DISPLAYNAME` sort order
// is case sensitive.
SortOrder ListInstanceAgentCommandExecutionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
LifecycleState InstanceAgentCommandExecutionSummaryLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" 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 ListInstanceAgentCommandExecutionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListInstanceAgentCommandExecutionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListInstanceAgentCommandExecutionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListInstanceAgentCommandExecutionsRequest) String() string
func (request ListInstanceAgentCommandExecutionsRequest) 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
ListInstanceAgentCommandExecutionsResponse wrapper for the ListInstanceAgentCommandExecutions operation
type ListInstanceAgentCommandExecutionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []InstanceAgentCommandExecutionSummary instances
Items []InstanceAgentCommandExecutionSummary `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages
// of results remain. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
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 ListInstanceAgentCommandExecutionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListInstanceAgentCommandExecutionsResponse) String() string
ListInstanceAgentCommandExecutionsSortByEnum Enum with underlying type: string
type ListInstanceAgentCommandExecutionsSortByEnum string
Set of constants representing the allowable values for ListInstanceAgentCommandExecutionsSortByEnum
const (
ListInstanceAgentCommandExecutionsSortByTimecreated ListInstanceAgentCommandExecutionsSortByEnum = "TIMECREATED"
ListInstanceAgentCommandExecutionsSortByDisplayname ListInstanceAgentCommandExecutionsSortByEnum = "DISPLAYNAME"
)
func GetListInstanceAgentCommandExecutionsSortByEnumValues() []ListInstanceAgentCommandExecutionsSortByEnum
GetListInstanceAgentCommandExecutionsSortByEnumValues Enumerates the set of values for ListInstanceAgentCommandExecutionsSortByEnum
func GetMappingListInstanceAgentCommandExecutionsSortByEnum(val string) (ListInstanceAgentCommandExecutionsSortByEnum, bool)
GetMappingListInstanceAgentCommandExecutionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListInstanceAgentCommandExecutionsSortOrderEnum Enum with underlying type: string
type ListInstanceAgentCommandExecutionsSortOrderEnum string
Set of constants representing the allowable values for ListInstanceAgentCommandExecutionsSortOrderEnum
const (
ListInstanceAgentCommandExecutionsSortOrderAsc ListInstanceAgentCommandExecutionsSortOrderEnum = "ASC"
ListInstanceAgentCommandExecutionsSortOrderDesc ListInstanceAgentCommandExecutionsSortOrderEnum = "DESC"
)
func GetListInstanceAgentCommandExecutionsSortOrderEnumValues() []ListInstanceAgentCommandExecutionsSortOrderEnum
GetListInstanceAgentCommandExecutionsSortOrderEnumValues Enumerates the set of values for ListInstanceAgentCommandExecutionsSortOrderEnum
func GetMappingListInstanceAgentCommandExecutionsSortOrderEnum(val string) (ListInstanceAgentCommandExecutionsSortOrderEnum, bool)
GetMappingListInstanceAgentCommandExecutionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListInstanceAgentCommandsRequest wrapper for the ListInstanceAgentCommands operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/ListInstanceAgentCommands.go.html to see an example of how to use ListInstanceAgentCommandsRequest.
type ListInstanceAgentCommandsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List"
// call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
// `TIMECREATED` is descending.
// **Note:** In general, some "List" operations (for example, `ListInstances`) let you
// optionally filter by availability domain if the scope of the resource type is within a
// single availability domain. If you call one of these "List" operations without specifying
// an availability domain, the resources are grouped by availability domain, then sorted.
SortBy ListInstanceAgentCommandsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The `DISPLAYNAME` sort order
// is case sensitive.
SortOrder ListInstanceAgentCommandsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" 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 ListInstanceAgentCommandsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListInstanceAgentCommandsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListInstanceAgentCommandsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListInstanceAgentCommandsRequest) String() string
func (request ListInstanceAgentCommandsRequest) 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
ListInstanceAgentCommandsResponse wrapper for the ListInstanceAgentCommands operation
type ListInstanceAgentCommandsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []InstanceAgentCommandSummary instances
Items []InstanceAgentCommandSummary `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages
// of results remain. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
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 ListInstanceAgentCommandsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListInstanceAgentCommandsResponse) String() string
ListInstanceAgentCommandsSortByEnum Enum with underlying type: string
type ListInstanceAgentCommandsSortByEnum string
Set of constants representing the allowable values for ListInstanceAgentCommandsSortByEnum
const (
ListInstanceAgentCommandsSortByTimecreated ListInstanceAgentCommandsSortByEnum = "TIMECREATED"
ListInstanceAgentCommandsSortByDisplayname ListInstanceAgentCommandsSortByEnum = "DISPLAYNAME"
)
func GetListInstanceAgentCommandsSortByEnumValues() []ListInstanceAgentCommandsSortByEnum
GetListInstanceAgentCommandsSortByEnumValues Enumerates the set of values for ListInstanceAgentCommandsSortByEnum
func GetMappingListInstanceAgentCommandsSortByEnum(val string) (ListInstanceAgentCommandsSortByEnum, bool)
GetMappingListInstanceAgentCommandsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListInstanceAgentCommandsSortOrderEnum Enum with underlying type: string
type ListInstanceAgentCommandsSortOrderEnum string
Set of constants representing the allowable values for ListInstanceAgentCommandsSortOrderEnum
const (
ListInstanceAgentCommandsSortOrderAsc ListInstanceAgentCommandsSortOrderEnum = "ASC"
ListInstanceAgentCommandsSortOrderDesc ListInstanceAgentCommandsSortOrderEnum = "DESC"
)
func GetListInstanceAgentCommandsSortOrderEnumValues() []ListInstanceAgentCommandsSortOrderEnum
GetListInstanceAgentCommandsSortOrderEnumValues Enumerates the set of values for ListInstanceAgentCommandsSortOrderEnum
func GetMappingListInstanceAgentCommandsSortOrderEnum(val string) (ListInstanceAgentCommandsSortOrderEnum, bool)
GetMappingListInstanceAgentCommandsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListInstanceAgentPluginsRequest wrapper for the ListInstanceAgentPlugins operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/ListInstanceAgentPlugins.go.html to see an example of how to use ListInstanceAgentPluginsRequest.
type ListInstanceAgentPluginsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID of the instance.
InstanceagentId *string `mandatory:"true" contributesTo:"path" name:"instanceagentId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The plugin status
Status ListInstanceAgentPluginsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List"
// call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
// `TIMECREATED` is descending.
// **Note:** In general, some "List" operations (for example, `ListInstances`) let you
// optionally filter by availability domain if the scope of the resource type is within a
// single availability domain. If you call one of these "List" operations without specifying
// an availability domain, the resources are grouped by availability domain, then sorted.
SortBy ListInstanceAgentPluginsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The `DISPLAYNAME` sort order
// is case sensitive.
SortOrder ListInstanceAgentPluginsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The plugin name
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// 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 ListInstanceAgentPluginsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListInstanceAgentPluginsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListInstanceAgentPluginsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListInstanceAgentPluginsRequest) String() string
func (request ListInstanceAgentPluginsRequest) 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
ListInstanceAgentPluginsResponse wrapper for the ListInstanceAgentPlugins operation
type ListInstanceAgentPluginsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []InstanceAgentPluginSummary instances
Items []InstanceAgentPluginSummary `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For list pagination. When this header appears in the response, additional pages
// of results remain. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListInstanceAgentPluginsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListInstanceAgentPluginsResponse) String() string
ListInstanceAgentPluginsSortByEnum Enum with underlying type: string
type ListInstanceAgentPluginsSortByEnum string
Set of constants representing the allowable values for ListInstanceAgentPluginsSortByEnum
const (
ListInstanceAgentPluginsSortByTimecreated ListInstanceAgentPluginsSortByEnum = "TIMECREATED"
ListInstanceAgentPluginsSortByDisplayname ListInstanceAgentPluginsSortByEnum = "DISPLAYNAME"
)
func GetListInstanceAgentPluginsSortByEnumValues() []ListInstanceAgentPluginsSortByEnum
GetListInstanceAgentPluginsSortByEnumValues Enumerates the set of values for ListInstanceAgentPluginsSortByEnum
func GetMappingListInstanceAgentPluginsSortByEnum(val string) (ListInstanceAgentPluginsSortByEnum, bool)
GetMappingListInstanceAgentPluginsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListInstanceAgentPluginsSortOrderEnum Enum with underlying type: string
type ListInstanceAgentPluginsSortOrderEnum string
Set of constants representing the allowable values for ListInstanceAgentPluginsSortOrderEnum
const (
ListInstanceAgentPluginsSortOrderAsc ListInstanceAgentPluginsSortOrderEnum = "ASC"
ListInstanceAgentPluginsSortOrderDesc ListInstanceAgentPluginsSortOrderEnum = "DESC"
)
func GetListInstanceAgentPluginsSortOrderEnumValues() []ListInstanceAgentPluginsSortOrderEnum
GetListInstanceAgentPluginsSortOrderEnumValues Enumerates the set of values for ListInstanceAgentPluginsSortOrderEnum
func GetMappingListInstanceAgentPluginsSortOrderEnum(val string) (ListInstanceAgentPluginsSortOrderEnum, bool)
GetMappingListInstanceAgentPluginsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListInstanceAgentPluginsStatusEnum Enum with underlying type: string
type ListInstanceAgentPluginsStatusEnum string
Set of constants representing the allowable values for ListInstanceAgentPluginsStatusEnum
const (
ListInstanceAgentPluginsStatusRunning ListInstanceAgentPluginsStatusEnum = "RUNNING"
ListInstanceAgentPluginsStatusStopped ListInstanceAgentPluginsStatusEnum = "STOPPED"
ListInstanceAgentPluginsStatusNotSupported ListInstanceAgentPluginsStatusEnum = "NOT_SUPPORTED"
ListInstanceAgentPluginsStatusInvalid ListInstanceAgentPluginsStatusEnum = "INVALID"
)
func GetListInstanceAgentPluginsStatusEnumValues() []ListInstanceAgentPluginsStatusEnum
GetListInstanceAgentPluginsStatusEnumValues Enumerates the set of values for ListInstanceAgentPluginsStatusEnum
func GetMappingListInstanceAgentPluginsStatusEnum(val string) (ListInstanceAgentPluginsStatusEnum, bool)
GetMappingListInstanceAgentPluginsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ListInstanceagentAvailablePluginsRequest wrapper for the ListInstanceagentAvailablePlugins operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/ListInstanceagentAvailablePlugins.go.html to see an example of how to use ListInstanceagentAvailablePluginsRequest.
type ListInstanceagentAvailablePluginsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OS for which the plugin is supported.
// Examples of OperatingSystemQueryParam:OperatingSystemVersionQueryParam are as follows:
// 'CentOS' '6.10' , 'CentOS Linux' '7', 'CentOS Linux' '8',
// 'Oracle Linux Server' '6.10', 'Oracle Linux Server' '8.0',
// 'Red Hat Enterprise Linux Server' '7.8',
// 'Windows' '10', 'Windows' '2008ServerR2', 'Windows' '2012ServerR2', 'Windows' '7', 'Windows' '8.1'
OsName *string `mandatory:"true" contributesTo:"query" name:"osName"`
// The OS version for which the plugin is supported.
OsVersion *string `mandatory:"true" contributesTo:"query" name:"osVersion"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,
// please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List"
// call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
// `TIMECREATED` is descending.
// **Note:** In general, some "List" operations (for example, `ListInstances`) let you
// optionally filter by availability domain if the scope of the resource type is within a
// single availability domain. If you call one of these "List" operations without specifying
// an availability domain, the resources are grouped by availability domain, then sorted.
SortBy ListInstanceagentAvailablePluginsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The `DISPLAYNAME` sort order
// is case sensitive.
SortOrder ListInstanceagentAvailablePluginsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The plugin name
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// 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 ListInstanceagentAvailablePluginsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListInstanceagentAvailablePluginsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListInstanceagentAvailablePluginsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListInstanceagentAvailablePluginsRequest) String() string
func (request ListInstanceagentAvailablePluginsRequest) 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
ListInstanceagentAvailablePluginsResponse wrapper for the ListInstanceagentAvailablePlugins operation
type ListInstanceagentAvailablePluginsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []AvailablePluginSummary instances
Items []AvailablePluginSummary `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For list pagination. When this header appears in the response, additional pages
// of results remain. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListInstanceagentAvailablePluginsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListInstanceagentAvailablePluginsResponse) String() string
ListInstanceagentAvailablePluginsSortByEnum Enum with underlying type: string
type ListInstanceagentAvailablePluginsSortByEnum string
Set of constants representing the allowable values for ListInstanceagentAvailablePluginsSortByEnum
const (
ListInstanceagentAvailablePluginsSortByTimecreated ListInstanceagentAvailablePluginsSortByEnum = "TIMECREATED"
ListInstanceagentAvailablePluginsSortByDisplayname ListInstanceagentAvailablePluginsSortByEnum = "DISPLAYNAME"
)
func GetListInstanceagentAvailablePluginsSortByEnumValues() []ListInstanceagentAvailablePluginsSortByEnum
GetListInstanceagentAvailablePluginsSortByEnumValues Enumerates the set of values for ListInstanceagentAvailablePluginsSortByEnum
func GetMappingListInstanceagentAvailablePluginsSortByEnum(val string) (ListInstanceagentAvailablePluginsSortByEnum, bool)
GetMappingListInstanceagentAvailablePluginsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListInstanceagentAvailablePluginsSortOrderEnum Enum with underlying type: string
type ListInstanceagentAvailablePluginsSortOrderEnum string
Set of constants representing the allowable values for ListInstanceagentAvailablePluginsSortOrderEnum
const (
ListInstanceagentAvailablePluginsSortOrderAsc ListInstanceagentAvailablePluginsSortOrderEnum = "ASC"
ListInstanceagentAvailablePluginsSortOrderDesc ListInstanceagentAvailablePluginsSortOrderEnum = "DESC"
)
func GetListInstanceagentAvailablePluginsSortOrderEnumValues() []ListInstanceagentAvailablePluginsSortOrderEnum
GetListInstanceagentAvailablePluginsSortOrderEnumValues Enumerates the set of values for ListInstanceagentAvailablePluginsSortOrderEnum
func GetMappingListInstanceagentAvailablePluginsSortOrderEnum(val string) (ListInstanceagentAvailablePluginsSortOrderEnum, bool)
GetMappingListInstanceagentAvailablePluginsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
Plugin The agent plugin
type Plugin struct {
// The plugin name
Name *string `mandatory:"true" json:"name"`
// The plugin version
Version *string `mandatory:"true" json:"version"`
// The plugin status
Status *string `mandatory:"true" json:"status"`
// The last update time of the plugin
LastUpdateTime *common.SDKTime `mandatory:"false" json:"lastUpdateTime"`
// The optional message from the agent plugin
Message *string `mandatory:"false" json:"message"`
}
func (m Plugin) String() string
func (m Plugin) 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
PluginClient a client for Plugin
type PluginClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewPluginClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client PluginClient, err error)
NewPluginClientWithConfigurationProvider Creates a new default Plugin client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewPluginClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client PluginClient, err error)
NewPluginClientWithOboToken Creates a new default Plugin 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 *PluginClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client PluginClient) GetInstanceAgentPlugin(ctx context.Context, request GetInstanceAgentPluginRequest) (response GetInstanceAgentPluginResponse, err error)
GetInstanceAgentPlugin The API to get information for a plugin.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/GetInstanceAgentPlugin.go.html to see an example of how to use GetInstanceAgentPlugin API.
func (client PluginClient) ListInstanceAgentPlugins(ctx context.Context, request ListInstanceAgentPluginsRequest) (response ListInstanceAgentPluginsResponse, err error)
ListInstanceAgentPlugins The API to get one or more plugin information.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/ListInstanceAgentPlugins.go.html to see an example of how to use ListInstanceAgentPlugins API.
func (client *PluginClient) SetRegion(region string)
SetRegion overrides the region of this client.
PluginconfigClient a client for Pluginconfig
type PluginconfigClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewPluginconfigClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client PluginconfigClient, err error)
NewPluginconfigClientWithConfigurationProvider Creates a new default Pluginconfig client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewPluginconfigClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client PluginconfigClient, err error)
NewPluginconfigClientWithOboToken Creates a new default Pluginconfig 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 *PluginconfigClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client PluginconfigClient) ListInstanceagentAvailablePlugins(ctx context.Context, request ListInstanceagentAvailablePluginsRequest) (response ListInstanceagentAvailablePluginsResponse, err error)
ListInstanceagentAvailablePlugins The API to get the list of plugins that are available.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/ListInstanceagentAvailablePlugins.go.html to see an example of how to use ListInstanceagentAvailablePlugins API.
func (client *PluginconfigClient) SetRegion(region string)
SetRegion overrides the region of this client.