Documentation
¶
Index ¶
- type AvailablePluginSummary
- type CancelInstanceAgentCommandRequest
- type CancelInstanceAgentCommandResponse
- type ComputeInstanceAgentClient
- func NewComputeInstanceAgentClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ComputeInstanceAgentClient, err error)
- func NewComputeInstanceAgentClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ComputeInstanceAgentClient, err error)
- func (client ComputeInstanceAgentClient) CancelInstanceAgentCommand(ctx context.Context, request CancelInstanceAgentCommandRequest) (response CancelInstanceAgentCommandResponse, err error)
- func (client *ComputeInstanceAgentClient) ConfigurationProvider() *common.ConfigurationProvider
- func (client ComputeInstanceAgentClient) CreateInstanceAgentCommand(ctx context.Context, request CreateInstanceAgentCommandRequest) (response CreateInstanceAgentCommandResponse, err error)
- func (client ComputeInstanceAgentClient) GetInstanceAgentCommand(ctx context.Context, request GetInstanceAgentCommandRequest) (response GetInstanceAgentCommandResponse, err error)
- func (client ComputeInstanceAgentClient) GetInstanceAgentCommandExecution(ctx context.Context, request GetInstanceAgentCommandExecutionRequest) (response GetInstanceAgentCommandExecutionResponse, err error)
- func (client ComputeInstanceAgentClient) ListInstanceAgentCommandExecutions(ctx context.Context, request ListInstanceAgentCommandExecutionsRequest) (response ListInstanceAgentCommandExecutionsResponse, err error)
- func (client ComputeInstanceAgentClient) ListInstanceAgentCommands(ctx context.Context, request ListInstanceAgentCommandsRequest) (response ListInstanceAgentCommandsResponse, err error)
- func (client *ComputeInstanceAgentClient) SetRegion(region string)
- type CreateInstanceAgentCommandDetails
- type CreateInstanceAgentCommandRequest
- type CreateInstanceAgentCommandResponse
- type GetInstanceAgentCommandExecutionRequest
- type GetInstanceAgentCommandExecutionResponse
- type GetInstanceAgentCommandRequest
- type GetInstanceAgentCommandResponse
- type GetInstanceAgentPluginRequest
- type GetInstanceAgentPluginResponse
- type InstanceAgentCommand
- type InstanceAgentCommandContent
- type InstanceAgentCommandExecution
- type InstanceAgentCommandExecutionDeliveryStateEnum
- type InstanceAgentCommandExecutionLifecycleStateEnum
- type InstanceAgentCommandExecutionOutputContent
- type InstanceAgentCommandExecutionOutputContentOutputTypeEnum
- type InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails
- func (m InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails) GetExitCode() *int
- func (m InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails) GetMessage() *string
- func (m InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails) MarshalJSON() (buff []byte, e error)
- func (m InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails) String() string
- type InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails
- func (m InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails) GetExitCode() *int
- func (m InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails) GetMessage() *string
- func (m InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails) MarshalJSON() (buff []byte, e error)
- func (m InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails) String() string
- type InstanceAgentCommandExecutionOutputViaTextDetails
- func (m InstanceAgentCommandExecutionOutputViaTextDetails) GetExitCode() *int
- func (m InstanceAgentCommandExecutionOutputViaTextDetails) GetMessage() *string
- func (m InstanceAgentCommandExecutionOutputViaTextDetails) MarshalJSON() (buff []byte, e error)
- func (m InstanceAgentCommandExecutionOutputViaTextDetails) String() string
- type InstanceAgentCommandExecutionSummary
- type InstanceAgentCommandExecutionSummaryDeliveryStateEnum
- type InstanceAgentCommandExecutionSummaryLifecycleStateEnum
- type InstanceAgentCommandOutputDetails
- type InstanceAgentCommandOutputDetailsOutputTypeEnum
- type InstanceAgentCommandOutputViaObjectStorageTupleDetails
- type InstanceAgentCommandOutputViaObjectStorageUriDetails
- type InstanceAgentCommandOutputViaTextDetails
- type InstanceAgentCommandSourceDetails
- type InstanceAgentCommandSourceDetailsSourceTypeEnum
- type InstanceAgentCommandSourceViaObjectStorageTupleDetails
- type InstanceAgentCommandSourceViaObjectStorageUriDetails
- type InstanceAgentCommandSourceViaTextDetails
- type InstanceAgentCommandSummary
- type InstanceAgentCommandTarget
- type InstanceAgentPlugin
- type InstanceAgentPluginStatusEnum
- type InstanceAgentPluginSummary
- type InstanceAgentPluginSummaryStatusEnum
- type ListInstanceAgentCommandExecutionsRequest
- type ListInstanceAgentCommandExecutionsResponse
- type ListInstanceAgentCommandExecutionsSortByEnum
- type ListInstanceAgentCommandExecutionsSortOrderEnum
- type ListInstanceAgentCommandsRequest
- type ListInstanceAgentCommandsResponse
- type ListInstanceAgentCommandsSortByEnum
- type ListInstanceAgentCommandsSortOrderEnum
- type ListInstanceAgentPluginsRequest
- type ListInstanceAgentPluginsResponse
- type ListInstanceAgentPluginsSortByEnum
- type ListInstanceAgentPluginsSortOrderEnum
- type ListInstanceAgentPluginsStatusEnum
- type ListInstanceagentAvailablePluginsRequest
- type ListInstanceagentAvailablePluginsResponse
- type ListInstanceagentAvailablePluginsSortByEnum
- type ListInstanceagentAvailablePluginsSortOrderEnum
- type Plugin
- type PluginClient
- func (client *PluginClient) ConfigurationProvider() *common.ConfigurationProvider
- func (client PluginClient) GetInstanceAgentPlugin(ctx context.Context, request GetInstanceAgentPluginRequest) (response GetInstanceAgentPluginResponse, err error)
- func (client PluginClient) ListInstanceAgentPlugins(ctx context.Context, request ListInstanceAgentPluginsRequest) (response ListInstanceAgentPluginsResponse, err error)
- func (client *PluginClient) SetRegion(region string)
- type PluginconfigClient
- func (client *PluginconfigClient) ConfigurationProvider() *common.ConfigurationProvider
- func (client PluginconfigClient) ListInstanceagentAvailablePlugins(ctx context.Context, request ListInstanceagentAvailablePluginsRequest) (response ListInstanceagentAvailablePluginsResponse, err error)
- func (client *PluginconfigClient) SetRegion(region string)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AvailablePluginSummary ¶
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"`
}
AvailablePluginSummary Describes where the plugin is supported
func (AvailablePluginSummary) String ¶
func (m AvailablePluginSummary) String() string
type CancelInstanceAgentCommandRequest ¶
type CancelInstanceAgentCommandRequest struct {
// The OCID (https://docs.cloud.oracle.com/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
}
CancelInstanceAgentCommandRequest wrapper for the CancelInstanceAgentCommand operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/CancelInstanceAgentCommand.go.html to see an example of how to use CancelInstanceAgentCommandRequest.
func (CancelInstanceAgentCommandRequest) HTTPRequest ¶
func (request CancelInstanceAgentCommandRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (CancelInstanceAgentCommandRequest) RetryPolicy ¶
func (request CancelInstanceAgentCommandRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (CancelInstanceAgentCommandRequest) String ¶
func (request CancelInstanceAgentCommandRequest) String() string
type CancelInstanceAgentCommandResponse ¶
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"`
}
CancelInstanceAgentCommandResponse wrapper for the CancelInstanceAgentCommand operation
func (CancelInstanceAgentCommandResponse) HTTPResponse ¶
func (response CancelInstanceAgentCommandResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CancelInstanceAgentCommandResponse) String ¶
func (response CancelInstanceAgentCommandResponse) String() string
type ComputeInstanceAgentClient ¶
type ComputeInstanceAgentClient struct {
common.BaseClient
// contains filtered or unexported fields
}
ComputeInstanceAgentClient a client for ComputeInstanceAgent
func NewComputeInstanceAgentClientWithConfigurationProvider ¶
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 ¶
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 (ComputeInstanceAgentClient) CancelInstanceAgentCommand ¶
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.
See also ¶
Click https://docs.cloud.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 (*ComputeInstanceAgentClient) ConfigurationProvider ¶
func (client *ComputeInstanceAgentClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (ComputeInstanceAgentClient) CreateInstanceAgentCommand ¶
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.
See also ¶
Click https://docs.cloud.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 (ComputeInstanceAgentClient) GetInstanceAgentCommand ¶
func (client ComputeInstanceAgentClient) GetInstanceAgentCommand(ctx context.Context, request GetInstanceAgentCommandRequest) (response GetInstanceAgentCommandResponse, err error)
GetInstanceAgentCommand Gets information about an Oracle Cloud Agent command.
See also ¶
Click https://docs.cloud.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 (ComputeInstanceAgentClient) GetInstanceAgentCommandExecution ¶
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.
See also ¶
Click https://docs.cloud.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 (ComputeInstanceAgentClient) ListInstanceAgentCommandExecutions ¶
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.
See also ¶
Click https://docs.cloud.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 (ComputeInstanceAgentClient) ListInstanceAgentCommands ¶
func (client ComputeInstanceAgentClient) ListInstanceAgentCommands(ctx context.Context, request ListInstanceAgentCommandsRequest) (response ListInstanceAgentCommandsResponse, err error)
ListInstanceAgentCommands Lists the Oracle Cloud Agent commands issued in a compartment.
See also ¶
Click https://docs.cloud.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 (*ComputeInstanceAgentClient) SetRegion ¶
func (client *ComputeInstanceAgentClient) SetRegion(region string)
SetRegion overrides the region of this client.
type CreateInstanceAgentCommandDetails ¶
type CreateInstanceAgentCommandDetails struct {
// The OCID (https://docs.cloud.oracle.com/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"`
}
CreateInstanceAgentCommandDetails Creation details for an Oracle Cloud Agent command.
func (CreateInstanceAgentCommandDetails) String ¶
func (m CreateInstanceAgentCommandDetails) String() string
type 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
}
CreateInstanceAgentCommandRequest wrapper for the CreateInstanceAgentCommand operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/CreateInstanceAgentCommand.go.html to see an example of how to use CreateInstanceAgentCommandRequest.
func (CreateInstanceAgentCommandRequest) HTTPRequest ¶
func (request CreateInstanceAgentCommandRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (CreateInstanceAgentCommandRequest) RetryPolicy ¶
func (request CreateInstanceAgentCommandRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (CreateInstanceAgentCommandRequest) String ¶
func (request CreateInstanceAgentCommandRequest) String() string
type CreateInstanceAgentCommandResponse ¶
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"`
}
CreateInstanceAgentCommandResponse wrapper for the CreateInstanceAgentCommand operation
func (CreateInstanceAgentCommandResponse) HTTPResponse ¶
func (response CreateInstanceAgentCommandResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CreateInstanceAgentCommandResponse) String ¶
func (response CreateInstanceAgentCommandResponse) String() string
type GetInstanceAgentCommandExecutionRequest ¶
type GetInstanceAgentCommandExecutionRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the command.
InstanceAgentCommandId *string `mandatory:"true" contributesTo:"path" name:"instanceAgentCommandId"`
// The OCID (https://docs.cloud.oracle.com/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
}
GetInstanceAgentCommandExecutionRequest wrapper for the GetInstanceAgentCommandExecution operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/GetInstanceAgentCommandExecution.go.html to see an example of how to use GetInstanceAgentCommandExecutionRequest.
func (GetInstanceAgentCommandExecutionRequest) HTTPRequest ¶
func (request GetInstanceAgentCommandExecutionRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (GetInstanceAgentCommandExecutionRequest) RetryPolicy ¶
func (request GetInstanceAgentCommandExecutionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (GetInstanceAgentCommandExecutionRequest) String ¶
func (request GetInstanceAgentCommandExecutionRequest) String() string
type GetInstanceAgentCommandExecutionResponse ¶
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"`
}
GetInstanceAgentCommandExecutionResponse wrapper for the GetInstanceAgentCommandExecution operation
func (GetInstanceAgentCommandExecutionResponse) HTTPResponse ¶
func (response GetInstanceAgentCommandExecutionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetInstanceAgentCommandExecutionResponse) String ¶
func (response GetInstanceAgentCommandExecutionResponse) String() string
type GetInstanceAgentCommandRequest ¶
type GetInstanceAgentCommandRequest struct {
// The OCID (https://docs.cloud.oracle.com/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
}
GetInstanceAgentCommandRequest wrapper for the GetInstanceAgentCommand operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/GetInstanceAgentCommand.go.html to see an example of how to use GetInstanceAgentCommandRequest.
func (GetInstanceAgentCommandRequest) HTTPRequest ¶
func (request GetInstanceAgentCommandRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (GetInstanceAgentCommandRequest) RetryPolicy ¶
func (request GetInstanceAgentCommandRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (GetInstanceAgentCommandRequest) String ¶
func (request GetInstanceAgentCommandRequest) String() string
type GetInstanceAgentCommandResponse ¶
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"`
}
GetInstanceAgentCommandResponse wrapper for the GetInstanceAgentCommand operation
func (GetInstanceAgentCommandResponse) HTTPResponse ¶
func (response GetInstanceAgentCommandResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetInstanceAgentCommandResponse) String ¶
func (response GetInstanceAgentCommandResponse) String() string
type GetInstanceAgentPluginRequest ¶
type GetInstanceAgentPluginRequest struct {
// The OCID of the instance.
InstanceagentId *string `mandatory:"true" contributesTo:"path" name:"instanceagentId"`
// The OCID (https://docs.cloud.oracle.com/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
}
GetInstanceAgentPluginRequest wrapper for the GetInstanceAgentPlugin operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/GetInstanceAgentPlugin.go.html to see an example of how to use GetInstanceAgentPluginRequest.
func (GetInstanceAgentPluginRequest) HTTPRequest ¶
func (request GetInstanceAgentPluginRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (GetInstanceAgentPluginRequest) RetryPolicy ¶
func (request GetInstanceAgentPluginRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (GetInstanceAgentPluginRequest) String ¶
func (request GetInstanceAgentPluginRequest) String() string
type GetInstanceAgentPluginResponse ¶
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"`
}
GetInstanceAgentPluginResponse wrapper for the GetInstanceAgentPlugin operation
func (GetInstanceAgentPluginResponse) HTTPResponse ¶
func (response GetInstanceAgentPluginResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetInstanceAgentPluginResponse) String ¶
func (response GetInstanceAgentPluginResponse) String() string
type InstanceAgentCommand ¶
type InstanceAgentCommand struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the command.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/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"`
}
InstanceAgentCommand The command payload.
func (InstanceAgentCommand) String ¶
func (m InstanceAgentCommand) String() string
type InstanceAgentCommandContent ¶
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"`
}
InstanceAgentCommandContent The contents of the command.
func (InstanceAgentCommandContent) String ¶
func (m InstanceAgentCommandContent) String() string
func (*InstanceAgentCommandContent) UnmarshalJSON ¶
func (m *InstanceAgentCommandContent) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
type InstanceAgentCommandExecution ¶
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"`
}
InstanceAgentCommandExecution A command's execution summary.
func (InstanceAgentCommandExecution) String ¶
func (m InstanceAgentCommandExecution) String() string
func (*InstanceAgentCommandExecution) UnmarshalJSON ¶
func (m *InstanceAgentCommandExecution) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
type InstanceAgentCommandExecutionDeliveryStateEnum ¶
type InstanceAgentCommandExecutionDeliveryStateEnum string
InstanceAgentCommandExecutionDeliveryStateEnum Enum with underlying type: string
const ( InstanceAgentCommandExecutionDeliveryStateVisible InstanceAgentCommandExecutionDeliveryStateEnum = "VISIBLE" InstanceAgentCommandExecutionDeliveryStatePending InstanceAgentCommandExecutionDeliveryStateEnum = "PENDING" InstanceAgentCommandExecutionDeliveryStateAcked InstanceAgentCommandExecutionDeliveryStateEnum = "ACKED" InstanceAgentCommandExecutionDeliveryStateAckedCanceled InstanceAgentCommandExecutionDeliveryStateEnum = "ACKED_CANCELED" InstanceAgentCommandExecutionDeliveryStateExpired InstanceAgentCommandExecutionDeliveryStateEnum = "EXPIRED" )
Set of constants representing the allowable values for InstanceAgentCommandExecutionDeliveryStateEnum
func GetInstanceAgentCommandExecutionDeliveryStateEnumValues ¶
func GetInstanceAgentCommandExecutionDeliveryStateEnumValues() []InstanceAgentCommandExecutionDeliveryStateEnum
GetInstanceAgentCommandExecutionDeliveryStateEnumValues Enumerates the set of values for InstanceAgentCommandExecutionDeliveryStateEnum
type InstanceAgentCommandExecutionLifecycleStateEnum ¶
type InstanceAgentCommandExecutionLifecycleStateEnum string
InstanceAgentCommandExecutionLifecycleStateEnum Enum with underlying type: string
const ( InstanceAgentCommandExecutionLifecycleStateAccepted InstanceAgentCommandExecutionLifecycleStateEnum = "ACCEPTED" InstanceAgentCommandExecutionLifecycleStateInProgress InstanceAgentCommandExecutionLifecycleStateEnum = "IN_PROGRESS" InstanceAgentCommandExecutionLifecycleStateSucceeded InstanceAgentCommandExecutionLifecycleStateEnum = "SUCCEEDED" InstanceAgentCommandExecutionLifecycleStateFailed InstanceAgentCommandExecutionLifecycleStateEnum = "FAILED" InstanceAgentCommandExecutionLifecycleStateTimedOut InstanceAgentCommandExecutionLifecycleStateEnum = "TIMED_OUT" InstanceAgentCommandExecutionLifecycleStateCanceled InstanceAgentCommandExecutionLifecycleStateEnum = "CANCELED" )
Set of constants representing the allowable values for InstanceAgentCommandExecutionLifecycleStateEnum
func GetInstanceAgentCommandExecutionLifecycleStateEnumValues ¶
func GetInstanceAgentCommandExecutionLifecycleStateEnumValues() []InstanceAgentCommandExecutionLifecycleStateEnum
GetInstanceAgentCommandExecutionLifecycleStateEnumValues Enumerates the set of values for InstanceAgentCommandExecutionLifecycleStateEnum
type InstanceAgentCommandExecutionOutputContent ¶
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
}
InstanceAgentCommandExecutionOutputContent The execution output from a command.
type InstanceAgentCommandExecutionOutputContentOutputTypeEnum ¶
type InstanceAgentCommandExecutionOutputContentOutputTypeEnum string
InstanceAgentCommandExecutionOutputContentOutputTypeEnum Enum with underlying type: string
const ( InstanceAgentCommandExecutionOutputContentOutputTypeText InstanceAgentCommandExecutionOutputContentOutputTypeEnum = "TEXT" InstanceAgentCommandExecutionOutputContentOutputTypeObjectStorageUri InstanceAgentCommandExecutionOutputContentOutputTypeEnum = "OBJECT_STORAGE_URI" InstanceAgentCommandExecutionOutputContentOutputTypeObjectStorageTuple InstanceAgentCommandExecutionOutputContentOutputTypeEnum = "OBJECT_STORAGE_TUPLE" )
Set of constants representing the allowable values for InstanceAgentCommandExecutionOutputContentOutputTypeEnum
func GetInstanceAgentCommandExecutionOutputContentOutputTypeEnumValues ¶
func GetInstanceAgentCommandExecutionOutputContentOutputTypeEnumValues() []InstanceAgentCommandExecutionOutputContentOutputTypeEnum
GetInstanceAgentCommandExecutionOutputContentOutputTypeEnumValues Enumerates the set of values for InstanceAgentCommandExecutionOutputContentOutputTypeEnum
type InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails ¶
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"`
}
InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails The execution output from a command when saved to an Object Storage bucket.
func (InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails) GetExitCode ¶
func (m InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails) GetExitCode() *int
GetExitCode returns ExitCode
func (InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails) GetMessage ¶
func (m InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails) GetMessage() *string
GetMessage returns Message
func (InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails) MarshalJSON ¶
func (m InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails) String ¶
func (m InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails) String() string
type InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails ¶
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"`
}
InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails The execution output from a command when saved to an Object Storage URL.
func (InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails) GetExitCode ¶
func (m InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails) GetExitCode() *int
GetExitCode returns ExitCode
func (InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails) GetMessage ¶
func (m InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails) GetMessage() *string
GetMessage returns Message
func (InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails) MarshalJSON ¶
func (m InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails) String ¶
func (m InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails) String() string
type InstanceAgentCommandExecutionOutputViaTextDetails ¶
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"`
}
InstanceAgentCommandExecutionOutputViaTextDetails The execution output from a command when returned in plain text.
func (InstanceAgentCommandExecutionOutputViaTextDetails) GetExitCode ¶
func (m InstanceAgentCommandExecutionOutputViaTextDetails) GetExitCode() *int
GetExitCode returns ExitCode
func (InstanceAgentCommandExecutionOutputViaTextDetails) GetMessage ¶
func (m InstanceAgentCommandExecutionOutputViaTextDetails) GetMessage() *string
GetMessage returns Message
func (InstanceAgentCommandExecutionOutputViaTextDetails) MarshalJSON ¶
func (m InstanceAgentCommandExecutionOutputViaTextDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (InstanceAgentCommandExecutionOutputViaTextDetails) String ¶
func (m InstanceAgentCommandExecutionOutputViaTextDetails) String() string
type InstanceAgentCommandExecutionSummary ¶
type InstanceAgentCommandExecutionSummary struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the command.
InstanceAgentCommandId *string `mandatory:"true" json:"instanceAgentCommandId"`
// The OCID (https://docs.cloud.oracle.com/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"`
}
InstanceAgentCommandExecutionSummary Execution details for a command.
func (InstanceAgentCommandExecutionSummary) String ¶
func (m InstanceAgentCommandExecutionSummary) String() string
func (*InstanceAgentCommandExecutionSummary) UnmarshalJSON ¶
func (m *InstanceAgentCommandExecutionSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
type InstanceAgentCommandExecutionSummaryDeliveryStateEnum ¶
type InstanceAgentCommandExecutionSummaryDeliveryStateEnum string
InstanceAgentCommandExecutionSummaryDeliveryStateEnum Enum with underlying type: string
const ( InstanceAgentCommandExecutionSummaryDeliveryStateVisible InstanceAgentCommandExecutionSummaryDeliveryStateEnum = "VISIBLE" InstanceAgentCommandExecutionSummaryDeliveryStatePending InstanceAgentCommandExecutionSummaryDeliveryStateEnum = "PENDING" InstanceAgentCommandExecutionSummaryDeliveryStateAcked InstanceAgentCommandExecutionSummaryDeliveryStateEnum = "ACKED" InstanceAgentCommandExecutionSummaryDeliveryStateAckedCanceled InstanceAgentCommandExecutionSummaryDeliveryStateEnum = "ACKED_CANCELED" InstanceAgentCommandExecutionSummaryDeliveryStateExpired InstanceAgentCommandExecutionSummaryDeliveryStateEnum = "EXPIRED" )
Set of constants representing the allowable values for InstanceAgentCommandExecutionSummaryDeliveryStateEnum
func GetInstanceAgentCommandExecutionSummaryDeliveryStateEnumValues ¶
func GetInstanceAgentCommandExecutionSummaryDeliveryStateEnumValues() []InstanceAgentCommandExecutionSummaryDeliveryStateEnum
GetInstanceAgentCommandExecutionSummaryDeliveryStateEnumValues Enumerates the set of values for InstanceAgentCommandExecutionSummaryDeliveryStateEnum
type InstanceAgentCommandExecutionSummaryLifecycleStateEnum ¶
type InstanceAgentCommandExecutionSummaryLifecycleStateEnum string
InstanceAgentCommandExecutionSummaryLifecycleStateEnum Enum with underlying type: string
const ( InstanceAgentCommandExecutionSummaryLifecycleStateAccepted InstanceAgentCommandExecutionSummaryLifecycleStateEnum = "ACCEPTED" InstanceAgentCommandExecutionSummaryLifecycleStateInProgress InstanceAgentCommandExecutionSummaryLifecycleStateEnum = "IN_PROGRESS" InstanceAgentCommandExecutionSummaryLifecycleStateSucceeded InstanceAgentCommandExecutionSummaryLifecycleStateEnum = "SUCCEEDED" InstanceAgentCommandExecutionSummaryLifecycleStateFailed InstanceAgentCommandExecutionSummaryLifecycleStateEnum = "FAILED" InstanceAgentCommandExecutionSummaryLifecycleStateTimedOut InstanceAgentCommandExecutionSummaryLifecycleStateEnum = "TIMED_OUT" InstanceAgentCommandExecutionSummaryLifecycleStateCanceled InstanceAgentCommandExecutionSummaryLifecycleStateEnum = "CANCELED" )
Set of constants representing the allowable values for InstanceAgentCommandExecutionSummaryLifecycleStateEnum
func GetInstanceAgentCommandExecutionSummaryLifecycleStateEnumValues ¶
func GetInstanceAgentCommandExecutionSummaryLifecycleStateEnumValues() []InstanceAgentCommandExecutionSummaryLifecycleStateEnum
GetInstanceAgentCommandExecutionSummaryLifecycleStateEnumValues Enumerates the set of values for InstanceAgentCommandExecutionSummaryLifecycleStateEnum
type InstanceAgentCommandOutputDetails ¶
type InstanceAgentCommandOutputDetails interface {
}
InstanceAgentCommandOutputDetails The output destination for the command.
type InstanceAgentCommandOutputDetailsOutputTypeEnum ¶
type InstanceAgentCommandOutputDetailsOutputTypeEnum string
InstanceAgentCommandOutputDetailsOutputTypeEnum Enum with underlying type: string
const ( InstanceAgentCommandOutputDetailsOutputTypeText InstanceAgentCommandOutputDetailsOutputTypeEnum = "TEXT" InstanceAgentCommandOutputDetailsOutputTypeObjectStorageUri InstanceAgentCommandOutputDetailsOutputTypeEnum = "OBJECT_STORAGE_URI" InstanceAgentCommandOutputDetailsOutputTypeObjectStorageTuple InstanceAgentCommandOutputDetailsOutputTypeEnum = "OBJECT_STORAGE_TUPLE" )
Set of constants representing the allowable values for InstanceAgentCommandOutputDetailsOutputTypeEnum
func GetInstanceAgentCommandOutputDetailsOutputTypeEnumValues ¶
func GetInstanceAgentCommandOutputDetailsOutputTypeEnumValues() []InstanceAgentCommandOutputDetailsOutputTypeEnum
GetInstanceAgentCommandOutputDetailsOutputTypeEnumValues Enumerates the set of values for InstanceAgentCommandOutputDetailsOutputTypeEnum
type InstanceAgentCommandOutputViaObjectStorageTupleDetails ¶
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"`
}
InstanceAgentCommandOutputViaObjectStorageTupleDetails The command output destination when saved to an Object Storage bucket.
func (InstanceAgentCommandOutputViaObjectStorageTupleDetails) MarshalJSON ¶
func (m InstanceAgentCommandOutputViaObjectStorageTupleDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (InstanceAgentCommandOutputViaObjectStorageTupleDetails) String ¶
func (m InstanceAgentCommandOutputViaObjectStorageTupleDetails) String() string
type InstanceAgentCommandOutputViaObjectStorageUriDetails ¶
type InstanceAgentCommandOutputViaObjectStorageUriDetails struct {
// The Object Storage URL or pre-authenticated request (PAR) for the command output.
OutputUri *string `mandatory:"true" json:"outputUri"`
}
InstanceAgentCommandOutputViaObjectStorageUriDetails The command output destination when saved to an Object Storage URL.
func (InstanceAgentCommandOutputViaObjectStorageUriDetails) MarshalJSON ¶
func (m InstanceAgentCommandOutputViaObjectStorageUriDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (InstanceAgentCommandOutputViaObjectStorageUriDetails) String ¶
func (m InstanceAgentCommandOutputViaObjectStorageUriDetails) String() string
type InstanceAgentCommandOutputViaTextDetails ¶
type InstanceAgentCommandOutputViaTextDetails struct {
}
InstanceAgentCommandOutputViaTextDetails The command output destination when returned in plain text.
func (InstanceAgentCommandOutputViaTextDetails) MarshalJSON ¶
func (m InstanceAgentCommandOutputViaTextDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (InstanceAgentCommandOutputViaTextDetails) String ¶
func (m InstanceAgentCommandOutputViaTextDetails) String() string
type InstanceAgentCommandSourceDetails ¶
type InstanceAgentCommandSourceDetails interface {
}
InstanceAgentCommandSourceDetails The source of the command.
type InstanceAgentCommandSourceDetailsSourceTypeEnum ¶
type InstanceAgentCommandSourceDetailsSourceTypeEnum string
InstanceAgentCommandSourceDetailsSourceTypeEnum Enum with underlying type: string
const ( InstanceAgentCommandSourceDetailsSourceTypeText InstanceAgentCommandSourceDetailsSourceTypeEnum = "TEXT" InstanceAgentCommandSourceDetailsSourceTypeObjectStorageUri InstanceAgentCommandSourceDetailsSourceTypeEnum = "OBJECT_STORAGE_URI" InstanceAgentCommandSourceDetailsSourceTypeObjectStorageTuple InstanceAgentCommandSourceDetailsSourceTypeEnum = "OBJECT_STORAGE_TUPLE" )
Set of constants representing the allowable values for InstanceAgentCommandSourceDetailsSourceTypeEnum
func GetInstanceAgentCommandSourceDetailsSourceTypeEnumValues ¶
func GetInstanceAgentCommandSourceDetailsSourceTypeEnumValues() []InstanceAgentCommandSourceDetailsSourceTypeEnum
GetInstanceAgentCommandSourceDetailsSourceTypeEnumValues Enumerates the set of values for InstanceAgentCommandSourceDetailsSourceTypeEnum
type InstanceAgentCommandSourceViaObjectStorageTupleDetails ¶
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"`
}
InstanceAgentCommandSourceViaObjectStorageTupleDetails The source of the command when imported from an Object Storage bucket.
func (InstanceAgentCommandSourceViaObjectStorageTupleDetails) MarshalJSON ¶
func (m InstanceAgentCommandSourceViaObjectStorageTupleDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (InstanceAgentCommandSourceViaObjectStorageTupleDetails) String ¶
func (m InstanceAgentCommandSourceViaObjectStorageTupleDetails) String() string
type InstanceAgentCommandSourceViaObjectStorageUriDetails ¶
type InstanceAgentCommandSourceViaObjectStorageUriDetails struct {
// The Object Storage URL or pre-authenticated request (PAR) for the command.
SourceUri *string `mandatory:"true" json:"sourceUri"`
}
InstanceAgentCommandSourceViaObjectStorageUriDetails The source of the command when imported from an Object Storage URL.
func (InstanceAgentCommandSourceViaObjectStorageUriDetails) MarshalJSON ¶
func (m InstanceAgentCommandSourceViaObjectStorageUriDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (InstanceAgentCommandSourceViaObjectStorageUriDetails) String ¶
func (m InstanceAgentCommandSourceViaObjectStorageUriDetails) String() string
type InstanceAgentCommandSourceViaTextDetails ¶
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"`
}
InstanceAgentCommandSourceViaTextDetails The source of the command when provided using plain text.
func (InstanceAgentCommandSourceViaTextDetails) MarshalJSON ¶
func (m InstanceAgentCommandSourceViaTextDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (InstanceAgentCommandSourceViaTextDetails) String ¶
func (m InstanceAgentCommandSourceViaTextDetails) String() string
type InstanceAgentCommandSummary ¶
type InstanceAgentCommandSummary struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the command.
InstanceAgentCommandId *string `mandatory:"true" json:"instanceAgentCommandId"`
// The OCID (https://docs.cloud.oracle.com/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"`
}
InstanceAgentCommandSummary Summary information for a command.
func (InstanceAgentCommandSummary) String ¶
func (m InstanceAgentCommandSummary) String() string
type InstanceAgentCommandTarget ¶
type InstanceAgentCommandTarget struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the target instance.
InstanceId *string `mandatory:"false" json:"instanceId"`
}
InstanceAgentCommandTarget The target instance that the command runs on.
func (InstanceAgentCommandTarget) String ¶
func (m InstanceAgentCommandTarget) String() string
type InstanceAgentPlugin ¶
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"`
}
InstanceAgentPlugin The agent plugin
func (InstanceAgentPlugin) String ¶
func (m InstanceAgentPlugin) String() string
type InstanceAgentPluginStatusEnum ¶
type InstanceAgentPluginStatusEnum string
InstanceAgentPluginStatusEnum Enum with underlying type: string
const ( InstanceAgentPluginStatusRunning InstanceAgentPluginStatusEnum = "RUNNING" InstanceAgentPluginStatusStopped InstanceAgentPluginStatusEnum = "STOPPED" InstanceAgentPluginStatusNotSupported InstanceAgentPluginStatusEnum = "NOT_SUPPORTED" InstanceAgentPluginStatusInvalid InstanceAgentPluginStatusEnum = "INVALID" )
Set of constants representing the allowable values for InstanceAgentPluginStatusEnum
func GetInstanceAgentPluginStatusEnumValues ¶
func GetInstanceAgentPluginStatusEnumValues() []InstanceAgentPluginStatusEnum
GetInstanceAgentPluginStatusEnumValues Enumerates the set of values for InstanceAgentPluginStatusEnum
type InstanceAgentPluginSummary ¶
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"`
}
InstanceAgentPluginSummary The agent plugin information
func (InstanceAgentPluginSummary) String ¶
func (m InstanceAgentPluginSummary) String() string
type InstanceAgentPluginSummaryStatusEnum ¶
type InstanceAgentPluginSummaryStatusEnum string
InstanceAgentPluginSummaryStatusEnum Enum with underlying type: string
const ( InstanceAgentPluginSummaryStatusRunning InstanceAgentPluginSummaryStatusEnum = "RUNNING" InstanceAgentPluginSummaryStatusStopped InstanceAgentPluginSummaryStatusEnum = "STOPPED" InstanceAgentPluginSummaryStatusNotSupported InstanceAgentPluginSummaryStatusEnum = "NOT_SUPPORTED" InstanceAgentPluginSummaryStatusInvalid InstanceAgentPluginSummaryStatusEnum = "INVALID" )
Set of constants representing the allowable values for InstanceAgentPluginSummaryStatusEnum
func GetInstanceAgentPluginSummaryStatusEnumValues ¶
func GetInstanceAgentPluginSummaryStatusEnumValues() []InstanceAgentPluginSummaryStatusEnum
GetInstanceAgentPluginSummaryStatusEnumValues Enumerates the set of values for InstanceAgentPluginSummaryStatusEnum
type ListInstanceAgentCommandExecutionsRequest ¶
type ListInstanceAgentCommandExecutionsRequest struct {
// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.cloud.oracle.com/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.cloud.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.cloud.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
}
ListInstanceAgentCommandExecutionsRequest wrapper for the ListInstanceAgentCommandExecutions operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/ListInstanceAgentCommandExecutions.go.html to see an example of how to use ListInstanceAgentCommandExecutionsRequest.
func (ListInstanceAgentCommandExecutionsRequest) HTTPRequest ¶
func (request ListInstanceAgentCommandExecutionsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListInstanceAgentCommandExecutionsRequest) RetryPolicy ¶
func (request ListInstanceAgentCommandExecutionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListInstanceAgentCommandExecutionsRequest) String ¶
func (request ListInstanceAgentCommandExecutionsRequest) String() string
type ListInstanceAgentCommandExecutionsResponse ¶
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.cloud.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"`
}
ListInstanceAgentCommandExecutionsResponse wrapper for the ListInstanceAgentCommandExecutions operation
func (ListInstanceAgentCommandExecutionsResponse) HTTPResponse ¶
func (response ListInstanceAgentCommandExecutionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListInstanceAgentCommandExecutionsResponse) String ¶
func (response ListInstanceAgentCommandExecutionsResponse) String() string
type ListInstanceAgentCommandExecutionsSortByEnum ¶
type ListInstanceAgentCommandExecutionsSortByEnum string
ListInstanceAgentCommandExecutionsSortByEnum Enum with underlying type: string
const ( ListInstanceAgentCommandExecutionsSortByTimecreated ListInstanceAgentCommandExecutionsSortByEnum = "TIMECREATED" ListInstanceAgentCommandExecutionsSortByDisplayname ListInstanceAgentCommandExecutionsSortByEnum = "DISPLAYNAME" )
Set of constants representing the allowable values for ListInstanceAgentCommandExecutionsSortByEnum
func GetListInstanceAgentCommandExecutionsSortByEnumValues ¶
func GetListInstanceAgentCommandExecutionsSortByEnumValues() []ListInstanceAgentCommandExecutionsSortByEnum
GetListInstanceAgentCommandExecutionsSortByEnumValues Enumerates the set of values for ListInstanceAgentCommandExecutionsSortByEnum
type ListInstanceAgentCommandExecutionsSortOrderEnum ¶
type ListInstanceAgentCommandExecutionsSortOrderEnum string
ListInstanceAgentCommandExecutionsSortOrderEnum Enum with underlying type: string
const ( ListInstanceAgentCommandExecutionsSortOrderAsc ListInstanceAgentCommandExecutionsSortOrderEnum = "ASC" ListInstanceAgentCommandExecutionsSortOrderDesc ListInstanceAgentCommandExecutionsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListInstanceAgentCommandExecutionsSortOrderEnum
func GetListInstanceAgentCommandExecutionsSortOrderEnumValues ¶
func GetListInstanceAgentCommandExecutionsSortOrderEnumValues() []ListInstanceAgentCommandExecutionsSortOrderEnum
GetListInstanceAgentCommandExecutionsSortOrderEnumValues Enumerates the set of values for ListInstanceAgentCommandExecutionsSortOrderEnum
type ListInstanceAgentCommandsRequest ¶
type ListInstanceAgentCommandsRequest struct {
// The OCID (https://docs.cloud.oracle.com/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.cloud.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.cloud.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
}
ListInstanceAgentCommandsRequest wrapper for the ListInstanceAgentCommands operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/ListInstanceAgentCommands.go.html to see an example of how to use ListInstanceAgentCommandsRequest.
func (ListInstanceAgentCommandsRequest) HTTPRequest ¶
func (request ListInstanceAgentCommandsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListInstanceAgentCommandsRequest) RetryPolicy ¶
func (request ListInstanceAgentCommandsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListInstanceAgentCommandsRequest) String ¶
func (request ListInstanceAgentCommandsRequest) String() string
type ListInstanceAgentCommandsResponse ¶
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.cloud.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"`
}
ListInstanceAgentCommandsResponse wrapper for the ListInstanceAgentCommands operation
func (ListInstanceAgentCommandsResponse) HTTPResponse ¶
func (response ListInstanceAgentCommandsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListInstanceAgentCommandsResponse) String ¶
func (response ListInstanceAgentCommandsResponse) String() string
type ListInstanceAgentCommandsSortByEnum ¶
type ListInstanceAgentCommandsSortByEnum string
ListInstanceAgentCommandsSortByEnum Enum with underlying type: string
const ( ListInstanceAgentCommandsSortByTimecreated ListInstanceAgentCommandsSortByEnum = "TIMECREATED" ListInstanceAgentCommandsSortByDisplayname ListInstanceAgentCommandsSortByEnum = "DISPLAYNAME" )
Set of constants representing the allowable values for ListInstanceAgentCommandsSortByEnum
func GetListInstanceAgentCommandsSortByEnumValues ¶
func GetListInstanceAgentCommandsSortByEnumValues() []ListInstanceAgentCommandsSortByEnum
GetListInstanceAgentCommandsSortByEnumValues Enumerates the set of values for ListInstanceAgentCommandsSortByEnum
type ListInstanceAgentCommandsSortOrderEnum ¶
type ListInstanceAgentCommandsSortOrderEnum string
ListInstanceAgentCommandsSortOrderEnum Enum with underlying type: string
const ( ListInstanceAgentCommandsSortOrderAsc ListInstanceAgentCommandsSortOrderEnum = "ASC" ListInstanceAgentCommandsSortOrderDesc ListInstanceAgentCommandsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListInstanceAgentCommandsSortOrderEnum
func GetListInstanceAgentCommandsSortOrderEnumValues ¶
func GetListInstanceAgentCommandsSortOrderEnumValues() []ListInstanceAgentCommandsSortOrderEnum
GetListInstanceAgentCommandsSortOrderEnumValues Enumerates the set of values for ListInstanceAgentCommandsSortOrderEnum
type ListInstanceAgentPluginsRequest ¶
type ListInstanceAgentPluginsRequest struct {
// The OCID (https://docs.cloud.oracle.com/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.cloud.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.cloud.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
}
ListInstanceAgentPluginsRequest wrapper for the ListInstanceAgentPlugins operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/ListInstanceAgentPlugins.go.html to see an example of how to use ListInstanceAgentPluginsRequest.
func (ListInstanceAgentPluginsRequest) HTTPRequest ¶
func (request ListInstanceAgentPluginsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListInstanceAgentPluginsRequest) RetryPolicy ¶
func (request ListInstanceAgentPluginsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListInstanceAgentPluginsRequest) String ¶
func (request ListInstanceAgentPluginsRequest) String() string
type ListInstanceAgentPluginsResponse ¶
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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
ListInstanceAgentPluginsResponse wrapper for the ListInstanceAgentPlugins operation
func (ListInstanceAgentPluginsResponse) HTTPResponse ¶
func (response ListInstanceAgentPluginsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListInstanceAgentPluginsResponse) String ¶
func (response ListInstanceAgentPluginsResponse) String() string
type ListInstanceAgentPluginsSortByEnum ¶
type ListInstanceAgentPluginsSortByEnum string
ListInstanceAgentPluginsSortByEnum Enum with underlying type: string
const ( ListInstanceAgentPluginsSortByTimecreated ListInstanceAgentPluginsSortByEnum = "TIMECREATED" ListInstanceAgentPluginsSortByDisplayname ListInstanceAgentPluginsSortByEnum = "DISPLAYNAME" )
Set of constants representing the allowable values for ListInstanceAgentPluginsSortByEnum
func GetListInstanceAgentPluginsSortByEnumValues ¶
func GetListInstanceAgentPluginsSortByEnumValues() []ListInstanceAgentPluginsSortByEnum
GetListInstanceAgentPluginsSortByEnumValues Enumerates the set of values for ListInstanceAgentPluginsSortByEnum
type ListInstanceAgentPluginsSortOrderEnum ¶
type ListInstanceAgentPluginsSortOrderEnum string
ListInstanceAgentPluginsSortOrderEnum Enum with underlying type: string
const ( ListInstanceAgentPluginsSortOrderAsc ListInstanceAgentPluginsSortOrderEnum = "ASC" ListInstanceAgentPluginsSortOrderDesc ListInstanceAgentPluginsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListInstanceAgentPluginsSortOrderEnum
func GetListInstanceAgentPluginsSortOrderEnumValues ¶
func GetListInstanceAgentPluginsSortOrderEnumValues() []ListInstanceAgentPluginsSortOrderEnum
GetListInstanceAgentPluginsSortOrderEnumValues Enumerates the set of values for ListInstanceAgentPluginsSortOrderEnum
type ListInstanceAgentPluginsStatusEnum ¶
type ListInstanceAgentPluginsStatusEnum string
ListInstanceAgentPluginsStatusEnum Enum with underlying type: string
const ( ListInstanceAgentPluginsStatusRunning ListInstanceAgentPluginsStatusEnum = "RUNNING" ListInstanceAgentPluginsStatusStopped ListInstanceAgentPluginsStatusEnum = "STOPPED" ListInstanceAgentPluginsStatusNotSupported ListInstanceAgentPluginsStatusEnum = "NOT_SUPPORTED" ListInstanceAgentPluginsStatusInvalid ListInstanceAgentPluginsStatusEnum = "INVALID" )
Set of constants representing the allowable values for ListInstanceAgentPluginsStatusEnum
func GetListInstanceAgentPluginsStatusEnumValues ¶
func GetListInstanceAgentPluginsStatusEnumValues() []ListInstanceAgentPluginsStatusEnum
GetListInstanceAgentPluginsStatusEnumValues Enumerates the set of values for ListInstanceAgentPluginsStatusEnum
type ListInstanceagentAvailablePluginsRequest ¶
type ListInstanceagentAvailablePluginsRequest struct {
// The OCID (https://docs.cloud.oracle.com/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.cloud.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.cloud.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
}
ListInstanceagentAvailablePluginsRequest wrapper for the ListInstanceagentAvailablePlugins operation
See also ¶
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/computeinstanceagent/ListInstanceagentAvailablePlugins.go.html to see an example of how to use ListInstanceagentAvailablePluginsRequest.
func (ListInstanceagentAvailablePluginsRequest) HTTPRequest ¶
func (request ListInstanceagentAvailablePluginsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListInstanceagentAvailablePluginsRequest) RetryPolicy ¶
func (request ListInstanceagentAvailablePluginsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListInstanceagentAvailablePluginsRequest) String ¶
func (request ListInstanceagentAvailablePluginsRequest) String() string
type ListInstanceagentAvailablePluginsResponse ¶
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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
ListInstanceagentAvailablePluginsResponse wrapper for the ListInstanceagentAvailablePlugins operation
func (ListInstanceagentAvailablePluginsResponse) HTTPResponse ¶
func (response ListInstanceagentAvailablePluginsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListInstanceagentAvailablePluginsResponse) String ¶
func (response ListInstanceagentAvailablePluginsResponse) String() string
type ListInstanceagentAvailablePluginsSortByEnum ¶
type ListInstanceagentAvailablePluginsSortByEnum string
ListInstanceagentAvailablePluginsSortByEnum Enum with underlying type: string
const ( ListInstanceagentAvailablePluginsSortByTimecreated ListInstanceagentAvailablePluginsSortByEnum = "TIMECREATED" ListInstanceagentAvailablePluginsSortByDisplayname ListInstanceagentAvailablePluginsSortByEnum = "DISPLAYNAME" )
Set of constants representing the allowable values for ListInstanceagentAvailablePluginsSortByEnum
func GetListInstanceagentAvailablePluginsSortByEnumValues ¶
func GetListInstanceagentAvailablePluginsSortByEnumValues() []ListInstanceagentAvailablePluginsSortByEnum
GetListInstanceagentAvailablePluginsSortByEnumValues Enumerates the set of values for ListInstanceagentAvailablePluginsSortByEnum
type ListInstanceagentAvailablePluginsSortOrderEnum ¶
type ListInstanceagentAvailablePluginsSortOrderEnum string
ListInstanceagentAvailablePluginsSortOrderEnum Enum with underlying type: string
const ( ListInstanceagentAvailablePluginsSortOrderAsc ListInstanceagentAvailablePluginsSortOrderEnum = "ASC" ListInstanceagentAvailablePluginsSortOrderDesc ListInstanceagentAvailablePluginsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListInstanceagentAvailablePluginsSortOrderEnum
func GetListInstanceagentAvailablePluginsSortOrderEnumValues ¶
func GetListInstanceagentAvailablePluginsSortOrderEnumValues() []ListInstanceagentAvailablePluginsSortOrderEnum
GetListInstanceagentAvailablePluginsSortOrderEnumValues Enumerates the set of values for ListInstanceagentAvailablePluginsSortOrderEnum
type 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"`
}
Plugin The agent plugin
type PluginClient ¶
type PluginClient struct {
common.BaseClient
// contains filtered or unexported fields
}
PluginClient a client for Plugin
func NewPluginClientWithConfigurationProvider ¶
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 ¶
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 (*PluginClient) ConfigurationProvider ¶
func (client *PluginClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (PluginClient) GetInstanceAgentPlugin ¶
func (client PluginClient) GetInstanceAgentPlugin(ctx context.Context, request GetInstanceAgentPluginRequest) (response GetInstanceAgentPluginResponse, err error)
GetInstanceAgentPlugin The API to get information for a plugin.
See also ¶
Click https://docs.cloud.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 (PluginClient) ListInstanceAgentPlugins ¶
func (client PluginClient) ListInstanceAgentPlugins(ctx context.Context, request ListInstanceAgentPluginsRequest) (response ListInstanceAgentPluginsResponse, err error)
ListInstanceAgentPlugins The API to get one or more plugin information.
See also ¶
Click https://docs.cloud.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 (*PluginClient) SetRegion ¶
func (client *PluginClient) SetRegion(region string)
SetRegion overrides the region of this client.
type PluginconfigClient ¶
type PluginconfigClient struct {
common.BaseClient
// contains filtered or unexported fields
}
PluginconfigClient a client for Pluginconfig
func NewPluginconfigClientWithConfigurationProvider ¶
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 ¶
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 (*PluginconfigClient) ConfigurationProvider ¶
func (client *PluginconfigClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (PluginconfigClient) ListInstanceagentAvailablePlugins ¶
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.
See also ¶
Click https://docs.cloud.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 (*PluginconfigClient) SetRegion ¶
func (client *PluginconfigClient) SetRegion(region string)
SetRegion overrides the region of this client.
Source Files
¶
- available_plugin_summary.go
- cancel_instance_agent_command_request_response.go
- computeinstanceagent_client.go
- computeinstanceagent_plugin_client.go
- computeinstanceagent_pluginconfig_client.go
- create_instance_agent_command_details.go
- create_instance_agent_command_request_response.go
- get_instance_agent_command_execution_request_response.go
- get_instance_agent_command_request_response.go
- get_instance_agent_plugin_request_response.go
- instance_agent_command.go
- instance_agent_command_content.go
- instance_agent_command_execution.go
- instance_agent_command_execution_output_content.go
- instance_agent_command_execution_output_via_object_storage_tuple_details.go
- instance_agent_command_execution_output_via_object_storage_uri_details.go
- instance_agent_command_execution_output_via_text_details.go
- instance_agent_command_execution_summary.go
- instance_agent_command_output_details.go
- instance_agent_command_output_via_object_storage_tuple_details.go
- instance_agent_command_output_via_object_storage_uri_details.go
- instance_agent_command_output_via_text_details.go
- instance_agent_command_source_details.go
- instance_agent_command_source_via_object_storage_tuple_details.go
- instance_agent_command_source_via_object_storage_uri_details.go
- instance_agent_command_source_via_text_details.go
- instance_agent_command_summary.go
- instance_agent_command_target.go
- instance_agent_plugin.go
- instance_agent_plugin_summary.go
- list_instance_agent_command_executions_request_response.go
- list_instance_agent_commands_request_response.go
- list_instance_agent_plugins_request_response.go
- list_instanceagent_available_plugins_request_response.go
- plugin.go