computeinstanceagent

package
v31.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 15, 2020 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CancelInstanceAgentCommandRequest 

type CancelInstanceAgentCommandRequest struct {

	// The OCID of the command.
	InstanceAgentCommandId *string `mandatory:"true" contributesTo:"path" name:"instanceAgentCommandId"`

	// Unique 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 Cancel a command. Cancel is best effort attempt. If the commmand has already completed it will skip cancel.

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 Create command for one or more managed instances

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 the specified instance agent commandId.

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 List all executions of a command, i.e return command execution results from all targeted instances batch by batch.

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 List Instance agent commands issued with the specified filter. Additonally you can filter commands sent to a particular InstanceId

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 of the compartment you want to create the command.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Command execution time limit. Zero means no timeout.
	ExecutionTimeOutInSeconds *int `mandatory:"true" json:"executionTimeOutInSeconds"`

	Target *InstanceAgentCommandTarget `mandatory:"true" json:"target"`

	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 Command`
	DisplayName *string `mandatory:"false" json:"displayName"`
}

CreateInstanceAgentCommandDetails Create Command Details

func (CreateInstanceAgentCommandDetails) String 

func (m CreateInstanceAgentCommandDetails) String() string

type CreateInstanceAgentCommandRequest 

type CreateInstanceAgentCommandRequest struct {

	// Create Instance agent command details
	CreateInstanceAgentCommandDetails `contributesTo:"body"`

	// Unique 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 of the command.
	InstanceAgentCommandId *string `mandatory:"true" contributesTo:"path" name:"instanceAgentCommandId"`

	// The OCID of the instance.
	InstanceId *string `mandatory:"true" contributesTo:"query" name:"instanceId"`

	// Unique 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 of the command.
	InstanceAgentCommandId *string `mandatory:"true" contributesTo:"path" name:"instanceAgentCommandId"`

	// Unique 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 InstanceAgentCommand 

type InstanceAgentCommand struct {

	// The command OCID
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the compartment the command is created in.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	Target *InstanceAgentCommandTarget `mandatory:"true" json:"target"`

	Content *InstanceAgentCommandContent `mandatory:"true" json:"content"`

	// The user friendly display name of the command.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// the time command was created at.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// the time command was updated at.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// Whether the command has been requested to be canceled.
	IsCanceled *bool `mandatory:"false" json:"isCanceled"`

	// Command execution time limit that the instance agent will honor when executing the command inside the instance. This timer starts when the instance agent starts the commond. 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 {
	Source InstanceAgentCommandSourceDetails `mandatory:"true" json:"source"`

	Output InstanceAgentCommandOutputDetails `mandatory:"false" json:"output"`
}

InstanceAgentCommandContent Command content.

func (InstanceAgentCommandContent) String 

func (m InstanceAgentCommandContent) String() string

func (*InstanceAgentCommandContent) UnmarshalJSON 

func (m *InstanceAgentCommandContent) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type InstanceAgentCommandContentInfo 

type InstanceAgentCommandContentInfo struct {

	// The command ocid
	InstanceAgentCommandId *string `mandatory:"true" json:"instanceAgentCommandId"`

	// The OCID of the compartment the command is created in.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	Content *InstanceAgentCommandContent `mandatory:"true" json:"content"`

	// created at time of command.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// updated time of command.
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// Whether the command has been canceled.
	IsCanceled *bool `mandatory:"false" json:"isCanceled"`

	// The last command time.
	ExecutionTimeOutInSeconds *int `mandatory:"false" json:"executionTimeOutInSeconds"`
}

InstanceAgentCommandContentInfo The command content.

func (InstanceAgentCommandContentInfo) String 

func (m InstanceAgentCommandContentInfo) String() string

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 {

	// command exit code.
	GetExitCode() *int

	// optional status message that agent's can populate for additional troubleshooting.
	GetMessage() *string
}

InstanceAgentCommandExecutionOutputContent command execution output.

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 {

	// command exit code.
	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 name for the command output.
	ObjectName *string `mandatory:"true" json:"objectName"`

	// optional status message that agent's can populate for additional troubleshooting.
	Message *string `mandatory:"false" json:"message"`
}

InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails command execution output via object storage tuple.

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 {

	// command exit code.
	ExitCode *int `mandatory:"true" json:"exitCode"`

	// The Object Storage URL or PAR for the command output.
	OutputUri *string `mandatory:"true" json:"outputUri"`

	// optional status message that agent's can populate for additional troubleshooting.
	Message *string `mandatory:"false" json:"message"`
}

InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails command execution output via uri.

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 {

	// command exit code.
	ExitCode *int `mandatory:"true" json:"exitCode"`

	// The command response output.
	Text *string `mandatory:"true" json:"text"`

	// optional status message that agent's can populate for additional troubleshooting.
	Message *string `mandatory:"false" json:"message"`

	// Sha256 checksum value of the text content
	TextSha256 *string `mandatory:"false" json:"textSha256"`
}

InstanceAgentCommandExecutionOutputViaTextDetails command execution output via 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 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 InstanceAgentCommandExecutionSummaryDeliveryStateEnum `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 InstanceAgentCommandExecutionSummaryLifecycleStateEnum `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"`
}

InstanceAgentCommandExecutionSummary A command's execution summary.

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 Command output.

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 name for the command output.
	ObjectName *string `mandatory:"true" json:"objectName"`
}

InstanceAgentCommandOutputViaObjectStorageTupleDetails Command output via object storage tuple.

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 PAR for the command output.
	OutputUri *string `mandatory:"true" json:"outputUri"`
}

InstanceAgentCommandOutputViaObjectStorageUriDetails Command output via uri.

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 Command output via 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 Command content.

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 name for the command.
	ObjectName *string `mandatory:"true" json:"objectName"`
}

InstanceAgentCommandSourceViaObjectStorageTupleDetails Command content via object storage tuple.

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 PAR for the command.
	SourceUri *string `mandatory:"true" json:"sourceUri"`
}

InstanceAgentCommandSourceViaObjectStorageUriDetails Command content via uri.

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"`

	// Sha256 checksum value of the text content
	TextSha256 *string `mandatory:"false" json:"textSha256"`
}

InstanceAgentCommandSourceViaTextDetails Command content via 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 command OCID
	InstanceAgentCommandId *string `mandatory:"true" json:"instanceAgentCommandId"`

	// The OCID of the compartment the command is created in.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// 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 user friendly display name of the command.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Set to true, if the command has been canceled.
	IsCanceled *bool `mandatory:"false" json:"isCanceled"`
}

InstanceAgentCommandSummary command summary.

func (InstanceAgentCommandSummary) String 

func (m InstanceAgentCommandSummary) String() string

type InstanceAgentCommandTarget 

type InstanceAgentCommandTarget struct {

	// The target instance OCID
	InstanceId *string `mandatory:"false" json:"instanceId"`
}

InstanceAgentCommandTarget Target instances that will receive a command.

func (InstanceAgentCommandTarget) String 

func (m InstanceAgentCommandTarget) String() string

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 of the instance.
	InstanceId *string `mandatory:"true" contributesTo:"query" name:"instanceId"`

	// Unique 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 value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	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 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 value of the `opc-next-page` response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The maximum number of items to return in a paginated "List" call.
	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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.