core

package
v3.5.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Jan 24, 2019 License: Apache-2.0, UPL-1.0 Imports: 5 Imported by: 0

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AppCatalogListing ¶ 

type AppCatalogListing struct {

	// Listing's contact URL.
	ContactUrl *string `mandatory:"false" json:"contactUrl"`

	// Description of the listing.
	Description *string `mandatory:"false" json:"description"`

	// The OCID of the listing.
	ListingId *string `mandatory:"false" json:"listingId"`

	// Name of the listing.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Date and time the listing was published, in RFC3339 format.
	// Example: `2018-03-20T12:32:53.532Z`
	TimePublished *common.SDKTime `mandatory:"false" json:"timePublished"`

	// Publisher's logo URL.
	PublisherLogoUrl *string `mandatory:"false" json:"publisherLogoUrl"`

	// Name of the publisher who published this listing.
	PublisherName *string `mandatory:"false" json:"publisherName"`

	// Summary of the listing.
	Summary *string `mandatory:"false" json:"summary"`
}

AppCatalogListing Listing details.

func (AppCatalogListing) String ¶ 

func (m AppCatalogListing) String() string

type AppCatalogListingResourceVersion ¶ 

type AppCatalogListingResourceVersion struct {

	// The OCID of the listing this resource version belongs to.
	ListingId *string `mandatory:"false" json:"listingId"`

	// Date and time the listing resource version was published, in RFC3339 format.
	// Example: `2018-03-20T12:32:53.532Z`
	TimePublished *common.SDKTime `mandatory:"false" json:"timePublished"`

	// OCID of the listing resource.
	ListingResourceId *string `mandatory:"false" json:"listingResourceId"`

	// Resource Version.
	ListingResourceVersion *string `mandatory:"false" json:"listingResourceVersion"`

	// List of regions that this listing resource version is available.
	// For information about Regions, see
	// Regions (https://docs.us-phoenix-1.oraclecloud.comGeneral/Concepts/regions.htm).
	// Example: `["us-ashburn-1", "us-phoenix-1"]`
	AvailableRegions []string `mandatory:"false" json:"availableRegions"`

	// Array of shapes compatible with this resource.
	// You may enumerate all available shapes by calling listShapes.
	// Example: `["VM.Standard1.1", "VM.Standard1.2"]`
	CompatibleShapes []string `mandatory:"false" json:"compatibleShapes"`

	// List of accessible ports for instances launched with this listing resource version.
	AccessiblePorts []int `mandatory:"false" json:"accessiblePorts"`

	// Allowed actions for the listing resource.
	AllowedActions []AppCatalogListingResourceVersionAllowedActionsEnum `mandatory:"false" json:"allowedActions,omitempty"`
}

AppCatalogListingResourceVersion Listing Resource Version

func (AppCatalogListingResourceVersion) String ¶ 

func (m AppCatalogListingResourceVersion) String() string

type AppCatalogListingResourceVersionAgreements ¶ 

type AppCatalogListingResourceVersionAgreements struct {

	// The OCID of the listing associated with these agreements.
	ListingId *string `mandatory:"false" json:"listingId"`

	// Listing resource version associated with these agreements.
	ListingResourceVersion *string `mandatory:"false" json:"listingResourceVersion"`

	// Oracle TOU link
	OracleTermsOfUseLink *string `mandatory:"false" json:"oracleTermsOfUseLink"`

	// EULA link
	EulaLink *string `mandatory:"false" json:"eulaLink"`

	// Date and time the agreements were retrieved, in RFC3339 format.
	// Example: `2018-03-20T12:32:53.532Z`
	TimeRetrieved *common.SDKTime `mandatory:"false" json:"timeRetrieved"`

	// A generated signature for this agreement retrieval operation which should be used in the create subscription call.
	Signature *string `mandatory:"false" json:"signature"`
}

AppCatalogListingResourceVersionAgreements Agreements for a listing resource version.

func (AppCatalogListingResourceVersionAgreements) String ¶ 

func (m AppCatalogListingResourceVersionAgreements) String() string

type AppCatalogListingResourceVersionAllowedActionsEnum ¶ 

type AppCatalogListingResourceVersionAllowedActionsEnum string

AppCatalogListingResourceVersionAllowedActionsEnum Enum with underlying type: string 

const (
	AppCatalogListingResourceVersionAllowedActionsSnapshot              AppCatalogListingResourceVersionAllowedActionsEnum = "SNAPSHOT"
	AppCatalogListingResourceVersionAllowedActionsBootVolumeDetach      AppCatalogListingResourceVersionAllowedActionsEnum = "BOOT_VOLUME_DETACH"
	AppCatalogListingResourceVersionAllowedActionsPreserveBootVolume    AppCatalogListingResourceVersionAllowedActionsEnum = "PRESERVE_BOOT_VOLUME"
	AppCatalogListingResourceVersionAllowedActionsSerialConsoleAccess   AppCatalogListingResourceVersionAllowedActionsEnum = "SERIAL_CONSOLE_ACCESS"
	AppCatalogListingResourceVersionAllowedActionsBootRecovery          AppCatalogListingResourceVersionAllowedActionsEnum = "BOOT_RECOVERY"
	AppCatalogListingResourceVersionAllowedActionsBackupBootVolume      AppCatalogListingResourceVersionAllowedActionsEnum = "BACKUP_BOOT_VOLUME"
	AppCatalogListingResourceVersionAllowedActionsCaptureConsoleHistory AppCatalogListingResourceVersionAllowedActionsEnum = "CAPTURE_CONSOLE_HISTORY"
)

Set of constants representing the allowable values for AppCatalogListingResourceVersionAllowedActionsEnum

func GetAppCatalogListingResourceVersionAllowedActionsEnumValues ¶ 

func GetAppCatalogListingResourceVersionAllowedActionsEnumValues() []AppCatalogListingResourceVersionAllowedActionsEnum

GetAppCatalogListingResourceVersionAllowedActionsEnumValues Enumerates the set of values for AppCatalogListingResourceVersionAllowedActionsEnum

type AppCatalogListingResourceVersionSummary ¶ 

type AppCatalogListingResourceVersionSummary struct {

	// The OCID of the listing this resource version belongs to.
	ListingId *string `mandatory:"false" json:"listingId"`

	// Date and time the listing resource version was published, in RFC3339 format.
	// Example: `2018-03-20T12:32:53.532Z`
	TimePublished *common.SDKTime `mandatory:"false" json:"timePublished"`

	// OCID of the listing resource.
	ListingResourceId *string `mandatory:"false" json:"listingResourceId"`

	// Resource Version.
	ListingResourceVersion *string `mandatory:"false" json:"listingResourceVersion"`
}

AppCatalogListingResourceVersionSummary Listing Resource Version summary

func (AppCatalogListingResourceVersionSummary) String ¶ 

func (m AppCatalogListingResourceVersionSummary) String() string

type AppCatalogListingSummary ¶ 

type AppCatalogListingSummary struct {

	// the region free ocid of the listing resource.
	ListingId *string `mandatory:"false" json:"listingId"`

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

	// The short summary for the listing.
	Summary *string `mandatory:"false" json:"summary"`

	// The name of the publisher who published this listing.
	PublisherName *string `mandatory:"false" json:"publisherName"`
}

AppCatalogListingSummary A summary of a listing.

func (AppCatalogListingSummary) String ¶ 

func (m AppCatalogListingSummary) String() string

type AppCatalogSubscription ¶ 

type AppCatalogSubscription struct {

	// Name of the publisher who published this listing.
	PublisherName *string `mandatory:"false" json:"publisherName"`

	// The ocid of the listing resource.
	ListingId *string `mandatory:"false" json:"listingId"`

	// Listing resource version.
	ListingResourceVersion *string `mandatory:"false" json:"listingResourceVersion"`

	// Listing resource id.
	ListingResourceId *string `mandatory:"false" json:"listingResourceId"`

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

	// The short summary to the listing.
	Summary *string `mandatory:"false" json:"summary"`

	// The compartmentID of the subscription.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// Date and time at which the subscription was created, in RFC3339 format.
	// Example: `2018-03-20T12:32:53.532Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

AppCatalogSubscription a subscription for a listing resource version.

func (AppCatalogSubscription) String ¶ 

func (m AppCatalogSubscription) String() string

type AppCatalogSubscriptionSummary ¶ 

type AppCatalogSubscriptionSummary struct {

	// Name of the publisher who published this listing.
	PublisherName *string `mandatory:"false" json:"publisherName"`

	// The ocid of the listing resource.
	ListingId *string `mandatory:"false" json:"listingId"`

	// Listing resource version.
	ListingResourceVersion *string `mandatory:"false" json:"listingResourceVersion"`

	// Listing resource id.
	ListingResourceId *string `mandatory:"false" json:"listingResourceId"`

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

	// The short summary to the listing.
	Summary *string `mandatory:"false" json:"summary"`

	// The compartmentID of the subscription.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// Date and time at which the subscription was created, in RFC3339 format.
	// Example: `2018-03-20T12:32:53.532Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

AppCatalogSubscriptionSummary a subscription summary for a listing resource version.

func (AppCatalogSubscriptionSummary) String ¶ 

func (m AppCatalogSubscriptionSummary) String() string

type AttachBootVolumeDetails ¶ 

type AttachBootVolumeDetails struct {

	// The OCID of the  boot volume.
	BootVolumeId *string `mandatory:"true" json:"bootVolumeId"`

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

	// A user-friendly name. Does not have to be unique, and it cannot be changed. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`
}

AttachBootVolumeDetails The representation of AttachBootVolumeDetails

func (AttachBootVolumeDetails) String ¶ 

func (m AttachBootVolumeDetails) String() string

type AttachBootVolumeRequest ¶ 

type AttachBootVolumeRequest struct {

	// Attach boot volume request
	AttachBootVolumeDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

AttachBootVolumeRequest wrapper for the AttachBootVolume operation

func (AttachBootVolumeRequest) HTTPRequest ¶ added in v1.3.0 

func (request AttachBootVolumeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (AttachBootVolumeRequest) RetryPolicy ¶ added in v1.3.0 

func (request AttachBootVolumeRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (AttachBootVolumeRequest) String ¶ 

func (request AttachBootVolumeRequest) String() string

type AttachBootVolumeResponse ¶ 

type AttachBootVolumeResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BootVolumeAttachment instance
	BootVolumeAttachment `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"`
}

AttachBootVolumeResponse wrapper for the AttachBootVolume operation

func (AttachBootVolumeResponse) HTTPResponse ¶ added in v1.3.0 

func (response AttachBootVolumeResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (AttachBootVolumeResponse) String ¶ 

func (response AttachBootVolumeResponse) String() string

type AttachIScsiVolumeDetails ¶ 

type AttachIScsiVolumeDetails struct {

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

	// The OCID of the volume.
	VolumeId *string `mandatory:"true" json:"volumeId"`

	// The device name.
	Device *string `mandatory:"false" json:"device"`

	// A user-friendly name. Does not have to be unique, and it cannot be changed. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Whether the attachment was created in read-only mode.
	IsReadOnly *bool `mandatory:"false" json:"isReadOnly"`

	// Whether to use CHAP authentication for the volume attachment. Defaults to false.
	UseChap *bool `mandatory:"false" json:"useChap"`
}

AttachIScsiVolumeDetails The representation of AttachIScsiVolumeDetails

func (AttachIScsiVolumeDetails) GetDevice ¶ 

func (m AttachIScsiVolumeDetails) GetDevice() *string

GetDevice returns Device

func (AttachIScsiVolumeDetails) GetDisplayName ¶ 

func (m AttachIScsiVolumeDetails) GetDisplayName() *string

GetDisplayName returns DisplayName

func (AttachIScsiVolumeDetails) GetInstanceId ¶ 

func (m AttachIScsiVolumeDetails) GetInstanceId() *string

GetInstanceId returns InstanceId

func (AttachIScsiVolumeDetails) GetIsReadOnly ¶ added in v1.1.0 

func (m AttachIScsiVolumeDetails) GetIsReadOnly() *bool

GetIsReadOnly returns IsReadOnly

func (AttachIScsiVolumeDetails) GetVolumeId ¶ 

func (m AttachIScsiVolumeDetails) GetVolumeId() *string

GetVolumeId returns VolumeId

func (AttachIScsiVolumeDetails) MarshalJSON ¶ 

func (m AttachIScsiVolumeDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (AttachIScsiVolumeDetails) String ¶ 

func (m AttachIScsiVolumeDetails) String() string

type AttachParavirtualizedVolumeDetails ¶ added in v1.2.0 

type AttachParavirtualizedVolumeDetails struct {

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

	// The OCID of the volume.
	VolumeId *string `mandatory:"true" json:"volumeId"`

	// The device name.
	Device *string `mandatory:"false" json:"device"`

	// A user-friendly name. Does not have to be unique, and it cannot be changed. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Whether the attachment was created in read-only mode.
	IsReadOnly *bool `mandatory:"false" json:"isReadOnly"`

	// Whether to enable encryption in transit for the PV data volume attachment. Defaults to false.
	IsPvEncryptionInTransitEnabled *bool `mandatory:"false" json:"isPvEncryptionInTransitEnabled"`
}

AttachParavirtualizedVolumeDetails The representation of AttachParavirtualizedVolumeDetails

func (AttachParavirtualizedVolumeDetails) GetDevice ¶ 

func (m AttachParavirtualizedVolumeDetails) GetDevice() *string

GetDevice returns Device

func (AttachParavirtualizedVolumeDetails) GetDisplayName ¶ added in v1.2.0 

func (m AttachParavirtualizedVolumeDetails) GetDisplayName() *string

GetDisplayName returns DisplayName

func (AttachParavirtualizedVolumeDetails) GetInstanceId ¶ added in v1.2.0 

func (m AttachParavirtualizedVolumeDetails) GetInstanceId() *string

GetInstanceId returns InstanceId

func (AttachParavirtualizedVolumeDetails) GetIsReadOnly ¶ added in v1.2.0 

func (m AttachParavirtualizedVolumeDetails) GetIsReadOnly() *bool

GetIsReadOnly returns IsReadOnly

func (AttachParavirtualizedVolumeDetails) GetVolumeId ¶ added in v1.2.0 

func (m AttachParavirtualizedVolumeDetails) GetVolumeId() *string

GetVolumeId returns VolumeId

func (AttachParavirtualizedVolumeDetails) MarshalJSON ¶ added in v1.2.0 

func (m AttachParavirtualizedVolumeDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (AttachParavirtualizedVolumeDetails) String ¶ added in v1.2.0 

func (m AttachParavirtualizedVolumeDetails) String() string

type AttachServiceIdRequest ¶ added in v1.8.0 

type AttachServiceIdRequest struct {

	// The service gateway's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
	ServiceGatewayId *string `mandatory:"true" contributesTo:"path" name:"serviceGatewayId"`

	// ServiceId of Service to be attached to a service gateway.
	AttachServiceDetails ServiceIdRequestDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

AttachServiceIdRequest wrapper for the AttachServiceId operation

func (AttachServiceIdRequest) HTTPRequest ¶ added in v1.8.0 

func (request AttachServiceIdRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (AttachServiceIdRequest) RetryPolicy ¶ added in v1.8.0 

func (request AttachServiceIdRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (AttachServiceIdRequest) String ¶ added in v1.8.0 

func (request AttachServiceIdRequest) String() string

type AttachServiceIdResponse ¶ added in v1.8.0 

type AttachServiceIdResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ServiceGateway instance
	ServiceGateway `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"`
}

AttachServiceIdResponse wrapper for the AttachServiceId operation

func (AttachServiceIdResponse) HTTPResponse ¶ added in v1.8.0 

func (response AttachServiceIdResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (AttachServiceIdResponse) String ¶ added in v1.8.0 

func (response AttachServiceIdResponse) String() string

type AttachVnicDetails ¶ 

type AttachVnicDetails struct {

	// Details for creating a new VNIC.
	CreateVnicDetails *CreateVnicDetails `mandatory:"true" json:"createVnicDetails"`

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

	// A user-friendly name for the attachment. Does not have to be unique, and it cannot be changed.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Which physical network interface card (NIC) the VNIC will use. Defaults to 0.
	// Certain bare metal instance shapes have two active physical NICs (0 and 1). If
	// you add a secondary VNIC to one of these instances, you can specify which NIC
	// the VNIC will use. For more information, see
	// Virtual Network Interface Cards (VNICs) (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm).
	NicIndex *int `mandatory:"false" json:"nicIndex"`
}

AttachVnicDetails The representation of AttachVnicDetails

func (AttachVnicDetails) String ¶ 

func (m AttachVnicDetails) String() string

type AttachVnicRequest ¶ 

type AttachVnicRequest struct {

	// Attach VNIC details.
	AttachVnicDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

AttachVnicRequest wrapper for the AttachVnic operation

func (AttachVnicRequest) HTTPRequest ¶ added in v1.3.0 

func (request AttachVnicRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (AttachVnicRequest) RetryPolicy ¶ added in v1.3.0 

func (request AttachVnicRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (AttachVnicRequest) String ¶ 

func (request AttachVnicRequest) String() string

type AttachVnicResponse ¶ 

type AttachVnicResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VnicAttachment instance
	VnicAttachment `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"`
}

AttachVnicResponse wrapper for the AttachVnic operation

func (AttachVnicResponse) HTTPResponse ¶ added in v1.3.0 

func (response AttachVnicResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (AttachVnicResponse) String ¶ 

func (response AttachVnicResponse) String() string

type AttachVolumeDetails ¶ 

type AttachVolumeDetails interface {

	// The OCID of the instance.
	GetInstanceId() *string

	// The OCID of the volume.
	GetVolumeId() *string

	// The device name.
	GetDevice() *string

	// A user-friendly name. Does not have to be unique, and it cannot be changed. Avoid entering confidential information.
	GetDisplayName() *string

	// Whether the attachment was created in read-only mode.
	GetIsReadOnly() *bool
}

AttachVolumeDetails The representation of AttachVolumeDetails

type AttachVolumeRequest ¶ 

type AttachVolumeRequest struct {

	// Attach volume request
	AttachVolumeDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

AttachVolumeRequest wrapper for the AttachVolume operation

func (AttachVolumeRequest) HTTPRequest ¶ added in v1.3.0 

func (request AttachVolumeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (AttachVolumeRequest) RetryPolicy ¶ added in v1.3.0 

func (request AttachVolumeRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (AttachVolumeRequest) String ¶ 

func (request AttachVolumeRequest) String() string

type AttachVolumeResponse ¶ 

type AttachVolumeResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VolumeAttachment instance
	VolumeAttachment `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"`
}

AttachVolumeResponse wrapper for the AttachVolume operation

func (AttachVolumeResponse) HTTPResponse ¶ added in v1.3.0 

func (response AttachVolumeResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (AttachVolumeResponse) String ¶ 

func (response AttachVolumeResponse) String() string

type BlockstorageClient ¶ 

type BlockstorageClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

BlockstorageClient a client for Blockstorage

func NewBlockstorageClientWithConfigurationProvider ¶ 

func NewBlockstorageClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client BlockstorageClient, err error)

NewBlockstorageClientWithConfigurationProvider Creates a new default Blockstorage client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func (*BlockstorageClient) ConfigurationProvider ¶ 

func (client *BlockstorageClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (BlockstorageClient) CopyVolumeBackup ¶ 

func (client BlockstorageClient) CopyVolumeBackup(ctx context.Context, request CopyVolumeBackupRequest) (response CopyVolumeBackupResponse, err error)

CopyVolumeBackup Creates a volume backup copy in specified region. For general information about volume backups, see Overview of Block Volume Service Backups (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/blockvolumebackups.htm)

func (BlockstorageClient) CreateBootVolume ¶ added in v1.8.0 

func (client BlockstorageClient) CreateBootVolume(ctx context.Context, request CreateBootVolumeRequest) (response CreateBootVolumeResponse, err error)

CreateBootVolume Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup. For general information about boot volumes, see Boot Volumes (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/bootvolumes.htm). You may optionally specify a *display name* for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.

func (BlockstorageClient) CreateBootVolumeBackup ¶ added in v1.8.0 

func (client BlockstorageClient) CreateBootVolumeBackup(ctx context.Context, request CreateBootVolumeBackupRequest) (response CreateBootVolumeBackupResponse, err error)

CreateBootVolumeBackup Creates a new boot volume backup of the specified boot volume. For general information about boot volume backups, see Overview of Boot Volume Backups (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/bootvolumebackups.htm) When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.

func (BlockstorageClient) CreateVolume ¶ 

func (client BlockstorageClient) CreateVolume(ctx context.Context, request CreateVolumeRequest) (response CreateVolumeResponse, err error)

CreateVolume Creates a new volume in the specified compartment. Volumes can be created in sizes ranging from 50 GB (51200 MB) to 32 TB (33554432 MB), in 1 GB (1024 MB) increments. By default, volumes are 1 TB (1048576 MB). For general information about block volumes, see Overview of Block Volume Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/overview.htm). A volume and instance can be in separate compartments but must be in the same availability domain. For information about access control and compartments, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about availability domains, see Regions and Availability Domains (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm). To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API. You may optionally specify a *display name* for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.

func (BlockstorageClient) CreateVolumeBackup ¶ 

func (client BlockstorageClient) CreateVolumeBackup(ctx context.Context, request CreateVolumeBackupRequest) (response CreateVolumeBackupResponse, err error)

CreateVolumeBackup Creates a new backup of the specified volume. For general information about volume backups, see Overview of Block Volume Service Backups (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/blockvolumebackups.htm) When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.

func (BlockstorageClient) CreateVolumeBackupPolicyAssignment ¶ added in v1.1.0 

func (client BlockstorageClient) CreateVolumeBackupPolicyAssignment(ctx context.Context, request CreateVolumeBackupPolicyAssignmentRequest) (response CreateVolumeBackupPolicyAssignmentResponse, err error)

CreateVolumeBackupPolicyAssignment Assigns a policy to the specified asset, such as a volume. Note that a given asset can only have one policy assigned to it; if this method is called for an asset that previously has a different policy assigned, the prior assignment will be silently deleted.

func (BlockstorageClient) CreateVolumeGroup ¶ added in v1.6.0 

func (client BlockstorageClient) CreateVolumeGroup(ctx context.Context, request CreateVolumeGroupRequest) (response CreateVolumeGroupResponse, err error)

CreateVolumeGroup Creates a new volume group in the specified compartment. A volume group is a collection of volumes and may be created from a list of volumes, cloning an existing volume group, or by restoring a volume group backup. A volume group can contain up to 64 volumes. You may optionally specify a *display name* for the volume group, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information. For more information, see Volume Groups (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/volumegroups.htm).

func (BlockstorageClient) CreateVolumeGroupBackup ¶ added in v1.6.0 

func (client BlockstorageClient) CreateVolumeGroupBackup(ctx context.Context, request CreateVolumeGroupBackupRequest) (response CreateVolumeGroupBackupResponse, err error)

CreateVolumeGroupBackup Creates a new backup volume group of the specified volume group. For more information, see Volume Groups (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/volumegroups.htm).

func (BlockstorageClient) DeleteBootVolume ¶ 

func (client BlockstorageClient) DeleteBootVolume(ctx context.Context, request DeleteBootVolumeRequest) (response DeleteBootVolumeResponse, err error)

DeleteBootVolume Deletes the specified boot volume. The volume cannot have an active connection to an instance. To disconnect the boot volume from a connected instance, see Disconnecting From a Boot Volume (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Tasks/deletingbootvolume.htm). **Warning:** All data on the boot volume will be permanently lost when the boot volume is deleted.

func (BlockstorageClient) DeleteBootVolumeBackup ¶ added in v1.8.0 

func (client BlockstorageClient) DeleteBootVolumeBackup(ctx context.Context, request DeleteBootVolumeBackupRequest) (response DeleteBootVolumeBackupResponse, err error)

DeleteBootVolumeBackup Deletes a boot volume backup.

func (BlockstorageClient) DeleteBootVolumeKmsKey ¶ 

func (client BlockstorageClient) DeleteBootVolumeKmsKey(ctx context.Context, request DeleteBootVolumeKmsKeyRequest) (response DeleteBootVolumeKmsKeyResponse, err error)

DeleteBootVolumeKmsKey Remove kms for the specific boot volume. If the volume doesn't use KMS, then do nothing.

func (BlockstorageClient) DeleteVolume ¶ 

func (client BlockstorageClient) DeleteVolume(ctx context.Context, request DeleteVolumeRequest) (response DeleteVolumeResponse, err error)

DeleteVolume Deletes the specified volume. The volume cannot have an active connection to an instance. To disconnect the volume from a connected instance, see Disconnecting From a Volume (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Tasks/disconnectingfromavolume.htm). **Warning:** All data on the volume will be permanently lost when the volume is deleted.

func (BlockstorageClient) DeleteVolumeBackup ¶ 

func (client BlockstorageClient) DeleteVolumeBackup(ctx context.Context, request DeleteVolumeBackupRequest) (response DeleteVolumeBackupResponse, err error)

DeleteVolumeBackup Deletes a volume backup.

func (BlockstorageClient) DeleteVolumeBackupPolicyAssignment ¶ added in v1.1.0 

func (client BlockstorageClient) DeleteVolumeBackupPolicyAssignment(ctx context.Context, request DeleteVolumeBackupPolicyAssignmentRequest) (response DeleteVolumeBackupPolicyAssignmentResponse, err error)

DeleteVolumeBackupPolicyAssignment Deletes a volume backup policy assignment (i.e. unassigns the policy from an asset).

func (BlockstorageClient) DeleteVolumeGroup ¶ added in v1.6.0 

func (client BlockstorageClient) DeleteVolumeGroup(ctx context.Context, request DeleteVolumeGroupRequest) (response DeleteVolumeGroupResponse, err error)

DeleteVolumeGroup Deletes the specified volume group. Individual volumes are not deleted, only the volume group is deleted. For more information, see Volume Groups (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/volumegroups.htm).

func (BlockstorageClient) DeleteVolumeGroupBackup ¶ added in v1.6.0 

func (client BlockstorageClient) DeleteVolumeGroupBackup(ctx context.Context, request DeleteVolumeGroupBackupRequest) (response DeleteVolumeGroupBackupResponse, err error)

DeleteVolumeGroupBackup Deletes a volume group backup. This operation deletes all the backups in the volume group. For more information, see Volume Groups (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/volumegroups.htm).

func (BlockstorageClient) DeleteVolumeKmsKey ¶ 

func (client BlockstorageClient) DeleteVolumeKmsKey(ctx context.Context, request DeleteVolumeKmsKeyRequest) (response DeleteVolumeKmsKeyResponse, err error)

DeleteVolumeKmsKey Remove kms for the specific volume. If the volume doesn't use KMS, then do nothing.

func (BlockstorageClient) GetBootVolume ¶ 

func (client BlockstorageClient) GetBootVolume(ctx context.Context, request GetBootVolumeRequest) (response GetBootVolumeResponse, err error)

GetBootVolume Gets information for the specified boot volume.

func (BlockstorageClient) GetBootVolumeBackup ¶ added in v1.8.0 

func (client BlockstorageClient) GetBootVolumeBackup(ctx context.Context, request GetBootVolumeBackupRequest) (response GetBootVolumeBackupResponse, err error)

GetBootVolumeBackup Gets information for the specified boot volume backup.

func (BlockstorageClient) GetBootVolumeKmsKey ¶ 

func (client BlockstorageClient) GetBootVolumeKmsKey(ctx context.Context, request GetBootVolumeKmsKeyRequest) (response GetBootVolumeKmsKeyResponse, err error)

GetBootVolumeKmsKey Gets kms key id for the specified boot volume.

func (BlockstorageClient) GetVolume ¶ 

func (client BlockstorageClient) GetVolume(ctx context.Context, request GetVolumeRequest) (response GetVolumeResponse, err error)

GetVolume Gets information for the specified volume.

func (BlockstorageClient) GetVolumeBackup ¶ 

func (client BlockstorageClient) GetVolumeBackup(ctx context.Context, request GetVolumeBackupRequest) (response GetVolumeBackupResponse, err error)

GetVolumeBackup Gets information for the specified volume backup.

func (BlockstorageClient) GetVolumeBackupPolicy ¶ added in v1.1.0 

func (client BlockstorageClient) GetVolumeBackupPolicy(ctx context.Context, request GetVolumeBackupPolicyRequest) (response GetVolumeBackupPolicyResponse, err error)

GetVolumeBackupPolicy Gets information for the specified volume backup policy.

func (BlockstorageClient) GetVolumeBackupPolicyAssetAssignment ¶ added in v1.1.0 

func (client BlockstorageClient) GetVolumeBackupPolicyAssetAssignment(ctx context.Context, request GetVolumeBackupPolicyAssetAssignmentRequest) (response GetVolumeBackupPolicyAssetAssignmentResponse, err error)

GetVolumeBackupPolicyAssetAssignment Gets the volume backup policy assignment for the specified asset. Note that the assetId query parameter is required, and that the returned list will contain at most one item (since any given asset can only have one policy assigned to it).

func (BlockstorageClient) GetVolumeBackupPolicyAssignment ¶ added in v1.1.0 

func (client BlockstorageClient) GetVolumeBackupPolicyAssignment(ctx context.Context, request GetVolumeBackupPolicyAssignmentRequest) (response GetVolumeBackupPolicyAssignmentResponse, err error)

GetVolumeBackupPolicyAssignment Gets information for the specified volume backup policy assignment.

func (BlockstorageClient) GetVolumeGroup ¶ added in v1.6.0 

func (client BlockstorageClient) GetVolumeGroup(ctx context.Context, request GetVolumeGroupRequest) (response GetVolumeGroupResponse, err error)

GetVolumeGroup Gets information for the specified volume group. For more information, see Volume Groups (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/volumegroups.htm).

func (BlockstorageClient) GetVolumeGroupBackup ¶ added in v1.6.0 

func (client BlockstorageClient) GetVolumeGroupBackup(ctx context.Context, request GetVolumeGroupBackupRequest) (response GetVolumeGroupBackupResponse, err error)

GetVolumeGroupBackup Gets information for the specified volume group backup. For more information, see Volume Groups (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/volumegroups.htm).

func (BlockstorageClient) GetVolumeKmsKey ¶ 

func (client BlockstorageClient) GetVolumeKmsKey(ctx context.Context, request GetVolumeKmsKeyRequest) (response GetVolumeKmsKeyResponse, err error)

GetVolumeKmsKey Gets kms key id for the specified volume.

func (BlockstorageClient) ListBootVolumeBackups ¶ added in v1.8.0 

func (client BlockstorageClient) ListBootVolumeBackups(ctx context.Context, request ListBootVolumeBackupsRequest) (response ListBootVolumeBackupsResponse, err error)

ListBootVolumeBackups Lists the boot volume backups in the specified compartment. You can filter the results by boot volume.

func (BlockstorageClient) ListBootVolumes ¶ 

func (client BlockstorageClient) ListBootVolumes(ctx context.Context, request ListBootVolumesRequest) (response ListBootVolumesResponse, err error)

ListBootVolumes Lists the boot volumes in the specified compartment and availability domain.

func (BlockstorageClient) ListVolumeBackupPolicies ¶ added in v1.1.0 

func (client BlockstorageClient) ListVolumeBackupPolicies(ctx context.Context, request ListVolumeBackupPoliciesRequest) (response ListVolumeBackupPoliciesResponse, err error)

ListVolumeBackupPolicies Lists all volume backup policies available to the caller.

func (BlockstorageClient) ListVolumeBackups ¶ 

func (client BlockstorageClient) ListVolumeBackups(ctx context.Context, request ListVolumeBackupsRequest) (response ListVolumeBackupsResponse, err error)

ListVolumeBackups Lists the volume backups in the specified compartment. You can filter the results by volume.

func (BlockstorageClient) ListVolumeGroupBackups ¶ added in v1.6.0 

func (client BlockstorageClient) ListVolumeGroupBackups(ctx context.Context, request ListVolumeGroupBackupsRequest) (response ListVolumeGroupBackupsResponse, err error)

ListVolumeGroupBackups Lists the volume group backups in the specified compartment. You can filter the results by volume group. For more information, see Volume Groups (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/volumegroups.htm).

func (BlockstorageClient) ListVolumeGroups ¶ added in v1.6.0 

func (client BlockstorageClient) ListVolumeGroups(ctx context.Context, request ListVolumeGroupsRequest) (response ListVolumeGroupsResponse, err error)

ListVolumeGroups Lists the volume groups in the specified compartment and availability domain. For more information, see Volume Groups (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/volumegroups.htm).

func (BlockstorageClient) ListVolumes ¶ 

func (client BlockstorageClient) ListVolumes(ctx context.Context, request ListVolumesRequest) (response ListVolumesResponse, err error)

ListVolumes Lists the volumes in the specified compartment and availability domain.

func (*BlockstorageClient) SetRegion ¶ 

func (client *BlockstorageClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (BlockstorageClient) UpdateBootVolume ¶ 

func (client BlockstorageClient) UpdateBootVolume(ctx context.Context, request UpdateBootVolumeRequest) (response UpdateBootVolumeResponse, err error)

UpdateBootVolume Updates the specified boot volume's display name, defined tags, and free-form tags.

func (BlockstorageClient) UpdateBootVolumeBackup ¶ added in v1.8.0 

func (client BlockstorageClient) UpdateBootVolumeBackup(ctx context.Context, request UpdateBootVolumeBackupRequest) (response UpdateBootVolumeBackupResponse, err error)

UpdateBootVolumeBackup Updates the display name for the specified boot volume backup. Avoid entering confidential information.

func (BlockstorageClient) UpdateBootVolumeKmsKey ¶ 

func (client BlockstorageClient) UpdateBootVolumeKmsKey(ctx context.Context, request UpdateBootVolumeKmsKeyRequest) (response UpdateBootVolumeKmsKeyResponse, err error)

UpdateBootVolumeKmsKey Update kms key id for the specific volume.

func (BlockstorageClient) UpdateVolume ¶ 

func (client BlockstorageClient) UpdateVolume(ctx context.Context, request UpdateVolumeRequest) (response UpdateVolumeResponse, err error)

UpdateVolume Updates the specified volume's display name. Avoid entering confidential information.

func (BlockstorageClient) UpdateVolumeBackup ¶ 

func (client BlockstorageClient) UpdateVolumeBackup(ctx context.Context, request UpdateVolumeBackupRequest) (response UpdateVolumeBackupResponse, err error)

UpdateVolumeBackup Updates the display name for the specified volume backup. Avoid entering confidential information.

func (BlockstorageClient) UpdateVolumeGroup ¶ added in v1.6.0 

func (client BlockstorageClient) UpdateVolumeGroup(ctx context.Context, request UpdateVolumeGroupRequest) (response UpdateVolumeGroupResponse, err error)

UpdateVolumeGroup Updates the set of volumes in a volume group along with the display name. Use this operation to add or remove volumes in a volume group. Specify the full list of volume IDs to include in the volume group. If the volume ID is not specified in the call, it will be removed from the volume group. Avoid entering confidential information. For more information, see Volume Groups (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/volumegroups.htm).

func (BlockstorageClient) UpdateVolumeGroupBackup ¶ added in v1.6.0 

func (client BlockstorageClient) UpdateVolumeGroupBackup(ctx context.Context, request UpdateVolumeGroupBackupRequest) (response UpdateVolumeGroupBackupResponse, err error)

UpdateVolumeGroupBackup Updates the display name for the specified volume group backup. For more information, see Volume Groups (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/volumegroups.htm).

func (BlockstorageClient) UpdateVolumeKmsKey ¶ 

func (client BlockstorageClient) UpdateVolumeKmsKey(ctx context.Context, request UpdateVolumeKmsKeyRequest) (response UpdateVolumeKmsKeyResponse, err error)

UpdateVolumeKmsKey Update kms key id for the specific volume.

type BootVolume ¶ 

type BootVolume struct {

	// The availability domain of the boot volume.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The OCID of the compartment that contains the boot volume.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The boot volume's Oracle ID (OCID).
	Id *string `mandatory:"true" json:"id"`

	// The current state of a boot volume.
	LifecycleState BootVolumeLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The size of the volume in MBs. The value must be a multiple of 1024.
	// This field is deprecated. Please use sizeInGBs.
	SizeInMBs *int64 `mandatory:"true" json:"sizeInMBs"`

	// The date and time the boot volume was created. Format defined by RFC3339.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The image OCID used to create the boot volume.
	ImageId *string `mandatory:"false" json:"imageId"`

	// Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
	IsHydrated *bool `mandatory:"false" json:"isHydrated"`

	// The size of the boot volume in GBs.
	SizeInGBs *int64 `mandatory:"false" json:"sizeInGBs"`

	// The boot volume source, either an existing boot volume in the same availability domain or a boot volume backup.
	// If null, this means that the boot volume was created from an image.
	SourceDetails BootVolumeSourceDetails `mandatory:"false" json:"sourceDetails"`

	// The OCID of the source volume group.
	VolumeGroupId *string `mandatory:"false" json:"volumeGroupId"`

	// The OCID of the KMS key which is the master encryption key for the boot volume.
	KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
}

BootVolume A detachable boot volume device that contains the image used to boot a Compute instance. For more information, see Overview of Boot Volumes (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/bootvolumes.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (BootVolume) String ¶ 

func (m BootVolume) String() string

func (*BootVolume) UnmarshalJSON ¶ added in v1.8.0 

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

UnmarshalJSON unmarshals from json

type BootVolumeAttachment ¶ 

type BootVolumeAttachment struct {

	// The availability domain of an instance.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The OCID of the boot volume.
	BootVolumeId *string `mandatory:"true" json:"bootVolumeId"`

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

	// The OCID of the boot volume attachment.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the instance the boot volume is attached to.
	InstanceId *string `mandatory:"true" json:"instanceId"`

	// The current state of the boot volume attachment.
	LifecycleState BootVolumeAttachmentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The date and time the boot volume was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// A user-friendly name. Does not have to be unique, and it cannot be changed.
	// Avoid entering confidential information.
	// Example: `My boot volume`
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Whether the enable encryption in transit for the PV volume attachment is on or not.
	IsPvEncryptionInTransitEnabled *bool `mandatory:"false" json:"isPvEncryptionInTransitEnabled"`
}

BootVolumeAttachment Represents an attachment between a boot volume and an instance. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (BootVolumeAttachment) String ¶ 

func (m BootVolumeAttachment) String() string

type BootVolumeAttachmentLifecycleStateEnum ¶ 

type BootVolumeAttachmentLifecycleStateEnum string

BootVolumeAttachmentLifecycleStateEnum Enum with underlying type: string 

const (
	BootVolumeAttachmentLifecycleStateAttaching BootVolumeAttachmentLifecycleStateEnum = "ATTACHING"
	BootVolumeAttachmentLifecycleStateAttached  BootVolumeAttachmentLifecycleStateEnum = "ATTACHED"
	BootVolumeAttachmentLifecycleStateDetaching BootVolumeAttachmentLifecycleStateEnum = "DETACHING"
	BootVolumeAttachmentLifecycleStateDetached  BootVolumeAttachmentLifecycleStateEnum = "DETACHED"
)

Set of constants representing the allowable values for BootVolumeAttachmentLifecycleStateEnum

func GetBootVolumeAttachmentLifecycleStateEnumValues ¶ 

func GetBootVolumeAttachmentLifecycleStateEnumValues() []BootVolumeAttachmentLifecycleStateEnum

GetBootVolumeAttachmentLifecycleStateEnumValues Enumerates the set of values for BootVolumeAttachmentLifecycleStateEnum

type BootVolumeBackup ¶ added in v1.8.0 

type BootVolumeBackup struct {

	// The OCID of the compartment that contains the boot volume backup.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A user-friendly name for the boot volume backup. Does not have to be unique and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The OCID of the boot volume backup.
	Id *string `mandatory:"true" json:"id"`

	// The current state of a boot volume backup.
	LifecycleState BootVolumeBackupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The date and time the boot volume backup was created. This is the time the actual point-in-time image
	// of the volume data was taken. Format defined by RFC3339.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The OCID of the boot volume.
	BootVolumeId *string `mandatory:"false" json:"bootVolumeId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// The date and time the volume backup will expire and be automatically deleted.
	// Format defined by RFC3339. This parameter will always be present for backups that
	// were created automatically by a scheduled-backup policy. For manually created backups,
	// it will be absent, signifying that there is no expiration time and the backup will
	// last forever until manually deleted.
	ExpirationTime *common.SDKTime `mandatory:"false" json:"expirationTime"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The image OCID used to create the boot volume the backup is taken from.
	ImageId *string `mandatory:"false" json:"imageId"`

	// The size of the boot volume, in GBs.
	SizeInGBs *int64 `mandatory:"false" json:"sizeInGBs"`

	// Specifies whether the backup was created manually, or via scheduled backup policy.
	SourceType BootVolumeBackupSourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`

	// The date and time the request to create the boot volume backup was received. Format defined by RFC3339.
	TimeRequestReceived *common.SDKTime `mandatory:"false" json:"timeRequestReceived"`

	// The type of a volume backup.
	Type BootVolumeBackupTypeEnum `mandatory:"false" json:"type,omitempty"`

	// The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space
	// consumed on the boot volume and whether the backup is full or incremental.
	UniqueSizeInGBs *int64 `mandatory:"false" json:"uniqueSizeInGBs"`
}

BootVolumeBackup A point-in-time copy of a boot volume that can then be used to create a new boot volume or recover a boot volume. For more information, see Overview of Boot Volume Backups (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/bootvolumebackups.htm) To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (BootVolumeBackup) String ¶ added in v1.8.0 

func (m BootVolumeBackup) String() string

type BootVolumeBackupLifecycleStateEnum ¶ added in v1.8.0 

type BootVolumeBackupLifecycleStateEnum string

BootVolumeBackupLifecycleStateEnum Enum with underlying type: string 

const (
	BootVolumeBackupLifecycleStateCreating        BootVolumeBackupLifecycleStateEnum = "CREATING"
	BootVolumeBackupLifecycleStateAvailable       BootVolumeBackupLifecycleStateEnum = "AVAILABLE"
	BootVolumeBackupLifecycleStateTerminating     BootVolumeBackupLifecycleStateEnum = "TERMINATING"
	BootVolumeBackupLifecycleStateTerminated      BootVolumeBackupLifecycleStateEnum = "TERMINATED"
	BootVolumeBackupLifecycleStateFaulty          BootVolumeBackupLifecycleStateEnum = "FAULTY"
	BootVolumeBackupLifecycleStateRequestReceived BootVolumeBackupLifecycleStateEnum = "REQUEST_RECEIVED"
)

Set of constants representing the allowable values for BootVolumeBackupLifecycleStateEnum

func GetBootVolumeBackupLifecycleStateEnumValues ¶ added in v1.8.0 

func GetBootVolumeBackupLifecycleStateEnumValues() []BootVolumeBackupLifecycleStateEnum

GetBootVolumeBackupLifecycleStateEnumValues Enumerates the set of values for BootVolumeBackupLifecycleStateEnum

type BootVolumeBackupSourceTypeEnum ¶ added in v1.8.0 

type BootVolumeBackupSourceTypeEnum string

BootVolumeBackupSourceTypeEnum Enum with underlying type: string 

const (
	BootVolumeBackupSourceTypeManual    BootVolumeBackupSourceTypeEnum = "MANUAL"
	BootVolumeBackupSourceTypeScheduled BootVolumeBackupSourceTypeEnum = "SCHEDULED"
)

Set of constants representing the allowable values for BootVolumeBackupSourceTypeEnum

func GetBootVolumeBackupSourceTypeEnumValues ¶ added in v1.8.0 

func GetBootVolumeBackupSourceTypeEnumValues() []BootVolumeBackupSourceTypeEnum

GetBootVolumeBackupSourceTypeEnumValues Enumerates the set of values for BootVolumeBackupSourceTypeEnum

type BootVolumeBackupTypeEnum ¶ added in v1.8.0 

type BootVolumeBackupTypeEnum string

BootVolumeBackupTypeEnum Enum with underlying type: string 

const (
	BootVolumeBackupTypeFull        BootVolumeBackupTypeEnum = "FULL"
	BootVolumeBackupTypeIncremental BootVolumeBackupTypeEnum = "INCREMENTAL"
)

Set of constants representing the allowable values for BootVolumeBackupTypeEnum

func GetBootVolumeBackupTypeEnumValues ¶ added in v1.8.0 

func GetBootVolumeBackupTypeEnumValues() []BootVolumeBackupTypeEnum

GetBootVolumeBackupTypeEnumValues Enumerates the set of values for BootVolumeBackupTypeEnum

type BootVolumeKmsKey ¶ 

type BootVolumeKmsKey struct {

	// Kms key id associated with this volume. If volume is not using KMS, then kmsKeyId will be null string.
	KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
}

BootVolumeKmsKey Kms key id associated with this volume.

func (BootVolumeKmsKey) String ¶ 

func (m BootVolumeKmsKey) String() string

type BootVolumeLifecycleStateEnum ¶ 

type BootVolumeLifecycleStateEnum string

BootVolumeLifecycleStateEnum Enum with underlying type: string 

const (
	BootVolumeLifecycleStateProvisioning BootVolumeLifecycleStateEnum = "PROVISIONING"
	BootVolumeLifecycleStateRestoring    BootVolumeLifecycleStateEnum = "RESTORING"
	BootVolumeLifecycleStateAvailable    BootVolumeLifecycleStateEnum = "AVAILABLE"
	BootVolumeLifecycleStateTerminating  BootVolumeLifecycleStateEnum = "TERMINATING"
	BootVolumeLifecycleStateTerminated   BootVolumeLifecycleStateEnum = "TERMINATED"
	BootVolumeLifecycleStateFaulty       BootVolumeLifecycleStateEnum = "FAULTY"
)

Set of constants representing the allowable values for BootVolumeLifecycleStateEnum

func GetBootVolumeLifecycleStateEnumValues ¶ 

func GetBootVolumeLifecycleStateEnumValues() []BootVolumeLifecycleStateEnum

GetBootVolumeLifecycleStateEnumValues Enumerates the set of values for BootVolumeLifecycleStateEnum

type BootVolumeSourceDetails ¶ added in v1.8.0 

type BootVolumeSourceDetails interface {
}

BootVolumeSourceDetails The representation of BootVolumeSourceDetails

type BootVolumeSourceFromBootVolumeBackupDetails ¶ added in v1.8.0 

type BootVolumeSourceFromBootVolumeBackupDetails struct {

	// The OCID of the boot volume backup.
	Id *string `mandatory:"true" json:"id"`
}

BootVolumeSourceFromBootVolumeBackupDetails Specifies the boot volume backup.

func (BootVolumeSourceFromBootVolumeBackupDetails) MarshalJSON ¶ added in v1.8.0 

func (m BootVolumeSourceFromBootVolumeBackupDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (BootVolumeSourceFromBootVolumeBackupDetails) String ¶ added in v1.8.0 

func (m BootVolumeSourceFromBootVolumeBackupDetails) String() string

type BootVolumeSourceFromBootVolumeDetails ¶ added in v1.8.0 

type BootVolumeSourceFromBootVolumeDetails struct {

	// The OCID of the boot volume.
	Id *string `mandatory:"true" json:"id"`
}

BootVolumeSourceFromBootVolumeDetails Specifies the source boot volume.

func (BootVolumeSourceFromBootVolumeDetails) MarshalJSON ¶ added in v1.8.0 

func (m BootVolumeSourceFromBootVolumeDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (BootVolumeSourceFromBootVolumeDetails) String ¶ added in v1.8.0 

func (m BootVolumeSourceFromBootVolumeDetails) String() string

type BulkAddVirtualCircuitPublicPrefixesDetails ¶ 

type BulkAddVirtualCircuitPublicPrefixesDetails struct {

	// The public IP prefixes (CIDRs) to add to the public virtual circuit.
	PublicPrefixes []CreateVirtualCircuitPublicPrefixDetails `mandatory:"true" json:"publicPrefixes"`
}

BulkAddVirtualCircuitPublicPrefixesDetails The representation of BulkAddVirtualCircuitPublicPrefixesDetails

func (BulkAddVirtualCircuitPublicPrefixesDetails) String ¶ 

func (m BulkAddVirtualCircuitPublicPrefixesDetails) String() string

type BulkAddVirtualCircuitPublicPrefixesRequest ¶ 

type BulkAddVirtualCircuitPublicPrefixesRequest struct {

	// The OCID of the virtual circuit.
	VirtualCircuitId *string `mandatory:"true" contributesTo:"path" name:"virtualCircuitId"`

	// Request with publix prefixes to be added to the virtual circuit
	BulkAddVirtualCircuitPublicPrefixesDetails `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"`

	// 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
}

BulkAddVirtualCircuitPublicPrefixesRequest wrapper for the BulkAddVirtualCircuitPublicPrefixes operation

func (BulkAddVirtualCircuitPublicPrefixesRequest) HTTPRequest ¶ added in v1.3.0 

func (request BulkAddVirtualCircuitPublicPrefixesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (BulkAddVirtualCircuitPublicPrefixesRequest) RetryPolicy ¶ added in v1.3.0 

func (request BulkAddVirtualCircuitPublicPrefixesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (BulkAddVirtualCircuitPublicPrefixesRequest) String ¶ 

func (request BulkAddVirtualCircuitPublicPrefixesRequest) String() string

type BulkAddVirtualCircuitPublicPrefixesResponse ¶ 

type BulkAddVirtualCircuitPublicPrefixesResponse struct {

	// The underlying http response
	RawResponse *http.Response
}

BulkAddVirtualCircuitPublicPrefixesResponse wrapper for the BulkAddVirtualCircuitPublicPrefixes operation

func (BulkAddVirtualCircuitPublicPrefixesResponse) HTTPResponse ¶ added in v1.3.0 

func (response BulkAddVirtualCircuitPublicPrefixesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (BulkAddVirtualCircuitPublicPrefixesResponse) String ¶ 

func (response BulkAddVirtualCircuitPublicPrefixesResponse) String() string

type BulkDeleteVirtualCircuitPublicPrefixesDetails ¶ 

type BulkDeleteVirtualCircuitPublicPrefixesDetails struct {

	// The public IP prefixes (CIDRs) to remove from the public virtual circuit.
	PublicPrefixes []DeleteVirtualCircuitPublicPrefixDetails `mandatory:"true" json:"publicPrefixes"`
}

BulkDeleteVirtualCircuitPublicPrefixesDetails The representation of BulkDeleteVirtualCircuitPublicPrefixesDetails

func (BulkDeleteVirtualCircuitPublicPrefixesDetails) String ¶ 

func (m BulkDeleteVirtualCircuitPublicPrefixesDetails) String() string

type BulkDeleteVirtualCircuitPublicPrefixesRequest ¶ 

type BulkDeleteVirtualCircuitPublicPrefixesRequest struct {

	// The OCID of the virtual circuit.
	VirtualCircuitId *string `mandatory:"true" contributesTo:"path" name:"virtualCircuitId"`

	// Request with publix prefixes to be deleted from the virtual circuit
	BulkDeleteVirtualCircuitPublicPrefixesDetails `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"`

	// 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
}

BulkDeleteVirtualCircuitPublicPrefixesRequest wrapper for the BulkDeleteVirtualCircuitPublicPrefixes operation

func (BulkDeleteVirtualCircuitPublicPrefixesRequest) HTTPRequest ¶ added in v1.3.0 

func (request BulkDeleteVirtualCircuitPublicPrefixesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (BulkDeleteVirtualCircuitPublicPrefixesRequest) RetryPolicy ¶ added in v1.3.0 

func (request BulkDeleteVirtualCircuitPublicPrefixesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (BulkDeleteVirtualCircuitPublicPrefixesRequest) String ¶ 

func (request BulkDeleteVirtualCircuitPublicPrefixesRequest) String() string

type BulkDeleteVirtualCircuitPublicPrefixesResponse ¶ 

type BulkDeleteVirtualCircuitPublicPrefixesResponse struct {

	// The underlying http response
	RawResponse *http.Response
}

BulkDeleteVirtualCircuitPublicPrefixesResponse wrapper for the BulkDeleteVirtualCircuitPublicPrefixes operation

func (BulkDeleteVirtualCircuitPublicPrefixesResponse) HTTPResponse ¶ added in v1.3.0 

func (response BulkDeleteVirtualCircuitPublicPrefixesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (BulkDeleteVirtualCircuitPublicPrefixesResponse) String ¶ 

func (response BulkDeleteVirtualCircuitPublicPrefixesResponse) String() string

type CaptureConsoleHistoryDetails ¶ 

type CaptureConsoleHistoryDetails struct {

	// The OCID of the instance to get the console history from.
	InstanceId *string `mandatory:"true" json:"instanceId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

CaptureConsoleHistoryDetails The representation of CaptureConsoleHistoryDetails

func (CaptureConsoleHistoryDetails) String ¶ 

func (m CaptureConsoleHistoryDetails) String() string

type CaptureConsoleHistoryRequest ¶ 

type CaptureConsoleHistoryRequest struct {

	// Console history details
	CaptureConsoleHistoryDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CaptureConsoleHistoryRequest wrapper for the CaptureConsoleHistory operation

func (CaptureConsoleHistoryRequest) HTTPRequest ¶ added in v1.3.0 

func (request CaptureConsoleHistoryRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CaptureConsoleHistoryRequest) RetryPolicy ¶ added in v1.3.0 

func (request CaptureConsoleHistoryRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CaptureConsoleHistoryRequest) String ¶ 

func (request CaptureConsoleHistoryRequest) String() string

type CaptureConsoleHistoryResponse ¶ 

type CaptureConsoleHistoryResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ConsoleHistory instance
	ConsoleHistory `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"`
}

CaptureConsoleHistoryResponse wrapper for the CaptureConsoleHistory operation

func (CaptureConsoleHistoryResponse) HTTPResponse ¶ added in v1.3.0 

func (response CaptureConsoleHistoryResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CaptureConsoleHistoryResponse) String ¶ 

func (response CaptureConsoleHistoryResponse) String() string

type ComputeClient ¶ 

type ComputeClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

ComputeClient a client for Compute

func NewComputeClientWithConfigurationProvider ¶ 

func NewComputeClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ComputeClient, err error)

NewComputeClientWithConfigurationProvider Creates a new default Compute client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func (ComputeClient) AttachBootVolume ¶ 

func (client ComputeClient) AttachBootVolume(ctx context.Context, request AttachBootVolumeRequest) (response AttachBootVolumeResponse, err error)

AttachBootVolume Attaches the specified boot volume to the specified instance.

func (ComputeClient) AttachVnic ¶ 

func (client ComputeClient) AttachVnic(ctx context.Context, request AttachVnicRequest) (response AttachVnicResponse, err error)

AttachVnic Creates a secondary VNIC and attaches it to the specified instance. For more information about secondary VNICs, see Virtual Network Interface Cards (VNICs) (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm).

func (ComputeClient) AttachVolume ¶ 

func (client ComputeClient) AttachVolume(ctx context.Context, request AttachVolumeRequest) (response AttachVolumeResponse, err error)

AttachVolume Attaches the specified storage volume to the specified instance.

func (ComputeClient) CaptureConsoleHistory ¶ 

func (client ComputeClient) CaptureConsoleHistory(ctx context.Context, request CaptureConsoleHistoryRequest) (response CaptureConsoleHistoryResponse, err error)

CaptureConsoleHistory Captures the most recent serial console data (up to a megabyte) for the specified instance. The `CaptureConsoleHistory` operation works with the other console history operations as described below. 1. Use `CaptureConsoleHistory` to request the capture of up to a megabyte of the most recent console history. This call returns a `ConsoleHistory` object. The object will have a state of REQUESTED. 2. Wait for the capture operation to succeed by polling `GetConsoleHistory` with the identifier of the console history metadata. The state of the `ConsoleHistory` object will go from REQUESTED to GETTING-HISTORY and then SUCCEEDED (or FAILED). 3. Use `GetConsoleHistoryContent` to get the actual console history data (not the metadata). 4. Optionally, use `DeleteConsoleHistory` to delete the console history metadata and the console history data.

func (*ComputeClient) ConfigurationProvider ¶ 

func (client *ComputeClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (ComputeClient) CreateAppCatalogSubscription ¶ 

func (client ComputeClient) CreateAppCatalogSubscription(ctx context.Context, request CreateAppCatalogSubscriptionRequest) (response CreateAppCatalogSubscriptionResponse, err error)

CreateAppCatalogSubscription Create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.

func (ComputeClient) CreateImage ¶ 

func (client ComputeClient) CreateImage(ctx context.Context, request CreateImageRequest) (response CreateImageResponse, err error)

CreateImage Creates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service. When creating a new image, you must provide the OCID of the instance you want to use as the basis for the image, and the OCID of the compartment containing that instance. For more information about images, see Managing Custom Images (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/managingcustomimages.htm). When importing an exported image from Object Storage, you specify the source information in ImageSourceDetails. When importing an image based on the namespace, bucket name, and object name, use ImageSourceViaObjectStorageTupleDetails. When importing an image based on the Object Storage URL, use ImageSourceViaObjectStorageUriDetails. See Object Storage URLs (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/imageimportexport.htm#URLs) and pre-authenticated requests (https://docs.us-phoenix-1.oraclecloud.com/Content/Object/Tasks/managingaccess.htm#pre-auth) for constructing URLs for image import/export. For more information about importing exported images, see Image Import/Export (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/imageimportexport.htm). You may optionally specify a *display name* for the image, which is simply a friendly name or description. It does not have to be unique, and you can change it. See UpdateImage. Avoid entering confidential information.

func (ComputeClient) CreateInstanceConsoleConnection ¶ 

func (client ComputeClient) CreateInstanceConsoleConnection(ctx context.Context, request CreateInstanceConsoleConnectionRequest) (response CreateInstanceConsoleConnectionResponse, err error)

CreateInstanceConsoleConnection Creates a new console connection to the specified instance. Once the console connection has been created and is available, you connect to the console using SSH. For more information about console access, see Accessing the Console (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/References/serialconsole.htm).

func (ComputeClient) DeleteAppCatalogSubscription ¶ 

func (client ComputeClient) DeleteAppCatalogSubscription(ctx context.Context, request DeleteAppCatalogSubscriptionRequest) (response DeleteAppCatalogSubscriptionResponse, err error)

DeleteAppCatalogSubscription Delete a subscription for a listing resource version for a compartment.

func (ComputeClient) DeleteConsoleHistory ¶ 

func (client ComputeClient) DeleteConsoleHistory(ctx context.Context, request DeleteConsoleHistoryRequest) (response DeleteConsoleHistoryResponse, err error)

DeleteConsoleHistory Deletes the specified console history metadata and the console history data.

func (ComputeClient) DeleteImage ¶ 

func (client ComputeClient) DeleteImage(ctx context.Context, request DeleteImageRequest) (response DeleteImageResponse, err error)

DeleteImage Deletes an image.

func (ComputeClient) DeleteInstanceConsoleConnection ¶ 

func (client ComputeClient) DeleteInstanceConsoleConnection(ctx context.Context, request DeleteInstanceConsoleConnectionRequest) (response DeleteInstanceConsoleConnectionResponse, err error)

DeleteInstanceConsoleConnection Deletes the specified instance console connection.

func (ComputeClient) DetachBootVolume ¶ 

func (client ComputeClient) DetachBootVolume(ctx context.Context, request DetachBootVolumeRequest) (response DetachBootVolumeResponse, err error)

DetachBootVolume Detaches a boot volume from an instance. You must specify the OCID of the boot volume attachment. This is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily until the attachment is completely removed.

func (ComputeClient) DetachVnic ¶ 

func (client ComputeClient) DetachVnic(ctx context.Context, request DetachVnicRequest) (response DetachVnicResponse, err error)

DetachVnic Detaches and deletes the specified secondary VNIC. This operation cannot be used on the instance's primary VNIC. When you terminate an instance, all attached VNICs (primary and secondary) are automatically detached and deleted. **Important:** If the VNIC has a PrivateIp that is the target of a route rule (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingroutetables.htm#privateip), deleting the VNIC causes that route rule to blackhole and the traffic will be dropped.

func (ComputeClient) DetachVolume ¶ 

func (client ComputeClient) DetachVolume(ctx context.Context, request DetachVolumeRequest) (response DetachVolumeResponse, err error)

DetachVolume Detaches a storage volume from an instance. You must specify the OCID of the volume attachment. This is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily until the attachment is completely removed.

func (ComputeClient) ExportImage ¶ 

func (client ComputeClient) ExportImage(ctx context.Context, request ExportImageRequest) (response ExportImageResponse, err error)

ExportImage Exports the specified image to the Oracle Cloud Infrastructure Object Storage service. You can use the Object Storage URL, or the namespace, bucket name, and object name when specifying the location to export to. For more information about exporting images, see Image Import/Export (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/imageimportexport.htm). To perform an image export, you need write access to the Object Storage bucket for the image, see Let Users Write Objects to Object Storage Buckets (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/commonpolicies.htm#Let4). See Object Storage URLs (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/imageimportexport.htm#URLs) and pre-authenticated requests (https://docs.us-phoenix-1.oraclecloud.com/Content/Object/Tasks/managingaccess.htm#pre-auth) for constructing URLs for image import/export.

func (ComputeClient) GetAppCatalogListing ¶ 

func (client ComputeClient) GetAppCatalogListing(ctx context.Context, request GetAppCatalogListingRequest) (response GetAppCatalogListingResponse, err error)

GetAppCatalogListing Gets the specified listing.

func (ComputeClient) GetAppCatalogListingAgreements ¶ 

func (client ComputeClient) GetAppCatalogListingAgreements(ctx context.Context, request GetAppCatalogListingAgreementsRequest) (response GetAppCatalogListingAgreementsResponse, err error)

GetAppCatalogListingAgreements Retrieves the agreements for a particular resource version of a listing.

func (ComputeClient) GetAppCatalogListingResourceVersion ¶ 

func (client ComputeClient) GetAppCatalogListingResourceVersion(ctx context.Context, request GetAppCatalogListingResourceVersionRequest) (response GetAppCatalogListingResourceVersionResponse, err error)

GetAppCatalogListingResourceVersion Gets the specified listing resource version.

func (ComputeClient) GetBootVolumeAttachment ¶ 

func (client ComputeClient) GetBootVolumeAttachment(ctx context.Context, request GetBootVolumeAttachmentRequest) (response GetBootVolumeAttachmentResponse, err error)

GetBootVolumeAttachment Gets information about the specified boot volume attachment.

func (ComputeClient) GetConsoleHistory ¶ 

func (client ComputeClient) GetConsoleHistory(ctx context.Context, request GetConsoleHistoryRequest) (response GetConsoleHistoryResponse, err error)

GetConsoleHistory Shows the metadata for the specified console history. See CaptureConsoleHistory for details about using the console history operations.

func (ComputeClient) GetConsoleHistoryContent ¶ 

func (client ComputeClient) GetConsoleHistoryContent(ctx context.Context, request GetConsoleHistoryContentRequest) (response GetConsoleHistoryContentResponse, err error)

GetConsoleHistoryContent Gets the actual console history data (not the metadata). See CaptureConsoleHistory for details about using the console history operations.

func (ComputeClient) GetImage ¶ 

func (client ComputeClient) GetImage(ctx context.Context, request GetImageRequest) (response GetImageResponse, err error)

GetImage Gets the specified image.

func (ComputeClient) GetInstance ¶ 

func (client ComputeClient) GetInstance(ctx context.Context, request GetInstanceRequest) (response GetInstanceResponse, err error)

GetInstance Gets information about the specified instance.

func (ComputeClient) GetInstanceConsoleConnection ¶ 

func (client ComputeClient) GetInstanceConsoleConnection(ctx context.Context, request GetInstanceConsoleConnectionRequest) (response GetInstanceConsoleConnectionResponse, err error)

GetInstanceConsoleConnection Gets the specified instance console connection's information.

func (ComputeClient) GetVnicAttachment ¶ 

func (client ComputeClient) GetVnicAttachment(ctx context.Context, request GetVnicAttachmentRequest) (response GetVnicAttachmentResponse, err error)

GetVnicAttachment Gets the information for the specified VNIC attachment.

func (ComputeClient) GetVolumeAttachment ¶ 

func (client ComputeClient) GetVolumeAttachment(ctx context.Context, request GetVolumeAttachmentRequest) (response GetVolumeAttachmentResponse, err error)

GetVolumeAttachment Gets information about the specified volume attachment.

func (ComputeClient) GetWindowsInstanceInitialCredentials ¶ 

func (client ComputeClient) GetWindowsInstanceInitialCredentials(ctx context.Context, request GetWindowsInstanceInitialCredentialsRequest) (response GetWindowsInstanceInitialCredentialsResponse, err error)

GetWindowsInstanceInitialCredentials Gets the generated credentials for the instance. Only works for instances that require password to log in (E.g. Windows). For certain OS'es, users will be forced to change the initial credentials.

func (ComputeClient) InstanceAction ¶ 

func (client ComputeClient) InstanceAction(ctx context.Context, request InstanceActionRequest) (response InstanceActionResponse, err error)

InstanceAction Performs one of the following power actions on the specified instance: - **START** - Powers on the instance. - **STOP** - Powers off the instance. - **SOFTRESET** - Gracefully reboots instance by sending a shutdown command to the operating system and then powers the instance back on. - **SOFTSTOP** - Gracefully shuts down instance by sending a shutdown command to the operating system. - **RESET** - Powers off the instance and then powers it back on. For more information see Stopping and Starting an Instance (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/restartinginstance.htm).

func (ComputeClient) LaunchInstance ¶ 

func (client ComputeClient) LaunchInstance(ctx context.Context, request LaunchInstanceRequest) (response LaunchInstanceResponse, err error)

LaunchInstance Creates a new instance in the specified compartment and the specified availability domain. For general information about instances, see Overview of the Compute Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Concepts/computeoverview.htm). For information about access control and compartments, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about availability domains, see Regions and Availability Domains (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm). To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API. All Oracle Cloud Infrastructure resources, including instances, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. To launch an instance using an image or a boot volume use the `sourceDetails` parameter in LaunchInstanceDetails. When you launch an instance, it is automatically attached to a virtual network interface card (VNIC), called the *primary VNIC*. The VNIC has a private IP address from the subnet's CIDR. You can either assign a private IP address of your choice or let Oracle automatically assign one. You can choose whether the instance has a public IP address. To retrieve the addresses, use the ListVnicAttachments operation to get the VNIC ID for the instance, and then call GetVnic with the VNIC ID. You can later add secondary VNICs to an instance. For more information, see Virtual Network Interface Cards (VNICs) (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm).

func (ComputeClient) ListAppCatalogListingResourceVersions ¶ 

func (client ComputeClient) ListAppCatalogListingResourceVersions(ctx context.Context, request ListAppCatalogListingResourceVersionsRequest) (response ListAppCatalogListingResourceVersionsResponse, err error)

ListAppCatalogListingResourceVersions Gets all resource versions for a particular listing.

func (ComputeClient) ListAppCatalogListings ¶ 

func (client ComputeClient) ListAppCatalogListings(ctx context.Context, request ListAppCatalogListingsRequest) (response ListAppCatalogListingsResponse, err error)

ListAppCatalogListings Lists the published listings.

func (ComputeClient) ListAppCatalogSubscriptions ¶ 

func (client ComputeClient) ListAppCatalogSubscriptions(ctx context.Context, request ListAppCatalogSubscriptionsRequest) (response ListAppCatalogSubscriptionsResponse, err error)

ListAppCatalogSubscriptions Lists subscriptions for a compartment.

func (ComputeClient) ListBootVolumeAttachments ¶ 

func (client ComputeClient) ListBootVolumeAttachments(ctx context.Context, request ListBootVolumeAttachmentsRequest) (response ListBootVolumeAttachmentsResponse, err error)

ListBootVolumeAttachments Lists the boot volume attachments in the specified compartment. You can filter the list by specifying an instance OCID, boot volume OCID, or both.

func (ComputeClient) ListConsoleHistories ¶ 

func (client ComputeClient) ListConsoleHistories(ctx context.Context, request ListConsoleHistoriesRequest) (response ListConsoleHistoriesResponse, err error)

ListConsoleHistories Lists the console history metadata for the specified compartment or instance.

func (ComputeClient) ListImages ¶ 

func (client ComputeClient) ListImages(ctx context.Context, request ListImagesRequest) (response ListImagesResponse, err error)

ListImages Lists the available images in the specified compartment, including both Oracle-provided images (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/References/images.htm) and custom images (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/managingcustomimages.htm) that have been created. The list of images returned is ordered to first show all Oracle-provided images, then all custom images. The order of images returned may change when new images are released.

func (ComputeClient) ListInstanceConsoleConnections ¶ 

func (client ComputeClient) ListInstanceConsoleConnections(ctx context.Context, request ListInstanceConsoleConnectionsRequest) (response ListInstanceConsoleConnectionsResponse, err error)

ListInstanceConsoleConnections Lists the console connections for the specified compartment or instance. For more information about console access, see Accessing the Console (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/References/serialconsole.htm).

func (ComputeClient) ListInstanceDevices ¶ 

func (client ComputeClient) ListInstanceDevices(ctx context.Context, request ListInstanceDevicesRequest) (response ListInstanceDevicesResponse, err error)

ListInstanceDevices Gets a list of all the devices for given instance. You can optionally filter results by device availability.

func (ComputeClient) ListInstances ¶ 

func (client ComputeClient) ListInstances(ctx context.Context, request ListInstancesRequest) (response ListInstancesResponse, err error)

ListInstances Lists the instances in the specified compartment and the specified availability domain. You can filter the results by specifying an instance name (the list will include all the identically-named instances in the compartment).

func (ComputeClient) ListShapes ¶ 

func (client ComputeClient) ListShapes(ctx context.Context, request ListShapesRequest) (response ListShapesResponse, err error)

ListShapes Lists the shapes that can be used to launch an instance within the specified compartment. You can filter the list by compatibility with a specific image.

func (ComputeClient) ListVnicAttachments ¶ 

func (client ComputeClient) ListVnicAttachments(ctx context.Context, request ListVnicAttachmentsRequest) (response ListVnicAttachmentsResponse, err error)

ListVnicAttachments Lists the VNIC attachments in the specified compartment. A VNIC attachment resides in the same compartment as the attached instance. The list can be filtered by instance, VNIC, or availability domain.

func (ComputeClient) ListVolumeAttachments ¶ 

func (client ComputeClient) ListVolumeAttachments(ctx context.Context, request ListVolumeAttachmentsRequest) (response ListVolumeAttachmentsResponse, err error)

ListVolumeAttachments Lists the volume attachments in the specified compartment. You can filter the list by specifying an instance OCID, volume OCID, or both. Currently, the only supported volume attachment type are IScsiVolumeAttachment and ParavirtualizedVolumeAttachment.

func (*ComputeClient) SetRegion ¶ 

func (client *ComputeClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (ComputeClient) TerminateInstance ¶ 

func (client ComputeClient) TerminateInstance(ctx context.Context, request TerminateInstanceRequest) (response TerminateInstanceResponse, err error)

TerminateInstance Terminates the specified instance. Any attached VNICs and volumes are automatically detached when the instance terminates. To preserve the boot volume associated with the instance, specify `true` for `PreserveBootVolumeQueryParam`. To delete the boot volume when the instance is deleted, specify `false` or do not specify a value for `PreserveBootVolumeQueryParam`. This is an asynchronous operation. The instance's `lifecycleState` will change to TERMINATING temporarily until the instance is completely removed.

func (ComputeClient) UpdateConsoleHistory ¶ 

func (client ComputeClient) UpdateConsoleHistory(ctx context.Context, request UpdateConsoleHistoryRequest) (response UpdateConsoleHistoryResponse, err error)

UpdateConsoleHistory Updates the specified console history metadata.

func (ComputeClient) UpdateImage ¶ 

func (client ComputeClient) UpdateImage(ctx context.Context, request UpdateImageRequest) (response UpdateImageResponse, err error)

UpdateImage Updates the display name of the image. Avoid entering confidential information.

func (ComputeClient) UpdateInstance ¶ 

func (client ComputeClient) UpdateInstance(ctx context.Context, request UpdateInstanceRequest) (response UpdateInstanceResponse, err error)

UpdateInstance Updates certain fields on the specified instance. Fields that are not provided in the request will not be updated. Avoid entering confidential information. Changes to metadata fields will be reflected in the instance metadata service (this may take up to a minute). The OCID of the instance remains the same.

type ComputeInstanceDetails ¶ 

type ComputeInstanceDetails struct {
	BlockVolumes []InstanceConfigurationBlockVolumeDetails `mandatory:"false" json:"blockVolumes"`

	LaunchDetails *InstanceConfigurationLaunchInstanceDetails `mandatory:"false" json:"launchDetails"`

	SecondaryVnics []InstanceConfigurationAttachVnicDetails `mandatory:"false" json:"secondaryVnics"`
}

ComputeInstanceDetails Compute Instance Configuration instance details.

func (ComputeInstanceDetails) MarshalJSON ¶ 

func (m ComputeInstanceDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ComputeInstanceDetails) String ¶ 

func (m ComputeInstanceDetails) String() string

type ComputeManagementClient ¶ 

type ComputeManagementClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

ComputeManagementClient a client for ComputeManagement

func NewComputeManagementClientWithConfigurationProvider ¶ 

func NewComputeManagementClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ComputeManagementClient, err error)

NewComputeManagementClientWithConfigurationProvider Creates a new default ComputeManagement client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func (*ComputeManagementClient) ConfigurationProvider ¶ 

func (client *ComputeManagementClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (ComputeManagementClient) CreateInstanceConfiguration ¶ 

func (client ComputeManagementClient) CreateInstanceConfiguration(ctx context.Context, request CreateInstanceConfigurationRequest) (response CreateInstanceConfigurationResponse, err error)

CreateInstanceConfiguration Creates an instance configuration

func (ComputeManagementClient) CreateInstancePool ¶ 

func (client ComputeManagementClient) CreateInstancePool(ctx context.Context, request CreateInstancePoolRequest) (response CreateInstancePoolResponse, err error)

CreateInstancePool Create an instance pool.

func (ComputeManagementClient) DeleteInstanceConfiguration ¶ 

func (client ComputeManagementClient) DeleteInstanceConfiguration(ctx context.Context, request DeleteInstanceConfigurationRequest) (response DeleteInstanceConfigurationResponse, err error)

DeleteInstanceConfiguration Deletes an instance configuration.

func (ComputeManagementClient) GetInstanceConfiguration ¶ 

func (client ComputeManagementClient) GetInstanceConfiguration(ctx context.Context, request GetInstanceConfigurationRequest) (response GetInstanceConfigurationResponse, err error)

GetInstanceConfiguration Gets the specified instance configuration

func (ComputeManagementClient) GetInstancePool ¶ 

func (client ComputeManagementClient) GetInstancePool(ctx context.Context, request GetInstancePoolRequest) (response GetInstancePoolResponse, err error)

GetInstancePool Gets the specified instance pool

func (ComputeManagementClient) LaunchInstanceConfiguration ¶ 

func (client ComputeManagementClient) LaunchInstanceConfiguration(ctx context.Context, request LaunchInstanceConfigurationRequest) (response LaunchInstanceConfigurationResponse, err error)

LaunchInstanceConfiguration Launch an instance from an instance configuration

func (ComputeManagementClient) ListInstanceConfigurations ¶ 

func (client ComputeManagementClient) ListInstanceConfigurations(ctx context.Context, request ListInstanceConfigurationsRequest) (response ListInstanceConfigurationsResponse, err error)

ListInstanceConfigurations Lists the available instanceConfigurations in the specific compartment.

func (ComputeManagementClient) ListInstancePoolInstances ¶ 

func (client ComputeManagementClient) ListInstancePoolInstances(ctx context.Context, request ListInstancePoolInstancesRequest) (response ListInstancePoolInstancesResponse, err error)

ListInstancePoolInstances List the instances in the specified instance pool.

func (ComputeManagementClient) ListInstancePools ¶ 

func (client ComputeManagementClient) ListInstancePools(ctx context.Context, request ListInstancePoolsRequest) (response ListInstancePoolsResponse, err error)

ListInstancePools Lists the instance pools in the specified compartment.

func (ComputeManagementClient) ResetInstancePool ¶ 

func (client ComputeManagementClient) ResetInstancePool(ctx context.Context, request ResetInstancePoolRequest) (response ResetInstancePoolResponse, err error)

ResetInstancePool Performs the reset (power off and power on) action on the specified instance pool, which performs the action on all the instances in the pool.

func (*ComputeManagementClient) SetRegion ¶ 

func (client *ComputeManagementClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (ComputeManagementClient) SoftresetInstancePool ¶ 

func (client ComputeManagementClient) SoftresetInstancePool(ctx context.Context, request SoftresetInstancePoolRequest) (response SoftresetInstancePoolResponse, err error)

SoftresetInstancePool Performs the softreset (ACPI shutdown and power on) action on the specified instance pool, which performs the action on all the instances in the pool.

func (ComputeManagementClient) StartInstancePool ¶ 

func (client ComputeManagementClient) StartInstancePool(ctx context.Context, request StartInstancePoolRequest) (response StartInstancePoolResponse, err error)

StartInstancePool Performs the start (power on) action on the specified instance pool, which performs the action on all the instances in the pool.

func (ComputeManagementClient) StopInstancePool ¶ 

func (client ComputeManagementClient) StopInstancePool(ctx context.Context, request StopInstancePoolRequest) (response StopInstancePoolResponse, err error)

StopInstancePool Performs the stop (power off) action on the specified instance pool, which performs the action on all the instances in the pool.

func (ComputeManagementClient) TerminateInstancePool ¶ 

func (client ComputeManagementClient) TerminateInstancePool(ctx context.Context, request TerminateInstancePoolRequest) (response TerminateInstancePoolResponse, err error)

TerminateInstancePool Terminate the specified instance pool.

func (ComputeManagementClient) UpdateInstanceConfiguration ¶ 

func (client ComputeManagementClient) UpdateInstanceConfiguration(ctx context.Context, request UpdateInstanceConfigurationRequest) (response UpdateInstanceConfigurationResponse, err error)

UpdateInstanceConfiguration Updates the freeFormTags, definedTags, and display name of an instance configuration.

func (ComputeManagementClient) UpdateInstancePool ¶ 

func (client ComputeManagementClient) UpdateInstancePool(ctx context.Context, request UpdateInstancePoolRequest) (response UpdateInstancePoolResponse, err error)

UpdateInstancePool Update the specified instance pool. The OCID of the instance pool remains the same.

type ConnectLocalPeeringGatewaysDetails ¶ 

type ConnectLocalPeeringGatewaysDetails struct {

	// The OCID of the LPG you want to peer with.
	PeerId *string `mandatory:"true" json:"peerId"`
}

ConnectLocalPeeringGatewaysDetails Information about the other local peering gateway (LPG).

func (ConnectLocalPeeringGatewaysDetails) String ¶ 

func (m ConnectLocalPeeringGatewaysDetails) String() string

type ConnectLocalPeeringGatewaysRequest ¶ 

type ConnectLocalPeeringGatewaysRequest struct {

	// The OCID of the local peering gateway.
	LocalPeeringGatewayId *string `mandatory:"true" contributesTo:"path" name:"localPeeringGatewayId"`

	// Details regarding the local peering gateway to connect.
	ConnectLocalPeeringGatewaysDetails `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"`

	// 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
}

ConnectLocalPeeringGatewaysRequest wrapper for the ConnectLocalPeeringGateways operation

func (ConnectLocalPeeringGatewaysRequest) HTTPRequest ¶ added in v1.3.0 

func (request ConnectLocalPeeringGatewaysRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ConnectLocalPeeringGatewaysRequest) RetryPolicy ¶ added in v1.3.0 

func (request ConnectLocalPeeringGatewaysRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ConnectLocalPeeringGatewaysRequest) String ¶ 

func (request ConnectLocalPeeringGatewaysRequest) String() string

type ConnectLocalPeeringGatewaysResponse ¶ 

type ConnectLocalPeeringGatewaysResponse 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"`
}

ConnectLocalPeeringGatewaysResponse wrapper for the ConnectLocalPeeringGateways operation

func (ConnectLocalPeeringGatewaysResponse) HTTPResponse ¶ added in v1.3.0 

func (response ConnectLocalPeeringGatewaysResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ConnectLocalPeeringGatewaysResponse) String ¶ 

func (response ConnectLocalPeeringGatewaysResponse) String() string

type ConnectRemotePeeringConnectionsDetails ¶ added in v1.2.0 

type ConnectRemotePeeringConnectionsDetails struct {

	// The OCID of the RPC you want to peer with.
	PeerId *string `mandatory:"true" json:"peerId"`

	// The name of the region that contains the RPC you want to peer with.
	// Example: `us-ashburn-1`
	PeerRegionName *string `mandatory:"true" json:"peerRegionName"`
}

ConnectRemotePeeringConnectionsDetails Information about the other remote peering connection (RPC).

func (ConnectRemotePeeringConnectionsDetails) String ¶ added in v1.2.0 

func (m ConnectRemotePeeringConnectionsDetails) String() string

type ConnectRemotePeeringConnectionsRequest ¶ added in v1.2.0 

type ConnectRemotePeeringConnectionsRequest struct {

	// The OCID of the remote peering connection (RPC).
	RemotePeeringConnectionId *string `mandatory:"true" contributesTo:"path" name:"remotePeeringConnectionId"`

	// Details to connect peering connection with peering connection from remote region
	ConnectRemotePeeringConnectionsDetails `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"`

	// 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
}

ConnectRemotePeeringConnectionsRequest wrapper for the ConnectRemotePeeringConnections operation

func (ConnectRemotePeeringConnectionsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ConnectRemotePeeringConnectionsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ConnectRemotePeeringConnectionsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ConnectRemotePeeringConnectionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ConnectRemotePeeringConnectionsRequest) String ¶ added in v1.2.0 

func (request ConnectRemotePeeringConnectionsRequest) String() string

type ConnectRemotePeeringConnectionsResponse ¶ added in v1.2.0 

type ConnectRemotePeeringConnectionsResponse 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"`
}

ConnectRemotePeeringConnectionsResponse wrapper for the ConnectRemotePeeringConnections operation

func (ConnectRemotePeeringConnectionsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ConnectRemotePeeringConnectionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ConnectRemotePeeringConnectionsResponse) String ¶ added in v1.2.0 

func (response ConnectRemotePeeringConnectionsResponse) String() string

type ConsoleHistory ¶ 

type ConsoleHistory struct {

	// The availability domain of an instance.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

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

	// The OCID of the console history metadata object.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the instance this console history was fetched from.
	InstanceId *string `mandatory:"true" json:"instanceId"`

	// The current state of the console history.
	LifecycleState ConsoleHistoryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The date and time the history was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	// Example: `My console history metadata`
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

ConsoleHistory An instance's serial console data. It includes configuration messages that occur when the instance boots, such as kernel and BIOS messages, and is useful for checking the status of the instance or diagnosing problems. The console data is minimally formatted ASCII text. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (ConsoleHistory) String ¶ 

func (m ConsoleHistory) String() string

type ConsoleHistoryLifecycleStateEnum ¶ 

type ConsoleHistoryLifecycleStateEnum string

ConsoleHistoryLifecycleStateEnum Enum with underlying type: string 

const (
	ConsoleHistoryLifecycleStateRequested      ConsoleHistoryLifecycleStateEnum = "REQUESTED"
	ConsoleHistoryLifecycleStateGettingHistory ConsoleHistoryLifecycleStateEnum = "GETTING-HISTORY"
	ConsoleHistoryLifecycleStateSucceeded      ConsoleHistoryLifecycleStateEnum = "SUCCEEDED"
	ConsoleHistoryLifecycleStateFailed         ConsoleHistoryLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ConsoleHistoryLifecycleStateEnum

func GetConsoleHistoryLifecycleStateEnumValues ¶ 

func GetConsoleHistoryLifecycleStateEnumValues() []ConsoleHistoryLifecycleStateEnum

GetConsoleHistoryLifecycleStateEnumValues Enumerates the set of values for ConsoleHistoryLifecycleStateEnum

type CopyVolumeBackupDetails ¶ 

type CopyVolumeBackupDetails struct {

	// The name of the destination region.
	// Example: `us-ashburn-1`
	DestinationRegion *string `mandatory:"true" json:"destinationRegion"`

	// A user-friendly name for the volume backup. Does not have to be unique and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`
}

CopyVolumeBackupDetails The representation of CopyVolumeBackupDetails

func (CopyVolumeBackupDetails) String ¶ 

func (m CopyVolumeBackupDetails) String() string

type CopyVolumeBackupRequest ¶ 

type CopyVolumeBackupRequest struct {

	// The OCID of the volume backup.
	VolumeBackupId *string `mandatory:"true" contributesTo:"path" name:"volumeBackupId"`

	// Request to create a cross-region copy of given backup.
	CopyVolumeBackupDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CopyVolumeBackupRequest wrapper for the CopyVolumeBackup operation

func (CopyVolumeBackupRequest) HTTPRequest ¶ 

func (request CopyVolumeBackupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CopyVolumeBackupRequest) RetryPolicy ¶ 

func (request CopyVolumeBackupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CopyVolumeBackupRequest) String ¶ 

func (request CopyVolumeBackupRequest) String() string

type CopyVolumeBackupResponse ¶ 

type CopyVolumeBackupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VolumeBackup instance
	VolumeBackup `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"`
}

CopyVolumeBackupResponse wrapper for the CopyVolumeBackup operation

func (CopyVolumeBackupResponse) HTTPResponse ¶ 

func (response CopyVolumeBackupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CopyVolumeBackupResponse) String ¶ 

func (response CopyVolumeBackupResponse) String() string

type Cpe ¶ 

type Cpe struct {

	// The OCID of the compartment containing the CPE.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The CPE's Oracle ID (OCID).
	Id *string `mandatory:"true" json:"id"`

	// The public IP address of the on-premises router.
	IpAddress *string `mandatory:"true" json:"ipAddress"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The date and time the CPE was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

Cpe An object you create when setting up an IPSec VPN between your on-premises network and VCN. The `Cpe` is a virtual representation of your customer-premises equipment, which is the actual router on-premises at your site at your end of the IPSec VPN connection. For more information, see Overview of the Networking Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (Cpe) String ¶ 

func (m Cpe) String() string

type CreateAppCatalogSubscriptionDetails ¶ 

type CreateAppCatalogSubscriptionDetails struct {

	// The compartmentID for the subscription.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The OCID of the listing.
	ListingId *string `mandatory:"false" json:"listingId"`

	// Listing resource version.
	ListingResourceVersion *string `mandatory:"false" json:"listingResourceVersion"`

	// Oracle TOU link
	OracleTermsOfUseLink *string `mandatory:"false" json:"oracleTermsOfUseLink"`

	// EULA link
	EulaLink *string `mandatory:"false" json:"eulaLink"`

	// Date and time the agreements were retrieved, in RFC3339 format.
	// Example: `2018-03-20T12:32:53.532Z`
	TimeRetrieved *common.SDKTime `mandatory:"false" json:"timeRetrieved"`

	// A generated signature for this listing resource version retrieved the agreements API.
	Signature *string `mandatory:"false" json:"signature"`
}

CreateAppCatalogSubscriptionDetails details for creating a subscription for a listing resource version.

func (CreateAppCatalogSubscriptionDetails) String ¶ 

func (m CreateAppCatalogSubscriptionDetails) String() string

type CreateAppCatalogSubscriptionRequest ¶ 

type CreateAppCatalogSubscriptionRequest struct {

	// Request for the creation of a subscription for listing resource version for a compartment.
	CreateAppCatalogSubscriptionDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateAppCatalogSubscriptionRequest wrapper for the CreateAppCatalogSubscription operation

func (CreateAppCatalogSubscriptionRequest) HTTPRequest ¶ 

func (request CreateAppCatalogSubscriptionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateAppCatalogSubscriptionRequest) RetryPolicy ¶ 

func (request CreateAppCatalogSubscriptionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateAppCatalogSubscriptionRequest) String ¶ 

func (request CreateAppCatalogSubscriptionRequest) String() string

type CreateAppCatalogSubscriptionResponse ¶ 

type CreateAppCatalogSubscriptionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AppCatalogSubscription instance
	AppCatalogSubscription `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"`
}

CreateAppCatalogSubscriptionResponse wrapper for the CreateAppCatalogSubscription operation

func (CreateAppCatalogSubscriptionResponse) HTTPResponse ¶ 

func (response CreateAppCatalogSubscriptionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateAppCatalogSubscriptionResponse) String ¶ 

func (response CreateAppCatalogSubscriptionResponse) String() string

type CreateBootVolumeBackupDetails ¶ added in v1.8.0 

type CreateBootVolumeBackupDetails struct {

	// The OCID of the boot volume that needs to be backed up.
	BootVolumeId *string `mandatory:"true" json:"bootVolumeId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name for the boot volume backup. Does not have to be unique and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The type of backup to create. If omitted, defaults to incremental.
	Type CreateBootVolumeBackupDetailsTypeEnum `mandatory:"false" json:"type,omitempty"`
}

CreateBootVolumeBackupDetails The representation of CreateBootVolumeBackupDetails

func (CreateBootVolumeBackupDetails) String ¶ added in v1.8.0 

func (m CreateBootVolumeBackupDetails) String() string

type CreateBootVolumeBackupDetailsTypeEnum ¶ added in v1.8.0 

type CreateBootVolumeBackupDetailsTypeEnum string

CreateBootVolumeBackupDetailsTypeEnum Enum with underlying type: string 

const (
	CreateBootVolumeBackupDetailsTypeFull        CreateBootVolumeBackupDetailsTypeEnum = "FULL"
	CreateBootVolumeBackupDetailsTypeIncremental CreateBootVolumeBackupDetailsTypeEnum = "INCREMENTAL"
)

Set of constants representing the allowable values for CreateBootVolumeBackupDetailsTypeEnum

func GetCreateBootVolumeBackupDetailsTypeEnumValues ¶ added in v1.8.0 

func GetCreateBootVolumeBackupDetailsTypeEnumValues() []CreateBootVolumeBackupDetailsTypeEnum

GetCreateBootVolumeBackupDetailsTypeEnumValues Enumerates the set of values for CreateBootVolumeBackupDetailsTypeEnum

type CreateBootVolumeBackupRequest ¶ added in v1.8.0 

type CreateBootVolumeBackupRequest struct {

	// Request to create a new backup of given boot volume.
	CreateBootVolumeBackupDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateBootVolumeBackupRequest wrapper for the CreateBootVolumeBackup operation

func (CreateBootVolumeBackupRequest) HTTPRequest ¶ added in v1.8.0 

func (request CreateBootVolumeBackupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateBootVolumeBackupRequest) RetryPolicy ¶ added in v1.8.0 

func (request CreateBootVolumeBackupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateBootVolumeBackupRequest) String ¶ added in v1.8.0 

func (request CreateBootVolumeBackupRequest) String() string

type CreateBootVolumeBackupResponse ¶ added in v1.8.0 

type CreateBootVolumeBackupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BootVolumeBackup instance
	BootVolumeBackup `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"`
}

CreateBootVolumeBackupResponse wrapper for the CreateBootVolumeBackup operation

func (CreateBootVolumeBackupResponse) HTTPResponse ¶ added in v1.8.0 

func (response CreateBootVolumeBackupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateBootVolumeBackupResponse) String ¶ added in v1.8.0 

func (response CreateBootVolumeBackupResponse) String() string

type CreateBootVolumeDetails ¶ added in v1.8.0 

type CreateBootVolumeDetails struct {

	// The availability domain of the boot volume.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The OCID of the compartment that contains the boot volume.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Specifies the boot volume source details for a new boot volume. The volume source is either another boot volume in the same availability domain or a boot volume backup.
	// This is a mandatory field for a boot volume.
	SourceDetails BootVolumeSourceDetails `mandatory:"true" json:"sourceDetails"`

	// If provided, specifies the ID of the boot volume backup policy to assign to the newly
	// created boot volume. If omitted, no policy will be assigned.
	BackupPolicyId *string `mandatory:"false" json:"backupPolicyId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The OCID of the KMS key to be used as the master encryption key for the boot volume.
	KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`

	// The size of the volume in GBs.
	SizeInGBs *int64 `mandatory:"false" json:"sizeInGBs"`
}

CreateBootVolumeDetails The representation of CreateBootVolumeDetails

func (CreateBootVolumeDetails) String ¶ added in v1.8.0 

func (m CreateBootVolumeDetails) String() string

func (*CreateBootVolumeDetails) UnmarshalJSON ¶ added in v1.8.0 

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

UnmarshalJSON unmarshals from json

type CreateBootVolumeRequest ¶ added in v1.8.0 

type CreateBootVolumeRequest struct {

	// Request to create a new boot volume.
	CreateBootVolumeDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateBootVolumeRequest wrapper for the CreateBootVolume operation

func (CreateBootVolumeRequest) HTTPRequest ¶ added in v1.8.0 

func (request CreateBootVolumeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateBootVolumeRequest) RetryPolicy ¶ added in v1.8.0 

func (request CreateBootVolumeRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateBootVolumeRequest) String ¶ added in v1.8.0 

func (request CreateBootVolumeRequest) String() string

type CreateBootVolumeResponse ¶ added in v1.8.0 

type CreateBootVolumeResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BootVolume instance
	BootVolume `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"`
}

CreateBootVolumeResponse wrapper for the CreateBootVolume operation

func (CreateBootVolumeResponse) HTTPResponse ¶ added in v1.8.0 

func (response CreateBootVolumeResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateBootVolumeResponse) String ¶ added in v1.8.0 

func (response CreateBootVolumeResponse) String() string

type CreateCpeDetails ¶ 

type CreateCpeDetails struct {

	// The OCID of the compartment to contain the CPE.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The public IP address of the on-premises router.
	// Example: `143.19.23.16`
	IpAddress *string `mandatory:"true" json:"ipAddress"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

CreateCpeDetails The representation of CreateCpeDetails

func (CreateCpeDetails) String ¶ 

func (m CreateCpeDetails) String() string

type CreateCpeRequest ¶ 

type CreateCpeRequest struct {

	// Details for creating a CPE.
	CreateCpeDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateCpeRequest wrapper for the CreateCpe operation

func (CreateCpeRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateCpeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateCpeRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateCpeRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateCpeRequest) String ¶ 

func (request CreateCpeRequest) String() string

type CreateCpeResponse ¶ 

type CreateCpeResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Cpe instance
	Cpe `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"`
}

CreateCpeResponse wrapper for the CreateCpe operation

func (CreateCpeResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateCpeResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateCpeResponse) String ¶ 

func (response CreateCpeResponse) String() string

type CreateCrossConnectDetails ¶ 

type CreateCrossConnectDetails struct {

	// The OCID of the compartment to contain the cross-connect.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The name of the FastConnect location where this cross-connect will be installed.
	// To get a list of the available locations, see
	// ListCrossConnectLocations.
	// Example: `CyrusOne, Chandler, AZ`
	LocationName *string `mandatory:"true" json:"locationName"`

	// The port speed for this cross-connect. To get a list of the available port speeds, see
	// ListCrossconnectPortSpeedShapes.
	// Example: `10 Gbps`
	PortSpeedShapeName *string `mandatory:"true" json:"portSpeedShapeName"`

	// The OCID of the cross-connect group to put this cross-connect in.
	CrossConnectGroupId *string `mandatory:"false" json:"crossConnectGroupId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// If you already have an existing cross-connect or cross-connect group at this FastConnect
	// location, and you want this new cross-connect to be on a different router (for the
	// purposes of redundancy), provide the OCID of that existing cross-connect or
	// cross-connect group.
	FarCrossConnectOrCrossConnectGroupId *string `mandatory:"false" json:"farCrossConnectOrCrossConnectGroupId"`

	// If you already have an existing cross-connect or cross-connect group at this FastConnect
	// location, and you want this new cross-connect to be on the same router, provide the
	// OCID of that existing cross-connect or cross-connect group.
	NearCrossConnectOrCrossConnectGroupId *string `mandatory:"false" json:"nearCrossConnectOrCrossConnectGroupId"`
}

CreateCrossConnectDetails The representation of CreateCrossConnectDetails

func (CreateCrossConnectDetails) String ¶ 

func (m CreateCrossConnectDetails) String() string

type CreateCrossConnectGroupDetails ¶ 

type CreateCrossConnectGroupDetails struct {

	// The OCID of the compartment to contain the cross-connect group.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`
}

CreateCrossConnectGroupDetails The representation of CreateCrossConnectGroupDetails

func (CreateCrossConnectGroupDetails) String ¶ 

func (m CreateCrossConnectGroupDetails) String() string

type CreateCrossConnectGroupRequest ¶ 

type CreateCrossConnectGroupRequest struct {

	// Details to create a CrossConnectGroup
	CreateCrossConnectGroupDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateCrossConnectGroupRequest wrapper for the CreateCrossConnectGroup operation

func (CreateCrossConnectGroupRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateCrossConnectGroupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateCrossConnectGroupRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateCrossConnectGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateCrossConnectGroupRequest) String ¶ 

func (request CreateCrossConnectGroupRequest) String() string

type CreateCrossConnectGroupResponse ¶ 

type CreateCrossConnectGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The CrossConnectGroup instance
	CrossConnectGroup `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"`
}

CreateCrossConnectGroupResponse wrapper for the CreateCrossConnectGroup operation

func (CreateCrossConnectGroupResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateCrossConnectGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateCrossConnectGroupResponse) String ¶ 

func (response CreateCrossConnectGroupResponse) String() string

type CreateCrossConnectRequest ¶ 

type CreateCrossConnectRequest struct {

	// Details to create a CrossConnect
	CreateCrossConnectDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateCrossConnectRequest wrapper for the CreateCrossConnect operation

func (CreateCrossConnectRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateCrossConnectRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateCrossConnectRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateCrossConnectRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateCrossConnectRequest) String ¶ 

func (request CreateCrossConnectRequest) String() string

type CreateCrossConnectResponse ¶ 

type CreateCrossConnectResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The CrossConnect instance
	CrossConnect `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"`
}

CreateCrossConnectResponse wrapper for the CreateCrossConnect operation

func (CreateCrossConnectResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateCrossConnectResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateCrossConnectResponse) String ¶ 

func (response CreateCrossConnectResponse) String() string

type CreateDhcpDetails ¶ 

type CreateDhcpDetails struct {

	// The OCID of the compartment to contain the set of DHCP options.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A set of DHCP options.
	Options []DhcpOption `mandatory:"true" json:"options"`

	// The OCID of the VCN the set of DHCP options belongs to.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

CreateDhcpDetails The representation of CreateDhcpDetails

func (CreateDhcpDetails) String ¶ 

func (m CreateDhcpDetails) String() string

func (*CreateDhcpDetails) UnmarshalJSON ¶ 

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

UnmarshalJSON unmarshals from json

type CreateDhcpOptionsRequest ¶ 

type CreateDhcpOptionsRequest struct {

	// Request object for creating a new set of DHCP options.
	CreateDhcpDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateDhcpOptionsRequest wrapper for the CreateDhcpOptions operation

func (CreateDhcpOptionsRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateDhcpOptionsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateDhcpOptionsRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateDhcpOptionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateDhcpOptionsRequest) String ¶ 

func (request CreateDhcpOptionsRequest) String() string

type CreateDhcpOptionsResponse ¶ 

type CreateDhcpOptionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DhcpOptions instance
	DhcpOptions `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"`
}

CreateDhcpOptionsResponse wrapper for the CreateDhcpOptions operation

func (CreateDhcpOptionsResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateDhcpOptionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateDhcpOptionsResponse) String ¶ 

func (response CreateDhcpOptionsResponse) String() string

type CreateDrgAttachmentDetails ¶ 

type CreateDrgAttachmentDetails struct {

	// The OCID of the DRG.
	DrgId *string `mandatory:"true" json:"drgId"`

	// The OCID of the VCN.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// A user-friendly name. Does not have to be unique. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The OCID of the route table the DRG attachment will use.
	// If you don't specify a route table here, the DRG attachment is created without an associated route
	// table. The Networking service does NOT automatically associate the attached VCN's default route table
	// with the DRG attachment.
	// For information about why you would associate a route table with a DRG attachment, see
	// Advanced Scenario: Transit Routing (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/transitrouting.htm).
	RouteTableId *string `mandatory:"false" json:"routeTableId"`
}

CreateDrgAttachmentDetails The representation of CreateDrgAttachmentDetails

func (CreateDrgAttachmentDetails) String ¶ 

func (m CreateDrgAttachmentDetails) String() string

type CreateDrgAttachmentRequest ¶ 

type CreateDrgAttachmentRequest struct {

	// Details for creating a `DrgAttachment`.
	CreateDrgAttachmentDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateDrgAttachmentRequest wrapper for the CreateDrgAttachment operation

func (CreateDrgAttachmentRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateDrgAttachmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateDrgAttachmentRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateDrgAttachmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateDrgAttachmentRequest) String ¶ 

func (request CreateDrgAttachmentRequest) String() string

type CreateDrgAttachmentResponse ¶ 

type CreateDrgAttachmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DrgAttachment instance
	DrgAttachment `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"`
}

CreateDrgAttachmentResponse wrapper for the CreateDrgAttachment operation

func (CreateDrgAttachmentResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateDrgAttachmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateDrgAttachmentResponse) String ¶ 

func (response CreateDrgAttachmentResponse) String() string

type CreateDrgDetails ¶ 

type CreateDrgDetails struct {

	// The OCID of the compartment to contain the DRG.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

CreateDrgDetails The representation of CreateDrgDetails

func (CreateDrgDetails) String ¶ 

func (m CreateDrgDetails) String() string

type CreateDrgRequest ¶ 

type CreateDrgRequest struct {

	// Details for creating a DRG.
	CreateDrgDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateDrgRequest wrapper for the CreateDrg operation

func (CreateDrgRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateDrgRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateDrgRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateDrgRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateDrgRequest) String ¶ 

func (request CreateDrgRequest) String() string

type CreateDrgResponse ¶ 

type CreateDrgResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Drg instance
	Drg `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"`
}

CreateDrgResponse wrapper for the CreateDrg operation

func (CreateDrgResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateDrgResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateDrgResponse) String ¶ 

func (response CreateDrgResponse) String() string

type CreateIPSecConnectionRequest ¶ 

type CreateIPSecConnectionRequest struct {

	// Details for creating an `IPSecConnection`.
	CreateIpSecConnectionDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateIPSecConnectionRequest wrapper for the CreateIPSecConnection operation

func (CreateIPSecConnectionRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateIPSecConnectionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateIPSecConnectionRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateIPSecConnectionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateIPSecConnectionRequest) String ¶ 

func (request CreateIPSecConnectionRequest) String() string

type CreateIPSecConnectionResponse ¶ 

type CreateIPSecConnectionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The IpSecConnection instance
	IpSecConnection `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"`
}

CreateIPSecConnectionResponse wrapper for the CreateIPSecConnection operation

func (CreateIPSecConnectionResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateIPSecConnectionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateIPSecConnectionResponse) String ¶ 

func (response CreateIPSecConnectionResponse) String() string

type CreateImageDetails ¶ 

type CreateImageDetails struct {

	// The OCID of the compartment containing the instance you want to use as the basis for the image.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name for the image. It does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	// You cannot use an Oracle-provided image name as a custom image name.
	// Example: `My Oracle Linux image`
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Details for creating an image through import
	ImageSourceDetails ImageSourceDetails `mandatory:"false" json:"imageSourceDetails"`

	// The OCID of the instance you want to use as the basis for the image.
	InstanceId *string `mandatory:"false" json:"instanceId"`

	// Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
	// * `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for Oracle-provided images.
	// * `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
	// * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using virtio drivers.
	// * `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.
	LaunchMode CreateImageDetailsLaunchModeEnum `mandatory:"false" json:"launchMode,omitempty"`
}

CreateImageDetails Either instanceId or imageSourceDetails must be provided in addition to other required parameters.

func (CreateImageDetails) String ¶ 

func (m CreateImageDetails) String() string

func (*CreateImageDetails) UnmarshalJSON ¶ 

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

UnmarshalJSON unmarshals from json

type CreateImageDetailsLaunchModeEnum ¶ added in v1.1.0 

type CreateImageDetailsLaunchModeEnum string

CreateImageDetailsLaunchModeEnum Enum with underlying type: string 

const (
	CreateImageDetailsLaunchModeNative          CreateImageDetailsLaunchModeEnum = "NATIVE"
	CreateImageDetailsLaunchModeEmulated        CreateImageDetailsLaunchModeEnum = "EMULATED"
	CreateImageDetailsLaunchModeParavirtualized CreateImageDetailsLaunchModeEnum = "PARAVIRTUALIZED"
	CreateImageDetailsLaunchModeCustom          CreateImageDetailsLaunchModeEnum = "CUSTOM"
)

Set of constants representing the allowable values for CreateImageDetailsLaunchModeEnum

func GetCreateImageDetailsLaunchModeEnumValues ¶ added in v1.1.0 

func GetCreateImageDetailsLaunchModeEnumValues() []CreateImageDetailsLaunchModeEnum

GetCreateImageDetailsLaunchModeEnumValues Enumerates the set of values for CreateImageDetailsLaunchModeEnum

type CreateImageRequest ¶ 

type CreateImageRequest struct {

	// Image creation details
	CreateImageDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateImageRequest wrapper for the CreateImage operation

func (CreateImageRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateImageRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateImageRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateImageRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateImageRequest) String ¶ 

func (request CreateImageRequest) String() string

type CreateImageResponse ¶ 

type CreateImageResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Image instance
	Image `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"`
}

CreateImageResponse wrapper for the CreateImage operation

func (CreateImageResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateImageResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateImageResponse) String ¶ 

func (response CreateImageResponse) String() string

type CreateInstanceConfigurationDetails ¶ 

type CreateInstanceConfigurationDetails struct {

	// The OCID of the compartment containing the instance configuration.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	InstanceDetails InstanceConfigurationInstanceDetails `mandatory:"true" json:"instanceDetails"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name for the instance configuration
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

CreateInstanceConfigurationDetails An instance configuration that can be used to launch

func (CreateInstanceConfigurationDetails) String ¶ 

func (m CreateInstanceConfigurationDetails) String() string

func (*CreateInstanceConfigurationDetails) UnmarshalJSON ¶ 

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

UnmarshalJSON unmarshals from json

type CreateInstanceConfigurationRequest ¶ 

type CreateInstanceConfigurationRequest struct {

	// Instance configuration creation details
	CreateInstanceConfiguration CreateInstanceConfigurationDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateInstanceConfigurationRequest wrapper for the CreateInstanceConfiguration operation

func (CreateInstanceConfigurationRequest) HTTPRequest ¶ 

func (request CreateInstanceConfigurationRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateInstanceConfigurationRequest) RetryPolicy ¶ 

func (request CreateInstanceConfigurationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateInstanceConfigurationRequest) String ¶ 

func (request CreateInstanceConfigurationRequest) String() string

type CreateInstanceConfigurationResponse ¶ 

type CreateInstanceConfigurationResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The InstanceConfiguration instance
	InstanceConfiguration `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"`
}

CreateInstanceConfigurationResponse wrapper for the CreateInstanceConfiguration operation

func (CreateInstanceConfigurationResponse) HTTPResponse ¶ 

func (response CreateInstanceConfigurationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateInstanceConfigurationResponse) String ¶ 

func (response CreateInstanceConfigurationResponse) String() string

type CreateInstanceConsoleConnectionDetails ¶ 

type CreateInstanceConsoleConnectionDetails struct {

	// The OCID of the instance to create the console connection to.
	InstanceId *string `mandatory:"true" json:"instanceId"`

	// The SSH public key used to authenticate the console connection.
	PublicKey *string `mandatory:"true" json:"publicKey"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

CreateInstanceConsoleConnectionDetails The details for creating a instance console connection. The instance console connection is created in the same compartment as the instance.

func (CreateInstanceConsoleConnectionDetails) String ¶ 

func (m CreateInstanceConsoleConnectionDetails) String() string

type CreateInstanceConsoleConnectionRequest ¶ 

type CreateInstanceConsoleConnectionRequest struct {

	// Request object for creating an InstanceConsoleConnection
	CreateInstanceConsoleConnectionDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateInstanceConsoleConnectionRequest wrapper for the CreateInstanceConsoleConnection operation

func (CreateInstanceConsoleConnectionRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateInstanceConsoleConnectionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateInstanceConsoleConnectionRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateInstanceConsoleConnectionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateInstanceConsoleConnectionRequest) String ¶ 

func (request CreateInstanceConsoleConnectionRequest) String() string

type CreateInstanceConsoleConnectionResponse ¶ 

type CreateInstanceConsoleConnectionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The InstanceConsoleConnection instance
	InstanceConsoleConnection `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"`
}

CreateInstanceConsoleConnectionResponse wrapper for the CreateInstanceConsoleConnection operation

func (CreateInstanceConsoleConnectionResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateInstanceConsoleConnectionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateInstanceConsoleConnectionResponse) String ¶ 

func (response CreateInstanceConsoleConnectionResponse) String() string

type CreateInstancePoolDetails ¶ 

type CreateInstancePoolDetails struct {

	// The OCID of the compartment containing the instance pool
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the instance configuration associated to the instance pool.
	InstanceConfigurationId *string `mandatory:"true" json:"instanceConfigurationId"`

	// The placement configurations for the instance pool.
	// There should be 1 placement configuration for each desired AD.
	PlacementConfigurations []CreateInstancePoolPlacementConfigurationDetails `mandatory:"true" json:"placementConfigurations"`

	// The number of instances that should be in the instance pool.
	Size *int `mandatory:"true" json:"size"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// The user-friendly name.  Does not have to be unique.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

CreateInstancePoolDetails The data to create an instance pool.

func (CreateInstancePoolDetails) String ¶ 

func (m CreateInstancePoolDetails) String() string

type CreateInstancePoolPlacementConfigurationDetails ¶ 

type CreateInstancePoolPlacementConfigurationDetails struct {

	// The availability domain to place instances.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The OCID of the primary subnet to place instances.
	PrimarySubnetId *string `mandatory:"true" json:"primarySubnetId"`

	// The set of secondary VNIC data for instances in the pool.
	SecondaryVnicSubnets []InstancePoolPlacementSecondaryVnicSubnet `mandatory:"false" json:"secondaryVnicSubnets"`
}

CreateInstancePoolPlacementConfigurationDetails The location for where an instance pool will place instances.

func (CreateInstancePoolPlacementConfigurationDetails) String ¶ 

func (m CreateInstancePoolPlacementConfigurationDetails) String() string

type CreateInstancePoolRequest ¶ 

type CreateInstancePoolRequest struct {

	// Instance Pool creation details
	CreateInstancePoolDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateInstancePoolRequest wrapper for the CreateInstancePool operation

func (CreateInstancePoolRequest) HTTPRequest ¶ 

func (request CreateInstancePoolRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateInstancePoolRequest) RetryPolicy ¶ 

func (request CreateInstancePoolRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateInstancePoolRequest) String ¶ 

func (request CreateInstancePoolRequest) String() string

type CreateInstancePoolResponse ¶ 

type CreateInstancePoolResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The InstancePool instance
	InstancePool `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"`
}

CreateInstancePoolResponse wrapper for the CreateInstancePool operation

func (CreateInstancePoolResponse) HTTPResponse ¶ 

func (response CreateInstancePoolResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateInstancePoolResponse) String ¶ 

func (response CreateInstancePoolResponse) String() string

type CreateInternetGatewayDetails ¶ 

type CreateInternetGatewayDetails struct {

	// The OCID of the compartment to contain the internet gateway.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Whether the gateway is enabled upon creation.
	IsEnabled *bool `mandatory:"true" json:"isEnabled"`

	// The OCID of the VCN the internet gateway is attached to.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

CreateInternetGatewayDetails The representation of CreateInternetGatewayDetails

func (CreateInternetGatewayDetails) String ¶ 

func (m CreateInternetGatewayDetails) String() string

type CreateInternetGatewayRequest ¶ 

type CreateInternetGatewayRequest struct {

	// Details for creating a new internet gateway.
	CreateInternetGatewayDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateInternetGatewayRequest wrapper for the CreateInternetGateway operation

func (CreateInternetGatewayRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateInternetGatewayRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateInternetGatewayRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateInternetGatewayRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateInternetGatewayRequest) String ¶ 

func (request CreateInternetGatewayRequest) String() string

type CreateInternetGatewayResponse ¶ 

type CreateInternetGatewayResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The InternetGateway instance
	InternetGateway `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"`
}

CreateInternetGatewayResponse wrapper for the CreateInternetGateway operation

func (CreateInternetGatewayResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateInternetGatewayResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateInternetGatewayResponse) String ¶ 

func (response CreateInternetGatewayResponse) String() string

type CreateIpSecConnectionDetails ¶ 

type CreateIpSecConnectionDetails struct {

	// The OCID of the compartment to contain the IPSec connection.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the CPE.
	CpeId *string `mandatory:"true" json:"cpeId"`

	// The OCID of the DRG.
	DrgId *string `mandatory:"true" json:"drgId"`

	// Static routes to the CPE. At least one route must be included. The CIDR must not be a
	// multicast address or class E address.
	// Example: `10.0.1.0/24`
	StaticRoutes []string `mandatory:"true" json:"staticRoutes"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

CreateIpSecConnectionDetails The representation of CreateIpSecConnectionDetails

func (CreateIpSecConnectionDetails) String ¶ 

func (m CreateIpSecConnectionDetails) String() string

type CreateLocalPeeringGatewayDetails ¶ 

type CreateLocalPeeringGatewayDetails struct {

	// The OCID of the compartment containing the local peering gateway (LPG).
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the VCN the LPG belongs to.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid
	// entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The OCID of the route table the LPG will use.
	// If you don't specify a route table here, the LPG is created without an associated route
	// table. The Networking service does NOT automatically associate the attached VCN's default route table
	// with the LPG.
	// For information about why you would associate a route table with an LPG, see
	// Advanced Scenario: Transit Routing (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/transitrouting.htm).
	RouteTableId *string `mandatory:"false" json:"routeTableId"`
}

CreateLocalPeeringGatewayDetails The representation of CreateLocalPeeringGatewayDetails

func (CreateLocalPeeringGatewayDetails) String ¶ 

func (m CreateLocalPeeringGatewayDetails) String() string

type CreateLocalPeeringGatewayRequest ¶ 

type CreateLocalPeeringGatewayRequest struct {

	// Details for creating a new local peering gateway.
	CreateLocalPeeringGatewayDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateLocalPeeringGatewayRequest wrapper for the CreateLocalPeeringGateway operation

func (CreateLocalPeeringGatewayRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateLocalPeeringGatewayRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateLocalPeeringGatewayRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateLocalPeeringGatewayRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateLocalPeeringGatewayRequest) String ¶ 

func (request CreateLocalPeeringGatewayRequest) String() string

type CreateLocalPeeringGatewayResponse ¶ 

type CreateLocalPeeringGatewayResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The LocalPeeringGateway instance
	LocalPeeringGateway `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"`
}

CreateLocalPeeringGatewayResponse wrapper for the CreateLocalPeeringGateway operation

func (CreateLocalPeeringGatewayResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateLocalPeeringGatewayResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateLocalPeeringGatewayResponse) String ¶ 

func (response CreateLocalPeeringGatewayResponse) String() string

type CreateNatGatewayDetails ¶ 

type CreateNatGatewayDetails struct {

	// The OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the compartment to contain the
	// NAT gateway.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the VCN the gateway belongs to.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Whether the NAT gateway blocks traffic through it. The default is `false`.
	// Example: `true`
	BlockTraffic *bool `mandatory:"false" json:"blockTraffic"`
}

CreateNatGatewayDetails The representation of CreateNatGatewayDetails

func (CreateNatGatewayDetails) String ¶ 

func (m CreateNatGatewayDetails) String() string

type CreateNatGatewayRequest ¶ 

type CreateNatGatewayRequest struct {

	// Details for creating a NAT gateway.
	CreateNatGatewayDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateNatGatewayRequest wrapper for the CreateNatGateway operation

func (CreateNatGatewayRequest) HTTPRequest ¶ 

func (request CreateNatGatewayRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateNatGatewayRequest) RetryPolicy ¶ 

func (request CreateNatGatewayRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateNatGatewayRequest) String ¶ 

func (request CreateNatGatewayRequest) String() string

type CreateNatGatewayResponse ¶ 

type CreateNatGatewayResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The NatGateway instance
	NatGateway `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"`
}

CreateNatGatewayResponse wrapper for the CreateNatGateway operation

func (CreateNatGatewayResponse) HTTPResponse ¶ 

func (response CreateNatGatewayResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateNatGatewayResponse) String ¶ 

func (response CreateNatGatewayResponse) String() string

type CreatePrivateIpDetails ¶ 

type CreatePrivateIpDetails struct {

	// The OCID of the VNIC to assign the private IP to. The VNIC and private IP
	// must be in the same subnet.
	VnicId *string `mandatory:"true" json:"vnicId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid
	// entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The hostname for the private IP. Used for DNS. The value
	// is the hostname portion of the private IP's fully qualified domain name (FQDN)
	// (for example, `bminstance-1` in FQDN `bminstance-1.subnet123.vcn1.oraclevcn.com`).
	// Must be unique across all VNICs in the subnet and comply with
	// RFC 952 (https://tools.ietf.org/html/rfc952) and
	// RFC 1123 (https://tools.ietf.org/html/rfc1123).
	// For more information, see
	// DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
	// Example: `bminstance-1`
	HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`

	// A private IP address of your choice. Must be an available IP address within
	// the subnet's CIDR. If you don't specify a value, Oracle automatically
	// assigns a private IP address from the subnet.
	// Example: `10.0.3.3`
	IpAddress *string `mandatory:"false" json:"ipAddress"`
}

CreatePrivateIpDetails The representation of CreatePrivateIpDetails

func (CreatePrivateIpDetails) String ¶ 

func (m CreatePrivateIpDetails) String() string

type CreatePrivateIpRequest ¶ 

type CreatePrivateIpRequest struct {

	// Create private IP details.
	CreatePrivateIpDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreatePrivateIpRequest wrapper for the CreatePrivateIp operation

func (CreatePrivateIpRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreatePrivateIpRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreatePrivateIpRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreatePrivateIpRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreatePrivateIpRequest) String ¶ 

func (request CreatePrivateIpRequest) String() string

type CreatePrivateIpResponse ¶ 

type CreatePrivateIpResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The PrivateIp instance
	PrivateIp `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"`
}

CreatePrivateIpResponse wrapper for the CreatePrivateIp operation

func (CreatePrivateIpResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreatePrivateIpResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreatePrivateIpResponse) String ¶ 

func (response CreatePrivateIpResponse) String() string

type CreatePublicIpDetails ¶ added in v1.1.0 

type CreatePublicIpDetails struct {

	// The OCID of the compartment to contain the public IP. For ephemeral public IPs,
	// you must set this to the private IP's compartment OCID.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Defines when the public IP is deleted and released back to the Oracle Cloud
	// Infrastructure public IP pool. For more information, see
	// Public IP Addresses (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingpublicIPs.htm).
	Lifetime CreatePublicIpDetailsLifetimeEnum `mandatory:"true" json:"lifetime"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid
	// entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The OCID of the private IP to assign the public IP to.
	// Required for an ephemeral public IP because it must always be assigned to a private IP
	// (specifically a *primary* private IP).
	// Optional for a reserved public IP. If you don't provide it, the public IP is created but not
	// assigned to a private IP. You can later assign the public IP with
	// UpdatePublicIp.
	PrivateIpId *string `mandatory:"false" json:"privateIpId"`
}

CreatePublicIpDetails The representation of CreatePublicIpDetails

func (CreatePublicIpDetails) String ¶ added in v1.1.0 

func (m CreatePublicIpDetails) String() string

type CreatePublicIpDetailsLifetimeEnum ¶ added in v1.1.0 

type CreatePublicIpDetailsLifetimeEnum string

CreatePublicIpDetailsLifetimeEnum Enum with underlying type: string 

const (
	CreatePublicIpDetailsLifetimeEphemeral CreatePublicIpDetailsLifetimeEnum = "EPHEMERAL"
	CreatePublicIpDetailsLifetimeReserved  CreatePublicIpDetailsLifetimeEnum = "RESERVED"
)

Set of constants representing the allowable values for CreatePublicIpDetailsLifetimeEnum

func GetCreatePublicIpDetailsLifetimeEnumValues ¶ added in v1.1.0 

func GetCreatePublicIpDetailsLifetimeEnumValues() []CreatePublicIpDetailsLifetimeEnum

GetCreatePublicIpDetailsLifetimeEnumValues Enumerates the set of values for CreatePublicIpDetailsLifetimeEnum

type CreatePublicIpRequest ¶ added in v1.1.0 

type CreatePublicIpRequest struct {

	// Create public IP details.
	CreatePublicIpDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreatePublicIpRequest wrapper for the CreatePublicIp operation

func (CreatePublicIpRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreatePublicIpRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreatePublicIpRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreatePublicIpRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreatePublicIpRequest) String ¶ added in v1.1.0 

func (request CreatePublicIpRequest) String() string

type CreatePublicIpResponse ¶ added in v1.1.0 

type CreatePublicIpResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The PublicIp instance
	PublicIp `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"`
}

CreatePublicIpResponse wrapper for the CreatePublicIp operation

func (CreatePublicIpResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreatePublicIpResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreatePublicIpResponse) String ¶ added in v1.1.0 

func (response CreatePublicIpResponse) String() string

type CreateRemotePeeringConnectionDetails ¶ added in v1.2.0 

type CreateRemotePeeringConnectionDetails struct {

	// The OCID of the compartment to contain the RPC.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the DRG the RPC belongs to.
	DrgId *string `mandatory:"true" json:"drgId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`
}

CreateRemotePeeringConnectionDetails The representation of CreateRemotePeeringConnectionDetails

func (CreateRemotePeeringConnectionDetails) String ¶ added in v1.2.0 

func (m CreateRemotePeeringConnectionDetails) String() string

type CreateRemotePeeringConnectionRequest ¶ added in v1.2.0 

type CreateRemotePeeringConnectionRequest struct {

	// Request to create peering connection to remote region
	CreateRemotePeeringConnectionDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateRemotePeeringConnectionRequest wrapper for the CreateRemotePeeringConnection operation

func (CreateRemotePeeringConnectionRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateRemotePeeringConnectionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateRemotePeeringConnectionRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateRemotePeeringConnectionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateRemotePeeringConnectionRequest) String ¶ added in v1.2.0 

func (request CreateRemotePeeringConnectionRequest) String() string

type CreateRemotePeeringConnectionResponse ¶ added in v1.2.0 

type CreateRemotePeeringConnectionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The RemotePeeringConnection instance
	RemotePeeringConnection `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"`
}

CreateRemotePeeringConnectionResponse wrapper for the CreateRemotePeeringConnection operation

func (CreateRemotePeeringConnectionResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateRemotePeeringConnectionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateRemotePeeringConnectionResponse) String ¶ added in v1.2.0 

func (response CreateRemotePeeringConnectionResponse) String() string

type CreateRouteTableDetails ¶ 

type CreateRouteTableDetails struct {

	// The OCID of the compartment to contain the route table.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The collection of rules used for routing destination IPs to network devices.
	RouteRules []RouteRule `mandatory:"true" json:"routeRules"`

	// The OCID of the VCN the route table belongs to.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

CreateRouteTableDetails The representation of CreateRouteTableDetails

func (CreateRouteTableDetails) String ¶ 

func (m CreateRouteTableDetails) String() string

type CreateRouteTableRequest ¶ 

type CreateRouteTableRequest struct {

	// Details for creating a new route table.
	CreateRouteTableDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateRouteTableRequest wrapper for the CreateRouteTable operation

func (CreateRouteTableRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateRouteTableRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateRouteTableRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateRouteTableRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateRouteTableRequest) String ¶ 

func (request CreateRouteTableRequest) String() string

type CreateRouteTableResponse ¶ 

type CreateRouteTableResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The RouteTable instance
	RouteTable `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"`
}

CreateRouteTableResponse wrapper for the CreateRouteTable operation

func (CreateRouteTableResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateRouteTableResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateRouteTableResponse) String ¶ 

func (response CreateRouteTableResponse) String() string

type CreateSecurityListDetails ¶ 

type CreateSecurityListDetails struct {

	// The OCID of the compartment to contain the security list.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Rules for allowing egress IP packets.
	EgressSecurityRules []EgressSecurityRule `mandatory:"true" json:"egressSecurityRules"`

	// Rules for allowing ingress IP packets.
	IngressSecurityRules []IngressSecurityRule `mandatory:"true" json:"ingressSecurityRules"`

	// The OCID of the VCN the security list belongs to.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

CreateSecurityListDetails The representation of CreateSecurityListDetails

func (CreateSecurityListDetails) String ¶ 

func (m CreateSecurityListDetails) String() string

type CreateSecurityListRequest ¶ 

type CreateSecurityListRequest struct {

	// Details regarding the security list to create.
	CreateSecurityListDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateSecurityListRequest wrapper for the CreateSecurityList operation

func (CreateSecurityListRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateSecurityListRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateSecurityListRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateSecurityListRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateSecurityListRequest) String ¶ 

func (request CreateSecurityListRequest) String() string

type CreateSecurityListResponse ¶ 

type CreateSecurityListResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The SecurityList instance
	SecurityList `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"`
}

CreateSecurityListResponse wrapper for the CreateSecurityList operation

func (CreateSecurityListResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateSecurityListResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateSecurityListResponse) String ¶ 

func (response CreateSecurityListResponse) String() string

type CreateServiceGatewayDetails ¶ added in v1.8.0 

type CreateServiceGatewayDetails struct {

	// The OCID  (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm)  of the compartment to contain the service gateway.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// List of the service OCIDs. These are the services that will be enabled on the service gateway. This list can be empty.
	Services []ServiceIdRequestDetails `mandatory:"true" json:"services"`

	// The OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the VCN.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

CreateServiceGatewayDetails The representation of CreateServiceGatewayDetails

func (CreateServiceGatewayDetails) String ¶ added in v1.8.0 

func (m CreateServiceGatewayDetails) String() string

type CreateServiceGatewayRequest ¶ added in v1.8.0 

type CreateServiceGatewayRequest struct {

	// Details for creating a service gateway.
	CreateServiceGatewayDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateServiceGatewayRequest wrapper for the CreateServiceGateway operation

func (CreateServiceGatewayRequest) HTTPRequest ¶ added in v1.8.0 

func (request CreateServiceGatewayRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateServiceGatewayRequest) RetryPolicy ¶ added in v1.8.0 

func (request CreateServiceGatewayRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateServiceGatewayRequest) String ¶ added in v1.8.0 

func (request CreateServiceGatewayRequest) String() string

type CreateServiceGatewayResponse ¶ added in v1.8.0 

type CreateServiceGatewayResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ServiceGateway instance
	ServiceGateway `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"`
}

CreateServiceGatewayResponse wrapper for the CreateServiceGateway operation

func (CreateServiceGatewayResponse) HTTPResponse ¶ added in v1.8.0 

func (response CreateServiceGatewayResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateServiceGatewayResponse) String ¶ added in v1.8.0 

func (response CreateServiceGatewayResponse) String() string

type CreateSubnetDetails ¶ 

type CreateSubnetDetails struct {

	// The availability domain to contain the subnet.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The CIDR IP address range of the subnet.
	// Example: `172.16.1.0/24`
	CidrBlock *string `mandatory:"true" json:"cidrBlock"`

	// The OCID of the compartment to contain the subnet.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the VCN to contain the subnet.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// The OCID of the set of DHCP options the subnet will use. If you don't
	// provide a value, the subnet uses the VCN's default set of DHCP options.
	DhcpOptionsId *string `mandatory:"false" json:"dhcpOptionsId"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// A DNS label for the subnet, used in conjunction with the VNIC's hostname and
	// VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC
	// within this subnet (for example, `bminstance-1.subnet123.vcn1.oraclevcn.com`).
	// Must be an alphanumeric string that begins with a letter and is unique within the VCN.
	// The value cannot be changed.
	// This value must be set if you want to use the Internet and VCN Resolver to resolve the
	// hostnames of instances in the subnet. It can only be set if the VCN itself
	// was created with a DNS label.
	// For more information, see
	// DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
	// Example: `subnet123`
	DnsLabel *string `mandatory:"false" json:"dnsLabel"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Whether VNICs within this subnet can have public IP addresses.
	// Defaults to false, which means VNICs created in this subnet will
	// automatically be assigned public IP addresses unless specified
	// otherwise during instance launch or VNIC creation (with the
	// `assignPublicIp` flag in CreateVnicDetails).
	// If `prohibitPublicIpOnVnic` is set to true, VNICs created in this
	// subnet cannot have public IP addresses (that is, it's a private
	// subnet).
	// Example: `true`
	ProhibitPublicIpOnVnic *bool `mandatory:"false" json:"prohibitPublicIpOnVnic"`

	// The OCID of the route table the subnet will use. If you don't provide a value,
	// the subnet uses the VCN's default route table.
	RouteTableId *string `mandatory:"false" json:"routeTableId"`

	// The OCIDs of the security list or lists the subnet will use. If you don't
	// provide a value, the subnet uses the VCN's default security list.
	// Remember that security lists are associated *with the subnet*, but the
	// rules are applied to the individual VNICs in the subnet.
	SecurityListIds []string `mandatory:"false" json:"securityListIds"`
}

CreateSubnetDetails The representation of CreateSubnetDetails

func (CreateSubnetDetails) String ¶ 

func (m CreateSubnetDetails) String() string

type CreateSubnetRequest ¶ 

type CreateSubnetRequest struct {

	// Details for creating a subnet.
	CreateSubnetDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateSubnetRequest wrapper for the CreateSubnet operation

func (CreateSubnetRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateSubnetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateSubnetRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateSubnetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateSubnetRequest) String ¶ 

func (request CreateSubnetRequest) String() string

type CreateSubnetResponse ¶ 

type CreateSubnetResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Subnet instance
	Subnet `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"`
}

CreateSubnetResponse wrapper for the CreateSubnet operation

func (CreateSubnetResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateSubnetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateSubnetResponse) String ¶ 

func (response CreateSubnetResponse) String() string

type CreateVcnDetails ¶ 

type CreateVcnDetails struct {

	// The CIDR IP address block of the VCN.
	// Example: `172.16.0.0/16`
	CidrBlock *string `mandatory:"true" json:"cidrBlock"`

	// The OCID of the compartment to contain the VCN.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// A DNS label for the VCN, used in conjunction with the VNIC's hostname and
	// subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC
	// within this subnet (for example, `bminstance-1.subnet123.vcn1.oraclevcn.com`).
	// Not required to be unique, but it's a best practice to set unique DNS labels
	// for VCNs in your tenancy. Must be an alphanumeric string that begins with a letter.
	// The value cannot be changed.
	// You must set this value if you want instances to be able to use hostnames to
	// resolve other instances in the VCN. Otherwise the Internet and VCN Resolver
	// will not work.
	// For more information, see
	// DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
	// Example: `vcn1`
	DnsLabel *string `mandatory:"false" json:"dnsLabel"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

CreateVcnDetails The representation of CreateVcnDetails

func (CreateVcnDetails) String ¶ 

func (m CreateVcnDetails) String() string

type CreateVcnRequest ¶ 

type CreateVcnRequest struct {

	// Details for creating a new VCN.
	CreateVcnDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateVcnRequest wrapper for the CreateVcn operation

func (CreateVcnRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateVcnRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateVcnRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateVcnRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateVcnRequest) String ¶ 

func (request CreateVcnRequest) String() string

type CreateVcnResponse ¶ 

type CreateVcnResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Vcn instance
	Vcn `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"`
}

CreateVcnResponse wrapper for the CreateVcn operation

func (CreateVcnResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateVcnResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateVcnResponse) String ¶ 

func (response CreateVcnResponse) String() string

type CreateVirtualCircuitDetails ¶ 

type CreateVirtualCircuitDetails struct {

	// The OCID of the compartment to contain the virtual circuit.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The type of IP addresses used in this virtual circuit. PRIVATE
	// means RFC 1918 (https://tools.ietf.org/html/rfc1918) addresses
	// (10.0.0.0/8, 172.16/12, and 192.168/16). Only PRIVATE is supported.
	Type CreateVirtualCircuitDetailsTypeEnum `mandatory:"true" json:"type"`

	// The provisioned data rate of the connection.  To get a list of the
	// available bandwidth levels (that is, shapes), see
	// ListFastConnectProviderVirtualCircuitBandwidthShapes.
	// Example: `10 Gbps`
	BandwidthShapeName *string `mandatory:"false" json:"bandwidthShapeName"`

	// Create a `CrossConnectMapping` for each cross-connect or cross-connect
	// group this virtual circuit will run on.
	CrossConnectMappings []CrossConnectMapping `mandatory:"false" json:"crossConnectMappings"`

	// Your BGP ASN (either public or private). Provide this value only if
	// there's a BGP session that goes from your edge router to Oracle.
	// Otherwise, leave this empty or null.
	CustomerBgpAsn *int `mandatory:"false" json:"customerBgpAsn"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// For private virtual circuits only. The OCID of the Drg
	// that this virtual circuit uses.
	GatewayId *string `mandatory:"false" json:"gatewayId"`

	// Deprecated. Instead use `providerServiceId`.
	// To get a list of the provider names, see
	// ListFastConnectProviderServices.
	ProviderName *string `mandatory:"false" json:"providerName"`

	// The OCID of the service offered by the provider (if you're connecting
	// via a provider). To get a list of the available service offerings, see
	// ListFastConnectProviderServices.
	ProviderServiceId *string `mandatory:"false" json:"providerServiceId"`

	// Deprecated. Instead use `providerServiceId`.
	// To get a list of the provider names, see
	// ListFastConnectProviderServices.
	ProviderServiceName *string `mandatory:"false" json:"providerServiceName"`

	// For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to
	// advertise across the connection.
	PublicPrefixes []CreateVirtualCircuitPublicPrefixDetails `mandatory:"false" json:"publicPrefixes"`

	// The Oracle Cloud Infrastructure region where this virtual
	// circuit is located.
	// Example: `phx`
	Region *string `mandatory:"false" json:"region"`
}

CreateVirtualCircuitDetails The representation of CreateVirtualCircuitDetails

func (CreateVirtualCircuitDetails) String ¶ 

func (m CreateVirtualCircuitDetails) String() string

type CreateVirtualCircuitDetailsTypeEnum ¶ 

type CreateVirtualCircuitDetailsTypeEnum string

CreateVirtualCircuitDetailsTypeEnum Enum with underlying type: string 

const (
	CreateVirtualCircuitDetailsTypePublic  CreateVirtualCircuitDetailsTypeEnum = "PUBLIC"
	CreateVirtualCircuitDetailsTypePrivate CreateVirtualCircuitDetailsTypeEnum = "PRIVATE"
)

Set of constants representing the allowable values for CreateVirtualCircuitDetailsTypeEnum

func GetCreateVirtualCircuitDetailsTypeEnumValues ¶ 

func GetCreateVirtualCircuitDetailsTypeEnumValues() []CreateVirtualCircuitDetailsTypeEnum

GetCreateVirtualCircuitDetailsTypeEnumValues Enumerates the set of values for CreateVirtualCircuitDetailsTypeEnum

type CreateVirtualCircuitPublicPrefixDetails ¶ 

type CreateVirtualCircuitPublicPrefixDetails struct {

	// An individual public IP prefix (CIDR) to add to the public virtual circuit.
	// Must be /31 or less specific.
	CidrBlock *string `mandatory:"true" json:"cidrBlock"`
}

CreateVirtualCircuitPublicPrefixDetails The representation of CreateVirtualCircuitPublicPrefixDetails

func (CreateVirtualCircuitPublicPrefixDetails) String ¶ 

func (m CreateVirtualCircuitPublicPrefixDetails) String() string

type CreateVirtualCircuitRequest ¶ 

type CreateVirtualCircuitRequest struct {

	// Details to create a VirtualCircuit.
	CreateVirtualCircuitDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateVirtualCircuitRequest wrapper for the CreateVirtualCircuit operation

func (CreateVirtualCircuitRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateVirtualCircuitRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateVirtualCircuitRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateVirtualCircuitRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateVirtualCircuitRequest) String ¶ 

func (request CreateVirtualCircuitRequest) String() string

type CreateVirtualCircuitResponse ¶ 

type CreateVirtualCircuitResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VirtualCircuit instance
	VirtualCircuit `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"`
}

CreateVirtualCircuitResponse wrapper for the CreateVirtualCircuit operation

func (CreateVirtualCircuitResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateVirtualCircuitResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateVirtualCircuitResponse) String ¶ 

func (response CreateVirtualCircuitResponse) String() string

type CreateVnicDetails ¶ 

type CreateVnicDetails struct {

	// The OCID of the subnet to create the VNIC in. When launching an instance,
	// use this `subnetId` instead of the deprecated `subnetId` in
	// LaunchInstanceDetails.
	// At least one of them is required; if you provide both, the values must match.
	SubnetId *string `mandatory:"true" json:"subnetId"`

	// Whether the VNIC should be assigned a public IP address. Defaults to whether
	// the subnet is public or private. If not set and the VNIC is being created
	// in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the
	// Subnet), then no public IP address is assigned.
	// If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then
	// a public IP address is assigned. If set to true and
	// `prohibitPublicIpOnVnic` = true, an error is returned.
	// **Note:** This public IP address is associated with the primary private IP
	// on the VNIC. For more information, see
	// IP Addresses (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIPaddresses.htm).
	// **Note:** There's a limit to the number of PublicIp
	// a VNIC or instance can have. If you try to create a secondary VNIC
	// with an assigned public IP for an instance that has already
	// reached its public IP limit, an error is returned. For information
	// about the public IP limits, see
	// Public IP Addresses (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingpublicIPs.htm).
	// Example: `false`
	AssignPublicIp *bool `mandatory:"false" json:"assignPublicIp"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name for the VNIC. Does not have to be unique.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname
	// portion of the primary private IP's fully qualified domain name (FQDN)
	// (for example, `bminstance-1` in FQDN `bminstance-1.subnet123.vcn1.oraclevcn.com`).
	// Must be unique across all VNICs in the subnet and comply with
	// RFC 952 (https://tools.ietf.org/html/rfc952) and
	// RFC 1123 (https://tools.ietf.org/html/rfc1123).
	// The value appears in the Vnic object and also the
	// PrivateIp object returned by
	// ListPrivateIps and
	// GetPrivateIp.
	// For more information, see
	// DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
	// When launching an instance, use this `hostnameLabel` instead
	// of the deprecated `hostnameLabel` in
	// LaunchInstanceDetails.
	// If you provide both, the values must match.
	// Example: `bminstance-1`
	HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`

	// A private IP address of your choice to assign to the VNIC. Must be an
	// available IP address within the subnet's CIDR. If you don't specify a
	// value, Oracle automatically assigns a private IP address from the subnet.
	// This is the VNIC's *primary* private IP address. The value appears in
	// the Vnic object and also the
	// PrivateIp object returned by
	// ListPrivateIps and
	// GetPrivateIp.
	// Example: `10.0.3.3`
	PrivateIp *string `mandatory:"false" json:"privateIp"`

	// Whether the source/destination check is disabled on the VNIC.
	// Defaults to `false`, which means the check is performed. For information
	// about why you would skip the source/destination check, see
	// Using a Private IP as a Route Target (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingroutetables.htm#privateip).
	// Example: `true`
	SkipSourceDestCheck *bool `mandatory:"false" json:"skipSourceDestCheck"`
}

CreateVnicDetails Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see Virtual Network Interface Cards (VNICs) (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm).

func (CreateVnicDetails) String ¶ 

func (m CreateVnicDetails) String() string

type CreateVolumeBackupDetails ¶ 

type CreateVolumeBackupDetails struct {

	// The OCID of the volume that needs to be backed up.
	VolumeId *string `mandatory:"true" json:"volumeId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name for the volume backup. Does not have to be unique and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The type of backup to create. If omitted, defaults to INCREMENTAL.
	Type CreateVolumeBackupDetailsTypeEnum `mandatory:"false" json:"type,omitempty"`
}

CreateVolumeBackupDetails The representation of CreateVolumeBackupDetails

func (CreateVolumeBackupDetails) String ¶ 

func (m CreateVolumeBackupDetails) String() string

type CreateVolumeBackupDetailsTypeEnum ¶ added in v1.1.0 

type CreateVolumeBackupDetailsTypeEnum string

CreateVolumeBackupDetailsTypeEnum Enum with underlying type: string 

const (
	CreateVolumeBackupDetailsTypeFull        CreateVolumeBackupDetailsTypeEnum = "FULL"
	CreateVolumeBackupDetailsTypeIncremental CreateVolumeBackupDetailsTypeEnum = "INCREMENTAL"
)

Set of constants representing the allowable values for CreateVolumeBackupDetailsTypeEnum

func GetCreateVolumeBackupDetailsTypeEnumValues ¶ added in v1.1.0 

func GetCreateVolumeBackupDetailsTypeEnumValues() []CreateVolumeBackupDetailsTypeEnum

GetCreateVolumeBackupDetailsTypeEnumValues Enumerates the set of values for CreateVolumeBackupDetailsTypeEnum

type CreateVolumeBackupPolicyAssignmentDetails ¶ added in v1.1.0 

type CreateVolumeBackupPolicyAssignmentDetails struct {

	// The OCID of the asset (e.g. a volume) to which to assign the policy.
	AssetId *string `mandatory:"true" json:"assetId"`

	// The OCID of the volume backup policy to assign to an asset.
	PolicyId *string `mandatory:"true" json:"policyId"`
}

CreateVolumeBackupPolicyAssignmentDetails The representation of CreateVolumeBackupPolicyAssignmentDetails

func (CreateVolumeBackupPolicyAssignmentDetails) String ¶ added in v1.1.0 

func (m CreateVolumeBackupPolicyAssignmentDetails) String() string

type CreateVolumeBackupPolicyAssignmentRequest ¶ added in v1.1.0 

type CreateVolumeBackupPolicyAssignmentRequest struct {

	// Request to assign a specified policy to a particular asset.
	CreateVolumeBackupPolicyAssignmentDetails `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"`

	// 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
}

CreateVolumeBackupPolicyAssignmentRequest wrapper for the CreateVolumeBackupPolicyAssignment operation

func (CreateVolumeBackupPolicyAssignmentRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateVolumeBackupPolicyAssignmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateVolumeBackupPolicyAssignmentRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateVolumeBackupPolicyAssignmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateVolumeBackupPolicyAssignmentRequest) String ¶ added in v1.1.0 

func (request CreateVolumeBackupPolicyAssignmentRequest) String() string

type CreateVolumeBackupPolicyAssignmentResponse ¶ added in v1.1.0 

type CreateVolumeBackupPolicyAssignmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VolumeBackupPolicyAssignment instance
	VolumeBackupPolicyAssignment `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"`
}

CreateVolumeBackupPolicyAssignmentResponse wrapper for the CreateVolumeBackupPolicyAssignment operation

func (CreateVolumeBackupPolicyAssignmentResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateVolumeBackupPolicyAssignmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateVolumeBackupPolicyAssignmentResponse) String ¶ added in v1.1.0 

func (response CreateVolumeBackupPolicyAssignmentResponse) String() string

type CreateVolumeBackupRequest ¶ 

type CreateVolumeBackupRequest struct {

	// Request to create a new backup of given volume.
	CreateVolumeBackupDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateVolumeBackupRequest wrapper for the CreateVolumeBackup operation

func (CreateVolumeBackupRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateVolumeBackupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateVolumeBackupRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateVolumeBackupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateVolumeBackupRequest) String ¶ 

func (request CreateVolumeBackupRequest) String() string

type CreateVolumeBackupResponse ¶ 

type CreateVolumeBackupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VolumeBackup instance
	VolumeBackup `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"`
}

CreateVolumeBackupResponse wrapper for the CreateVolumeBackup operation

func (CreateVolumeBackupResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateVolumeBackupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateVolumeBackupResponse) String ¶ 

func (response CreateVolumeBackupResponse) String() string

type CreateVolumeDetails ¶ 

type CreateVolumeDetails struct {

	// The availability domain of the volume.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The OCID of the compartment that contains the volume.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// If provided, specifies the ID of the volume backup policy to assign to the newly
	// created volume. If omitted, no policy will be assigned.
	BackupPolicyId *string `mandatory:"false" json:"backupPolicyId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The OCID of the KMS key to be used as the master encryption key for the volume.
	KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`

	// The size of the volume in GBs.
	SizeInGBs *int64 `mandatory:"false" json:"sizeInGBs"`

	// The size of the volume in MBs. The value must be a multiple of 1024.
	// This field is deprecated. Use sizeInGBs instead.
	SizeInMBs *int64 `mandatory:"false" json:"sizeInMBs"`

	// Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same availability domain or a Block volume backup.
	// This is an optional field. If not specified or set to null, the new Block volume will be empty.
	// When specified, the new Block volume will contain data from the source volume or backup.
	SourceDetails VolumeSourceDetails `mandatory:"false" json:"sourceDetails"`

	// The OCID of the volume backup from which the data should be restored on the newly created volume.
	// This field is deprecated. Use the sourceDetails field instead to specify the
	// backup for the volume.
	VolumeBackupId *string `mandatory:"false" json:"volumeBackupId"`
}

CreateVolumeDetails The representation of CreateVolumeDetails

func (CreateVolumeDetails) String ¶ 

func (m CreateVolumeDetails) String() string

func (*CreateVolumeDetails) UnmarshalJSON ¶ 

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

UnmarshalJSON unmarshals from json

type CreateVolumeGroupBackupDetails ¶ added in v1.6.0 

type CreateVolumeGroupBackupDetails struct {

	// The OCID of the volume group that needs to be backed up.
	VolumeGroupId *string `mandatory:"true" json:"volumeGroupId"`

	// The OCID of the compartment that will contain the volume group backup. This parameter is optional, by default backup will be created in the same compartment and source volume group.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name for the volume group backup. Does not have to be unique and it's changeable.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The type of backup to create. If omitted, defaults to incremental.
	Type CreateVolumeGroupBackupDetailsTypeEnum `mandatory:"false" json:"type,omitempty"`
}

CreateVolumeGroupBackupDetails The representation of CreateVolumeGroupBackupDetails

func (CreateVolumeGroupBackupDetails) String ¶ added in v1.6.0 

func (m CreateVolumeGroupBackupDetails) String() string

type CreateVolumeGroupBackupDetailsTypeEnum ¶ added in v1.6.0 

type CreateVolumeGroupBackupDetailsTypeEnum string

CreateVolumeGroupBackupDetailsTypeEnum Enum with underlying type: string 

const (
	CreateVolumeGroupBackupDetailsTypeFull        CreateVolumeGroupBackupDetailsTypeEnum = "FULL"
	CreateVolumeGroupBackupDetailsTypeIncremental CreateVolumeGroupBackupDetailsTypeEnum = "INCREMENTAL"
)

Set of constants representing the allowable values for CreateVolumeGroupBackupDetailsTypeEnum

func GetCreateVolumeGroupBackupDetailsTypeEnumValues ¶ added in v1.6.0 

func GetCreateVolumeGroupBackupDetailsTypeEnumValues() []CreateVolumeGroupBackupDetailsTypeEnum

GetCreateVolumeGroupBackupDetailsTypeEnumValues Enumerates the set of values for CreateVolumeGroupBackupDetailsTypeEnum

type CreateVolumeGroupBackupRequest ¶ added in v1.6.0 

type CreateVolumeGroupBackupRequest struct {

	// Request to create a new backup group of given volume group.
	CreateVolumeGroupBackupDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateVolumeGroupBackupRequest wrapper for the CreateVolumeGroupBackup operation

func (CreateVolumeGroupBackupRequest) HTTPRequest ¶ added in v1.6.0 

func (request CreateVolumeGroupBackupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateVolumeGroupBackupRequest) RetryPolicy ¶ added in v1.6.0 

func (request CreateVolumeGroupBackupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateVolumeGroupBackupRequest) String ¶ added in v1.6.0 

func (request CreateVolumeGroupBackupRequest) String() string

type CreateVolumeGroupBackupResponse ¶ added in v1.6.0 

type CreateVolumeGroupBackupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VolumeGroupBackup instance
	VolumeGroupBackup `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"`
}

CreateVolumeGroupBackupResponse wrapper for the CreateVolumeGroupBackup operation

func (CreateVolumeGroupBackupResponse) HTTPResponse ¶ added in v1.6.0 

func (response CreateVolumeGroupBackupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateVolumeGroupBackupResponse) String ¶ added in v1.6.0 

func (response CreateVolumeGroupBackupResponse) String() string

type CreateVolumeGroupDetails ¶ added in v1.6.0 

type CreateVolumeGroupDetails struct {

	// The availability domain of the volume group.
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The OCID of the compartment that contains the volume group.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Specifies the volume group source details for a new volume group. The volume source is either another a list of
	// volume ids in the same availability domain, another volume group or a volume group backup.
	SourceDetails VolumeGroupSourceDetails `mandatory:"true" json:"sourceDetails"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name for the volume group. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

CreateVolumeGroupDetails The representation of CreateVolumeGroupDetails

func (CreateVolumeGroupDetails) String ¶ added in v1.6.0 

func (m CreateVolumeGroupDetails) String() string

func (*CreateVolumeGroupDetails) UnmarshalJSON ¶ added in v1.6.0 

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

UnmarshalJSON unmarshals from json

type CreateVolumeGroupRequest ¶ added in v1.6.0 

type CreateVolumeGroupRequest struct {

	// Request to create a new volume group.
	CreateVolumeGroupDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateVolumeGroupRequest wrapper for the CreateVolumeGroup operation

func (CreateVolumeGroupRequest) HTTPRequest ¶ added in v1.6.0 

func (request CreateVolumeGroupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateVolumeGroupRequest) RetryPolicy ¶ added in v1.6.0 

func (request CreateVolumeGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateVolumeGroupRequest) String ¶ added in v1.6.0 

func (request CreateVolumeGroupRequest) String() string

type CreateVolumeGroupResponse ¶ added in v1.6.0 

type CreateVolumeGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VolumeGroup instance
	VolumeGroup `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"`
}

CreateVolumeGroupResponse wrapper for the CreateVolumeGroup operation

func (CreateVolumeGroupResponse) HTTPResponse ¶ added in v1.6.0 

func (response CreateVolumeGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateVolumeGroupResponse) String ¶ added in v1.6.0 

func (response CreateVolumeGroupResponse) String() string

type CreateVolumeRequest ¶ 

type CreateVolumeRequest struct {

	// Request to create a new volume.
	CreateVolumeDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

CreateVolumeRequest wrapper for the CreateVolume operation

func (CreateVolumeRequest) HTTPRequest ¶ added in v1.3.0 

func (request CreateVolumeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateVolumeRequest) RetryPolicy ¶ added in v1.3.0 

func (request CreateVolumeRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateVolumeRequest) String ¶ 

func (request CreateVolumeRequest) String() string

type CreateVolumeResponse ¶ 

type CreateVolumeResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Volume instance
	Volume `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"`
}

CreateVolumeResponse wrapper for the CreateVolume operation

func (CreateVolumeResponse) HTTPResponse ¶ added in v1.3.0 

func (response CreateVolumeResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateVolumeResponse) String ¶ 

func (response CreateVolumeResponse) String() string

type CrossConnect ¶ 

type CrossConnect struct {

	// The OCID of the compartment containing the cross-connect group.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The OCID of the cross-connect group this cross-connect belongs to (if any).
	CrossConnectGroupId *string `mandatory:"false" json:"crossConnectGroupId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The cross-connect's Oracle ID (OCID).
	Id *string `mandatory:"false" json:"id"`

	// The cross-connect's current state.
	LifecycleState CrossConnectLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The name of the FastConnect location where this cross-connect is installed.
	LocationName *string `mandatory:"false" json:"locationName"`

	// A string identifying the meet-me room port for this cross-connect.
	PortName *string `mandatory:"false" json:"portName"`

	// The port speed for this cross-connect.
	// Example: `10 Gbps`
	PortSpeedShapeName *string `mandatory:"false" json:"portSpeedShapeName"`

	// The date and time the cross-connect was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

CrossConnect For use with Oracle Cloud Infrastructure FastConnect. A cross-connect represents a physical connection between an existing network and Oracle. Customers who are colocated with Oracle in a FastConnect location create and use cross-connects. For more information, see FastConnect Overview (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm). Oracle recommends you create each cross-connect in a CrossConnectGroup so you can use link aggregation with the connection. **Note:** If you're a provider who is setting up a physical connection to Oracle so customers can use FastConnect over the connection, be aware that your connection is modeled the same way as a colocated customer's (with `CrossConnect` and `CrossConnectGroup` objects, and so on). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (CrossConnect) String ¶ 

func (m CrossConnect) String() string

type CrossConnectGroup ¶ 

type CrossConnectGroup struct {

	// The OCID of the compartment containing the cross-connect group.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The display name of A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The cross-connect group's Oracle ID (OCID).
	Id *string `mandatory:"false" json:"id"`

	// The cross-connect group's current state.
	LifecycleState CrossConnectGroupLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The date and time the cross-connect group was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

CrossConnectGroup For use with Oracle Cloud Infrastructure FastConnect. A cross-connect group is a link aggregation group (LAG), which can contain one or more CrossConnect. Customers who are colocated with Oracle in a FastConnect location create and use cross-connect groups. For more information, see FastConnect Overview (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm). **Note:** If you're a provider who is setting up a physical connection to Oracle so customers can use FastConnect over the connection, be aware that your connection is modeled the same way as a colocated customer's (with `CrossConnect` and `CrossConnectGroup` objects, and so on). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (CrossConnectGroup) String ¶ 

func (m CrossConnectGroup) String() string

type CrossConnectGroupLifecycleStateEnum ¶ 

type CrossConnectGroupLifecycleStateEnum string

CrossConnectGroupLifecycleStateEnum Enum with underlying type: string 

const (
	CrossConnectGroupLifecycleStateProvisioning CrossConnectGroupLifecycleStateEnum = "PROVISIONING"
	CrossConnectGroupLifecycleStateProvisioned  CrossConnectGroupLifecycleStateEnum = "PROVISIONED"
	CrossConnectGroupLifecycleStateInactive     CrossConnectGroupLifecycleStateEnum = "INACTIVE"
	CrossConnectGroupLifecycleStateTerminating  CrossConnectGroupLifecycleStateEnum = "TERMINATING"
	CrossConnectGroupLifecycleStateTerminated   CrossConnectGroupLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for CrossConnectGroupLifecycleStateEnum

func GetCrossConnectGroupLifecycleStateEnumValues ¶ 

func GetCrossConnectGroupLifecycleStateEnumValues() []CrossConnectGroupLifecycleStateEnum

GetCrossConnectGroupLifecycleStateEnumValues Enumerates the set of values for CrossConnectGroupLifecycleStateEnum

type CrossConnectLifecycleStateEnum ¶ 

type CrossConnectLifecycleStateEnum string

CrossConnectLifecycleStateEnum Enum with underlying type: string 

const (
	CrossConnectLifecycleStatePendingCustomer CrossConnectLifecycleStateEnum = "PENDING_CUSTOMER"
	CrossConnectLifecycleStateProvisioning    CrossConnectLifecycleStateEnum = "PROVISIONING"
	CrossConnectLifecycleStateProvisioned     CrossConnectLifecycleStateEnum = "PROVISIONED"
	CrossConnectLifecycleStateInactive        CrossConnectLifecycleStateEnum = "INACTIVE"
	CrossConnectLifecycleStateTerminating     CrossConnectLifecycleStateEnum = "TERMINATING"
	CrossConnectLifecycleStateTerminated      CrossConnectLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for CrossConnectLifecycleStateEnum

func GetCrossConnectLifecycleStateEnumValues ¶ 

func GetCrossConnectLifecycleStateEnumValues() []CrossConnectLifecycleStateEnum

GetCrossConnectLifecycleStateEnumValues Enumerates the set of values for CrossConnectLifecycleStateEnum

type CrossConnectLocation ¶ 

type CrossConnectLocation struct {

	// A description of the location.
	Description *string `mandatory:"true" json:"description"`

	// The name of the location.
	// Example: `CyrusOne, Chandler, AZ`
	Name *string `mandatory:"true" json:"name"`
}

CrossConnectLocation An individual FastConnect location.

func (CrossConnectLocation) String ¶ 

func (m CrossConnectLocation) String() string

type CrossConnectMapping ¶ 

type CrossConnectMapping struct {

	// The key for BGP MD5 authentication. Only applicable if your system
	// requires MD5 authentication. If empty or not set (null), that
	// means you don't use BGP MD5 authentication.
	BgpMd5AuthKey *string `mandatory:"false" json:"bgpMd5AuthKey"`

	// The OCID of the cross-connect or cross-connect group for this mapping.
	// Specified by the owner of the cross-connect or cross-connect group (the
	// customer if the customer is colocated with Oracle, or the provider if the
	// customer is connecting via provider).
	CrossConnectOrCrossConnectGroupId *string `mandatory:"false" json:"crossConnectOrCrossConnectGroupId"`

	// The BGP IPv4 address for the router on the other end of the BGP session from
	// Oracle. Specified by the owner of that router. If the session goes from Oracle
	// to a customer, this is the BGP IPv4 address of the customer's edge router. If the
	// session goes from Oracle to a provider, this is the BGP IPv4 address of the
	// provider's edge router. Must use a /30 or /31 subnet mask.
	// There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.
	// Example: `10.0.0.18/31`
	CustomerBgpPeeringIp *string `mandatory:"false" json:"customerBgpPeeringIp"`

	// The IPv4 address for Oracle's end of the BGP session. Must use a /30 or /31
	// subnet mask. If the session goes from Oracle to a customer's edge router,
	// the customer specifies this information. If the session goes from Oracle to
	// a provider's edge router, the provider specifies this.
	// There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.
	// Example: `10.0.0.19/31`
	OracleBgpPeeringIp *string `mandatory:"false" json:"oracleBgpPeeringIp"`

	// The number of the specific VLAN (on the cross-connect or cross-connect group)
	// that is assigned to this virtual circuit. Specified by the owner of the cross-connect
	// or cross-connect group (the customer if the customer is colocated with Oracle, or
	// the provider if the customer is connecting via provider).
	// Example: `200`
	Vlan *int `mandatory:"false" json:"vlan"`
}

CrossConnectMapping For use with Oracle Cloud Infrastructure FastConnect. Each VirtualCircuit runs on one or more cross-connects or cross-connect groups. A `CrossConnectMapping` contains the properties for an individual cross-connect or cross-connect group associated with a given virtual circuit. The mapping includes information about the cross-connect or cross-connect group, the VLAN, and the BGP peering session. If you're a customer who is colocated with Oracle, that means you own both the virtual circuit and the physical connection it runs on (cross-connect or cross-connect group), so you specify all the information in the mapping. There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses. If you're a provider, then you own the physical connection that the customer's virtual circuit runs on, so you contribute information about the cross-connect or cross-connect group and VLAN. Who specifies the BGP peering information in the case of customer connection via provider? If the BGP session goes from Oracle to the provider's edge router, then the provider also specifies the BGP peering information. If the BGP session instead goes from Oracle to the customer's edge router, then the customer specifies the BGP peering information. There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.

func (CrossConnectMapping) String ¶ 

func (m CrossConnectMapping) String() string

type CrossConnectPortSpeedShape ¶ 

type CrossConnectPortSpeedShape struct {

	// The name of the port speed shape.
	// Example: `10 Gbps`
	Name *string `mandatory:"true" json:"name"`

	// The port speed in Gbps.
	// Example: `10`
	PortSpeedInGbps *int `mandatory:"true" json:"portSpeedInGbps"`
}

CrossConnectPortSpeedShape An individual port speed level for cross-connects.

func (CrossConnectPortSpeedShape) String ¶ 

func (m CrossConnectPortSpeedShape) String() string

type CrossConnectStatus ¶ 

type CrossConnectStatus struct {

	// The OCID of the cross-connect.
	CrossConnectId *string `mandatory:"true" json:"crossConnectId"`

	// Whether Oracle's side of the interface is up or down.
	InterfaceState CrossConnectStatusInterfaceStateEnum `mandatory:"false" json:"interfaceState,omitempty"`

	// The light level of the cross-connect (in dBm).
	// Example: `14.0`
	LightLevelIndBm *float32 `mandatory:"false" json:"lightLevelIndBm"`

	// Status indicator corresponding to the light level.
	//   * **NO_LIGHT:** No measurable light
	//   * **LOW_WARN:** There's measurable light but it's too low
	//   * **HIGH_WARN:** Light level is too high
	//   * **BAD:** There's measurable light but the signal-to-noise ratio is bad
	//   * **GOOD:** Good light level
	LightLevelIndicator CrossConnectStatusLightLevelIndicatorEnum `mandatory:"false" json:"lightLevelIndicator,omitempty"`
}

CrossConnectStatus The status of the cross-connect.

func (CrossConnectStatus) String ¶ 

func (m CrossConnectStatus) String() string

type CrossConnectStatusInterfaceStateEnum ¶ 

type CrossConnectStatusInterfaceStateEnum string

CrossConnectStatusInterfaceStateEnum Enum with underlying type: string 

const (
	CrossConnectStatusInterfaceStateUp   CrossConnectStatusInterfaceStateEnum = "UP"
	CrossConnectStatusInterfaceStateDown CrossConnectStatusInterfaceStateEnum = "DOWN"
)

Set of constants representing the allowable values for CrossConnectStatusInterfaceStateEnum

func GetCrossConnectStatusInterfaceStateEnumValues ¶ 

func GetCrossConnectStatusInterfaceStateEnumValues() []CrossConnectStatusInterfaceStateEnum

GetCrossConnectStatusInterfaceStateEnumValues Enumerates the set of values for CrossConnectStatusInterfaceStateEnum

type CrossConnectStatusLightLevelIndicatorEnum ¶ 

type CrossConnectStatusLightLevelIndicatorEnum string

CrossConnectStatusLightLevelIndicatorEnum Enum with underlying type: string 

const (
	CrossConnectStatusLightLevelIndicatorNoLight  CrossConnectStatusLightLevelIndicatorEnum = "NO_LIGHT"
	CrossConnectStatusLightLevelIndicatorLowWarn  CrossConnectStatusLightLevelIndicatorEnum = "LOW_WARN"
	CrossConnectStatusLightLevelIndicatorHighWarn CrossConnectStatusLightLevelIndicatorEnum = "HIGH_WARN"
	CrossConnectStatusLightLevelIndicatorBad      CrossConnectStatusLightLevelIndicatorEnum = "BAD"
	CrossConnectStatusLightLevelIndicatorGood     CrossConnectStatusLightLevelIndicatorEnum = "GOOD"
)

Set of constants representing the allowable values for CrossConnectStatusLightLevelIndicatorEnum

func GetCrossConnectStatusLightLevelIndicatorEnumValues ¶ 

func GetCrossConnectStatusLightLevelIndicatorEnumValues() []CrossConnectStatusLightLevelIndicatorEnum

GetCrossConnectStatusLightLevelIndicatorEnumValues Enumerates the set of values for CrossConnectStatusLightLevelIndicatorEnum

type DeleteAppCatalogSubscriptionRequest ¶ 

type DeleteAppCatalogSubscriptionRequest struct {

	// The OCID of the listing.
	ListingId *string `mandatory:"true" contributesTo:"query" name:"listingId"`

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// Listing Resource Version.
	ResourceVersion *string `mandatory:"true" contributesTo:"query" name:"resourceVersion"`

	// 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
}

DeleteAppCatalogSubscriptionRequest wrapper for the DeleteAppCatalogSubscription operation

func (DeleteAppCatalogSubscriptionRequest) HTTPRequest ¶ 

func (request DeleteAppCatalogSubscriptionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteAppCatalogSubscriptionRequest) RetryPolicy ¶ 

func (request DeleteAppCatalogSubscriptionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteAppCatalogSubscriptionRequest) String ¶ 

func (request DeleteAppCatalogSubscriptionRequest) String() string

type DeleteAppCatalogSubscriptionResponse ¶ 

type DeleteAppCatalogSubscriptionResponse 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"`
}

DeleteAppCatalogSubscriptionResponse wrapper for the DeleteAppCatalogSubscription operation

func (DeleteAppCatalogSubscriptionResponse) HTTPResponse ¶ 

func (response DeleteAppCatalogSubscriptionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteAppCatalogSubscriptionResponse) String ¶ 

func (response DeleteAppCatalogSubscriptionResponse) String() string

type DeleteBootVolumeBackupRequest ¶ added in v1.8.0 

type DeleteBootVolumeBackupRequest struct {

	// The OCID of the boot volume backup.
	BootVolumeBackupId *string `mandatory:"true" contributesTo:"path" name:"bootVolumeBackupId"`

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

	// 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
}

DeleteBootVolumeBackupRequest wrapper for the DeleteBootVolumeBackup operation

func (DeleteBootVolumeBackupRequest) HTTPRequest ¶ added in v1.8.0 

func (request DeleteBootVolumeBackupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteBootVolumeBackupRequest) RetryPolicy ¶ added in v1.8.0 

func (request DeleteBootVolumeBackupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteBootVolumeBackupRequest) String ¶ added in v1.8.0 

func (request DeleteBootVolumeBackupRequest) String() string

type DeleteBootVolumeBackupResponse ¶ added in v1.8.0 

type DeleteBootVolumeBackupResponse 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"`
}

DeleteBootVolumeBackupResponse wrapper for the DeleteBootVolumeBackup operation

func (DeleteBootVolumeBackupResponse) HTTPResponse ¶ added in v1.8.0 

func (response DeleteBootVolumeBackupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteBootVolumeBackupResponse) String ¶ added in v1.8.0 

func (response DeleteBootVolumeBackupResponse) String() string

type DeleteBootVolumeKmsKeyRequest ¶ 

type DeleteBootVolumeKmsKeyRequest struct {

	// The OCID of the boot volume.
	BootVolumeId *string `mandatory:"true" contributesTo:"path" name:"bootVolumeId"`

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

	// 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
}

DeleteBootVolumeKmsKeyRequest wrapper for the DeleteBootVolumeKmsKey operation

func (DeleteBootVolumeKmsKeyRequest) HTTPRequest ¶ 

func (request DeleteBootVolumeKmsKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteBootVolumeKmsKeyRequest) RetryPolicy ¶ 

func (request DeleteBootVolumeKmsKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteBootVolumeKmsKeyRequest) String ¶ 

func (request DeleteBootVolumeKmsKeyRequest) String() string

type DeleteBootVolumeKmsKeyResponse ¶ 

type DeleteBootVolumeKmsKeyResponse 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"`
}

DeleteBootVolumeKmsKeyResponse wrapper for the DeleteBootVolumeKmsKey operation

func (DeleteBootVolumeKmsKeyResponse) HTTPResponse ¶ 

func (response DeleteBootVolumeKmsKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteBootVolumeKmsKeyResponse) String ¶ 

func (response DeleteBootVolumeKmsKeyResponse) String() string

type DeleteBootVolumeRequest ¶ 

type DeleteBootVolumeRequest struct {

	// The OCID of the boot volume.
	BootVolumeId *string `mandatory:"true" contributesTo:"path" name:"bootVolumeId"`

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

	// 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
}

DeleteBootVolumeRequest wrapper for the DeleteBootVolume operation

func (DeleteBootVolumeRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteBootVolumeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteBootVolumeRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteBootVolumeRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteBootVolumeRequest) String ¶ 

func (request DeleteBootVolumeRequest) String() string

type DeleteBootVolumeResponse ¶ 

type DeleteBootVolumeResponse 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"`
}

DeleteBootVolumeResponse wrapper for the DeleteBootVolume operation

func (DeleteBootVolumeResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteBootVolumeResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteBootVolumeResponse) String ¶ 

func (response DeleteBootVolumeResponse) String() string

type DeleteConsoleHistoryRequest ¶ 

type DeleteConsoleHistoryRequest struct {

	// The OCID of the console history.
	InstanceConsoleHistoryId *string `mandatory:"true" contributesTo:"path" name:"instanceConsoleHistoryId"`

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

	// 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
}

DeleteConsoleHistoryRequest wrapper for the DeleteConsoleHistory operation

func (DeleteConsoleHistoryRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteConsoleHistoryRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteConsoleHistoryRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteConsoleHistoryRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteConsoleHistoryRequest) String ¶ 

func (request DeleteConsoleHistoryRequest) String() string

type DeleteConsoleHistoryResponse ¶ 

type DeleteConsoleHistoryResponse 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"`
}

DeleteConsoleHistoryResponse wrapper for the DeleteConsoleHistory operation

func (DeleteConsoleHistoryResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteConsoleHistoryResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteConsoleHistoryResponse) String ¶ 

func (response DeleteConsoleHistoryResponse) String() string

type DeleteCpeRequest ¶ 

type DeleteCpeRequest struct {

	// The OCID of the CPE.
	CpeId *string `mandatory:"true" contributesTo:"path" name:"cpeId"`

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

	// 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
}

DeleteCpeRequest wrapper for the DeleteCpe operation

func (DeleteCpeRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteCpeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteCpeRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteCpeRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteCpeRequest) String ¶ 

func (request DeleteCpeRequest) String() string

type DeleteCpeResponse ¶ 

type DeleteCpeResponse 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"`
}

DeleteCpeResponse wrapper for the DeleteCpe operation

func (DeleteCpeResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteCpeResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteCpeResponse) String ¶ 

func (response DeleteCpeResponse) String() string

type DeleteCrossConnectGroupRequest ¶ 

type DeleteCrossConnectGroupRequest struct {

	// The OCID of the cross-connect group.
	CrossConnectGroupId *string `mandatory:"true" contributesTo:"path" name:"crossConnectGroupId"`

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

	// 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
}

DeleteCrossConnectGroupRequest wrapper for the DeleteCrossConnectGroup operation

func (DeleteCrossConnectGroupRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteCrossConnectGroupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteCrossConnectGroupRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteCrossConnectGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteCrossConnectGroupRequest) String ¶ 

func (request DeleteCrossConnectGroupRequest) String() string

type DeleteCrossConnectGroupResponse ¶ 

type DeleteCrossConnectGroupResponse 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"`
}

DeleteCrossConnectGroupResponse wrapper for the DeleteCrossConnectGroup operation

func (DeleteCrossConnectGroupResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteCrossConnectGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteCrossConnectGroupResponse) String ¶ 

func (response DeleteCrossConnectGroupResponse) String() string

type DeleteCrossConnectRequest ¶ 

type DeleteCrossConnectRequest struct {

	// The OCID of the cross-connect.
	CrossConnectId *string `mandatory:"true" contributesTo:"path" name:"crossConnectId"`

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

	// 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
}

DeleteCrossConnectRequest wrapper for the DeleteCrossConnect operation

func (DeleteCrossConnectRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteCrossConnectRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteCrossConnectRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteCrossConnectRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteCrossConnectRequest) String ¶ 

func (request DeleteCrossConnectRequest) String() string

type DeleteCrossConnectResponse ¶ 

type DeleteCrossConnectResponse 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"`
}

DeleteCrossConnectResponse wrapper for the DeleteCrossConnect operation

func (DeleteCrossConnectResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteCrossConnectResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteCrossConnectResponse) String ¶ 

func (response DeleteCrossConnectResponse) String() string

type DeleteDhcpOptionsRequest ¶ 

type DeleteDhcpOptionsRequest struct {

	// The OCID for the set of DHCP options.
	DhcpId *string `mandatory:"true" contributesTo:"path" name:"dhcpId"`

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

	// 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
}

DeleteDhcpOptionsRequest wrapper for the DeleteDhcpOptions operation

func (DeleteDhcpOptionsRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteDhcpOptionsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDhcpOptionsRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteDhcpOptionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteDhcpOptionsRequest) String ¶ 

func (request DeleteDhcpOptionsRequest) String() string

type DeleteDhcpOptionsResponse ¶ 

type DeleteDhcpOptionsResponse 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"`
}

DeleteDhcpOptionsResponse wrapper for the DeleteDhcpOptions operation

func (DeleteDhcpOptionsResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteDhcpOptionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteDhcpOptionsResponse) String ¶ 

func (response DeleteDhcpOptionsResponse) String() string

type DeleteDrgAttachmentRequest ¶ 

type DeleteDrgAttachmentRequest struct {

	// The OCID of the DRG attachment.
	DrgAttachmentId *string `mandatory:"true" contributesTo:"path" name:"drgAttachmentId"`

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

	// 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
}

DeleteDrgAttachmentRequest wrapper for the DeleteDrgAttachment operation

func (DeleteDrgAttachmentRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteDrgAttachmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDrgAttachmentRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteDrgAttachmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteDrgAttachmentRequest) String ¶ 

func (request DeleteDrgAttachmentRequest) String() string

type DeleteDrgAttachmentResponse ¶ 

type DeleteDrgAttachmentResponse 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"`
}

DeleteDrgAttachmentResponse wrapper for the DeleteDrgAttachment operation

func (DeleteDrgAttachmentResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteDrgAttachmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteDrgAttachmentResponse) String ¶ 

func (response DeleteDrgAttachmentResponse) String() string

type DeleteDrgRequest ¶ 

type DeleteDrgRequest struct {

	// The OCID of the DRG.
	DrgId *string `mandatory:"true" contributesTo:"path" name:"drgId"`

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

	// 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
}

DeleteDrgRequest wrapper for the DeleteDrg operation

func (DeleteDrgRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteDrgRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDrgRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteDrgRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteDrgRequest) String ¶ 

func (request DeleteDrgRequest) String() string

type DeleteDrgResponse ¶ 

type DeleteDrgResponse 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"`
}

DeleteDrgResponse wrapper for the DeleteDrg operation

func (DeleteDrgResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteDrgResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteDrgResponse) String ¶ 

func (response DeleteDrgResponse) String() string

type DeleteIPSecConnectionRequest ¶ 

type DeleteIPSecConnectionRequest struct {

	// The OCID of the IPSec connection.
	IpscId *string `mandatory:"true" contributesTo:"path" name:"ipscId"`

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

	// 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
}

DeleteIPSecConnectionRequest wrapper for the DeleteIPSecConnection operation

func (DeleteIPSecConnectionRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteIPSecConnectionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteIPSecConnectionRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteIPSecConnectionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteIPSecConnectionRequest) String ¶ 

func (request DeleteIPSecConnectionRequest) String() string

type DeleteIPSecConnectionResponse ¶ 

type DeleteIPSecConnectionResponse 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"`
}

DeleteIPSecConnectionResponse wrapper for the DeleteIPSecConnection operation

func (DeleteIPSecConnectionResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteIPSecConnectionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteIPSecConnectionResponse) String ¶ 

func (response DeleteIPSecConnectionResponse) String() string

type DeleteImageRequest ¶ 

type DeleteImageRequest struct {

	// The OCID of the image.
	ImageId *string `mandatory:"true" contributesTo:"path" name:"imageId"`

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

	// 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
}

DeleteImageRequest wrapper for the DeleteImage operation

func (DeleteImageRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteImageRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteImageRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteImageRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteImageRequest) String ¶ 

func (request DeleteImageRequest) String() string

type DeleteImageResponse ¶ 

type DeleteImageResponse 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"`
}

DeleteImageResponse wrapper for the DeleteImage operation

func (DeleteImageResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteImageResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteImageResponse) String ¶ 

func (response DeleteImageResponse) String() string

type DeleteInstanceConfigurationRequest ¶ 

type DeleteInstanceConfigurationRequest struct {

	// The OCID of the instance configuration.
	InstanceConfigurationId *string `mandatory:"true" contributesTo:"path" name:"instanceConfigurationId"`

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

	// 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
}

DeleteInstanceConfigurationRequest wrapper for the DeleteInstanceConfiguration operation

func (DeleteInstanceConfigurationRequest) HTTPRequest ¶ 

func (request DeleteInstanceConfigurationRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteInstanceConfigurationRequest) RetryPolicy ¶ 

func (request DeleteInstanceConfigurationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteInstanceConfigurationRequest) String ¶ 

func (request DeleteInstanceConfigurationRequest) String() string

type DeleteInstanceConfigurationResponse ¶ 

type DeleteInstanceConfigurationResponse 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"`
}

DeleteInstanceConfigurationResponse wrapper for the DeleteInstanceConfiguration operation

func (DeleteInstanceConfigurationResponse) HTTPResponse ¶ 

func (response DeleteInstanceConfigurationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteInstanceConfigurationResponse) String ¶ 

func (response DeleteInstanceConfigurationResponse) String() string

type DeleteInstanceConsoleConnectionRequest ¶ 

type DeleteInstanceConsoleConnectionRequest struct {

	// The OCID of the intance console connection
	InstanceConsoleConnectionId *string `mandatory:"true" contributesTo:"path" name:"instanceConsoleConnectionId"`

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

	// 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
}

DeleteInstanceConsoleConnectionRequest wrapper for the DeleteInstanceConsoleConnection operation

func (DeleteInstanceConsoleConnectionRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteInstanceConsoleConnectionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteInstanceConsoleConnectionRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteInstanceConsoleConnectionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteInstanceConsoleConnectionRequest) String ¶ 

func (request DeleteInstanceConsoleConnectionRequest) String() string

type DeleteInstanceConsoleConnectionResponse ¶ 

type DeleteInstanceConsoleConnectionResponse 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"`
}

DeleteInstanceConsoleConnectionResponse wrapper for the DeleteInstanceConsoleConnection operation

func (DeleteInstanceConsoleConnectionResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteInstanceConsoleConnectionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteInstanceConsoleConnectionResponse) String ¶ 

func (response DeleteInstanceConsoleConnectionResponse) String() string

type DeleteInternetGatewayRequest ¶ 

type DeleteInternetGatewayRequest struct {

	// The OCID of the internet gateway.
	IgId *string `mandatory:"true" contributesTo:"path" name:"igId"`

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

	// 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
}

DeleteInternetGatewayRequest wrapper for the DeleteInternetGateway operation

func (DeleteInternetGatewayRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteInternetGatewayRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteInternetGatewayRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteInternetGatewayRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteInternetGatewayRequest) String ¶ 

func (request DeleteInternetGatewayRequest) String() string

type DeleteInternetGatewayResponse ¶ 

type DeleteInternetGatewayResponse 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"`
}

DeleteInternetGatewayResponse wrapper for the DeleteInternetGateway operation

func (DeleteInternetGatewayResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteInternetGatewayResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteInternetGatewayResponse) String ¶ 

func (response DeleteInternetGatewayResponse) String() string

type DeleteLocalPeeringGatewayRequest ¶ 

type DeleteLocalPeeringGatewayRequest struct {

	// The OCID of the local peering gateway.
	LocalPeeringGatewayId *string `mandatory:"true" contributesTo:"path" name:"localPeeringGatewayId"`

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

	// 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
}

DeleteLocalPeeringGatewayRequest wrapper for the DeleteLocalPeeringGateway operation

func (DeleteLocalPeeringGatewayRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteLocalPeeringGatewayRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteLocalPeeringGatewayRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteLocalPeeringGatewayRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteLocalPeeringGatewayRequest) String ¶ 

func (request DeleteLocalPeeringGatewayRequest) String() string

type DeleteLocalPeeringGatewayResponse ¶ 

type DeleteLocalPeeringGatewayResponse 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"`
}

DeleteLocalPeeringGatewayResponse wrapper for the DeleteLocalPeeringGateway operation

func (DeleteLocalPeeringGatewayResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteLocalPeeringGatewayResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteLocalPeeringGatewayResponse) String ¶ 

func (response DeleteLocalPeeringGatewayResponse) String() string

type DeleteNatGatewayRequest ¶ 

type DeleteNatGatewayRequest struct {

	// The NAT gateway's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
	NatGatewayId *string `mandatory:"true" contributesTo:"path" name:"natGatewayId"`

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

	// 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
}

DeleteNatGatewayRequest wrapper for the DeleteNatGateway operation

func (DeleteNatGatewayRequest) HTTPRequest ¶ 

func (request DeleteNatGatewayRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteNatGatewayRequest) RetryPolicy ¶ 

func (request DeleteNatGatewayRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteNatGatewayRequest) String ¶ 

func (request DeleteNatGatewayRequest) String() string

type DeleteNatGatewayResponse ¶ 

type DeleteNatGatewayResponse 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"`
}

DeleteNatGatewayResponse wrapper for the DeleteNatGateway operation

func (DeleteNatGatewayResponse) HTTPResponse ¶ 

func (response DeleteNatGatewayResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteNatGatewayResponse) String ¶ 

func (response DeleteNatGatewayResponse) String() string

type DeletePrivateIpRequest ¶ 

type DeletePrivateIpRequest struct {

	// The OCID of the private IP.
	PrivateIpId *string `mandatory:"true" contributesTo:"path" name:"privateIpId"`

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

	// 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
}

DeletePrivateIpRequest wrapper for the DeletePrivateIp operation

func (DeletePrivateIpRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeletePrivateIpRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeletePrivateIpRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeletePrivateIpRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeletePrivateIpRequest) String ¶ 

func (request DeletePrivateIpRequest) String() string

type DeletePrivateIpResponse ¶ 

type DeletePrivateIpResponse 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"`
}

DeletePrivateIpResponse wrapper for the DeletePrivateIp operation

func (DeletePrivateIpResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeletePrivateIpResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeletePrivateIpResponse) String ¶ 

func (response DeletePrivateIpResponse) String() string

type DeletePublicIpRequest ¶ added in v1.1.0 

type DeletePublicIpRequest struct {

	// The OCID of the public IP.
	PublicIpId *string `mandatory:"true" contributesTo:"path" name:"publicIpId"`

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

	// 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
}

DeletePublicIpRequest wrapper for the DeletePublicIp operation

func (DeletePublicIpRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeletePublicIpRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeletePublicIpRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeletePublicIpRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeletePublicIpRequest) String ¶ added in v1.1.0 

func (request DeletePublicIpRequest) String() string

type DeletePublicIpResponse ¶ added in v1.1.0 

type DeletePublicIpResponse 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"`
}

DeletePublicIpResponse wrapper for the DeletePublicIp operation

func (DeletePublicIpResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeletePublicIpResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeletePublicIpResponse) String ¶ added in v1.1.0 

func (response DeletePublicIpResponse) String() string

type DeleteRemotePeeringConnectionRequest ¶ added in v1.2.0 

type DeleteRemotePeeringConnectionRequest struct {

	// The OCID of the remote peering connection (RPC).
	RemotePeeringConnectionId *string `mandatory:"true" contributesTo:"path" name:"remotePeeringConnectionId"`

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

	// 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
}

DeleteRemotePeeringConnectionRequest wrapper for the DeleteRemotePeeringConnection operation

func (DeleteRemotePeeringConnectionRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteRemotePeeringConnectionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteRemotePeeringConnectionRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteRemotePeeringConnectionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteRemotePeeringConnectionRequest) String ¶ added in v1.2.0 

func (request DeleteRemotePeeringConnectionRequest) String() string

type DeleteRemotePeeringConnectionResponse ¶ added in v1.2.0 

type DeleteRemotePeeringConnectionResponse 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"`
}

DeleteRemotePeeringConnectionResponse wrapper for the DeleteRemotePeeringConnection operation

func (DeleteRemotePeeringConnectionResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteRemotePeeringConnectionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteRemotePeeringConnectionResponse) String ¶ added in v1.2.0 

func (response DeleteRemotePeeringConnectionResponse) String() string

type DeleteRouteTableRequest ¶ 

type DeleteRouteTableRequest struct {

	// The OCID of the route table.
	RtId *string `mandatory:"true" contributesTo:"path" name:"rtId"`

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

	// 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
}

DeleteRouteTableRequest wrapper for the DeleteRouteTable operation

func (DeleteRouteTableRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteRouteTableRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteRouteTableRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteRouteTableRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteRouteTableRequest) String ¶ 

func (request DeleteRouteTableRequest) String() string

type DeleteRouteTableResponse ¶ 

type DeleteRouteTableResponse 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"`
}

DeleteRouteTableResponse wrapper for the DeleteRouteTable operation

func (DeleteRouteTableResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteRouteTableResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteRouteTableResponse) String ¶ 

func (response DeleteRouteTableResponse) String() string

type DeleteSecurityListRequest ¶ 

type DeleteSecurityListRequest struct {

	// The OCID of the security list.
	SecurityListId *string `mandatory:"true" contributesTo:"path" name:"securityListId"`

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

	// 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
}

DeleteSecurityListRequest wrapper for the DeleteSecurityList operation

func (DeleteSecurityListRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteSecurityListRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteSecurityListRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteSecurityListRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteSecurityListRequest) String ¶ 

func (request DeleteSecurityListRequest) String() string

type DeleteSecurityListResponse ¶ 

type DeleteSecurityListResponse 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"`
}

DeleteSecurityListResponse wrapper for the DeleteSecurityList operation

func (DeleteSecurityListResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteSecurityListResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteSecurityListResponse) String ¶ 

func (response DeleteSecurityListResponse) String() string

type DeleteServiceGatewayRequest ¶ added in v1.8.0 

type DeleteServiceGatewayRequest struct {

	// The service gateway's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
	ServiceGatewayId *string `mandatory:"true" contributesTo:"path" name:"serviceGatewayId"`

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

	// 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
}

DeleteServiceGatewayRequest wrapper for the DeleteServiceGateway operation

func (DeleteServiceGatewayRequest) HTTPRequest ¶ added in v1.8.0 

func (request DeleteServiceGatewayRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteServiceGatewayRequest) RetryPolicy ¶ added in v1.8.0 

func (request DeleteServiceGatewayRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteServiceGatewayRequest) String ¶ added in v1.8.0 

func (request DeleteServiceGatewayRequest) String() string

type DeleteServiceGatewayResponse ¶ added in v1.8.0 

type DeleteServiceGatewayResponse 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"`
}

DeleteServiceGatewayResponse wrapper for the DeleteServiceGateway operation

func (DeleteServiceGatewayResponse) HTTPResponse ¶ added in v1.8.0 

func (response DeleteServiceGatewayResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteServiceGatewayResponse) String ¶ added in v1.8.0 

func (response DeleteServiceGatewayResponse) String() string

type DeleteSubnetRequest ¶ 

type DeleteSubnetRequest struct {

	// The OCID of the subnet.
	SubnetId *string `mandatory:"true" contributesTo:"path" name:"subnetId"`

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

	// 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
}

DeleteSubnetRequest wrapper for the DeleteSubnet operation

func (DeleteSubnetRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteSubnetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteSubnetRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteSubnetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteSubnetRequest) String ¶ 

func (request DeleteSubnetRequest) String() string

type DeleteSubnetResponse ¶ 

type DeleteSubnetResponse 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"`
}

DeleteSubnetResponse wrapper for the DeleteSubnet operation

func (DeleteSubnetResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteSubnetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteSubnetResponse) String ¶ 

func (response DeleteSubnetResponse) String() string

type DeleteVcnRequest ¶ 

type DeleteVcnRequest struct {

	// The OCID of the VCN.
	VcnId *string `mandatory:"true" contributesTo:"path" name:"vcnId"`

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

	// 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
}

DeleteVcnRequest wrapper for the DeleteVcn operation

func (DeleteVcnRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteVcnRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteVcnRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteVcnRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteVcnRequest) String ¶ 

func (request DeleteVcnRequest) String() string

type DeleteVcnResponse ¶ 

type DeleteVcnResponse 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"`
}

DeleteVcnResponse wrapper for the DeleteVcn operation

func (DeleteVcnResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteVcnResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteVcnResponse) String ¶ 

func (response DeleteVcnResponse) String() string

type DeleteVirtualCircuitPublicPrefixDetails ¶ 

type DeleteVirtualCircuitPublicPrefixDetails struct {

	// An individual public IP prefix (CIDR) to remove from the public virtual circuit.
	CidrBlock *string `mandatory:"true" json:"cidrBlock"`
}

DeleteVirtualCircuitPublicPrefixDetails The representation of DeleteVirtualCircuitPublicPrefixDetails

func (DeleteVirtualCircuitPublicPrefixDetails) String ¶ 

func (m DeleteVirtualCircuitPublicPrefixDetails) String() string

type DeleteVirtualCircuitRequest ¶ 

type DeleteVirtualCircuitRequest struct {

	// The OCID of the virtual circuit.
	VirtualCircuitId *string `mandatory:"true" contributesTo:"path" name:"virtualCircuitId"`

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

	// 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
}

DeleteVirtualCircuitRequest wrapper for the DeleteVirtualCircuit operation

func (DeleteVirtualCircuitRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteVirtualCircuitRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteVirtualCircuitRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteVirtualCircuitRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteVirtualCircuitRequest) String ¶ 

func (request DeleteVirtualCircuitRequest) String() string

type DeleteVirtualCircuitResponse ¶ 

type DeleteVirtualCircuitResponse 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"`
}

DeleteVirtualCircuitResponse wrapper for the DeleteVirtualCircuit operation

func (DeleteVirtualCircuitResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteVirtualCircuitResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteVirtualCircuitResponse) String ¶ 

func (response DeleteVirtualCircuitResponse) String() string

type DeleteVolumeBackupPolicyAssignmentRequest ¶ added in v1.1.0 

type DeleteVolumeBackupPolicyAssignmentRequest struct {

	// The OCID of the volume backup policy assignment.
	PolicyAssignmentId *string `mandatory:"true" contributesTo:"path" name:"policyAssignmentId"`

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

	// 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
}

DeleteVolumeBackupPolicyAssignmentRequest wrapper for the DeleteVolumeBackupPolicyAssignment operation

func (DeleteVolumeBackupPolicyAssignmentRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteVolumeBackupPolicyAssignmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteVolumeBackupPolicyAssignmentRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteVolumeBackupPolicyAssignmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteVolumeBackupPolicyAssignmentRequest) String ¶ added in v1.1.0 

func (request DeleteVolumeBackupPolicyAssignmentRequest) String() string

type DeleteVolumeBackupPolicyAssignmentResponse ¶ added in v1.1.0 

type DeleteVolumeBackupPolicyAssignmentResponse 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"`
}

DeleteVolumeBackupPolicyAssignmentResponse wrapper for the DeleteVolumeBackupPolicyAssignment operation

func (DeleteVolumeBackupPolicyAssignmentResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteVolumeBackupPolicyAssignmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteVolumeBackupPolicyAssignmentResponse) String ¶ added in v1.1.0 

func (response DeleteVolumeBackupPolicyAssignmentResponse) String() string

type DeleteVolumeBackupRequest ¶ 

type DeleteVolumeBackupRequest struct {

	// The OCID of the volume backup.
	VolumeBackupId *string `mandatory:"true" contributesTo:"path" name:"volumeBackupId"`

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

	// 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
}

DeleteVolumeBackupRequest wrapper for the DeleteVolumeBackup operation

func (DeleteVolumeBackupRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteVolumeBackupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteVolumeBackupRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteVolumeBackupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteVolumeBackupRequest) String ¶ 

func (request DeleteVolumeBackupRequest) String() string

type DeleteVolumeBackupResponse ¶ 

type DeleteVolumeBackupResponse 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"`
}

DeleteVolumeBackupResponse wrapper for the DeleteVolumeBackup operation

func (DeleteVolumeBackupResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteVolumeBackupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteVolumeBackupResponse) String ¶ 

func (response DeleteVolumeBackupResponse) String() string

type DeleteVolumeGroupBackupRequest ¶ added in v1.6.0 

type DeleteVolumeGroupBackupRequest struct {

	// The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.
	VolumeGroupBackupId *string `mandatory:"true" contributesTo:"path" name:"volumeGroupBackupId"`

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

	// 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
}

DeleteVolumeGroupBackupRequest wrapper for the DeleteVolumeGroupBackup operation

func (DeleteVolumeGroupBackupRequest) HTTPRequest ¶ added in v1.6.0 

func (request DeleteVolumeGroupBackupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteVolumeGroupBackupRequest) RetryPolicy ¶ added in v1.6.0 

func (request DeleteVolumeGroupBackupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteVolumeGroupBackupRequest) String ¶ added in v1.6.0 

func (request DeleteVolumeGroupBackupRequest) String() string

type DeleteVolumeGroupBackupResponse ¶ added in v1.6.0 

type DeleteVolumeGroupBackupResponse 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"`
}

DeleteVolumeGroupBackupResponse wrapper for the DeleteVolumeGroupBackup operation

func (DeleteVolumeGroupBackupResponse) HTTPResponse ¶ added in v1.6.0 

func (response DeleteVolumeGroupBackupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteVolumeGroupBackupResponse) String ¶ added in v1.6.0 

func (response DeleteVolumeGroupBackupResponse) String() string

type DeleteVolumeGroupRequest ¶ added in v1.6.0 

type DeleteVolumeGroupRequest struct {

	// The Oracle Cloud ID (OCID) that uniquely identifies the volume group.
	VolumeGroupId *string `mandatory:"true" contributesTo:"path" name:"volumeGroupId"`

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

	// 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
}

DeleteVolumeGroupRequest wrapper for the DeleteVolumeGroup operation

func (DeleteVolumeGroupRequest) HTTPRequest ¶ added in v1.6.0 

func (request DeleteVolumeGroupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteVolumeGroupRequest) RetryPolicy ¶ added in v1.6.0 

func (request DeleteVolumeGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteVolumeGroupRequest) String ¶ added in v1.6.0 

func (request DeleteVolumeGroupRequest) String() string

type DeleteVolumeGroupResponse ¶ added in v1.6.0 

type DeleteVolumeGroupResponse 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"`
}

DeleteVolumeGroupResponse wrapper for the DeleteVolumeGroup operation

func (DeleteVolumeGroupResponse) HTTPResponse ¶ added in v1.6.0 

func (response DeleteVolumeGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteVolumeGroupResponse) String ¶ added in v1.6.0 

func (response DeleteVolumeGroupResponse) String() string

type DeleteVolumeKmsKeyRequest ¶ 

type DeleteVolumeKmsKeyRequest struct {

	// The OCID of the volume.
	VolumeId *string `mandatory:"true" contributesTo:"path" name:"volumeId"`

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

	// 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
}

DeleteVolumeKmsKeyRequest wrapper for the DeleteVolumeKmsKey operation

func (DeleteVolumeKmsKeyRequest) HTTPRequest ¶ 

func (request DeleteVolumeKmsKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteVolumeKmsKeyRequest) RetryPolicy ¶ 

func (request DeleteVolumeKmsKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteVolumeKmsKeyRequest) String ¶ 

func (request DeleteVolumeKmsKeyRequest) String() string

type DeleteVolumeKmsKeyResponse ¶ 

type DeleteVolumeKmsKeyResponse 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"`
}

DeleteVolumeKmsKeyResponse wrapper for the DeleteVolumeKmsKey operation

func (DeleteVolumeKmsKeyResponse) HTTPResponse ¶ 

func (response DeleteVolumeKmsKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteVolumeKmsKeyResponse) String ¶ 

func (response DeleteVolumeKmsKeyResponse) String() string

type DeleteVolumeRequest ¶ 

type DeleteVolumeRequest struct {

	// The OCID of the volume.
	VolumeId *string `mandatory:"true" contributesTo:"path" name:"volumeId"`

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

	// 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
}

DeleteVolumeRequest wrapper for the DeleteVolume operation

func (DeleteVolumeRequest) HTTPRequest ¶ added in v1.3.0 

func (request DeleteVolumeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteVolumeRequest) RetryPolicy ¶ added in v1.3.0 

func (request DeleteVolumeRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteVolumeRequest) String ¶ 

func (request DeleteVolumeRequest) String() string

type DeleteVolumeResponse ¶ 

type DeleteVolumeResponse 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"`
}

DeleteVolumeResponse wrapper for the DeleteVolume operation

func (DeleteVolumeResponse) HTTPResponse ¶ added in v1.3.0 

func (response DeleteVolumeResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteVolumeResponse) String ¶ 

func (response DeleteVolumeResponse) String() string

type DetachBootVolumeRequest ¶ 

type DetachBootVolumeRequest struct {

	// The OCID of the boot volume attachment.
	BootVolumeAttachmentId *string `mandatory:"true" contributesTo:"path" name:"bootVolumeAttachmentId"`

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

	// 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
}

DetachBootVolumeRequest wrapper for the DetachBootVolume operation

func (DetachBootVolumeRequest) HTTPRequest ¶ added in v1.3.0 

func (request DetachBootVolumeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DetachBootVolumeRequest) RetryPolicy ¶ added in v1.3.0 

func (request DetachBootVolumeRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DetachBootVolumeRequest) String ¶ 

func (request DetachBootVolumeRequest) String() string

type DetachBootVolumeResponse ¶ 

type DetachBootVolumeResponse 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"`
}

DetachBootVolumeResponse wrapper for the DetachBootVolume operation

func (DetachBootVolumeResponse) HTTPResponse ¶ added in v1.3.0 

func (response DetachBootVolumeResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DetachBootVolumeResponse) String ¶ 

func (response DetachBootVolumeResponse) String() string

type DetachServiceIdRequest ¶ added in v1.8.0 

type DetachServiceIdRequest struct {

	// The service gateway's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
	ServiceGatewayId *string `mandatory:"true" contributesTo:"path" name:"serviceGatewayId"`

	// ServiceId of Service to be detached from a service gateway.
	DetachServiceDetails ServiceIdRequestDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

DetachServiceIdRequest wrapper for the DetachServiceId operation

func (DetachServiceIdRequest) HTTPRequest ¶ added in v1.8.0 

func (request DetachServiceIdRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DetachServiceIdRequest) RetryPolicy ¶ added in v1.8.0 

func (request DetachServiceIdRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DetachServiceIdRequest) String ¶ added in v1.8.0 

func (request DetachServiceIdRequest) String() string

type DetachServiceIdResponse ¶ added in v1.8.0 

type DetachServiceIdResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ServiceGateway instance
	ServiceGateway `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"`
}

DetachServiceIdResponse wrapper for the DetachServiceId operation

func (DetachServiceIdResponse) HTTPResponse ¶ added in v1.8.0 

func (response DetachServiceIdResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DetachServiceIdResponse) String ¶ added in v1.8.0 

func (response DetachServiceIdResponse) String() string

type DetachVnicRequest ¶ 

type DetachVnicRequest struct {

	// The OCID of the VNIC attachment.
	VnicAttachmentId *string `mandatory:"true" contributesTo:"path" name:"vnicAttachmentId"`

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

	// 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
}

DetachVnicRequest wrapper for the DetachVnic operation

func (DetachVnicRequest) HTTPRequest ¶ added in v1.3.0 

func (request DetachVnicRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DetachVnicRequest) RetryPolicy ¶ added in v1.3.0 

func (request DetachVnicRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DetachVnicRequest) String ¶ 

func (request DetachVnicRequest) String() string

type DetachVnicResponse ¶ 

type DetachVnicResponse 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"`
}

DetachVnicResponse wrapper for the DetachVnic operation

func (DetachVnicResponse) HTTPResponse ¶ added in v1.3.0 

func (response DetachVnicResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DetachVnicResponse) String ¶ 

func (response DetachVnicResponse) String() string

type DetachVolumeRequest ¶ 

type DetachVolumeRequest struct {

	// The OCID of the volume attachment.
	VolumeAttachmentId *string `mandatory:"true" contributesTo:"path" name:"volumeAttachmentId"`

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

	// 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
}

DetachVolumeRequest wrapper for the DetachVolume operation

func (DetachVolumeRequest) HTTPRequest ¶ added in v1.3.0 

func (request DetachVolumeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DetachVolumeRequest) RetryPolicy ¶ added in v1.3.0 

func (request DetachVolumeRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DetachVolumeRequest) String ¶ 

func (request DetachVolumeRequest) String() string

type DetachVolumeResponse ¶ 

type DetachVolumeResponse 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"`
}

DetachVolumeResponse wrapper for the DetachVolume operation

func (DetachVolumeResponse) HTTPResponse ¶ added in v1.3.0 

func (response DetachVolumeResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DetachVolumeResponse) String ¶ 

func (response DetachVolumeResponse) String() string

type Device ¶ 

type Device struct {

	// The device name.
	Name *string `mandatory:"true" json:"name"`

	// The flag denoting whether device is available.
	IsAvailable *bool `mandatory:"true" json:"isAvailable"`
}

Device Device Path corresponding to the block devices attached to instances having a name and isAvailable flag.

func (Device) String ¶ 

func (m Device) String() string

type DhcpDnsOption ¶ 

type DhcpDnsOption struct {

	// If you set `serverType` to `CustomDnsServer`, specify the
	// IP address of at least one DNS server of your choice (three maximum).
	CustomDnsServers []string `mandatory:"false" json:"customDnsServers"`

	// * **VcnLocal:** Reserved for future use.
	// * **VcnLocalPlusInternet:** Also referred to as "Internet and VCN Resolver".
	// Instances can resolve internet hostnames (no internet gateway is required),
	// and can resolve hostnames of instances in the VCN. This is the default
	// value in the default set of DHCP options in the VCN. For the Internet and
	// VCN Resolver to work across the VCN, there must also be a DNS label set for
	// the VCN, a DNS label set for each subnet, and a hostname for each instance.
	// The Internet and VCN Resolver also enables reverse DNS lookup, which lets
	// you determine the hostname corresponding to the private IP address. For more
	// information, see
	// DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
	// * **CustomDnsServer:** Instances use a DNS server of your choice (three
	// maximum).
	ServerType DhcpDnsOptionServerTypeEnum `mandatory:"true" json:"serverType"`
}

DhcpDnsOption DHCP option for specifying how DNS (hostname resolution) is handled in the subnets in the VCN. For more information, see DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).

func (DhcpDnsOption) MarshalJSON ¶ 

func (m DhcpDnsOption) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (DhcpDnsOption) String ¶ 

func (m DhcpDnsOption) String() string

type DhcpDnsOptionServerTypeEnum ¶ 

type DhcpDnsOptionServerTypeEnum string

DhcpDnsOptionServerTypeEnum Enum with underlying type: string 

const (
	DhcpDnsOptionServerTypeVcnlocal             DhcpDnsOptionServerTypeEnum = "VcnLocal"
	DhcpDnsOptionServerTypeVcnlocalplusinternet DhcpDnsOptionServerTypeEnum = "VcnLocalPlusInternet"
	DhcpDnsOptionServerTypeCustomdnsserver      DhcpDnsOptionServerTypeEnum = "CustomDnsServer"
)

Set of constants representing the allowable values for DhcpDnsOptionServerTypeEnum

func GetDhcpDnsOptionServerTypeEnumValues ¶ 

func GetDhcpDnsOptionServerTypeEnumValues() []DhcpDnsOptionServerTypeEnum

GetDhcpDnsOptionServerTypeEnumValues Enumerates the set of values for DhcpDnsOptionServerTypeEnum

type DhcpOption ¶ 

type DhcpOption interface {
}

DhcpOption A single DHCP option according to RFC 1533 (https://tools.ietf.org/html/rfc1533). The two options available to use are DhcpDnsOption and DhcpSearchDomainOption. For more information, see DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm) and DHCP Options (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingDHCP.htm).

type DhcpOptions ¶ 

type DhcpOptions struct {

	// The OCID of the compartment containing the set of DHCP options.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Oracle ID (OCID) for the set of DHCP options.
	Id *string `mandatory:"true" json:"id"`

	// The current state of the set of DHCP options.
	LifecycleState DhcpOptionsLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The collection of individual DHCP options.
	Options []DhcpOption `mandatory:"true" json:"options"`

	// Date and time the set of DHCP options was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The OCID of the VCN the set of DHCP options belongs to.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

DhcpOptions A set of DHCP options. Used by the VCN to automatically provide configuration information to the instances when they boot up. There are two options you can set: - DhcpDnsOption: Lets you specify how DNS (hostname resolution) is handled in the subnets in your VCN. - DhcpSearchDomainOption: Lets you specify a search domain name to use for DNS queries. For more information, see DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm) and DHCP Options (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingDHCP.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (DhcpOptions) String ¶ 

func (m DhcpOptions) String() string

func (*DhcpOptions) UnmarshalJSON ¶ 

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

UnmarshalJSON unmarshals from json

type DhcpOptionsLifecycleStateEnum ¶ 

type DhcpOptionsLifecycleStateEnum string

DhcpOptionsLifecycleStateEnum Enum with underlying type: string 

const (
	DhcpOptionsLifecycleStateProvisioning DhcpOptionsLifecycleStateEnum = "PROVISIONING"
	DhcpOptionsLifecycleStateAvailable    DhcpOptionsLifecycleStateEnum = "AVAILABLE"
	DhcpOptionsLifecycleStateTerminating  DhcpOptionsLifecycleStateEnum = "TERMINATING"
	DhcpOptionsLifecycleStateTerminated   DhcpOptionsLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for DhcpOptionsLifecycleStateEnum

func GetDhcpOptionsLifecycleStateEnumValues ¶ 

func GetDhcpOptionsLifecycleStateEnumValues() []DhcpOptionsLifecycleStateEnum

GetDhcpOptionsLifecycleStateEnumValues Enumerates the set of values for DhcpOptionsLifecycleStateEnum

type DhcpSearchDomainOption ¶ 

type DhcpSearchDomainOption struct {

	// A single search domain name according to RFC 952 (https://tools.ietf.org/html/rfc952)
	// and RFC 1123 (https://tools.ietf.org/html/rfc1123). During a DNS query,
	// the OS will append this search domain name to the value being queried.
	// If you set DhcpDnsOption to `VcnLocalPlusInternet`,
	// and you assign a DNS label to the VCN during creation, the search domain name in the
	// VCN's default set of DHCP options is automatically set to the VCN domain
	// (for example, `vcn1.oraclevcn.com`).
	// If you don't want to use a search domain name, omit this option from the
	// set of DHCP options. Do not include this option with an empty list
	// of search domain names, or with an empty string as the value for any search
	// domain name.
	SearchDomainNames []string `mandatory:"true" json:"searchDomainNames"`
}

DhcpSearchDomainOption DHCP option for specifying a search domain name for DNS queries. For more information, see DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).

func (DhcpSearchDomainOption) MarshalJSON ¶ 

func (m DhcpSearchDomainOption) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (DhcpSearchDomainOption) String ¶ 

func (m DhcpSearchDomainOption) String() string

type Drg ¶ 

type Drg struct {

	// The OCID of the compartment containing the DRG.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The DRG's Oracle ID (OCID).
	Id *string `mandatory:"true" json:"id"`

	// The DRG's current state.
	LifecycleState DrgLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The date and time the DRG was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

Drg A dynamic routing gateway (DRG), which is a virtual router that provides a path for private network traffic between your VCN and your existing network. You use it with other Networking Service components to create an IPSec VPN or a connection that uses Oracle Cloud Infrastructure FastConnect. For more information, see Overview of the Networking Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (Drg) String ¶ 

func (m Drg) String() string

type DrgAttachment ¶ 

type DrgAttachment struct {

	// The OCID of the compartment containing the DRG attachment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the DRG.
	DrgId *string `mandatory:"true" json:"drgId"`

	// The DRG attachment's Oracle ID (OCID).
	Id *string `mandatory:"true" json:"id"`

	// The DRG attachment's current state.
	LifecycleState DrgAttachmentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The OCID of the VCN.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The OCID of the route table the DRG attachment is using. For information about why you
	// would associate a route table with a DRG attachment, see
	// Advanced Scenario: Transit Routing (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/transitrouting.htm).
	RouteTableId *string `mandatory:"false" json:"routeTableId"`

	// The date and time the DRG attachment was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

DrgAttachment A link between a DRG and VCN. For more information, see Overview of the Networking Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (DrgAttachment) String ¶ 

func (m DrgAttachment) String() string

type DrgAttachmentLifecycleStateEnum ¶ 

type DrgAttachmentLifecycleStateEnum string

DrgAttachmentLifecycleStateEnum Enum with underlying type: string 

const (
	DrgAttachmentLifecycleStateAttaching DrgAttachmentLifecycleStateEnum = "ATTACHING"
	DrgAttachmentLifecycleStateAttached  DrgAttachmentLifecycleStateEnum = "ATTACHED"
	DrgAttachmentLifecycleStateDetaching DrgAttachmentLifecycleStateEnum = "DETACHING"
	DrgAttachmentLifecycleStateDetached  DrgAttachmentLifecycleStateEnum = "DETACHED"
)

Set of constants representing the allowable values for DrgAttachmentLifecycleStateEnum

func GetDrgAttachmentLifecycleStateEnumValues ¶ 

func GetDrgAttachmentLifecycleStateEnumValues() []DrgAttachmentLifecycleStateEnum

GetDrgAttachmentLifecycleStateEnumValues Enumerates the set of values for DrgAttachmentLifecycleStateEnum

type DrgLifecycleStateEnum ¶ 

type DrgLifecycleStateEnum string

DrgLifecycleStateEnum Enum with underlying type: string 

const (
	DrgLifecycleStateProvisioning DrgLifecycleStateEnum = "PROVISIONING"
	DrgLifecycleStateAvailable    DrgLifecycleStateEnum = "AVAILABLE"
	DrgLifecycleStateTerminating  DrgLifecycleStateEnum = "TERMINATING"
	DrgLifecycleStateTerminated   DrgLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for DrgLifecycleStateEnum

func GetDrgLifecycleStateEnumValues ¶ 

func GetDrgLifecycleStateEnumValues() []DrgLifecycleStateEnum

GetDrgLifecycleStateEnumValues Enumerates the set of values for DrgLifecycleStateEnum

type EgressSecurityRule ¶ 

type EgressSecurityRule struct {

	// Conceptually, this is the range of IP addresses that a packet originating from the instance
	// can go to.
	// Allowed values:
	//   * IP address range in CIDR notation. For example: `192.168.1.0/24`
	//   * The `cidrBlock` value for a Service, if you're
	//     setting up a security list rule for traffic destined for a particular service through
	//     a service gateway. For example: `oci-phx-objectstorage`
	Destination *string `mandatory:"true" json:"destination"`

	// The transport protocol. Specify either `all` or an IPv4 protocol number as
	// defined in
	// Protocol Numbers (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
	// Options are supported only for ICMP ("1"), TCP ("6"), and UDP ("17").
	Protocol *string `mandatory:"true" json:"protocol"`

	// Type of destination for the rule. The default is `CIDR_BLOCK`.
	// Allowed values:
	//   * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.
	//   * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a
	//     Service (the rule is for traffic destined for a
	//     particular service through a service gateway).
	DestinationType EgressSecurityRuleDestinationTypeEnum `mandatory:"false" json:"destinationType,omitempty"`

	// Optional and valid only for ICMP. Use to specify a particular ICMP type and code
	// as defined in
	// ICMP Parameters (http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml).
	// If you specify ICMP as the protocol but omit this object, then all ICMP types and
	// codes are allowed. If you do provide this object, the type is required and the code is optional.
	// To enable MTU negotiation for ingress internet traffic, make sure to allow type 3 ("Destination
	// Unreachable") code 4 ("Fragmentation Needed and Don't Fragment was Set"). If you need to specify
	// multiple codes for a single type, create a separate security list rule for each.
	IcmpOptions *IcmpOptions `mandatory:"false" json:"icmpOptions"`

	// A stateless rule allows traffic in one direction. Remember to add a corresponding
	// stateless rule in the other direction if you need to support bidirectional traffic. For
	// example, if egress traffic allows TCP destination port 80, there should be an ingress
	// rule to allow TCP source port 80. Defaults to false, which means the rule is stateful
	// and a corresponding rule is not necessary for bidirectional traffic.
	IsStateless *bool `mandatory:"false" json:"isStateless"`

	// Optional and valid only for TCP. Use to specify particular destination ports for TCP rules.
	// If you specify TCP as the protocol but omit this object, then all destination ports are allowed.
	TcpOptions *TcpOptions `mandatory:"false" json:"tcpOptions"`

	// Optional and valid only for UDP. Use to specify particular destination ports for UDP rules.
	// If you specify UDP as the protocol but omit this object, then all destination ports are allowed.
	UdpOptions *UdpOptions `mandatory:"false" json:"udpOptions"`
}

EgressSecurityRule A rule for allowing outbound IP packets.

func (EgressSecurityRule) String ¶ 

func (m EgressSecurityRule) String() string

type EgressSecurityRuleDestinationTypeEnum ¶ added in v1.8.0 

type EgressSecurityRuleDestinationTypeEnum string

EgressSecurityRuleDestinationTypeEnum Enum with underlying type: string 

const (
	EgressSecurityRuleDestinationTypeCidrBlock        EgressSecurityRuleDestinationTypeEnum = "CIDR_BLOCK"
	EgressSecurityRuleDestinationTypeServiceCidrBlock EgressSecurityRuleDestinationTypeEnum = "SERVICE_CIDR_BLOCK"
)

Set of constants representing the allowable values for EgressSecurityRuleDestinationTypeEnum

func GetEgressSecurityRuleDestinationTypeEnumValues ¶ added in v1.8.0 

func GetEgressSecurityRuleDestinationTypeEnumValues() []EgressSecurityRuleDestinationTypeEnum

GetEgressSecurityRuleDestinationTypeEnumValues Enumerates the set of values for EgressSecurityRuleDestinationTypeEnum

type ExportImageDetails ¶ 

type ExportImageDetails interface {
}

ExportImageDetails The destination details for the image export. Set `destinationType` to `objectStorageTuple` and use ExportImageViaObjectStorageTupleDetails when specifying the namespace, bucket name, and object name. Set `destinationType` to `objectStorageUri` and use ExportImageViaObjectStorageUriDetails when specifying the Object Storage URL.

type ExportImageRequest ¶ 

type ExportImageRequest struct {

	// The OCID of the image.
	ImageId *string `mandatory:"true" contributesTo:"path" name:"imageId"`

	// Details for the image export.
	ExportImageDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

	// 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
}

ExportImageRequest wrapper for the ExportImage operation

func (ExportImageRequest) HTTPRequest ¶ added in v1.3.0 

func (request ExportImageRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ExportImageRequest) RetryPolicy ¶ added in v1.3.0 

func (request ExportImageRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ExportImageRequest) String ¶ 

func (request ExportImageRequest) String() string

type ExportImageResponse ¶ 

type ExportImageResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Image instance
	Image `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"`
}

ExportImageResponse wrapper for the ExportImage operation

func (ExportImageResponse) HTTPResponse ¶ added in v1.3.0 

func (response ExportImageResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ExportImageResponse) String ¶ 

func (response ExportImageResponse) String() string

type ExportImageViaObjectStorageTupleDetails ¶ 

type ExportImageViaObjectStorageTupleDetails struct {

	// The Object Storage bucket to export the image to.
	BucketName *string `mandatory:"false" json:"bucketName"`

	// The Object Storage namespace to export the image to.
	NamespaceName *string `mandatory:"false" json:"namespaceName"`

	// The Object Storage object name for the exported image.
	ObjectName *string `mandatory:"false" json:"objectName"`
}

ExportImageViaObjectStorageTupleDetails The representation of ExportImageViaObjectStorageTupleDetails

func (ExportImageViaObjectStorageTupleDetails) MarshalJSON ¶ 

func (m ExportImageViaObjectStorageTupleDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ExportImageViaObjectStorageTupleDetails) String ¶ 

func (m ExportImageViaObjectStorageTupleDetails) String() string

type ExportImageViaObjectStorageUriDetails ¶ 

type ExportImageViaObjectStorageUriDetails struct {

	// The Object Storage URL to export the image to. See Object Storage URLs (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/imageimportexport.htm#URLs)
	// and pre-authenticated requests (https://docs.us-phoenix-1.oraclecloud.com/Content/Object/Tasks/managingaccess.htm#pre-auth) for constructing URLs for image import/export.
	DestinationUri *string `mandatory:"true" json:"destinationUri"`
}

ExportImageViaObjectStorageUriDetails The representation of ExportImageViaObjectStorageUriDetails

func (ExportImageViaObjectStorageUriDetails) MarshalJSON ¶ 

func (m ExportImageViaObjectStorageUriDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ExportImageViaObjectStorageUriDetails) String ¶ 

func (m ExportImageViaObjectStorageUriDetails) String() string

type FastConnectProviderService ¶ 

type FastConnectProviderService struct {

	// The OCID of the service offered by the provider.
	Id *string `mandatory:"true" json:"id"`

	// Who is responsible for managing the private peering BGP information.
	PrivatePeeringBgpManagement FastConnectProviderServicePrivatePeeringBgpManagementEnum `mandatory:"true" json:"privatePeeringBgpManagement"`

	// The name of the provider.
	ProviderName *string `mandatory:"true" json:"providerName"`

	// The name of the service offered by the provider.
	ProviderServiceName *string `mandatory:"true" json:"providerServiceName"`

	// Who is responsible for managing the public peering BGP information.
	PublicPeeringBgpManagement FastConnectProviderServicePublicPeeringBgpManagementEnum `mandatory:"true" json:"publicPeeringBgpManagement"`

	// Provider service type.
	Type FastConnectProviderServiceTypeEnum `mandatory:"true" json:"type"`

	// A description of the service offered by the provider.
	Description *string `mandatory:"false" json:"description"`

	// An array of virtual circuit types supported by this service.
	SupportedVirtualCircuitTypes []FastConnectProviderServiceSupportedVirtualCircuitTypesEnum `mandatory:"false" json:"supportedVirtualCircuitTypes,omitempty"`
}

FastConnectProviderService A service offering from a supported provider. For more information, see FastConnect Overview (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm).

func (FastConnectProviderService) String ¶ 

func (m FastConnectProviderService) String() string

type FastConnectProviderServicePrivatePeeringBgpManagementEnum ¶ 

type FastConnectProviderServicePrivatePeeringBgpManagementEnum string

FastConnectProviderServicePrivatePeeringBgpManagementEnum Enum with underlying type: string 

const (
	FastConnectProviderServicePrivatePeeringBgpManagementCustomerManaged FastConnectProviderServicePrivatePeeringBgpManagementEnum = "CUSTOMER_MANAGED"
	FastConnectProviderServicePrivatePeeringBgpManagementProviderManaged FastConnectProviderServicePrivatePeeringBgpManagementEnum = "PROVIDER_MANAGED"
	FastConnectProviderServicePrivatePeeringBgpManagementOracleManaged   FastConnectProviderServicePrivatePeeringBgpManagementEnum = "ORACLE_MANAGED"
)

Set of constants representing the allowable values for FastConnectProviderServicePrivatePeeringBgpManagementEnum

func GetFastConnectProviderServicePrivatePeeringBgpManagementEnumValues ¶ 

func GetFastConnectProviderServicePrivatePeeringBgpManagementEnumValues() []FastConnectProviderServicePrivatePeeringBgpManagementEnum

GetFastConnectProviderServicePrivatePeeringBgpManagementEnumValues Enumerates the set of values for FastConnectProviderServicePrivatePeeringBgpManagementEnum

type FastConnectProviderServicePublicPeeringBgpManagementEnum ¶ 

type FastConnectProviderServicePublicPeeringBgpManagementEnum string

FastConnectProviderServicePublicPeeringBgpManagementEnum Enum with underlying type: string 

const (
	FastConnectProviderServicePublicPeeringBgpManagementCustomerManaged FastConnectProviderServicePublicPeeringBgpManagementEnum = "CUSTOMER_MANAGED"
	FastConnectProviderServicePublicPeeringBgpManagementProviderManaged FastConnectProviderServicePublicPeeringBgpManagementEnum = "PROVIDER_MANAGED"
	FastConnectProviderServicePublicPeeringBgpManagementOracleManaged   FastConnectProviderServicePublicPeeringBgpManagementEnum = "ORACLE_MANAGED"
)

Set of constants representing the allowable values for FastConnectProviderServicePublicPeeringBgpManagementEnum

func GetFastConnectProviderServicePublicPeeringBgpManagementEnumValues ¶ 

func GetFastConnectProviderServicePublicPeeringBgpManagementEnumValues() []FastConnectProviderServicePublicPeeringBgpManagementEnum

GetFastConnectProviderServicePublicPeeringBgpManagementEnumValues Enumerates the set of values for FastConnectProviderServicePublicPeeringBgpManagementEnum

type FastConnectProviderServiceSupportedVirtualCircuitTypesEnum ¶ 

type FastConnectProviderServiceSupportedVirtualCircuitTypesEnum string

FastConnectProviderServiceSupportedVirtualCircuitTypesEnum Enum with underlying type: string 

const (
	FastConnectProviderServiceSupportedVirtualCircuitTypesPublic  FastConnectProviderServiceSupportedVirtualCircuitTypesEnum = "PUBLIC"
	FastConnectProviderServiceSupportedVirtualCircuitTypesPrivate FastConnectProviderServiceSupportedVirtualCircuitTypesEnum = "PRIVATE"
)

Set of constants representing the allowable values for FastConnectProviderServiceSupportedVirtualCircuitTypesEnum

func GetFastConnectProviderServiceSupportedVirtualCircuitTypesEnumValues ¶ 

func GetFastConnectProviderServiceSupportedVirtualCircuitTypesEnumValues() []FastConnectProviderServiceSupportedVirtualCircuitTypesEnum

GetFastConnectProviderServiceSupportedVirtualCircuitTypesEnumValues Enumerates the set of values for FastConnectProviderServiceSupportedVirtualCircuitTypesEnum

type FastConnectProviderServiceTypeEnum ¶ 

type FastConnectProviderServiceTypeEnum string

FastConnectProviderServiceTypeEnum Enum with underlying type: string 

const (
	FastConnectProviderServiceTypeLayer2 FastConnectProviderServiceTypeEnum = "LAYER2"
	FastConnectProviderServiceTypeLayer3 FastConnectProviderServiceTypeEnum = "LAYER3"
)

Set of constants representing the allowable values for FastConnectProviderServiceTypeEnum

func GetFastConnectProviderServiceTypeEnumValues ¶ 

func GetFastConnectProviderServiceTypeEnumValues() []FastConnectProviderServiceTypeEnum

GetFastConnectProviderServiceTypeEnumValues Enumerates the set of values for FastConnectProviderServiceTypeEnum

type GetAppCatalogListingAgreementsRequest ¶ 

type GetAppCatalogListingAgreementsRequest struct {

	// The OCID of the listing.
	ListingId *string `mandatory:"true" contributesTo:"path" name:"listingId"`

	// Listing Resource Version.
	ResourceVersion *string `mandatory:"true" contributesTo:"path" name:"resourceVersion"`

	// 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
}

GetAppCatalogListingAgreementsRequest wrapper for the GetAppCatalogListingAgreements operation

func (GetAppCatalogListingAgreementsRequest) HTTPRequest ¶ 

func (request GetAppCatalogListingAgreementsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetAppCatalogListingAgreementsRequest) RetryPolicy ¶ 

func (request GetAppCatalogListingAgreementsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetAppCatalogListingAgreementsRequest) String ¶ 

func (request GetAppCatalogListingAgreementsRequest) String() string

type GetAppCatalogListingAgreementsResponse ¶ 

type GetAppCatalogListingAgreementsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AppCatalogListingResourceVersionAgreements instance
	AppCatalogListingResourceVersionAgreements `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"`
}

GetAppCatalogListingAgreementsResponse wrapper for the GetAppCatalogListingAgreements operation

func (GetAppCatalogListingAgreementsResponse) HTTPResponse ¶ 

func (response GetAppCatalogListingAgreementsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetAppCatalogListingAgreementsResponse) String ¶ 

func (response GetAppCatalogListingAgreementsResponse) String() string

type GetAppCatalogListingRequest ¶ 

type GetAppCatalogListingRequest struct {

	// The OCID of the listing.
	ListingId *string `mandatory:"true" contributesTo:"path" name:"listingId"`

	// 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
}

GetAppCatalogListingRequest wrapper for the GetAppCatalogListing operation

func (GetAppCatalogListingRequest) HTTPRequest ¶ 

func (request GetAppCatalogListingRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetAppCatalogListingRequest) RetryPolicy ¶ 

func (request GetAppCatalogListingRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetAppCatalogListingRequest) String ¶ 

func (request GetAppCatalogListingRequest) String() string

type GetAppCatalogListingResourceVersionRequest ¶ 

type GetAppCatalogListingResourceVersionRequest struct {

	// The OCID of the listing.
	ListingId *string `mandatory:"true" contributesTo:"path" name:"listingId"`

	// Listing Resource Version.
	ResourceVersion *string `mandatory:"true" contributesTo:"path" name:"resourceVersion"`

	// 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
}

GetAppCatalogListingResourceVersionRequest wrapper for the GetAppCatalogListingResourceVersion operation

func (GetAppCatalogListingResourceVersionRequest) HTTPRequest ¶ 

func (request GetAppCatalogListingResourceVersionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetAppCatalogListingResourceVersionRequest) RetryPolicy ¶ 

func (request GetAppCatalogListingResourceVersionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetAppCatalogListingResourceVersionRequest) String ¶ 

func (request GetAppCatalogListingResourceVersionRequest) String() string

type GetAppCatalogListingResourceVersionResponse ¶ 

type GetAppCatalogListingResourceVersionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AppCatalogListingResourceVersion instance
	AppCatalogListingResourceVersion `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"`
}

GetAppCatalogListingResourceVersionResponse wrapper for the GetAppCatalogListingResourceVersion operation

func (GetAppCatalogListingResourceVersionResponse) HTTPResponse ¶ 

func (response GetAppCatalogListingResourceVersionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetAppCatalogListingResourceVersionResponse) String ¶ 

func (response GetAppCatalogListingResourceVersionResponse) String() string

type GetAppCatalogListingResponse ¶ 

type GetAppCatalogListingResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AppCatalogListing instance
	AppCatalogListing `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"`
}

GetAppCatalogListingResponse wrapper for the GetAppCatalogListing operation

func (GetAppCatalogListingResponse) HTTPResponse ¶ 

func (response GetAppCatalogListingResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetAppCatalogListingResponse) String ¶ 

func (response GetAppCatalogListingResponse) String() string

type GetBootVolumeAttachmentRequest ¶ 

type GetBootVolumeAttachmentRequest struct {

	// The OCID of the boot volume attachment.
	BootVolumeAttachmentId *string `mandatory:"true" contributesTo:"path" name:"bootVolumeAttachmentId"`

	// 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
}

GetBootVolumeAttachmentRequest wrapper for the GetBootVolumeAttachment operation

func (GetBootVolumeAttachmentRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetBootVolumeAttachmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetBootVolumeAttachmentRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetBootVolumeAttachmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetBootVolumeAttachmentRequest) String ¶ 

func (request GetBootVolumeAttachmentRequest) String() string

type GetBootVolumeAttachmentResponse ¶ 

type GetBootVolumeAttachmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BootVolumeAttachment instance
	BootVolumeAttachment `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"`
}

GetBootVolumeAttachmentResponse wrapper for the GetBootVolumeAttachment operation

func (GetBootVolumeAttachmentResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetBootVolumeAttachmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetBootVolumeAttachmentResponse) String ¶ 

func (response GetBootVolumeAttachmentResponse) String() string

type GetBootVolumeBackupRequest ¶ added in v1.8.0 

type GetBootVolumeBackupRequest struct {

	// The OCID of the boot volume backup.
	BootVolumeBackupId *string `mandatory:"true" contributesTo:"path" name:"bootVolumeBackupId"`

	// 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
}

GetBootVolumeBackupRequest wrapper for the GetBootVolumeBackup operation

func (GetBootVolumeBackupRequest) HTTPRequest ¶ added in v1.8.0 

func (request GetBootVolumeBackupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetBootVolumeBackupRequest) RetryPolicy ¶ added in v1.8.0 

func (request GetBootVolumeBackupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetBootVolumeBackupRequest) String ¶ added in v1.8.0 

func (request GetBootVolumeBackupRequest) String() string

type GetBootVolumeBackupResponse ¶ added in v1.8.0 

type GetBootVolumeBackupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BootVolumeBackup instance
	BootVolumeBackup `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"`
}

GetBootVolumeBackupResponse wrapper for the GetBootVolumeBackup operation

func (GetBootVolumeBackupResponse) HTTPResponse ¶ added in v1.8.0 

func (response GetBootVolumeBackupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetBootVolumeBackupResponse) String ¶ added in v1.8.0 

func (response GetBootVolumeBackupResponse) String() string

type GetBootVolumeKmsKeyRequest ¶ 

type GetBootVolumeKmsKeyRequest struct {

	// The OCID of the boot volume.
	BootVolumeId *string `mandatory:"true" contributesTo:"path" name:"bootVolumeId"`

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

	// 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
}

GetBootVolumeKmsKeyRequest wrapper for the GetBootVolumeKmsKey operation

func (GetBootVolumeKmsKeyRequest) HTTPRequest ¶ 

func (request GetBootVolumeKmsKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetBootVolumeKmsKeyRequest) RetryPolicy ¶ 

func (request GetBootVolumeKmsKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetBootVolumeKmsKeyRequest) String ¶ 

func (request GetBootVolumeKmsKeyRequest) String() string

type GetBootVolumeKmsKeyResponse ¶ 

type GetBootVolumeKmsKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BootVolumeKmsKey instance
	BootVolumeKmsKey `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"`
}

GetBootVolumeKmsKeyResponse wrapper for the GetBootVolumeKmsKey operation

func (GetBootVolumeKmsKeyResponse) HTTPResponse ¶ 

func (response GetBootVolumeKmsKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetBootVolumeKmsKeyResponse) String ¶ 

func (response GetBootVolumeKmsKeyResponse) String() string

type GetBootVolumeRequest ¶ 

type GetBootVolumeRequest struct {

	// The OCID of the boot volume.
	BootVolumeId *string `mandatory:"true" contributesTo:"path" name:"bootVolumeId"`

	// 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
}

GetBootVolumeRequest wrapper for the GetBootVolume operation

func (GetBootVolumeRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetBootVolumeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetBootVolumeRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetBootVolumeRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetBootVolumeRequest) String ¶ 

func (request GetBootVolumeRequest) String() string

type GetBootVolumeResponse ¶ 

type GetBootVolumeResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BootVolume instance
	BootVolume `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"`
}

GetBootVolumeResponse wrapper for the GetBootVolume operation

func (GetBootVolumeResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetBootVolumeResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetBootVolumeResponse) String ¶ 

func (response GetBootVolumeResponse) String() string

type GetConsoleHistoryContentRequest ¶ 

type GetConsoleHistoryContentRequest struct {

	// The OCID of the console history.
	InstanceConsoleHistoryId *string `mandatory:"true" contributesTo:"path" name:"instanceConsoleHistoryId"`

	// Offset of the snapshot data to retrieve.
	Offset *int `mandatory:"false" contributesTo:"query" name:"offset"`

	// Length of the snapshot data to retrieve.
	Length *int `mandatory:"false" contributesTo:"query" name:"length"`

	// 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
}

GetConsoleHistoryContentRequest wrapper for the GetConsoleHistoryContent operation

func (GetConsoleHistoryContentRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetConsoleHistoryContentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetConsoleHistoryContentRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetConsoleHistoryContentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetConsoleHistoryContentRequest) String ¶ 

func (request GetConsoleHistoryContentRequest) String() string

type GetConsoleHistoryContentResponse ¶ 

type GetConsoleHistoryContentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The string instance
	Value *string `presentIn:"body" encoding:"plain-text"`

	// The number of bytes remaining in the snapshot.
	OpcBytesRemaining *int `presentIn:"header" name:"opc-bytes-remaining"`

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

GetConsoleHistoryContentResponse wrapper for the GetConsoleHistoryContent operation

func (GetConsoleHistoryContentResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetConsoleHistoryContentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetConsoleHistoryContentResponse) String ¶ 

func (response GetConsoleHistoryContentResponse) String() string

type GetConsoleHistoryRequest ¶ 

type GetConsoleHistoryRequest struct {

	// The OCID of the console history.
	InstanceConsoleHistoryId *string `mandatory:"true" contributesTo:"path" name:"instanceConsoleHistoryId"`

	// 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
}

GetConsoleHistoryRequest wrapper for the GetConsoleHistory operation

func (GetConsoleHistoryRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetConsoleHistoryRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetConsoleHistoryRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetConsoleHistoryRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetConsoleHistoryRequest) String ¶ 

func (request GetConsoleHistoryRequest) String() string

type GetConsoleHistoryResponse ¶ 

type GetConsoleHistoryResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ConsoleHistory instance
	ConsoleHistory `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"`
}

GetConsoleHistoryResponse wrapper for the GetConsoleHistory operation

func (GetConsoleHistoryResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetConsoleHistoryResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetConsoleHistoryResponse) String ¶ 

func (response GetConsoleHistoryResponse) String() string

type GetCpeRequest ¶ 

type GetCpeRequest struct {

	// The OCID of the CPE.
	CpeId *string `mandatory:"true" contributesTo:"path" name:"cpeId"`

	// 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
}

GetCpeRequest wrapper for the GetCpe operation

func (GetCpeRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetCpeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetCpeRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetCpeRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetCpeRequest) String ¶ 

func (request GetCpeRequest) String() string

type GetCpeResponse ¶ 

type GetCpeResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Cpe instance
	Cpe `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"`
}

GetCpeResponse wrapper for the GetCpe operation

func (GetCpeResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetCpeResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetCpeResponse) String ¶ 

func (response GetCpeResponse) String() string

type GetCrossConnectGroupRequest ¶ 

type GetCrossConnectGroupRequest struct {

	// The OCID of the cross-connect group.
	CrossConnectGroupId *string `mandatory:"true" contributesTo:"path" name:"crossConnectGroupId"`

	// 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
}

GetCrossConnectGroupRequest wrapper for the GetCrossConnectGroup operation

func (GetCrossConnectGroupRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetCrossConnectGroupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetCrossConnectGroupRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetCrossConnectGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetCrossConnectGroupRequest) String ¶ 

func (request GetCrossConnectGroupRequest) String() string

type GetCrossConnectGroupResponse ¶ 

type GetCrossConnectGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The CrossConnectGroup instance
	CrossConnectGroup `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"`
}

GetCrossConnectGroupResponse wrapper for the GetCrossConnectGroup operation

func (GetCrossConnectGroupResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetCrossConnectGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetCrossConnectGroupResponse) String ¶ 

func (response GetCrossConnectGroupResponse) String() string

type GetCrossConnectLetterOfAuthorityRequest ¶ 

type GetCrossConnectLetterOfAuthorityRequest struct {

	// The OCID of the cross-connect.
	CrossConnectId *string `mandatory:"true" contributesTo:"path" name:"crossConnectId"`

	// 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
}

GetCrossConnectLetterOfAuthorityRequest wrapper for the GetCrossConnectLetterOfAuthority operation

func (GetCrossConnectLetterOfAuthorityRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetCrossConnectLetterOfAuthorityRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetCrossConnectLetterOfAuthorityRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetCrossConnectLetterOfAuthorityRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetCrossConnectLetterOfAuthorityRequest) String ¶ 

func (request GetCrossConnectLetterOfAuthorityRequest) String() string

type GetCrossConnectLetterOfAuthorityResponse ¶ 

type GetCrossConnectLetterOfAuthorityResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The LetterOfAuthority instance
	LetterOfAuthority `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"`
}

GetCrossConnectLetterOfAuthorityResponse wrapper for the GetCrossConnectLetterOfAuthority operation

func (GetCrossConnectLetterOfAuthorityResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetCrossConnectLetterOfAuthorityResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetCrossConnectLetterOfAuthorityResponse) String ¶ 

func (response GetCrossConnectLetterOfAuthorityResponse) String() string

type GetCrossConnectRequest ¶ 

type GetCrossConnectRequest struct {

	// The OCID of the cross-connect.
	CrossConnectId *string `mandatory:"true" contributesTo:"path" name:"crossConnectId"`

	// 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
}

GetCrossConnectRequest wrapper for the GetCrossConnect operation

func (GetCrossConnectRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetCrossConnectRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetCrossConnectRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetCrossConnectRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetCrossConnectRequest) String ¶ 

func (request GetCrossConnectRequest) String() string

type GetCrossConnectResponse ¶ 

type GetCrossConnectResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The CrossConnect instance
	CrossConnect `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"`
}

GetCrossConnectResponse wrapper for the GetCrossConnect operation

func (GetCrossConnectResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetCrossConnectResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetCrossConnectResponse) String ¶ 

func (response GetCrossConnectResponse) String() string

type GetCrossConnectStatusRequest ¶ 

type GetCrossConnectStatusRequest struct {

	// The OCID of the cross-connect.
	CrossConnectId *string `mandatory:"true" contributesTo:"path" name:"crossConnectId"`

	// 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
}

GetCrossConnectStatusRequest wrapper for the GetCrossConnectStatus operation

func (GetCrossConnectStatusRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetCrossConnectStatusRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetCrossConnectStatusRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetCrossConnectStatusRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetCrossConnectStatusRequest) String ¶ 

func (request GetCrossConnectStatusRequest) String() string

type GetCrossConnectStatusResponse ¶ 

type GetCrossConnectStatusResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The CrossConnectStatus instance
	CrossConnectStatus `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"`
}

GetCrossConnectStatusResponse wrapper for the GetCrossConnectStatus operation

func (GetCrossConnectStatusResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetCrossConnectStatusResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetCrossConnectStatusResponse) String ¶ 

func (response GetCrossConnectStatusResponse) String() string

type GetDhcpOptionsRequest ¶ 

type GetDhcpOptionsRequest struct {

	// The OCID for the set of DHCP options.
	DhcpId *string `mandatory:"true" contributesTo:"path" name:"dhcpId"`

	// 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
}

GetDhcpOptionsRequest wrapper for the GetDhcpOptions operation

func (GetDhcpOptionsRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetDhcpOptionsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDhcpOptionsRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetDhcpOptionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetDhcpOptionsRequest) String ¶ 

func (request GetDhcpOptionsRequest) String() string

type GetDhcpOptionsResponse ¶ 

type GetDhcpOptionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DhcpOptions instance
	DhcpOptions `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"`
}

GetDhcpOptionsResponse wrapper for the GetDhcpOptions operation

func (GetDhcpOptionsResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetDhcpOptionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetDhcpOptionsResponse) String ¶ 

func (response GetDhcpOptionsResponse) String() string

type GetDrgAttachmentRequest ¶ 

type GetDrgAttachmentRequest struct {

	// The OCID of the DRG attachment.
	DrgAttachmentId *string `mandatory:"true" contributesTo:"path" name:"drgAttachmentId"`

	// 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
}

GetDrgAttachmentRequest wrapper for the GetDrgAttachment operation

func (GetDrgAttachmentRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetDrgAttachmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDrgAttachmentRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetDrgAttachmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetDrgAttachmentRequest) String ¶ 

func (request GetDrgAttachmentRequest) String() string

type GetDrgAttachmentResponse ¶ 

type GetDrgAttachmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DrgAttachment instance
	DrgAttachment `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"`
}

GetDrgAttachmentResponse wrapper for the GetDrgAttachment operation

func (GetDrgAttachmentResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetDrgAttachmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetDrgAttachmentResponse) String ¶ 

func (response GetDrgAttachmentResponse) String() string

type GetDrgRequest ¶ 

type GetDrgRequest struct {

	// The OCID of the DRG.
	DrgId *string `mandatory:"true" contributesTo:"path" name:"drgId"`

	// 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
}

GetDrgRequest wrapper for the GetDrg operation

func (GetDrgRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetDrgRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDrgRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetDrgRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetDrgRequest) String ¶ 

func (request GetDrgRequest) String() string

type GetDrgResponse ¶ 

type GetDrgResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Drg instance
	Drg `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"`
}

GetDrgResponse wrapper for the GetDrg operation

func (GetDrgResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetDrgResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetDrgResponse) String ¶ 

func (response GetDrgResponse) String() string

type GetFastConnectProviderServiceRequest ¶ 

type GetFastConnectProviderServiceRequest struct {

	// The OCID of the provider service.
	ProviderServiceId *string `mandatory:"true" contributesTo:"path" name:"providerServiceId"`

	// 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
}

GetFastConnectProviderServiceRequest wrapper for the GetFastConnectProviderService operation

func (GetFastConnectProviderServiceRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetFastConnectProviderServiceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetFastConnectProviderServiceRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetFastConnectProviderServiceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetFastConnectProviderServiceRequest) String ¶ 

func (request GetFastConnectProviderServiceRequest) String() string

type GetFastConnectProviderServiceResponse ¶ 

type GetFastConnectProviderServiceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The FastConnectProviderService instance
	FastConnectProviderService `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"`
}

GetFastConnectProviderServiceResponse wrapper for the GetFastConnectProviderService operation

func (GetFastConnectProviderServiceResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetFastConnectProviderServiceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetFastConnectProviderServiceResponse) String ¶ 

func (response GetFastConnectProviderServiceResponse) String() string

type GetIPSecConnectionDeviceConfigRequest ¶ 

type GetIPSecConnectionDeviceConfigRequest struct {

	// The OCID of the IPSec connection.
	IpscId *string `mandatory:"true" contributesTo:"path" name:"ipscId"`

	// 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
}

GetIPSecConnectionDeviceConfigRequest wrapper for the GetIPSecConnectionDeviceConfig operation

func (GetIPSecConnectionDeviceConfigRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetIPSecConnectionDeviceConfigRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetIPSecConnectionDeviceConfigRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetIPSecConnectionDeviceConfigRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetIPSecConnectionDeviceConfigRequest) String ¶ 

func (request GetIPSecConnectionDeviceConfigRequest) String() string

type GetIPSecConnectionDeviceConfigResponse ¶ 

type GetIPSecConnectionDeviceConfigResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The IpSecConnectionDeviceConfig instance
	IpSecConnectionDeviceConfig `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"`
}

GetIPSecConnectionDeviceConfigResponse wrapper for the GetIPSecConnectionDeviceConfig operation

func (GetIPSecConnectionDeviceConfigResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetIPSecConnectionDeviceConfigResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetIPSecConnectionDeviceConfigResponse) String ¶ 

func (response GetIPSecConnectionDeviceConfigResponse) String() string

type GetIPSecConnectionDeviceStatusRequest ¶ 

type GetIPSecConnectionDeviceStatusRequest struct {

	// The OCID of the IPSec connection.
	IpscId *string `mandatory:"true" contributesTo:"path" name:"ipscId"`

	// 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
}

GetIPSecConnectionDeviceStatusRequest wrapper for the GetIPSecConnectionDeviceStatus operation

func (GetIPSecConnectionDeviceStatusRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetIPSecConnectionDeviceStatusRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetIPSecConnectionDeviceStatusRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetIPSecConnectionDeviceStatusRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetIPSecConnectionDeviceStatusRequest) String ¶ 

func (request GetIPSecConnectionDeviceStatusRequest) String() string

type GetIPSecConnectionDeviceStatusResponse ¶ 

type GetIPSecConnectionDeviceStatusResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The IpSecConnectionDeviceStatus instance
	IpSecConnectionDeviceStatus `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"`
}

GetIPSecConnectionDeviceStatusResponse wrapper for the GetIPSecConnectionDeviceStatus operation

func (GetIPSecConnectionDeviceStatusResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetIPSecConnectionDeviceStatusResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetIPSecConnectionDeviceStatusResponse) String ¶ 

func (response GetIPSecConnectionDeviceStatusResponse) String() string

type GetIPSecConnectionRequest ¶ 

type GetIPSecConnectionRequest struct {

	// The OCID of the IPSec connection.
	IpscId *string `mandatory:"true" contributesTo:"path" name:"ipscId"`

	// 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
}

GetIPSecConnectionRequest wrapper for the GetIPSecConnection operation

func (GetIPSecConnectionRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetIPSecConnectionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetIPSecConnectionRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetIPSecConnectionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetIPSecConnectionRequest) String ¶ 

func (request GetIPSecConnectionRequest) String() string

type GetIPSecConnectionResponse ¶ 

type GetIPSecConnectionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The IpSecConnection instance
	IpSecConnection `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"`
}

GetIPSecConnectionResponse wrapper for the GetIPSecConnection operation

func (GetIPSecConnectionResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetIPSecConnectionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetIPSecConnectionResponse) String ¶ 

func (response GetIPSecConnectionResponse) String() string

type GetImageRequest ¶ 

type GetImageRequest struct {

	// The OCID of the image.
	ImageId *string `mandatory:"true" contributesTo:"path" name:"imageId"`

	// 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
}

GetImageRequest wrapper for the GetImage operation

func (GetImageRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetImageRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetImageRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetImageRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetImageRequest) String ¶ 

func (request GetImageRequest) String() string

type GetImageResponse ¶ 

type GetImageResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Image instance
	Image `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"`
}

GetImageResponse wrapper for the GetImage operation

func (GetImageResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetImageResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetImageResponse) String ¶ 

func (response GetImageResponse) String() string

type GetInstanceConfigurationRequest ¶ 

type GetInstanceConfigurationRequest struct {

	// The OCID of the instance configuration.
	InstanceConfigurationId *string `mandatory:"true" contributesTo:"path" name:"instanceConfigurationId"`

	// 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
}

GetInstanceConfigurationRequest wrapper for the GetInstanceConfiguration operation

func (GetInstanceConfigurationRequest) HTTPRequest ¶ 

func (request GetInstanceConfigurationRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetInstanceConfigurationRequest) RetryPolicy ¶ 

func (request GetInstanceConfigurationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetInstanceConfigurationRequest) String ¶ 

func (request GetInstanceConfigurationRequest) String() string

type GetInstanceConfigurationResponse ¶ 

type GetInstanceConfigurationResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The InstanceConfiguration instance
	InstanceConfiguration `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"`
}

GetInstanceConfigurationResponse wrapper for the GetInstanceConfiguration operation

func (GetInstanceConfigurationResponse) HTTPResponse ¶ 

func (response GetInstanceConfigurationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetInstanceConfigurationResponse) String ¶ 

func (response GetInstanceConfigurationResponse) String() string

type GetInstanceConsoleConnectionRequest ¶ 

type GetInstanceConsoleConnectionRequest struct {

	// The OCID of the intance console connection
	InstanceConsoleConnectionId *string `mandatory:"true" contributesTo:"path" name:"instanceConsoleConnectionId"`

	// 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
}

GetInstanceConsoleConnectionRequest wrapper for the GetInstanceConsoleConnection operation

func (GetInstanceConsoleConnectionRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetInstanceConsoleConnectionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetInstanceConsoleConnectionRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetInstanceConsoleConnectionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetInstanceConsoleConnectionRequest) String ¶ 

func (request GetInstanceConsoleConnectionRequest) String() string

type GetInstanceConsoleConnectionResponse ¶ 

type GetInstanceConsoleConnectionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The InstanceConsoleConnection instance
	InstanceConsoleConnection `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"`
}

GetInstanceConsoleConnectionResponse wrapper for the GetInstanceConsoleConnection operation

func (GetInstanceConsoleConnectionResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetInstanceConsoleConnectionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetInstanceConsoleConnectionResponse) String ¶ 

func (response GetInstanceConsoleConnectionResponse) String() string

type GetInstancePoolRequest ¶ 

type GetInstancePoolRequest struct {

	// The OCID of the instance pool.
	InstancePoolId *string `mandatory:"true" contributesTo:"path" name:"instancePoolId"`

	// 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
}

GetInstancePoolRequest wrapper for the GetInstancePool operation

func (GetInstancePoolRequest) HTTPRequest ¶ 

func (request GetInstancePoolRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetInstancePoolRequest) RetryPolicy ¶ 

func (request GetInstancePoolRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetInstancePoolRequest) String ¶ 

func (request GetInstancePoolRequest) String() string

type GetInstancePoolResponse ¶ 

type GetInstancePoolResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The InstancePool instance
	InstancePool `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"`
}

GetInstancePoolResponse wrapper for the GetInstancePool operation

func (GetInstancePoolResponse) HTTPResponse ¶ 

func (response GetInstancePoolResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetInstancePoolResponse) String ¶ 

func (response GetInstancePoolResponse) String() string

type GetInstanceRequest ¶ 

type GetInstanceRequest struct {

	// The OCID of the instance.
	InstanceId *string `mandatory:"true" contributesTo:"path" 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
}

GetInstanceRequest wrapper for the GetInstance operation

func (GetInstanceRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetInstanceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetInstanceRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetInstanceRequest) String ¶ 

func (request GetInstanceRequest) String() string

type GetInstanceResponse ¶ 

type GetInstanceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Instance instance
	Instance `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"`
}

GetInstanceResponse wrapper for the GetInstance operation

func (GetInstanceResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetInstanceResponse) String ¶ 

func (response GetInstanceResponse) String() string

type GetInternetGatewayRequest ¶ 

type GetInternetGatewayRequest struct {

	// The OCID of the internet gateway.
	IgId *string `mandatory:"true" contributesTo:"path" name:"igId"`

	// 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
}

GetInternetGatewayRequest wrapper for the GetInternetGateway operation

func (GetInternetGatewayRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetInternetGatewayRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetInternetGatewayRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetInternetGatewayRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetInternetGatewayRequest) String ¶ 

func (request GetInternetGatewayRequest) String() string

type GetInternetGatewayResponse ¶ 

type GetInternetGatewayResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The InternetGateway instance
	InternetGateway `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"`
}

GetInternetGatewayResponse wrapper for the GetInternetGateway operation

func (GetInternetGatewayResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetInternetGatewayResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetInternetGatewayResponse) String ¶ 

func (response GetInternetGatewayResponse) String() string

type GetLocalPeeringGatewayRequest ¶ 

type GetLocalPeeringGatewayRequest struct {

	// The OCID of the local peering gateway.
	LocalPeeringGatewayId *string `mandatory:"true" contributesTo:"path" name:"localPeeringGatewayId"`

	// 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
}

GetLocalPeeringGatewayRequest wrapper for the GetLocalPeeringGateway operation

func (GetLocalPeeringGatewayRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetLocalPeeringGatewayRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetLocalPeeringGatewayRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetLocalPeeringGatewayRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetLocalPeeringGatewayRequest) String ¶ 

func (request GetLocalPeeringGatewayRequest) String() string

type GetLocalPeeringGatewayResponse ¶ 

type GetLocalPeeringGatewayResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The LocalPeeringGateway instance
	LocalPeeringGateway `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"`
}

GetLocalPeeringGatewayResponse wrapper for the GetLocalPeeringGateway operation

func (GetLocalPeeringGatewayResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetLocalPeeringGatewayResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetLocalPeeringGatewayResponse) String ¶ 

func (response GetLocalPeeringGatewayResponse) String() string

type GetNatGatewayRequest ¶ 

type GetNatGatewayRequest struct {

	// The NAT gateway's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
	NatGatewayId *string `mandatory:"true" contributesTo:"path" name:"natGatewayId"`

	// 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
}

GetNatGatewayRequest wrapper for the GetNatGateway operation

func (GetNatGatewayRequest) HTTPRequest ¶ 

func (request GetNatGatewayRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetNatGatewayRequest) RetryPolicy ¶ 

func (request GetNatGatewayRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetNatGatewayRequest) String ¶ 

func (request GetNatGatewayRequest) String() string

type GetNatGatewayResponse ¶ 

type GetNatGatewayResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The NatGateway instance
	NatGateway `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"`
}

GetNatGatewayResponse wrapper for the GetNatGateway operation

func (GetNatGatewayResponse) HTTPResponse ¶ 

func (response GetNatGatewayResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetNatGatewayResponse) String ¶ 

func (response GetNatGatewayResponse) String() string

type GetPrivateIpRequest ¶ 

type GetPrivateIpRequest struct {

	// The OCID of the private IP.
	PrivateIpId *string `mandatory:"true" contributesTo:"path" name:"privateIpId"`

	// 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
}

GetPrivateIpRequest wrapper for the GetPrivateIp operation

func (GetPrivateIpRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetPrivateIpRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetPrivateIpRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetPrivateIpRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetPrivateIpRequest) String ¶ 

func (request GetPrivateIpRequest) String() string

type GetPrivateIpResponse ¶ 

type GetPrivateIpResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The PrivateIp instance
	PrivateIp `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"`
}

GetPrivateIpResponse wrapper for the GetPrivateIp operation

func (GetPrivateIpResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetPrivateIpResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetPrivateIpResponse) String ¶ 

func (response GetPrivateIpResponse) String() string

type GetPublicIpByIpAddressDetails ¶ added in v1.1.0 

type GetPublicIpByIpAddressDetails struct {

	// The public IP address.
	// Example: 129.146.2.1
	IpAddress *string `mandatory:"true" json:"ipAddress"`
}

GetPublicIpByIpAddressDetails IP address of the public IP.

func (GetPublicIpByIpAddressDetails) String ¶ added in v1.1.0 

func (m GetPublicIpByIpAddressDetails) String() string

type GetPublicIpByIpAddressRequest ¶ added in v1.1.0 

type GetPublicIpByIpAddressRequest struct {

	// IP address details for fetching the public IP.
	GetPublicIpByIpAddressDetails `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"`

	// 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
}

GetPublicIpByIpAddressRequest wrapper for the GetPublicIpByIpAddress operation

func (GetPublicIpByIpAddressRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetPublicIpByIpAddressRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetPublicIpByIpAddressRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetPublicIpByIpAddressRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetPublicIpByIpAddressRequest) String ¶ added in v1.1.0 

func (request GetPublicIpByIpAddressRequest) String() string

type GetPublicIpByIpAddressResponse ¶ added in v1.1.0 

type GetPublicIpByIpAddressResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The PublicIp instance
	PublicIp `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"`
}

GetPublicIpByIpAddressResponse wrapper for the GetPublicIpByIpAddress operation

func (GetPublicIpByIpAddressResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetPublicIpByIpAddressResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetPublicIpByIpAddressResponse) String ¶ added in v1.1.0 

func (response GetPublicIpByIpAddressResponse) String() string

type GetPublicIpByPrivateIpIdDetails ¶ added in v1.1.0 

type GetPublicIpByPrivateIpIdDetails struct {

	// OCID of the private IP.
	PrivateIpId *string `mandatory:"true" json:"privateIpId"`
}

GetPublicIpByPrivateIpIdDetails Details of the private IP that the public IP is assigned to.

func (GetPublicIpByPrivateIpIdDetails) String ¶ added in v1.1.0 

func (m GetPublicIpByPrivateIpIdDetails) String() string

type GetPublicIpByPrivateIpIdRequest ¶ added in v1.1.0 

type GetPublicIpByPrivateIpIdRequest struct {

	// Private IP details for fetching the public IP.
	GetPublicIpByPrivateIpIdDetails `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"`

	// 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
}

GetPublicIpByPrivateIpIdRequest wrapper for the GetPublicIpByPrivateIpId operation

func (GetPublicIpByPrivateIpIdRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetPublicIpByPrivateIpIdRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetPublicIpByPrivateIpIdRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetPublicIpByPrivateIpIdRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetPublicIpByPrivateIpIdRequest) String ¶ added in v1.1.0 

func (request GetPublicIpByPrivateIpIdRequest) String() string

type GetPublicIpByPrivateIpIdResponse ¶ added in v1.1.0 

type GetPublicIpByPrivateIpIdResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The PublicIp instance
	PublicIp `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"`
}

GetPublicIpByPrivateIpIdResponse wrapper for the GetPublicIpByPrivateIpId operation

func (GetPublicIpByPrivateIpIdResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetPublicIpByPrivateIpIdResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetPublicIpByPrivateIpIdResponse) String ¶ added in v1.1.0 

func (response GetPublicIpByPrivateIpIdResponse) String() string

type GetPublicIpRequest ¶ added in v1.1.0 

type GetPublicIpRequest struct {

	// The OCID of the public IP.
	PublicIpId *string `mandatory:"true" contributesTo:"path" name:"publicIpId"`

	// 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
}

GetPublicIpRequest wrapper for the GetPublicIp operation

func (GetPublicIpRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetPublicIpRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetPublicIpRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetPublicIpRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetPublicIpRequest) String ¶ added in v1.1.0 

func (request GetPublicIpRequest) String() string

type GetPublicIpResponse ¶ added in v1.1.0 

type GetPublicIpResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The PublicIp instance
	PublicIp `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"`
}

GetPublicIpResponse wrapper for the GetPublicIp operation

func (GetPublicIpResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetPublicIpResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetPublicIpResponse) String ¶ added in v1.1.0 

func (response GetPublicIpResponse) String() string

type GetRemotePeeringConnectionRequest ¶ added in v1.2.0 

type GetRemotePeeringConnectionRequest struct {

	// The OCID of the remote peering connection (RPC).
	RemotePeeringConnectionId *string `mandatory:"true" contributesTo:"path" name:"remotePeeringConnectionId"`

	// 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
}

GetRemotePeeringConnectionRequest wrapper for the GetRemotePeeringConnection operation

func (GetRemotePeeringConnectionRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetRemotePeeringConnectionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetRemotePeeringConnectionRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetRemotePeeringConnectionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetRemotePeeringConnectionRequest) String ¶ added in v1.2.0 

func (request GetRemotePeeringConnectionRequest) String() string

type GetRemotePeeringConnectionResponse ¶ added in v1.2.0 

type GetRemotePeeringConnectionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The RemotePeeringConnection instance
	RemotePeeringConnection `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"`
}

GetRemotePeeringConnectionResponse wrapper for the GetRemotePeeringConnection operation

func (GetRemotePeeringConnectionResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetRemotePeeringConnectionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetRemotePeeringConnectionResponse) String ¶ added in v1.2.0 

func (response GetRemotePeeringConnectionResponse) String() string

type GetRouteTableRequest ¶ 

type GetRouteTableRequest struct {

	// The OCID of the route table.
	RtId *string `mandatory:"true" contributesTo:"path" name:"rtId"`

	// 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
}

GetRouteTableRequest wrapper for the GetRouteTable operation

func (GetRouteTableRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetRouteTableRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetRouteTableRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetRouteTableRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetRouteTableRequest) String ¶ 

func (request GetRouteTableRequest) String() string

type GetRouteTableResponse ¶ 

type GetRouteTableResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The RouteTable instance
	RouteTable `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"`
}

GetRouteTableResponse wrapper for the GetRouteTable operation

func (GetRouteTableResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetRouteTableResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetRouteTableResponse) String ¶ 

func (response GetRouteTableResponse) String() string

type GetSecurityListRequest ¶ 

type GetSecurityListRequest struct {

	// The OCID of the security list.
	SecurityListId *string `mandatory:"true" contributesTo:"path" name:"securityListId"`

	// 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
}

GetSecurityListRequest wrapper for the GetSecurityList operation

func (GetSecurityListRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetSecurityListRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetSecurityListRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetSecurityListRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetSecurityListRequest) String ¶ 

func (request GetSecurityListRequest) String() string

type GetSecurityListResponse ¶ 

type GetSecurityListResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The SecurityList instance
	SecurityList `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"`
}

GetSecurityListResponse wrapper for the GetSecurityList operation

func (GetSecurityListResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetSecurityListResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetSecurityListResponse) String ¶ 

func (response GetSecurityListResponse) String() string

type GetServiceGatewayRequest ¶ added in v1.8.0 

type GetServiceGatewayRequest struct {

	// The service gateway's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
	ServiceGatewayId *string `mandatory:"true" contributesTo:"path" name:"serviceGatewayId"`

	// 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
}

GetServiceGatewayRequest wrapper for the GetServiceGateway operation

func (GetServiceGatewayRequest) HTTPRequest ¶ added in v1.8.0 

func (request GetServiceGatewayRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetServiceGatewayRequest) RetryPolicy ¶ added in v1.8.0 

func (request GetServiceGatewayRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetServiceGatewayRequest) String ¶ added in v1.8.0 

func (request GetServiceGatewayRequest) String() string

type GetServiceGatewayResponse ¶ added in v1.8.0 

type GetServiceGatewayResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ServiceGateway instance
	ServiceGateway `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"`
}

GetServiceGatewayResponse wrapper for the GetServiceGateway operation

func (GetServiceGatewayResponse) HTTPResponse ¶ added in v1.8.0 

func (response GetServiceGatewayResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetServiceGatewayResponse) String ¶ added in v1.8.0 

func (response GetServiceGatewayResponse) String() string

type GetServiceRequest ¶ added in v1.8.0 

type GetServiceRequest struct {

	// The service's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
	ServiceId *string `mandatory:"true" contributesTo:"path" name:"serviceId"`

	// 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
}

GetServiceRequest wrapper for the GetService operation

func (GetServiceRequest) HTTPRequest ¶ added in v1.8.0 

func (request GetServiceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetServiceRequest) RetryPolicy ¶ added in v1.8.0 

func (request GetServiceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetServiceRequest) String ¶ added in v1.8.0 

func (request GetServiceRequest) String() string

type GetServiceResponse ¶ added in v1.8.0 

type GetServiceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Service instance
	Service `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"`
}

GetServiceResponse wrapper for the GetService operation

func (GetServiceResponse) HTTPResponse ¶ added in v1.8.0 

func (response GetServiceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetServiceResponse) String ¶ added in v1.8.0 

func (response GetServiceResponse) String() string

type GetSubnetRequest ¶ 

type GetSubnetRequest struct {

	// The OCID of the subnet.
	SubnetId *string `mandatory:"true" contributesTo:"path" name:"subnetId"`

	// 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
}

GetSubnetRequest wrapper for the GetSubnet operation

func (GetSubnetRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetSubnetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetSubnetRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetSubnetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetSubnetRequest) String ¶ 

func (request GetSubnetRequest) String() string

type GetSubnetResponse ¶ 

type GetSubnetResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Subnet instance
	Subnet `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"`
}

GetSubnetResponse wrapper for the GetSubnet operation

func (GetSubnetResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetSubnetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetSubnetResponse) String ¶ 

func (response GetSubnetResponse) String() string

type GetVcnRequest ¶ 

type GetVcnRequest struct {

	// The OCID of the VCN.
	VcnId *string `mandatory:"true" contributesTo:"path" name:"vcnId"`

	// 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
}

GetVcnRequest wrapper for the GetVcn operation

func (GetVcnRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetVcnRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetVcnRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetVcnRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetVcnRequest) String ¶ 

func (request GetVcnRequest) String() string

type GetVcnResponse ¶ 

type GetVcnResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Vcn instance
	Vcn `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"`
}

GetVcnResponse wrapper for the GetVcn operation

func (GetVcnResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetVcnResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetVcnResponse) String ¶ 

func (response GetVcnResponse) String() string

type GetVirtualCircuitRequest ¶ 

type GetVirtualCircuitRequest struct {

	// The OCID of the virtual circuit.
	VirtualCircuitId *string `mandatory:"true" contributesTo:"path" name:"virtualCircuitId"`

	// 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
}

GetVirtualCircuitRequest wrapper for the GetVirtualCircuit operation

func (GetVirtualCircuitRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetVirtualCircuitRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetVirtualCircuitRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetVirtualCircuitRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetVirtualCircuitRequest) String ¶ 

func (request GetVirtualCircuitRequest) String() string

type GetVirtualCircuitResponse ¶ 

type GetVirtualCircuitResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VirtualCircuit instance
	VirtualCircuit `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"`
}

GetVirtualCircuitResponse wrapper for the GetVirtualCircuit operation

func (GetVirtualCircuitResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetVirtualCircuitResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetVirtualCircuitResponse) String ¶ 

func (response GetVirtualCircuitResponse) String() string

type GetVnicAttachmentRequest ¶ 

type GetVnicAttachmentRequest struct {

	// The OCID of the VNIC attachment.
	VnicAttachmentId *string `mandatory:"true" contributesTo:"path" name:"vnicAttachmentId"`

	// 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
}

GetVnicAttachmentRequest wrapper for the GetVnicAttachment operation

func (GetVnicAttachmentRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetVnicAttachmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetVnicAttachmentRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetVnicAttachmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetVnicAttachmentRequest) String ¶ 

func (request GetVnicAttachmentRequest) String() string

type GetVnicAttachmentResponse ¶ 

type GetVnicAttachmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VnicAttachment instance
	VnicAttachment `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"`
}

GetVnicAttachmentResponse wrapper for the GetVnicAttachment operation

func (GetVnicAttachmentResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetVnicAttachmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetVnicAttachmentResponse) String ¶ 

func (response GetVnicAttachmentResponse) String() string

type GetVnicRequest ¶ 

type GetVnicRequest struct {

	// The OCID of the VNIC.
	VnicId *string `mandatory:"true" contributesTo:"path" name:"vnicId"`

	// 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
}

GetVnicRequest wrapper for the GetVnic operation

func (GetVnicRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetVnicRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetVnicRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetVnicRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetVnicRequest) String ¶ 

func (request GetVnicRequest) String() string

type GetVnicResponse ¶ 

type GetVnicResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Vnic instance
	Vnic `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"`
}

GetVnicResponse wrapper for the GetVnic operation

func (GetVnicResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetVnicResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetVnicResponse) String ¶ 

func (response GetVnicResponse) String() string

type GetVolumeAttachmentRequest ¶ 

type GetVolumeAttachmentRequest struct {

	// The OCID of the volume attachment.
	VolumeAttachmentId *string `mandatory:"true" contributesTo:"path" name:"volumeAttachmentId"`

	// 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
}

GetVolumeAttachmentRequest wrapper for the GetVolumeAttachment operation

func (GetVolumeAttachmentRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetVolumeAttachmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetVolumeAttachmentRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetVolumeAttachmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetVolumeAttachmentRequest) String ¶ 

func (request GetVolumeAttachmentRequest) String() string

type GetVolumeAttachmentResponse ¶ 

type GetVolumeAttachmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VolumeAttachment instance
	VolumeAttachment `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"`
}

GetVolumeAttachmentResponse wrapper for the GetVolumeAttachment operation

func (GetVolumeAttachmentResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetVolumeAttachmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetVolumeAttachmentResponse) String ¶ 

func (response GetVolumeAttachmentResponse) String() string

type GetVolumeBackupPolicyAssetAssignmentRequest ¶ added in v1.1.0 

type GetVolumeBackupPolicyAssetAssignmentRequest struct {

	// The OCID of an asset (e.g. a volume).
	AssetId *string `mandatory:"true" contributesTo:"query" name:"assetId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"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 `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
}

GetVolumeBackupPolicyAssetAssignmentRequest wrapper for the GetVolumeBackupPolicyAssetAssignment operation

func (GetVolumeBackupPolicyAssetAssignmentRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetVolumeBackupPolicyAssetAssignmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetVolumeBackupPolicyAssetAssignmentRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetVolumeBackupPolicyAssetAssignmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetVolumeBackupPolicyAssetAssignmentRequest) String ¶ added in v1.1.0 

func (request GetVolumeBackupPolicyAssetAssignmentRequest) String() string

type GetVolumeBackupPolicyAssetAssignmentResponse ¶ added in v1.1.0 

type GetVolumeBackupPolicyAssetAssignmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []VolumeBackupPolicyAssignment instances
	Items []VolumeBackupPolicyAssignment `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.us-phoenix-1.oraclecloud.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"`
}

GetVolumeBackupPolicyAssetAssignmentResponse wrapper for the GetVolumeBackupPolicyAssetAssignment operation

func (GetVolumeBackupPolicyAssetAssignmentResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetVolumeBackupPolicyAssetAssignmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetVolumeBackupPolicyAssetAssignmentResponse) String ¶ added in v1.1.0 

func (response GetVolumeBackupPolicyAssetAssignmentResponse) String() string

type GetVolumeBackupPolicyAssignmentRequest ¶ added in v1.1.0 

type GetVolumeBackupPolicyAssignmentRequest struct {

	// The OCID of the volume backup policy assignment.
	PolicyAssignmentId *string `mandatory:"true" contributesTo:"path" name:"policyAssignmentId"`

	// 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
}

GetVolumeBackupPolicyAssignmentRequest wrapper for the GetVolumeBackupPolicyAssignment operation

func (GetVolumeBackupPolicyAssignmentRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetVolumeBackupPolicyAssignmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetVolumeBackupPolicyAssignmentRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetVolumeBackupPolicyAssignmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetVolumeBackupPolicyAssignmentRequest) String ¶ added in v1.1.0 

func (request GetVolumeBackupPolicyAssignmentRequest) String() string

type GetVolumeBackupPolicyAssignmentResponse ¶ added in v1.1.0 

type GetVolumeBackupPolicyAssignmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VolumeBackupPolicyAssignment instance
	VolumeBackupPolicyAssignment `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"`
}

GetVolumeBackupPolicyAssignmentResponse wrapper for the GetVolumeBackupPolicyAssignment operation

func (GetVolumeBackupPolicyAssignmentResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetVolumeBackupPolicyAssignmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetVolumeBackupPolicyAssignmentResponse) String ¶ added in v1.1.0 

func (response GetVolumeBackupPolicyAssignmentResponse) String() string

type GetVolumeBackupPolicyRequest ¶ added in v1.1.0 

type GetVolumeBackupPolicyRequest struct {

	// The OCID of the volume backup policy.
	PolicyId *string `mandatory:"true" contributesTo:"path" name:"policyId"`

	// 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
}

GetVolumeBackupPolicyRequest wrapper for the GetVolumeBackupPolicy operation

func (GetVolumeBackupPolicyRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetVolumeBackupPolicyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetVolumeBackupPolicyRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetVolumeBackupPolicyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetVolumeBackupPolicyRequest) String ¶ added in v1.1.0 

func (request GetVolumeBackupPolicyRequest) String() string

type GetVolumeBackupPolicyResponse ¶ added in v1.1.0 

type GetVolumeBackupPolicyResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VolumeBackupPolicy instance
	VolumeBackupPolicy `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"`
}

GetVolumeBackupPolicyResponse wrapper for the GetVolumeBackupPolicy operation

func (GetVolumeBackupPolicyResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetVolumeBackupPolicyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetVolumeBackupPolicyResponse) String ¶ added in v1.1.0 

func (response GetVolumeBackupPolicyResponse) String() string

type GetVolumeBackupRequest ¶ 

type GetVolumeBackupRequest struct {

	// The OCID of the volume backup.
	VolumeBackupId *string `mandatory:"true" contributesTo:"path" name:"volumeBackupId"`

	// 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
}

GetVolumeBackupRequest wrapper for the GetVolumeBackup operation

func (GetVolumeBackupRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetVolumeBackupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetVolumeBackupRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetVolumeBackupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetVolumeBackupRequest) String ¶ 

func (request GetVolumeBackupRequest) String() string

type GetVolumeBackupResponse ¶ 

type GetVolumeBackupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VolumeBackup instance
	VolumeBackup `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"`
}

GetVolumeBackupResponse wrapper for the GetVolumeBackup operation

func (GetVolumeBackupResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetVolumeBackupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetVolumeBackupResponse) String ¶ 

func (response GetVolumeBackupResponse) String() string

type GetVolumeGroupBackupRequest ¶ added in v1.6.0 

type GetVolumeGroupBackupRequest struct {

	// The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.
	VolumeGroupBackupId *string `mandatory:"true" contributesTo:"path" name:"volumeGroupBackupId"`

	// 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
}

GetVolumeGroupBackupRequest wrapper for the GetVolumeGroupBackup operation

func (GetVolumeGroupBackupRequest) HTTPRequest ¶ added in v1.6.0 

func (request GetVolumeGroupBackupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetVolumeGroupBackupRequest) RetryPolicy ¶ added in v1.6.0 

func (request GetVolumeGroupBackupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetVolumeGroupBackupRequest) String ¶ added in v1.6.0 

func (request GetVolumeGroupBackupRequest) String() string

type GetVolumeGroupBackupResponse ¶ added in v1.6.0 

type GetVolumeGroupBackupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VolumeGroupBackup instance
	VolumeGroupBackup `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"`
}

GetVolumeGroupBackupResponse wrapper for the GetVolumeGroupBackup operation

func (GetVolumeGroupBackupResponse) HTTPResponse ¶ added in v1.6.0 

func (response GetVolumeGroupBackupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetVolumeGroupBackupResponse) String ¶ added in v1.6.0 

func (response GetVolumeGroupBackupResponse) String() string

type GetVolumeGroupRequest ¶ added in v1.6.0 

type GetVolumeGroupRequest struct {

	// The Oracle Cloud ID (OCID) that uniquely identifies the volume group.
	VolumeGroupId *string `mandatory:"true" contributesTo:"path" name:"volumeGroupId"`

	// 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
}

GetVolumeGroupRequest wrapper for the GetVolumeGroup operation

func (GetVolumeGroupRequest) HTTPRequest ¶ added in v1.6.0 

func (request GetVolumeGroupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetVolumeGroupRequest) RetryPolicy ¶ added in v1.6.0 

func (request GetVolumeGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetVolumeGroupRequest) String ¶ added in v1.6.0 

func (request GetVolumeGroupRequest) String() string

type GetVolumeGroupResponse ¶ added in v1.6.0 

type GetVolumeGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VolumeGroup instance
	VolumeGroup `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"`
}

GetVolumeGroupResponse wrapper for the GetVolumeGroup operation

func (GetVolumeGroupResponse) HTTPResponse ¶ added in v1.6.0 

func (response GetVolumeGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetVolumeGroupResponse) String ¶ added in v1.6.0 

func (response GetVolumeGroupResponse) String() string

type GetVolumeKmsKeyRequest ¶ 

type GetVolumeKmsKeyRequest struct {

	// The OCID of the volume.
	VolumeId *string `mandatory:"true" contributesTo:"path" name:"volumeId"`

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

	// 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
}

GetVolumeKmsKeyRequest wrapper for the GetVolumeKmsKey operation

func (GetVolumeKmsKeyRequest) HTTPRequest ¶ 

func (request GetVolumeKmsKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetVolumeKmsKeyRequest) RetryPolicy ¶ 

func (request GetVolumeKmsKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetVolumeKmsKeyRequest) String ¶ 

func (request GetVolumeKmsKeyRequest) String() string

type GetVolumeKmsKeyResponse ¶ 

type GetVolumeKmsKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VolumeKmsKey instance
	VolumeKmsKey `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"`
}

GetVolumeKmsKeyResponse wrapper for the GetVolumeKmsKey operation

func (GetVolumeKmsKeyResponse) HTTPResponse ¶ 

func (response GetVolumeKmsKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetVolumeKmsKeyResponse) String ¶ 

func (response GetVolumeKmsKeyResponse) String() string

type GetVolumeRequest ¶ 

type GetVolumeRequest struct {

	// The OCID of the volume.
	VolumeId *string `mandatory:"true" contributesTo:"path" name:"volumeId"`

	// 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
}

GetVolumeRequest wrapper for the GetVolume operation

func (GetVolumeRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetVolumeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetVolumeRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetVolumeRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetVolumeRequest) String ¶ 

func (request GetVolumeRequest) String() string

type GetVolumeResponse ¶ 

type GetVolumeResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Volume instance
	Volume `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"`
}

GetVolumeResponse wrapper for the GetVolume operation

func (GetVolumeResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetVolumeResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetVolumeResponse) String ¶ 

func (response GetVolumeResponse) String() string

type GetWindowsInstanceInitialCredentialsRequest ¶ 

type GetWindowsInstanceInitialCredentialsRequest struct {

	// The OCID of the instance.
	InstanceId *string `mandatory:"true" contributesTo:"path" 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
}

GetWindowsInstanceInitialCredentialsRequest wrapper for the GetWindowsInstanceInitialCredentials operation

func (GetWindowsInstanceInitialCredentialsRequest) HTTPRequest ¶ added in v1.3.0 

func (request GetWindowsInstanceInitialCredentialsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWindowsInstanceInitialCredentialsRequest) RetryPolicy ¶ added in v1.3.0 

func (request GetWindowsInstanceInitialCredentialsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetWindowsInstanceInitialCredentialsRequest) String ¶ 

func (request GetWindowsInstanceInitialCredentialsRequest) String() string

type GetWindowsInstanceInitialCredentialsResponse ¶ 

type GetWindowsInstanceInitialCredentialsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The InstanceCredentials instance
	InstanceCredentials `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"`
}

GetWindowsInstanceInitialCredentialsResponse wrapper for the GetWindowsInstanceInitialCredentials operation

func (GetWindowsInstanceInitialCredentialsResponse) HTTPResponse ¶ added in v1.3.0 

func (response GetWindowsInstanceInitialCredentialsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetWindowsInstanceInitialCredentialsResponse) String ¶ 

func (response GetWindowsInstanceInitialCredentialsResponse) String() string

type IScsiVolumeAttachment ¶ 

type IScsiVolumeAttachment struct {

	// The availability domain of an instance.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

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

	// The OCID of the volume attachment.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the instance the volume is attached to.
	InstanceId *string `mandatory:"true" json:"instanceId"`

	// The date and time the volume was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The OCID of the volume.
	VolumeId *string `mandatory:"true" json:"volumeId"`

	// The volume's iSCSI IP address.
	// Example: `169.254.0.2`
	Ipv4 *string `mandatory:"true" json:"ipv4"`

	// The target volume's iSCSI Qualified Name in the format defined by RFC 3720.
	// Example: `iqn.2015-12.us.oracle.com:456b0391-17b8-4122-bbf1-f85fc0bb97d9`
	Iqn *string `mandatory:"true" json:"iqn"`

	// The volume's iSCSI port.
	// Example: `3260`
	Port *int `mandatory:"true" json:"port"`

	// The device name.
	Device *string `mandatory:"false" json:"device"`

	// A user-friendly name. Does not have to be unique, and it cannot be changed.
	// Avoid entering confidential information.
	// Example: `My volume attachment`
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Whether the attachment was created in read-only mode.
	IsReadOnly *bool `mandatory:"false" json:"isReadOnly"`

	// Whether the enable encryption in transit for the PV volume attachment is on or not.
	IsPvEncryptionInTransitEnabled *bool `mandatory:"false" json:"isPvEncryptionInTransitEnabled"`

	// The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name.
	// (Also called the "CHAP password".)
	// Example: `d6866c0d-298b-48ba-95af-309b4faux45e`
	ChapSecret *string `mandatory:"false" json:"chapSecret"`

	// The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name.
	// Example: `ocid1.volume.oc1.phx.abyhqljrgvttnlx73nmrwfaux7kcvzfs3s66izvxf2h4lgvyndsdsnoiwr5q`
	ChapUsername *string `mandatory:"false" json:"chapUsername"`

	// The current state of the volume attachment.
	LifecycleState VolumeAttachmentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}

IScsiVolumeAttachment An ISCSI volume attachment.

func (IScsiVolumeAttachment) GetAvailabilityDomain ¶ 

func (m IScsiVolumeAttachment) GetAvailabilityDomain() *string

GetAvailabilityDomain returns AvailabilityDomain

func (IScsiVolumeAttachment) GetCompartmentId ¶ 

func (m IScsiVolumeAttachment) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (IScsiVolumeAttachment) GetDevice ¶ 

func (m IScsiVolumeAttachment) GetDevice() *string

GetDevice returns Device

func (IScsiVolumeAttachment) GetDisplayName ¶ 

func (m IScsiVolumeAttachment) GetDisplayName() *string

GetDisplayName returns DisplayName

func (IScsiVolumeAttachment) GetId ¶ 

func (m IScsiVolumeAttachment) GetId() *string

GetId returns Id

func (IScsiVolumeAttachment) GetInstanceId ¶ 

func (m IScsiVolumeAttachment) GetInstanceId() *string

GetInstanceId returns InstanceId

func (IScsiVolumeAttachment) GetIsPvEncryptionInTransitEnabled ¶ 

func (m IScsiVolumeAttachment) GetIsPvEncryptionInTransitEnabled() *bool

GetIsPvEncryptionInTransitEnabled returns IsPvEncryptionInTransitEnabled

func (IScsiVolumeAttachment) GetIsReadOnly ¶ added in v1.1.0 

func (m IScsiVolumeAttachment) GetIsReadOnly() *bool

GetIsReadOnly returns IsReadOnly

func (IScsiVolumeAttachment) GetLifecycleState ¶ 

func (m IScsiVolumeAttachment) GetLifecycleState() VolumeAttachmentLifecycleStateEnum

GetLifecycleState returns LifecycleState

func (IScsiVolumeAttachment) GetTimeCreated ¶ 

func (m IScsiVolumeAttachment) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (IScsiVolumeAttachment) GetVolumeId ¶ 

func (m IScsiVolumeAttachment) GetVolumeId() *string

GetVolumeId returns VolumeId

func (IScsiVolumeAttachment) MarshalJSON ¶ 

func (m IScsiVolumeAttachment) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (IScsiVolumeAttachment) String ¶ 

func (m IScsiVolumeAttachment) String() string

type IcmpOptions ¶ 

type IcmpOptions struct {

	// The ICMP type.
	Type *int `mandatory:"true" json:"type"`

	// The ICMP code (optional).
	Code *int `mandatory:"false" json:"code"`
}

IcmpOptions Optional object to specify a particular ICMP type and code. If you specify ICMP as the protocol but do not provide this object, then all ICMP types and codes are allowed. If you do provide this object, the type is required and the code is optional. See ICMP Parameters (http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) for allowed values. To enable MTU negotiation for ingress internet traffic, make sure to allow type 3 ("Destination Unreachable") code 4 ("Fragmentation Needed and Don't Fragment was Set"). If you need to specify multiple codes for a single type, create a separate security list rule for each.

func (IcmpOptions) String ¶ 

func (m IcmpOptions) String() string

type Image ¶ 

type Image struct {

	// The OCID of the compartment containing the instance you want to use as the basis for the image.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Whether instances launched with this image can be used to create new images.
	// For example, you cannot create an image of an Oracle Database instance.
	// Example: `true`
	CreateImageAllowed *bool `mandatory:"true" json:"createImageAllowed"`

	// The OCID of the image.
	Id *string `mandatory:"true" json:"id"`

	LifecycleState ImageLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The image's operating system.
	// Example: `Oracle Linux`
	OperatingSystem *string `mandatory:"true" json:"operatingSystem"`

	// The image's operating system version.
	// Example: `7.2`
	OperatingSystemVersion *string `mandatory:"true" json:"operatingSystemVersion"`

	// The date and time the image was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The OCID of the image originally used to launch the instance.
	BaseImageId *string `mandatory:"false" json:"baseImageId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name for the image. It does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	// You cannot use an Oracle-provided image name as a custom image name.
	// Example: `My custom Oracle Linux image`
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
	// * `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for Oracle-provided images.
	// * `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
	// * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using virtio drivers.
	// * `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.
	LaunchMode ImageLaunchModeEnum `mandatory:"false" json:"launchMode,omitempty"`

	LaunchOptions *LaunchOptions `mandatory:"false" json:"launchOptions"`

	// Image size (1 MB = 1048576 bytes)
	// Example: `47694`
	SizeInMBs *int64 `mandatory:"false" json:"sizeInMBs"`
}

Image A boot disk image for launching an instance. For more information, see Overview of the Compute Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Concepts/computeoverview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (Image) String ¶ 

func (m Image) String() string

type ImageLaunchModeEnum ¶ added in v1.1.0 

type ImageLaunchModeEnum string

ImageLaunchModeEnum Enum with underlying type: string 

const (
	ImageLaunchModeNative          ImageLaunchModeEnum = "NATIVE"
	ImageLaunchModeEmulated        ImageLaunchModeEnum = "EMULATED"
	ImageLaunchModeParavirtualized ImageLaunchModeEnum = "PARAVIRTUALIZED"
	ImageLaunchModeCustom          ImageLaunchModeEnum = "CUSTOM"
)

Set of constants representing the allowable values for ImageLaunchModeEnum

func GetImageLaunchModeEnumValues ¶ added in v1.1.0 

func GetImageLaunchModeEnumValues() []ImageLaunchModeEnum

GetImageLaunchModeEnumValues Enumerates the set of values for ImageLaunchModeEnum

type ImageLifecycleStateEnum ¶ 

type ImageLifecycleStateEnum string

ImageLifecycleStateEnum Enum with underlying type: string 

const (
	ImageLifecycleStateProvisioning ImageLifecycleStateEnum = "PROVISIONING"
	ImageLifecycleStateImporting    ImageLifecycleStateEnum = "IMPORTING"
	ImageLifecycleStateAvailable    ImageLifecycleStateEnum = "AVAILABLE"
	ImageLifecycleStateExporting    ImageLifecycleStateEnum = "EXPORTING"
	ImageLifecycleStateDisabled     ImageLifecycleStateEnum = "DISABLED"
	ImageLifecycleStateDeleted      ImageLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for ImageLifecycleStateEnum

func GetImageLifecycleStateEnumValues ¶ 

func GetImageLifecycleStateEnumValues() []ImageLifecycleStateEnum

GetImageLifecycleStateEnumValues Enumerates the set of values for ImageLifecycleStateEnum

type ImageSourceDetails ¶ 

type ImageSourceDetails interface {

	// The format of the image to be imported.  Exported Oracle images are QCOW2.  Only monolithic
	// images are supported.
	GetSourceImageType() ImageSourceDetailsSourceImageTypeEnum
}

ImageSourceDetails The representation of ImageSourceDetails

type ImageSourceDetailsSourceImageTypeEnum ¶ added in v1.1.0 

type ImageSourceDetailsSourceImageTypeEnum string

ImageSourceDetailsSourceImageTypeEnum Enum with underlying type: string 

const (
	ImageSourceDetailsSourceImageTypeQcow2 ImageSourceDetailsSourceImageTypeEnum = "QCOW2"
	ImageSourceDetailsSourceImageTypeVmdk  ImageSourceDetailsSourceImageTypeEnum = "VMDK"
)

Set of constants representing the allowable values for ImageSourceDetailsSourceImageTypeEnum

func GetImageSourceDetailsSourceImageTypeEnumValues ¶ added in v1.1.0 

func GetImageSourceDetailsSourceImageTypeEnumValues() []ImageSourceDetailsSourceImageTypeEnum

GetImageSourceDetailsSourceImageTypeEnumValues Enumerates the set of values for ImageSourceDetailsSourceImageTypeEnum

type ImageSourceViaObjectStorageTupleDetails ¶ 

type ImageSourceViaObjectStorageTupleDetails struct {

	// The Object Storage bucket for the image.
	BucketName *string `mandatory:"true" json:"bucketName"`

	// The Object Storage namespace for the image.
	NamespaceName *string `mandatory:"true" json:"namespaceName"`

	// The Object Storage name for the image.
	ObjectName *string `mandatory:"true" json:"objectName"`

	// The format of the image to be imported.  Exported Oracle images are QCOW2.  Only monolithic
	// images are supported.
	SourceImageType ImageSourceDetailsSourceImageTypeEnum `mandatory:"false" json:"sourceImageType,omitempty"`
}

ImageSourceViaObjectStorageTupleDetails The representation of ImageSourceViaObjectStorageTupleDetails

func (ImageSourceViaObjectStorageTupleDetails) GetSourceImageType ¶ added in v1.1.0 

func (m ImageSourceViaObjectStorageTupleDetails) GetSourceImageType() ImageSourceDetailsSourceImageTypeEnum

GetSourceImageType returns SourceImageType

func (ImageSourceViaObjectStorageTupleDetails) MarshalJSON ¶ 

func (m ImageSourceViaObjectStorageTupleDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ImageSourceViaObjectStorageTupleDetails) String ¶ 

func (m ImageSourceViaObjectStorageTupleDetails) String() string

type ImageSourceViaObjectStorageUriDetails ¶ 

type ImageSourceViaObjectStorageUriDetails struct {

	// The Object Storage URL for the image.
	SourceUri *string `mandatory:"true" json:"sourceUri"`

	// The format of the image to be imported.  Exported Oracle images are QCOW2.  Only monolithic
	// images are supported.
	SourceImageType ImageSourceDetailsSourceImageTypeEnum `mandatory:"false" json:"sourceImageType,omitempty"`
}

ImageSourceViaObjectStorageUriDetails The representation of ImageSourceViaObjectStorageUriDetails

func (ImageSourceViaObjectStorageUriDetails) GetSourceImageType ¶ added in v1.1.0 

func (m ImageSourceViaObjectStorageUriDetails) GetSourceImageType() ImageSourceDetailsSourceImageTypeEnum

GetSourceImageType returns SourceImageType

func (ImageSourceViaObjectStorageUriDetails) MarshalJSON ¶ 

func (m ImageSourceViaObjectStorageUriDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ImageSourceViaObjectStorageUriDetails) String ¶ 

func (m ImageSourceViaObjectStorageUriDetails) String() string

type IngressSecurityRule ¶ 

type IngressSecurityRule struct {

	// The transport protocol. Specify either `all` or an IPv4 protocol number as
	// defined in
	// Protocol Numbers (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
	// Options are supported only for ICMP ("1"), TCP ("6"), and UDP ("17").
	Protocol *string `mandatory:"true" json:"protocol"`

	// Conceptually, this is the range of IP addresses that a packet coming into the instance
	// can come from.
	// Allowed values:
	//   * IP address range in CIDR notation. For example: `192.168.1.0/24`
	//   * The `cidrBlock` value for a Service, if you're
	//     setting up a security list rule for traffic coming from a particular service through
	//     a service gateway. For example: `oci-phx-objectstorage`
	Source *string `mandatory:"true" json:"source"`

	// Optional and valid only for ICMP. Use to specify a particular ICMP type and code
	// as defined in
	// ICMP Parameters (http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml).
	// If you specify ICMP as the protocol but omit this object, then all ICMP types and
	// codes are allowed. If you do provide this object, the type is required and the code is optional.
	// To enable MTU negotiation for ingress internet traffic, make sure to allow type 3 ("Destination
	// Unreachable") code 4 ("Fragmentation Needed and Don't Fragment was Set"). If you need to specify
	// multiple codes for a single type, create a separate security list rule for each.
	IcmpOptions *IcmpOptions `mandatory:"false" json:"icmpOptions"`

	// A stateless rule allows traffic in one direction. Remember to add a corresponding
	// stateless rule in the other direction if you need to support bidirectional traffic. For
	// example, if ingress traffic allows TCP destination port 80, there should be an egress
	// rule to allow TCP source port 80. Defaults to false, which means the rule is stateful
	// and a corresponding rule is not necessary for bidirectional traffic.
	IsStateless *bool `mandatory:"false" json:"isStateless"`

	// Type of source for the rule. The default is `CIDR_BLOCK`.
	//   * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation.
	//   * `SERVICE_CIDR_BLOCK`: If the rule's `source` is the `cidrBlock` value for a
	//     Service (the rule is for traffic coming from a
	//     particular service through a service gateway).
	SourceType IngressSecurityRuleSourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`

	// Optional and valid only for TCP. Use to specify particular destination ports for TCP rules.
	// If you specify TCP as the protocol but omit this object, then all destination ports are allowed.
	TcpOptions *TcpOptions `mandatory:"false" json:"tcpOptions"`

	// Optional and valid only for UDP. Use to specify particular destination ports for UDP rules.
	// If you specify UDP as the protocol but omit this object, then all destination ports are allowed.
	UdpOptions *UdpOptions `mandatory:"false" json:"udpOptions"`
}

IngressSecurityRule A rule for allowing inbound IP packets.

func (IngressSecurityRule) String ¶ 

func (m IngressSecurityRule) String() string

type IngressSecurityRuleSourceTypeEnum ¶ added in v1.8.0 

type IngressSecurityRuleSourceTypeEnum string

IngressSecurityRuleSourceTypeEnum Enum with underlying type: string 

const (
	IngressSecurityRuleSourceTypeCidrBlock        IngressSecurityRuleSourceTypeEnum = "CIDR_BLOCK"
	IngressSecurityRuleSourceTypeServiceCidrBlock IngressSecurityRuleSourceTypeEnum = "SERVICE_CIDR_BLOCK"
)

Set of constants representing the allowable values for IngressSecurityRuleSourceTypeEnum

func GetIngressSecurityRuleSourceTypeEnumValues ¶ added in v1.8.0 

func GetIngressSecurityRuleSourceTypeEnumValues() []IngressSecurityRuleSourceTypeEnum

GetIngressSecurityRuleSourceTypeEnumValues Enumerates the set of values for IngressSecurityRuleSourceTypeEnum

type Instance ¶ 

type Instance struct {

	// The availability domain the instance is running in.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The OCID of the compartment that contains the instance.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the instance.
	Id *string `mandatory:"true" json:"id"`

	// The current state of the instance.
	LifecycleState InstanceLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The region that contains the availability domain the instance is running in.
	// Example: `phx`
	Region *string `mandatory:"true" json:"region"`

	// The shape of the instance. The shape determines the number of CPUs and the amount of memory
	// allocated to the instance. You can enumerate all available shapes by calling
	// ListShapes.
	Shape *string `mandatory:"true" json:"shape"`

	// The date and time the instance was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	// Example: `My bare metal instance`
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the 'metadata' object.
	// They are distinguished from 'metadata' fields in that these can be nested JSON objects (whereas 'metadata' fields are string/string maps only).
	ExtendedMetadata map[string]interface{} `mandatory:"false" json:"extendedMetadata"`

	// The name of the fault domain the instance is running in.
	// A fault domain is a grouping of hardware and infrastructure within an availability domain.
	// Each availability domain contains three fault domains. Fault domains let you distribute your
	// instances so that they are not on the same physical hardware within a single availability domain.
	// A hardware failure or Compute hardware maintenance that affects one fault domain does not affect
	// instances in other fault domains.
	// If you do not specify the fault domain, the system selects one for you. To change the fault
	// domain for an instance, terminate it and launch a new instance in the preferred fault domain.
	// Example: `FAULT-DOMAIN-1`
	FaultDomain *string `mandatory:"false" json:"faultDomain"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Deprecated. Use `sourceDetails` instead.
	ImageId *string `mandatory:"false" json:"imageId"`

	// When a bare metal or virtual machine
	// instance boots, the iPXE firmware that runs on the instance is
	// configured to run an iPXE script to continue the boot process.
	// If you want more control over the boot process, you can provide
	// your own custom iPXE script that will run when the instance boots;
	// however, you should be aware that the same iPXE script will run
	// every time an instance boots; not only after the initial
	// LaunchInstance call.
	// The default iPXE script connects to the instance's local boot
	// volume over iSCSI and performs a network boot. If you use a custom iPXE
	// script and want to network-boot from the instance's local boot volume
	// over iSCSI the same way as the default iPXE script, you should use the
	// following iSCSI IP address: 169.254.0.2, and boot volume IQN:
	// iqn.2015-02.oracle.boot.
	// For more information about the Bring Your Own Image feature of
	// Oracle Cloud Infrastructure, see
	// Bring Your Own Image (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/References/bringyourownimage.htm).
	// For more information about iPXE, see http://ipxe.org.
	IpxeScript *string `mandatory:"false" json:"ipxeScript"`

	// Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
	// * `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for Oracle-provided images.
	// * `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
	// * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using virtio drivers.
	// * `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.
	LaunchMode InstanceLaunchModeEnum `mandatory:"false" json:"launchMode,omitempty"`

	LaunchOptions *LaunchOptions `mandatory:"false" json:"launchOptions"`

	// Custom metadata that you provide.
	Metadata map[string]string `mandatory:"false" json:"metadata"`

	// Details for creating an instance
	SourceDetails InstanceSourceDetails `mandatory:"false" json:"sourceDetails"`

	// The date and time the instance is expected to be stopped / started,  in the format defined by RFC3339.
	// After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time.
	// Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state.
	// Example: `2018-05-25T21:10:29.600Z`
	TimeMaintenanceRebootDue *common.SDKTime `mandatory:"false" json:"timeMaintenanceRebootDue"`
}

Instance A compute host. The image used to launch the instance determines its operating system and other software. The shape specified during the launch process determines the number of CPUs and memory allocated to the instance. For more information, see Overview of the Compute Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Concepts/computeoverview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (Instance) String ¶ 

func (m Instance) String() string

func (*Instance) UnmarshalJSON ¶ 

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

UnmarshalJSON unmarshals from json

type InstanceActionActionEnum ¶ 

type InstanceActionActionEnum string

InstanceActionActionEnum Enum with underlying type: string 

const (
	InstanceActionActionStop      InstanceActionActionEnum = "STOP"
	InstanceActionActionStart     InstanceActionActionEnum = "START"
	InstanceActionActionSoftreset InstanceActionActionEnum = "SOFTRESET"
	InstanceActionActionReset     InstanceActionActionEnum = "RESET"
	InstanceActionActionSoftstop  InstanceActionActionEnum = "SOFTSTOP"
)

Set of constants representing the allowable values for InstanceActionActionEnum

func GetInstanceActionActionEnumValues ¶ 

func GetInstanceActionActionEnumValues() []InstanceActionActionEnum

GetInstanceActionActionEnumValues Enumerates the set of values for InstanceActionActionEnum

type InstanceActionRequest ¶ 

type InstanceActionRequest struct {

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

	// The action to perform on the instance.
	Action InstanceActionActionEnum `mandatory:"true" contributesTo:"query" name:"action" omitEmpty:"true"`

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

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

	// 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
}

InstanceActionRequest wrapper for the InstanceAction operation

func (InstanceActionRequest) HTTPRequest ¶ added in v1.3.0 

func (request InstanceActionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (InstanceActionRequest) RetryPolicy ¶ added in v1.3.0 

func (request InstanceActionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (InstanceActionRequest) String ¶ 

func (request InstanceActionRequest) String() string

type InstanceActionResponse ¶ 

type InstanceActionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Instance instance
	Instance `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"`
}

InstanceActionResponse wrapper for the InstanceAction operation

func (InstanceActionResponse) HTTPResponse ¶ added in v1.3.0 

func (response InstanceActionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (InstanceActionResponse) String ¶ 

func (response InstanceActionResponse) String() string

type InstanceConfiguration ¶ 

type InstanceConfiguration struct {

	// The OCID of the compartment containing the instance configuration.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the instance configuration
	Id *string `mandatory:"true" json:"id"`

	// The date and time the instance configuration was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name for the instance configuration
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	InstanceDetails InstanceConfigurationInstanceDetails `mandatory:"false" json:"instanceDetails"`

	DeferredFields []string `mandatory:"false" json:"deferredFields"`
}

InstanceConfiguration Instance Configuration

func (InstanceConfiguration) String ¶ 

func (m InstanceConfiguration) String() string

func (*InstanceConfiguration) UnmarshalJSON ¶ 

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

UnmarshalJSON unmarshals from json

type InstanceConfigurationAttachVnicDetails ¶ 

type InstanceConfigurationAttachVnicDetails struct {

	// Details for creating a new VNIC.
	CreateVnicDetails *InstanceConfigurationCreateVnicDetails `mandatory:"false" json:"createVnicDetails"`

	// A user-friendly name for the attachment. Does not have to be unique, and it cannot be changed.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Which physical network interface card (NIC) the VNIC will use. Defaults to 0.
	// Certain bare metal instance shapes have two active physical NICs (0 and 1). If
	// you add a secondary VNIC to one of these instances, you can specify which NIC
	// the VNIC will use. For more information, see
	// Virtual Network Interface Cards (VNICs) (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm).
	NicIndex *int `mandatory:"false" json:"nicIndex"`
}

InstanceConfigurationAttachVnicDetails The representation of InstanceConfigurationAttachVnicDetails

func (InstanceConfigurationAttachVnicDetails) String ¶ 

func (m InstanceConfigurationAttachVnicDetails) String() string

type InstanceConfigurationAttachVolumeDetails ¶ 

type InstanceConfigurationAttachVolumeDetails interface {

	// A user-friendly name. Does not have to be unique, and it cannot be changed. Avoid entering confidential information.
	GetDisplayName() *string

	// Whether the attachment should be created in read-only mode.
	GetIsReadOnly() *bool
}

InstanceConfigurationAttachVolumeDetails Volume attachmentDetails. Please see AttachVolumeDetails

type InstanceConfigurationBlockVolumeDetails ¶ 

type InstanceConfigurationBlockVolumeDetails struct {
	AttachDetails InstanceConfigurationAttachVolumeDetails `mandatory:"false" json:"attachDetails"`

	CreateDetails *InstanceConfigurationCreateVolumeDetails `mandatory:"false" json:"createDetails"`

	// The OCID of the volume.
	VolumeId *string `mandatory:"false" json:"volumeId"`
}

InstanceConfigurationBlockVolumeDetails Create new block volumes or attach to an existing volume. Specify either createDetails or volumeId.

func (InstanceConfigurationBlockVolumeDetails) String ¶ 

func (m InstanceConfigurationBlockVolumeDetails) String() string

func (*InstanceConfigurationBlockVolumeDetails) UnmarshalJSON ¶ 

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

UnmarshalJSON unmarshals from json

type InstanceConfigurationCreateVnicDetails ¶ 

type InstanceConfigurationCreateVnicDetails struct {
	AssignPublicIp *bool `mandatory:"false" json:"assignPublicIp"`

	// A user-friendly name for the VNIC. Does not have to be unique.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`

	PrivateIp *string `mandatory:"false" json:"privateIp"`

	SkipSourceDestCheck *bool `mandatory:"false" json:"skipSourceDestCheck"`

	SubnetId *string `mandatory:"false" json:"subnetId"`
}

InstanceConfigurationCreateVnicDetails Please see CreateVnicDetails

func (InstanceConfigurationCreateVnicDetails) String ¶ 

func (m InstanceConfigurationCreateVnicDetails) String() string

type InstanceConfigurationCreateVolumeDetails ¶ 

type InstanceConfigurationCreateVolumeDetails struct {

	// The availability domain of the volume.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`

	// If provided, specifies the ID of the volume backup policy to assign to the newly
	// created volume. If omitted, no policy will be assigned.
	BackupPolicyId *string `mandatory:"false" json:"backupPolicyId"`

	// The OCID of the compartment that contains the volume.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The size of the volume in GBs.
	SizeInGBs *int64 `mandatory:"false" json:"sizeInGBs"`

	// Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same availability domain or a Block volume backup.
	// This is an optional field. If not specified or set to null, the new Block volume will be empty.
	// When specified, the new Block volume will contain data from the source volume or backup.
	SourceDetails InstanceConfigurationVolumeSourceDetails `mandatory:"false" json:"sourceDetails"`
}

InstanceConfigurationCreateVolumeDetails Creates a new block volume. Please see CreateVolumeDetails

func (InstanceConfigurationCreateVolumeDetails) String ¶ 

func (m InstanceConfigurationCreateVolumeDetails) String() string

func (*InstanceConfigurationCreateVolumeDetails) UnmarshalJSON ¶ 

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

UnmarshalJSON unmarshals from json

type InstanceConfigurationInstanceDetails ¶ 

type InstanceConfigurationInstanceDetails interface {
}

InstanceConfigurationInstanceDetails The representation of InstanceConfigurationInstanceDetails

type InstanceConfigurationInstanceSourceDetails ¶ 

type InstanceConfigurationInstanceSourceDetails interface {
}

InstanceConfigurationInstanceSourceDetails The representation of InstanceConfigurationInstanceSourceDetails

type InstanceConfigurationInstanceSourceViaBootVolumeDetails ¶ 

type InstanceConfigurationInstanceSourceViaBootVolumeDetails struct {

	// The OCID of the boot volume used to boot the instance.
	BootVolumeId *string `mandatory:"false" json:"bootVolumeId"`
}

InstanceConfigurationInstanceSourceViaBootVolumeDetails The representation of InstanceConfigurationInstanceSourceViaBootVolumeDetails

func (InstanceConfigurationInstanceSourceViaBootVolumeDetails) MarshalJSON ¶ 

func (m InstanceConfigurationInstanceSourceViaBootVolumeDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (InstanceConfigurationInstanceSourceViaBootVolumeDetails) String ¶ 

func (m InstanceConfigurationInstanceSourceViaBootVolumeDetails) String() string

type InstanceConfigurationInstanceSourceViaImageDetails ¶ 

type InstanceConfigurationInstanceSourceViaImageDetails struct {

	// The OCID of the image used to boot the instance.
	ImageId *string `mandatory:"false" json:"imageId"`
}

InstanceConfigurationInstanceSourceViaImageDetails The representation of InstanceConfigurationInstanceSourceViaImageDetails

func (InstanceConfigurationInstanceSourceViaImageDetails) MarshalJSON ¶ 

func (m InstanceConfigurationInstanceSourceViaImageDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (InstanceConfigurationInstanceSourceViaImageDetails) String ¶ 

func (m InstanceConfigurationInstanceSourceViaImageDetails) String() string

type InstanceConfigurationIscsiAttachVolumeDetails ¶ 

type InstanceConfigurationIscsiAttachVolumeDetails struct {

	// A user-friendly name. Does not have to be unique, and it cannot be changed. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Whether the attachment should be created in read-only mode.
	IsReadOnly *bool `mandatory:"false" json:"isReadOnly"`

	// Whether to use CHAP authentication for the volume attachment. Defaults to false.
	UseChap *bool `mandatory:"false" json:"useChap"`
}

InstanceConfigurationIscsiAttachVolumeDetails The representation of InstanceConfigurationIscsiAttachVolumeDetails

func (InstanceConfigurationIscsiAttachVolumeDetails) GetDisplayName ¶ 

func (m InstanceConfigurationIscsiAttachVolumeDetails) GetDisplayName() *string

GetDisplayName returns DisplayName

func (InstanceConfigurationIscsiAttachVolumeDetails) GetIsReadOnly ¶ 

func (m InstanceConfigurationIscsiAttachVolumeDetails) GetIsReadOnly() *bool

GetIsReadOnly returns IsReadOnly

func (InstanceConfigurationIscsiAttachVolumeDetails) MarshalJSON ¶ 

func (m InstanceConfigurationIscsiAttachVolumeDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (InstanceConfigurationIscsiAttachVolumeDetails) String ¶ 

func (m InstanceConfigurationIscsiAttachVolumeDetails) String() string

type InstanceConfigurationLaunchInstanceDetails ¶ 

type InstanceConfigurationLaunchInstanceDetails struct {

	// The availability domain of the instance.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// Details for the primary VNIC, which is automatically created and attached when
	// the instance is launched.
	CreateVnicDetails *InstanceConfigurationCreateVnicDetails `mandatory:"false" json:"createVnicDetails"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	// Example: `My bare metal instance`
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the 'metadata' object.
	// They are distinguished from 'metadata' fields in that these can be nested JSON objects (whereas 'metadata' fields are string/string maps only).
	ExtendedMetadata map[string]interface{} `mandatory:"false" json:"extendedMetadata"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// This is an advanced option.
	// When a bare metal or virtual machine
	// instance boots, the iPXE firmware that runs on the instance is
	// configured to run an iPXE script to continue the boot process.
	// If you want more control over the boot process, you can provide
	// your own custom iPXE script that will run when the instance boots;
	// however, you should be aware that the same iPXE script will run
	// every time an instance boots; not only after the initial
	// LaunchInstance call.
	// The default iPXE script connects to the instance's local boot
	// volume over iSCSI and performs a network boot. If you use a custom iPXE
	// script and want to network-boot from the instance's local boot volume
	// over iSCSI the same way as the default iPXE script, you should use the
	// following iSCSI IP address: 169.254.0.2, and boot volume IQN:
	// iqn.2015-02.oracle.boot.
	// For more information about the Bring Your Own Image feature of
	// Oracle Cloud Infrastructure, see
	// Bring Your Own Image (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/References/bringyourownimage.htm).
	// For more information about iPXE, see http://ipxe.org.
	IpxeScript *string `mandatory:"false" json:"ipxeScript"`

	// Custom metadata key/value pairs that you provide, such as the SSH public key
	// required to connect to the instance.
	// A metadata service runs on every launched instance. The service is an HTTP
	// endpoint listening on 169.254.169.254. You can use the service to:
	// * Provide information to Cloud-Init (https://cloudinit.readthedocs.org/en/latest/)
	//   to be used for various system initialization tasks.
	// * Get information about the instance, including the custom metadata that you
	//   provide when you launch the instance.
	//  **Providing Cloud-Init Metadata**
	//  You can use the following metadata key names to provide information to
	//  Cloud-Init:
	//  **"ssh_authorized_keys"** - Provide one or more public SSH keys to be
	//  included in the `~/.ssh/authorized_keys` file for the default user on the
	//  instance. Use a newline character to separate multiple keys. The SSH
	//  keys must be in the format necessary for the `authorized_keys` file, as shown
	//  in the example below.
	//  **"user_data"** - Provide your own base64-encoded data to be used by
	//  Cloud-Init to run custom scripts or provide custom Cloud-Init configuration. For
	//  information about how to take advantage of user data, see the
	//  Cloud-Init Documentation (http://cloudinit.readthedocs.org/en/latest/topics/format.html).
	//  **Note:** Cloud-Init does not pull this data from the `http://169.254.169.254/opc/v1/instance/metadata/`
	//  path. When the instance launches and either of these keys are provided, the key values are formatted as
	//  OpenStack metadata and copied to the following locations, which are recognized by Cloud-Init:
	//  `http://169.254.169.254/openstack/latest/meta_data.json` - This JSON blob
	//  contains, among other things, the SSH keys that you provided for
	//   **"ssh_authorized_keys"**.
	//  `http://169.254.169.254/openstack/latest/user_data` - Contains the
	//  base64-decoded data that you provided for **"user_data"**.
	//  **Metadata Example**
	//       "metadata" : {
	//          "quake_bot_level" : "Severe",
	//          "ssh_authorized_keys" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCZ06fccNTQfq+xubFlJ5ZR3kt+uzspdH9tXL+lAejSM1NXM+CFZev7MIxfEjas06y80ZBZ7DUTQO0GxJPeD8NCOb1VorF8M4xuLwrmzRtkoZzU16umt4y1W0Q4ifdp3IiiU0U8/WxczSXcUVZOLqkz5dc6oMHdMVpkimietWzGZ4LBBsH/LjEVY7E0V+a0sNchlVDIZcm7ErReBLcdTGDq0uLBiuChyl6RUkX1PNhusquTGwK7zc8OBXkRuubn5UKXhI3Ul9Nyk4XESkVWIGNKmw8mSpoJSjR8P9ZjRmcZVo8S+x4KVPMZKQEor== ryan.smith@company.com
	//          ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAzJSAtwEPoB3Jmr58IXrDGzLuDYkWAYg8AsLYlo6JZvKpjY1xednIcfEVQJm4T2DhVmdWhRrwQ8DmayVZvBkLt+zs2LdoAJEVimKwXcJFD/7wtH8Lnk17HiglbbbNXsemjDY0hea4JUE5CfvkIdZBITuMrfqSmA4n3VNoorXYdvtTMoGG8fxMub46RPtuxtqi9bG9Zqenordkg5FJt2mVNfQRqf83CWojcOkklUWq4CjyxaeLf5i9gv1fRoBo4QhiA8I6NCSppO8GnoV/6Ox6TNoh9BiifqGKC9VGYuC89RvUajRBTZSK2TK4DPfaT+2R+slPsFrwiT/oPEhhEK1S5Q== rsa-key-20160227",
	//          "user_data" : "SWYgeW91IGNhbiBzZWUgdGhpcywgdGhlbiBpdCB3b3JrZWQgbWF5YmUuCg=="
	//       }
	//  **Getting Metadata on the Instance**
	//  To get information about your instance, connect to the instance using SSH and issue any of the
	//  following GET requests:
	//      curl http://169.254.169.254/opc/v1/instance/
	//      curl http://169.254.169.254/opc/v1/instance/metadata/
	//      curl http://169.254.169.254/opc/v1/instance/metadata/<any-key-name>
	//  You'll get back a response that includes all the instance information; only the metadata information; or
	//  the metadata information for the specified key name, respectively.
	Metadata map[string]string `mandatory:"false" json:"metadata"`

	// The shape of an instance. The shape determines the number of CPUs, amount of memory,
	// and other resources allocated to the instance.
	// You can enumerate all available shapes by calling ListShapes.
	Shape *string `mandatory:"false" json:"shape"`

	// Details for creating an instance.
	// Use this parameter to specify whether a boot volume or an image should be used to launch a new instance.
	SourceDetails InstanceConfigurationInstanceSourceDetails `mandatory:"false" json:"sourceDetails"`
}

InstanceConfigurationLaunchInstanceDetails See Instance launch details - LaunchInstanceDetails

func (InstanceConfigurationLaunchInstanceDetails) String ¶ 

func (m InstanceConfigurationLaunchInstanceDetails) String() string

func (*InstanceConfigurationLaunchInstanceDetails) UnmarshalJSON ¶ 

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

UnmarshalJSON unmarshals from json

type InstanceConfigurationParavirtualizedAttachVolumeDetails ¶ 

type InstanceConfigurationParavirtualizedAttachVolumeDetails struct {

	// A user-friendly name. Does not have to be unique, and it cannot be changed. Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Whether the attachment should be created in read-only mode.
	IsReadOnly *bool `mandatory:"false" json:"isReadOnly"`
}

InstanceConfigurationParavirtualizedAttachVolumeDetails The representation of InstanceConfigurationParavirtualizedAttachVolumeDetails

func (InstanceConfigurationParavirtualizedAttachVolumeDetails) GetDisplayName ¶ 

func (m InstanceConfigurationParavirtualizedAttachVolumeDetails) GetDisplayName() *string

GetDisplayName returns DisplayName

func (InstanceConfigurationParavirtualizedAttachVolumeDetails) GetIsReadOnly ¶ 

func (m InstanceConfigurationParavirtualizedAttachVolumeDetails) GetIsReadOnly() *bool

GetIsReadOnly returns IsReadOnly

func (InstanceConfigurationParavirtualizedAttachVolumeDetails) MarshalJSON ¶ 

func (m InstanceConfigurationParavirtualizedAttachVolumeDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (InstanceConfigurationParavirtualizedAttachVolumeDetails) String ¶ 

func (m InstanceConfigurationParavirtualizedAttachVolumeDetails) String() string

type InstanceConfigurationSummary ¶ 

type InstanceConfigurationSummary struct {

	// The OCID of the compartment containing the instance configuration.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the instance configuration
	Id *string `mandatory:"true" json:"id"`

	// The date and time the instance configuration was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// A user-friendly name for the instance configuration
	DisplayName *string `mandatory:"false" json:"displayName"`
}

InstanceConfigurationSummary Instance Configuration Summary

func (InstanceConfigurationSummary) String ¶ 

func (m InstanceConfigurationSummary) String() string

type InstanceConfigurationVolumeSourceDetails ¶ 

type InstanceConfigurationVolumeSourceDetails interface {
}

InstanceConfigurationVolumeSourceDetails The representation of InstanceConfigurationVolumeSourceDetails

type InstanceConfigurationVolumeSourceFromVolumeBackupDetails ¶ 

type InstanceConfigurationVolumeSourceFromVolumeBackupDetails struct {

	// The OCID of the volume backup.
	Id *string `mandatory:"false" json:"id"`
}

InstanceConfigurationVolumeSourceFromVolumeBackupDetails Specifies the volume backup.

func (InstanceConfigurationVolumeSourceFromVolumeBackupDetails) MarshalJSON ¶ 

func (m InstanceConfigurationVolumeSourceFromVolumeBackupDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (InstanceConfigurationVolumeSourceFromVolumeBackupDetails) String ¶ 

func (m InstanceConfigurationVolumeSourceFromVolumeBackupDetails) String() string

type InstanceConfigurationVolumeSourceFromVolumeDetails ¶ 

type InstanceConfigurationVolumeSourceFromVolumeDetails struct {

	// The OCID of the volume.
	Id *string `mandatory:"false" json:"id"`
}

InstanceConfigurationVolumeSourceFromVolumeDetails Specifies the source volume.

func (InstanceConfigurationVolumeSourceFromVolumeDetails) MarshalJSON ¶ 

func (m InstanceConfigurationVolumeSourceFromVolumeDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (InstanceConfigurationVolumeSourceFromVolumeDetails) String ¶ 

func (m InstanceConfigurationVolumeSourceFromVolumeDetails) String() string

type InstanceConsoleConnection ¶ 

type InstanceConsoleConnection struct {

	// The OCID of the compartment to contain the console connection.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The SSH connection string for the console connection.
	ConnectionString *string `mandatory:"false" json:"connectionString"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// The SSH public key fingerprint for the console connection.
	Fingerprint *string `mandatory:"false" json:"fingerprint"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The OCID of the console connection.
	Id *string `mandatory:"false" json:"id"`

	// The OCID of the instance the console connection connects to.
	InstanceId *string `mandatory:"false" json:"instanceId"`

	// The current state of the console connection.
	LifecycleState InstanceConsoleConnectionLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The SSH connection string for the SSH tunnel used to
	// connect to the console connection over VNC.
	VncConnectionString *string `mandatory:"false" json:"vncConnectionString"`
}

InstanceConsoleConnection The `InstanceConsoleConnection` API provides you with console access to virtual machine (VM) instances, enabling you to troubleshoot malfunctioning instances remotely. For more information about console access, see Accessing the Console (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/References/serialconsole.htm).

func (InstanceConsoleConnection) String ¶ 

func (m InstanceConsoleConnection) String() string

type InstanceConsoleConnectionLifecycleStateEnum ¶ 

type InstanceConsoleConnectionLifecycleStateEnum string

InstanceConsoleConnectionLifecycleStateEnum Enum with underlying type: string 

const (
	InstanceConsoleConnectionLifecycleStateActive   InstanceConsoleConnectionLifecycleStateEnum = "ACTIVE"
	InstanceConsoleConnectionLifecycleStateCreating InstanceConsoleConnectionLifecycleStateEnum = "CREATING"
	InstanceConsoleConnectionLifecycleStateDeleted  InstanceConsoleConnectionLifecycleStateEnum = "DELETED"
	InstanceConsoleConnectionLifecycleStateDeleting InstanceConsoleConnectionLifecycleStateEnum = "DELETING"
	InstanceConsoleConnectionLifecycleStateFailed   InstanceConsoleConnectionLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for InstanceConsoleConnectionLifecycleStateEnum

func GetInstanceConsoleConnectionLifecycleStateEnumValues ¶ 

func GetInstanceConsoleConnectionLifecycleStateEnumValues() []InstanceConsoleConnectionLifecycleStateEnum

GetInstanceConsoleConnectionLifecycleStateEnumValues Enumerates the set of values for InstanceConsoleConnectionLifecycleStateEnum

type InstanceCredentials ¶ 

type InstanceCredentials struct {

	// The password for the username.
	Password *string `mandatory:"true" json:"password"`

	// The username.
	Username *string `mandatory:"true" json:"username"`
}

InstanceCredentials The credentials for a particular instance.

func (InstanceCredentials) String ¶ 

func (m InstanceCredentials) String() string

type InstanceLaunchModeEnum ¶ added in v1.1.0 

type InstanceLaunchModeEnum string

InstanceLaunchModeEnum Enum with underlying type: string 

const (
	InstanceLaunchModeNative          InstanceLaunchModeEnum = "NATIVE"
	InstanceLaunchModeEmulated        InstanceLaunchModeEnum = "EMULATED"
	InstanceLaunchModeParavirtualized InstanceLaunchModeEnum = "PARAVIRTUALIZED"
	InstanceLaunchModeCustom          InstanceLaunchModeEnum = "CUSTOM"
)

Set of constants representing the allowable values for InstanceLaunchModeEnum

func GetInstanceLaunchModeEnumValues ¶ added in v1.1.0 

func GetInstanceLaunchModeEnumValues() []InstanceLaunchModeEnum

GetInstanceLaunchModeEnumValues Enumerates the set of values for InstanceLaunchModeEnum

type InstanceLifecycleStateEnum ¶ 

type InstanceLifecycleStateEnum string

InstanceLifecycleStateEnum Enum with underlying type: string 

const (
	InstanceLifecycleStateProvisioning  InstanceLifecycleStateEnum = "PROVISIONING"
	InstanceLifecycleStateRunning       InstanceLifecycleStateEnum = "RUNNING"
	InstanceLifecycleStateStarting      InstanceLifecycleStateEnum = "STARTING"
	InstanceLifecycleStateStopping      InstanceLifecycleStateEnum = "STOPPING"
	InstanceLifecycleStateStopped       InstanceLifecycleStateEnum = "STOPPED"
	InstanceLifecycleStateCreatingImage InstanceLifecycleStateEnum = "CREATING_IMAGE"
	InstanceLifecycleStateTerminating   InstanceLifecycleStateEnum = "TERMINATING"
	InstanceLifecycleStateTerminated    InstanceLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for InstanceLifecycleStateEnum

func GetInstanceLifecycleStateEnumValues ¶ 

func GetInstanceLifecycleStateEnumValues() []InstanceLifecycleStateEnum

GetInstanceLifecycleStateEnumValues Enumerates the set of values for InstanceLifecycleStateEnum

type InstancePool ¶ 

type InstancePool struct {

	// The OCID of the instance pool
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the compartment containing the instance pool
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the instance configuration associated to the intance pool.
	InstanceConfigurationId *string `mandatory:"true" json:"instanceConfigurationId"`

	// The current state of the instance pool.
	LifecycleState InstancePoolLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The placement configurations for the instance pool.
	PlacementConfigurations []InstancePoolPlacementConfiguration `mandatory:"true" json:"placementConfigurations"`

	// The number of instances that should be in the instance pool.
	Size *int `mandatory:"true" json:"size"`

	// The date and time the instance pool was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// The user-friendly name.  Does not have to be unique.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

InstancePool Instance Pool

func (InstancePool) String ¶ 

func (m InstancePool) String() string

type InstancePoolLifecycleStateEnum ¶ 

type InstancePoolLifecycleStateEnum string

InstancePoolLifecycleStateEnum Enum with underlying type: string 

const (
	InstancePoolLifecycleStateProvisioning InstancePoolLifecycleStateEnum = "PROVISIONING"
	InstancePoolLifecycleStateScaling      InstancePoolLifecycleStateEnum = "SCALING"
	InstancePoolLifecycleStateStarting     InstancePoolLifecycleStateEnum = "STARTING"
	InstancePoolLifecycleStateStopping     InstancePoolLifecycleStateEnum = "STOPPING"
	InstancePoolLifecycleStateTerminating  InstancePoolLifecycleStateEnum = "TERMINATING"
	InstancePoolLifecycleStateStopped      InstancePoolLifecycleStateEnum = "STOPPED"
	InstancePoolLifecycleStateTerminated   InstancePoolLifecycleStateEnum = "TERMINATED"
	InstancePoolLifecycleStateRunning      InstancePoolLifecycleStateEnum = "RUNNING"
)

Set of constants representing the allowable values for InstancePoolLifecycleStateEnum

func GetInstancePoolLifecycleStateEnumValues ¶ 

func GetInstancePoolLifecycleStateEnumValues() []InstancePoolLifecycleStateEnum

GetInstancePoolLifecycleStateEnumValues Enumerates the set of values for InstancePoolLifecycleStateEnum

type InstancePoolPlacementConfiguration ¶ 

type InstancePoolPlacementConfiguration struct {

	// The availability domain to place instances.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The OCID of the primary subnet to place instances.
	PrimarySubnetId *string `mandatory:"true" json:"primarySubnetId"`

	// The set of secondary VNIC data for instances in the pool.
	SecondaryVnicSubnets []InstancePoolPlacementSecondaryVnicSubnet `mandatory:"false" json:"secondaryVnicSubnets"`
}

InstancePoolPlacementConfiguration The location for where an instance pool will place instances.

func (InstancePoolPlacementConfiguration) String ¶ 

func (m InstancePoolPlacementConfiguration) String() string

type InstancePoolPlacementSecondaryVnicSubnet ¶ 

type InstancePoolPlacementSecondaryVnicSubnet struct {

	// The subnet OCID for the secondary vnic
	SubnetId *string `mandatory:"true" json:"subnetId"`

	// The displayName of the vnic. This is also use to match against the Instance Configuration defined
	// secondary vnic.
	DisplayName *string `mandatory:"false" json:"displayName"`
}

InstancePoolPlacementSecondaryVnicSubnet The secondary VNIC object for the placement configuration for an instance pool.

func (InstancePoolPlacementSecondaryVnicSubnet) String ¶ 

func (m InstancePoolPlacementSecondaryVnicSubnet) String() string

type InstancePoolSummary ¶ 

type InstancePoolSummary struct {

	// The OCID of the instance pool
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the compartment containing the instance pool
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the instance configuration associated to the intance pool.
	InstanceConfigurationId *string `mandatory:"true" json:"instanceConfigurationId"`

	// The current state of the instance pool.
	LifecycleState InstancePoolSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The availability domains for the instance pool.
	AvailabilityDomains []string `mandatory:"true" json:"availabilityDomains"`

	// The number of instances that should be in the instance pool.
	Size *int `mandatory:"true" json:"size"`

	// The date and time the instance pool was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The user-friendly name.  Does not have to be unique.
	DisplayName *string `mandatory:"false" json:"displayName"`
}

InstancePoolSummary Condensed InstancePool data when listing instance pools.

func (InstancePoolSummary) String ¶ 

func (m InstancePoolSummary) String() string

type InstancePoolSummaryLifecycleStateEnum ¶ 

type InstancePoolSummaryLifecycleStateEnum string

InstancePoolSummaryLifecycleStateEnum Enum with underlying type: string 

const (
	InstancePoolSummaryLifecycleStateProvisioning InstancePoolSummaryLifecycleStateEnum = "PROVISIONING"
	InstancePoolSummaryLifecycleStateScaling      InstancePoolSummaryLifecycleStateEnum = "SCALING"
	InstancePoolSummaryLifecycleStateStarting     InstancePoolSummaryLifecycleStateEnum = "STARTING"
	InstancePoolSummaryLifecycleStateStopping     InstancePoolSummaryLifecycleStateEnum = "STOPPING"
	InstancePoolSummaryLifecycleStateTerminating  InstancePoolSummaryLifecycleStateEnum = "TERMINATING"
	InstancePoolSummaryLifecycleStateStopped      InstancePoolSummaryLifecycleStateEnum = "STOPPED"
	InstancePoolSummaryLifecycleStateTerminated   InstancePoolSummaryLifecycleStateEnum = "TERMINATED"
	InstancePoolSummaryLifecycleStateRunning      InstancePoolSummaryLifecycleStateEnum = "RUNNING"
)

Set of constants representing the allowable values for InstancePoolSummaryLifecycleStateEnum

func GetInstancePoolSummaryLifecycleStateEnumValues ¶ 

func GetInstancePoolSummaryLifecycleStateEnumValues() []InstancePoolSummaryLifecycleStateEnum

GetInstancePoolSummaryLifecycleStateEnumValues Enumerates the set of values for InstancePoolSummaryLifecycleStateEnum

type InstanceSourceDetails ¶ 

type InstanceSourceDetails interface {
}

InstanceSourceDetails The representation of InstanceSourceDetails

type InstanceSourceViaBootVolumeDetails ¶ 

type InstanceSourceViaBootVolumeDetails struct {

	// The OCID of the boot volume used to boot the instance.
	BootVolumeId *string `mandatory:"true" json:"bootVolumeId"`
}

InstanceSourceViaBootVolumeDetails The representation of InstanceSourceViaBootVolumeDetails

func (InstanceSourceViaBootVolumeDetails) MarshalJSON ¶ 

func (m InstanceSourceViaBootVolumeDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (InstanceSourceViaBootVolumeDetails) String ¶ 

func (m InstanceSourceViaBootVolumeDetails) String() string

type InstanceSourceViaImageDetails ¶ 

type InstanceSourceViaImageDetails struct {

	// The OCID of the image used to boot the instance.
	ImageId *string `mandatory:"true" json:"imageId"`

	// The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 16384 GB (16TB).
	BootVolumeSizeInGBs *int64 `mandatory:"false" json:"bootVolumeSizeInGBs"`

	// The OCID of the KMS key to be used as the master encryption key for the boot volume.
	KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
}

InstanceSourceViaImageDetails The representation of InstanceSourceViaImageDetails

func (InstanceSourceViaImageDetails) MarshalJSON ¶ 

func (m InstanceSourceViaImageDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (InstanceSourceViaImageDetails) String ¶ 

func (m InstanceSourceViaImageDetails) String() string

type InstanceSummary ¶ 

type InstanceSummary struct {

	// The OCID of the instance
	Id *string `mandatory:"true" json:"id"`

	// The availability domain the instance is running in.
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The OCID of the compartment that contains the instance.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the instance confgiuration used to create the instance.
	InstanceConfigurationId *string `mandatory:"true" json:"instanceConfigurationId"`

	// The region that contains the availability domain the instance is running in.
	Region *string `mandatory:"true" json:"region"`

	// The current state of the instance pool instance.
	State *string `mandatory:"true" json:"state"`

	// The date and time the instance pool instance was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The user-friendly name.  Does not have to be unique.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The name of the Fault Domain the instance is running in.
	FaultDomain *string `mandatory:"false" json:"faultDomain"`

	// The shape of an instance. The shape determines the number of CPUs, amount of memory,
	// and other resources allocated to the instance.
	// You can enumerate all available shapes by calling ListShapes.
	Shape *string `mandatory:"false" json:"shape"`
}

InstanceSummary Condensed instance data when listing instances in an instance pool.

func (InstanceSummary) String ¶ 

func (m InstanceSummary) String() string

type InternetGateway ¶ 

type InternetGateway struct {

	// The OCID of the compartment containing the internet gateway.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The internet gateway's Oracle ID (OCID).
	Id *string `mandatory:"true" json:"id"`

	// The internet gateway's current state.
	LifecycleState InternetGatewayLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The OCID of the VCN the internet gateway belongs to.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Whether the gateway is enabled. When the gateway is disabled, traffic is not
	// routed to/from the Internet, regardless of route rules.
	IsEnabled *bool `mandatory:"false" json:"isEnabled"`

	// The date and time the internet gateway was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

InternetGateway Represents a router that connects the edge of a VCN with the Internet. For an example scenario that uses an internet gateway, see Typical Networking Service Scenarios (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm#scenarios). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (InternetGateway) String ¶ 

func (m InternetGateway) String() string

type InternetGatewayLifecycleStateEnum ¶ 

type InternetGatewayLifecycleStateEnum string

InternetGatewayLifecycleStateEnum Enum with underlying type: string 

const (
	InternetGatewayLifecycleStateProvisioning InternetGatewayLifecycleStateEnum = "PROVISIONING"
	InternetGatewayLifecycleStateAvailable    InternetGatewayLifecycleStateEnum = "AVAILABLE"
	InternetGatewayLifecycleStateTerminating  InternetGatewayLifecycleStateEnum = "TERMINATING"
	InternetGatewayLifecycleStateTerminated   InternetGatewayLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for InternetGatewayLifecycleStateEnum

func GetInternetGatewayLifecycleStateEnumValues ¶ 

func GetInternetGatewayLifecycleStateEnumValues() []InternetGatewayLifecycleStateEnum

GetInternetGatewayLifecycleStateEnumValues Enumerates the set of values for InternetGatewayLifecycleStateEnum

type IpSecConnection ¶ 

type IpSecConnection struct {

	// The OCID of the compartment containing the IPSec connection.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the CPE.
	CpeId *string `mandatory:"true" json:"cpeId"`

	// The OCID of the DRG.
	DrgId *string `mandatory:"true" json:"drgId"`

	// The IPSec connection's Oracle ID (OCID).
	Id *string `mandatory:"true" json:"id"`

	// The IPSec connection's current state.
	LifecycleState IpSecConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Static routes to the CPE. At least one route must be included. The CIDR must not be a
	// multicast address or class E address.
	// Example: `10.0.1.0/24`
	StaticRoutes []string `mandatory:"true" json:"staticRoutes"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The date and time the IPSec connection was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

IpSecConnection A connection between a DRG and CPE. This connection consists of multiple IPSec tunnels. Creating this connection is one of the steps required when setting up an IPSec VPN. For more information, see Overview of the Networking Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (IpSecConnection) String ¶ 

func (m IpSecConnection) String() string

type IpSecConnectionDeviceConfig ¶ 

type IpSecConnectionDeviceConfig struct {

	// The OCID of the compartment containing the IPSec connection.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The IPSec connection's Oracle ID (OCID).
	Id *string `mandatory:"true" json:"id"`

	// The date and time the IPSec connection was created.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Two TunnelConfig objects.
	Tunnels []TunnelConfig `mandatory:"false" json:"tunnels"`
}

IpSecConnectionDeviceConfig Information about the IPSecConnection device configuration.

func (IpSecConnectionDeviceConfig) String ¶ 

func (m IpSecConnectionDeviceConfig) String() string

type IpSecConnectionDeviceStatus ¶ 

type IpSecConnectionDeviceStatus struct {

	// The OCID of the compartment containing the IPSec connection.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The IPSec connection's Oracle ID (OCID).
	Id *string `mandatory:"true" json:"id"`

	// The date and time the IPSec connection was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Two TunnelStatus objects.
	Tunnels []TunnelStatus `mandatory:"false" json:"tunnels"`
}

IpSecConnectionDeviceStatus Status of the IPSec connection.

func (IpSecConnectionDeviceStatus) String ¶ 

func (m IpSecConnectionDeviceStatus) String() string

type IpSecConnectionLifecycleStateEnum ¶ 

type IpSecConnectionLifecycleStateEnum string

IpSecConnectionLifecycleStateEnum Enum with underlying type: string 

const (
	IpSecConnectionLifecycleStateProvisioning IpSecConnectionLifecycleStateEnum = "PROVISIONING"
	IpSecConnectionLifecycleStateAvailable    IpSecConnectionLifecycleStateEnum = "AVAILABLE"
	IpSecConnectionLifecycleStateTerminating  IpSecConnectionLifecycleStateEnum = "TERMINATING"
	IpSecConnectionLifecycleStateTerminated   IpSecConnectionLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for IpSecConnectionLifecycleStateEnum

func GetIpSecConnectionLifecycleStateEnumValues ¶ 

func GetIpSecConnectionLifecycleStateEnumValues() []IpSecConnectionLifecycleStateEnum

GetIpSecConnectionLifecycleStateEnumValues Enumerates the set of values for IpSecConnectionLifecycleStateEnum

type LaunchInstanceConfigurationRequest ¶ 

type LaunchInstanceConfigurationRequest struct {

	// The OCID of the instance configuration.
	InstanceConfigurationId *string `mandatory:"true" contributesTo:"path" name:"instanceConfigurationId"`

	// Instance configuration Instance Details
	InstanceConfiguration InstanceConfigurationInstanceDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

LaunchInstanceConfigurationRequest wrapper for the LaunchInstanceConfiguration operation

func (LaunchInstanceConfigurationRequest) HTTPRequest ¶ 

func (request LaunchInstanceConfigurationRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (LaunchInstanceConfigurationRequest) RetryPolicy ¶ 

func (request LaunchInstanceConfigurationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (LaunchInstanceConfigurationRequest) String ¶ 

func (request LaunchInstanceConfigurationRequest) String() string

type LaunchInstanceConfigurationResponse ¶ 

type LaunchInstanceConfigurationResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Instance instance
	Instance `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"`
}

LaunchInstanceConfigurationResponse wrapper for the LaunchInstanceConfiguration operation

func (LaunchInstanceConfigurationResponse) HTTPResponse ¶ 

func (response LaunchInstanceConfigurationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (LaunchInstanceConfigurationResponse) String ¶ 

func (response LaunchInstanceConfigurationResponse) String() string

type LaunchInstanceDetails ¶ 

type LaunchInstanceDetails struct {

	// The availability domain of the instance.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

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

	// The shape of an instance. The shape determines the number of CPUs, amount of memory,
	// and other resources allocated to the instance.
	// You can enumerate all available shapes by calling ListShapes.
	Shape *string `mandatory:"true" json:"shape"`

	// Details for the primary VNIC, which is automatically created and attached when
	// the instance is launched.
	CreateVnicDetails *CreateVnicDetails `mandatory:"false" json:"createVnicDetails"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	// Example: `My bare metal instance`
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the 'metadata' object.
	// They are distinguished from 'metadata' fields in that these can be nested JSON objects (whereas 'metadata' fields are string/string maps only).
	ExtendedMetadata map[string]interface{} `mandatory:"false" json:"extendedMetadata"`

	// A fault domain is a grouping of hardware and infrastructure within an availability domain.
	// Each availability domain contains three fault domains. Fault domains let you distribute your
	// instances so that they are not on the same physical hardware within a single availability domain.
	// A hardware failure or Compute hardware maintenance that affects one fault domain does not affect
	// instances in other fault domains.
	// If you do not specify the fault domain, the system selects one for you. To change the fault
	// domain for an instance, terminate it and launch a new instance in the preferred fault domain.
	// To get a list of fault domains, use the
	// ListFaultDomains operation in the
	// Identity and Access Management Service API.
	// Example: `FAULT-DOMAIN-1`
	FaultDomain *string `mandatory:"false" json:"faultDomain"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Deprecated. Instead use `hostnameLabel` in
	// CreateVnicDetails.
	// If you provide both, the values must match.
	HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`

	// Deprecated. Use `sourceDetails` with InstanceSourceViaImageDetails
	// source type instead. If you specify values for both, the values must match.
	ImageId *string `mandatory:"false" json:"imageId"`

	// This is an advanced option.
	// When a bare metal or virtual machine
	// instance boots, the iPXE firmware that runs on the instance is
	// configured to run an iPXE script to continue the boot process.
	// If you want more control over the boot process, you can provide
	// your own custom iPXE script that will run when the instance boots;
	// however, you should be aware that the same iPXE script will run
	// every time an instance boots; not only after the initial
	// LaunchInstance call.
	// The default iPXE script connects to the instance's local boot
	// volume over iSCSI and performs a network boot. If you use a custom iPXE
	// script and want to network-boot from the instance's local boot volume
	// over iSCSI the same way as the default iPXE script, you should use the
	// following iSCSI IP address: 169.254.0.2, and boot volume IQN:
	// iqn.2015-02.oracle.boot.
	// For more information about the Bring Your Own Image feature of
	// Oracle Cloud Infrastructure, see
	// Bring Your Own Image (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/References/bringyourownimage.htm).
	// For more information about iPXE, see http://ipxe.org.
	IpxeScript *string `mandatory:"false" json:"ipxeScript"`

	// Custom metadata key/value pairs that you provide, such as the SSH public key
	// required to connect to the instance.
	// A metadata service runs on every launched instance. The service is an HTTP
	// endpoint listening on 169.254.169.254. You can use the service to:
	// * Provide information to Cloud-Init (https://cloudinit.readthedocs.org/en/latest/)
	//   to be used for various system initialization tasks.
	// * Get information about the instance, including the custom metadata that you
	//   provide when you launch the instance.
	//  **Providing Cloud-Init Metadata**
	//  You can use the following metadata key names to provide information to
	//  Cloud-Init:
	//  **"ssh_authorized_keys"** - Provide one or more public SSH keys to be
	//  included in the `~/.ssh/authorized_keys` file for the default user on the
	//  instance. Use a newline character to separate multiple keys. The SSH
	//  keys must be in the format necessary for the `authorized_keys` file, as shown
	//  in the example below.
	//  **"user_data"** - Provide your own base64-encoded data to be used by
	//  Cloud-Init to run custom scripts or provide custom Cloud-Init configuration. For
	//  information about how to take advantage of user data, see the
	//  Cloud-Init Documentation (http://cloudinit.readthedocs.org/en/latest/topics/format.html).
	//  **Note:** Cloud-Init does not pull this data from the `http://169.254.169.254/opc/v1/instance/metadata/`
	//  path. When the instance launches and either of these keys are provided, the key values are formatted as
	//  OpenStack metadata and copied to the following locations, which are recognized by Cloud-Init:
	//  `http://169.254.169.254/openstack/latest/meta_data.json` - This JSON blob
	//  contains, among other things, the SSH keys that you provided for
	//   **"ssh_authorized_keys"**.
	//  `http://169.254.169.254/openstack/latest/user_data` - Contains the
	//  base64-decoded data that you provided for **"user_data"**.
	//  **Metadata Example**
	//       "metadata" : {
	//          "quake_bot_level" : "Severe",
	//          "ssh_authorized_keys" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCZ06fccNTQfq+xubFlJ5ZR3kt+uzspdH9tXL+lAejSM1NXM+CFZev7MIxfEjas06y80ZBZ7DUTQO0GxJPeD8NCOb1VorF8M4xuLwrmzRtkoZzU16umt4y1W0Q4ifdp3IiiU0U8/WxczSXcUVZOLqkz5dc6oMHdMVpkimietWzGZ4LBBsH/LjEVY7E0V+a0sNchlVDIZcm7ErReBLcdTGDq0uLBiuChyl6RUkX1PNhusquTGwK7zc8OBXkRuubn5UKXhI3Ul9Nyk4XESkVWIGNKmw8mSpoJSjR8P9ZjRmcZVo8S+x4KVPMZKQEor== ryan.smith@company.com
	//          ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAzJSAtwEPoB3Jmr58IXrDGzLuDYkWAYg8AsLYlo6JZvKpjY1xednIcfEVQJm4T2DhVmdWhRrwQ8DmayVZvBkLt+zs2LdoAJEVimKwXcJFD/7wtH8Lnk17HiglbbbNXsemjDY0hea4JUE5CfvkIdZBITuMrfqSmA4n3VNoorXYdvtTMoGG8fxMub46RPtuxtqi9bG9Zqenordkg5FJt2mVNfQRqf83CWojcOkklUWq4CjyxaeLf5i9gv1fRoBo4QhiA8I6NCSppO8GnoV/6Ox6TNoh9BiifqGKC9VGYuC89RvUajRBTZSK2TK4DPfaT+2R+slPsFrwiT/oPEhhEK1S5Q== rsa-key-20160227",
	//          "user_data" : "SWYgeW91IGNhbiBzZWUgdGhpcywgdGhlbiBpdCB3b3JrZWQgbWF5YmUuCg=="
	//       }
	//  **Getting Metadata on the Instance**
	//  To get information about your instance, connect to the instance using SSH and issue any of the
	//  following GET requests:
	//      curl http://169.254.169.254/opc/v1/instance/
	//      curl http://169.254.169.254/opc/v1/instance/metadata/
	//      curl http://169.254.169.254/opc/v1/instance/metadata/<any-key-name>
	//  You'll get back a response that includes all the instance information; only the metadata information; or
	//  the metadata information for the specified key name, respectively.
	Metadata map[string]string `mandatory:"false" json:"metadata"`

	// Details for creating an instance.
	// Use this parameter to specify whether a boot volume or an image should be used to launch a new instance.
	SourceDetails InstanceSourceDetails `mandatory:"false" json:"sourceDetails"`

	// Deprecated. Instead use `subnetId` in
	// CreateVnicDetails.
	// At least one of them is required; if you provide both, the values must match.
	SubnetId *string `mandatory:"false" json:"subnetId"`

	// Whether to enable encryption in transit for the PV boot volume attachment. Defaults to false.
	IsPvEncryptionInTransitEnabled *bool `mandatory:"false" json:"isPvEncryptionInTransitEnabled"`
}

LaunchInstanceDetails Instance launch details. Use the `sourceDetails` parameter to specify whether a boot volume or an image should be used to launch a new instance.

func (LaunchInstanceDetails) String ¶ 

func (m LaunchInstanceDetails) String() string

func (*LaunchInstanceDetails) UnmarshalJSON ¶ 

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

UnmarshalJSON unmarshals from json

type LaunchInstanceRequest ¶ 

type LaunchInstanceRequest struct {

	// Instance details
	LaunchInstanceDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// 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
}

LaunchInstanceRequest wrapper for the LaunchInstance operation

func (LaunchInstanceRequest) HTTPRequest ¶ added in v1.3.0 

func (request LaunchInstanceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (LaunchInstanceRequest) RetryPolicy ¶ added in v1.3.0 

func (request LaunchInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (LaunchInstanceRequest) String ¶ 

func (request LaunchInstanceRequest) String() string

type LaunchInstanceResponse ¶ 

type LaunchInstanceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Instance instance
	Instance `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"`
}

LaunchInstanceResponse wrapper for the LaunchInstance operation

func (LaunchInstanceResponse) HTTPResponse ¶ added in v1.3.0 

func (response LaunchInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (LaunchInstanceResponse) String ¶ 

func (response LaunchInstanceResponse) String() string

type LaunchOptions ¶ added in v1.1.0 

type LaunchOptions struct {

	// Emulation type for volume.
	// * `ISCSI` - ISCSI attached block storage device. This is the default for Boot Volumes and Remote Block
	// Storage volumes on Oracle provided images.
	// * `SCSI` - Emulated SCSI disk.
	// * `IDE` - Emulated IDE disk.
	// * `VFIO` - Direct attached Virtual Function storage.  This is the default option for Local data
	// volumes on Oracle provided images.
	// * `PARAVIRTUALIZED` - Paravirtualized disk.
	BootVolumeType LaunchOptionsBootVolumeTypeEnum `mandatory:"true" json:"bootVolumeType"`

	// Firmware used to boot VM.  Select the option that matches your operating system.
	// * `BIOS` - Boot VM using BIOS style firmware.  This is compatible with both 32 bit and 64 bit operating
	// systems that boot using MBR style bootloaders.
	// * `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems.  This is the
	// default for Oracle provided images.
	Firmware LaunchOptionsFirmwareEnum `mandatory:"true" json:"firmware"`

	// Emulation type for NIC.
	// * `E1000` - Emulated Gigabit ethernet controller.  Compatible with Linux e1000 network driver.
	// * `VFIO` - Direct attached Virtual Function network controller.  Default for Oracle provided images.
	// * `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using virtio drivers.
	NetworkType LaunchOptionsNetworkTypeEnum `mandatory:"true" json:"networkType"`

	// Emulation type for volume.
	// * `ISCSI` - ISCSI attached block storage device. This is the default for Boot Volumes and Remote Block
	// Storage volumes on Oracle provided images.
	// * `SCSI` - Emulated SCSI disk.
	// * `IDE` - Emulated IDE disk.
	// * `VFIO` - Direct attached Virtual Function storage.  This is the default option for Local data
	// volumes on Oracle provided images.
	// * `PARAVIRTUALIZED` - Paravirtualized disk.
	RemoteDataVolumeType LaunchOptionsRemoteDataVolumeTypeEnum `mandatory:"true" json:"remoteDataVolumeType"`

	// Whether to enable encryption in transit for the PV boot volume attachment. Defaults to false.
	IsPvEncryptionInTransitEnabled *bool `mandatory:"false" json:"isPvEncryptionInTransitEnabled"`

	// Whether to enable consistent volume naming feature. Defaults to false.
	IsConsistentVolumeNamingEnabled *bool `mandatory:"false" json:"isConsistentVolumeNamingEnabled"`
}

LaunchOptions Options for tuning compatibility and performance of VM shapes.

func (LaunchOptions) String ¶ added in v1.1.0 

func (m LaunchOptions) String() string

type LaunchOptionsBootVolumeTypeEnum ¶ added in v1.1.0 

type LaunchOptionsBootVolumeTypeEnum string

LaunchOptionsBootVolumeTypeEnum Enum with underlying type: string 

const (
	LaunchOptionsBootVolumeTypeIscsi           LaunchOptionsBootVolumeTypeEnum = "ISCSI"
	LaunchOptionsBootVolumeTypeScsi            LaunchOptionsBootVolumeTypeEnum = "SCSI"
	LaunchOptionsBootVolumeTypeIde             LaunchOptionsBootVolumeTypeEnum = "IDE"
	LaunchOptionsBootVolumeTypeVfio            LaunchOptionsBootVolumeTypeEnum = "VFIO"
	LaunchOptionsBootVolumeTypeParavirtualized LaunchOptionsBootVolumeTypeEnum = "PARAVIRTUALIZED"
)

Set of constants representing the allowable values for LaunchOptionsBootVolumeTypeEnum

func GetLaunchOptionsBootVolumeTypeEnumValues ¶ added in v1.1.0 

func GetLaunchOptionsBootVolumeTypeEnumValues() []LaunchOptionsBootVolumeTypeEnum

GetLaunchOptionsBootVolumeTypeEnumValues Enumerates the set of values for LaunchOptionsBootVolumeTypeEnum

type LaunchOptionsFirmwareEnum ¶ added in v1.1.0 

type LaunchOptionsFirmwareEnum string

LaunchOptionsFirmwareEnum Enum with underlying type: string 

const (
	LaunchOptionsFirmwareBios   LaunchOptionsFirmwareEnum = "BIOS"
	LaunchOptionsFirmwareUefi64 LaunchOptionsFirmwareEnum = "UEFI_64"
)

Set of constants representing the allowable values for LaunchOptionsFirmwareEnum

func GetLaunchOptionsFirmwareEnumValues ¶ added in v1.1.0 

func GetLaunchOptionsFirmwareEnumValues() []LaunchOptionsFirmwareEnum

GetLaunchOptionsFirmwareEnumValues Enumerates the set of values for LaunchOptionsFirmwareEnum

type LaunchOptionsNetworkTypeEnum ¶ added in v1.1.0 

type LaunchOptionsNetworkTypeEnum string

LaunchOptionsNetworkTypeEnum Enum with underlying type: string 

const (
	LaunchOptionsNetworkTypeE1000           LaunchOptionsNetworkTypeEnum = "E1000"
	LaunchOptionsNetworkTypeVfio            LaunchOptionsNetworkTypeEnum = "VFIO"
	LaunchOptionsNetworkTypeParavirtualized LaunchOptionsNetworkTypeEnum = "PARAVIRTUALIZED"
)

Set of constants representing the allowable values for LaunchOptionsNetworkTypeEnum

func GetLaunchOptionsNetworkTypeEnumValues ¶ added in v1.1.0 

func GetLaunchOptionsNetworkTypeEnumValues() []LaunchOptionsNetworkTypeEnum

GetLaunchOptionsNetworkTypeEnumValues Enumerates the set of values for LaunchOptionsNetworkTypeEnum

type LaunchOptionsRemoteDataVolumeTypeEnum ¶ added in v1.1.0 

type LaunchOptionsRemoteDataVolumeTypeEnum string

LaunchOptionsRemoteDataVolumeTypeEnum Enum with underlying type: string 

const (
	LaunchOptionsRemoteDataVolumeTypeIscsi           LaunchOptionsRemoteDataVolumeTypeEnum = "ISCSI"
	LaunchOptionsRemoteDataVolumeTypeScsi            LaunchOptionsRemoteDataVolumeTypeEnum = "SCSI"
	LaunchOptionsRemoteDataVolumeTypeIde             LaunchOptionsRemoteDataVolumeTypeEnum = "IDE"
	LaunchOptionsRemoteDataVolumeTypeVfio            LaunchOptionsRemoteDataVolumeTypeEnum = "VFIO"
	LaunchOptionsRemoteDataVolumeTypeParavirtualized LaunchOptionsRemoteDataVolumeTypeEnum = "PARAVIRTUALIZED"
)

Set of constants representing the allowable values for LaunchOptionsRemoteDataVolumeTypeEnum

func GetLaunchOptionsRemoteDataVolumeTypeEnumValues ¶ added in v1.1.0 

func GetLaunchOptionsRemoteDataVolumeTypeEnumValues() []LaunchOptionsRemoteDataVolumeTypeEnum

GetLaunchOptionsRemoteDataVolumeTypeEnumValues Enumerates the set of values for LaunchOptionsRemoteDataVolumeTypeEnum

type LetterOfAuthority ¶ 

type LetterOfAuthority struct {

	// The name of the entity authorized by this Letter of Authority.
	AuthorizedEntityName *string `mandatory:"false" json:"authorizedEntityName"`

	// The type of cross-connect fiber, termination, and optical specification.
	CircuitType LetterOfAuthorityCircuitTypeEnum `mandatory:"false" json:"circuitType,omitempty"`

	// The OCID of the cross-connect.
	CrossConnectId *string `mandatory:"false" json:"crossConnectId"`

	// The address of the FastConnect location.
	FacilityLocation *string `mandatory:"false" json:"facilityLocation"`

	// The meet-me room port for this cross-connect.
	PortName *string `mandatory:"false" json:"portName"`

	// The date and time when the Letter of Authority expires, in the format defined by RFC3339.
	TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`

	// The date and time the Letter of Authority was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeIssued *common.SDKTime `mandatory:"false" json:"timeIssued"`
}

LetterOfAuthority The Letter of Authority for the cross-connect. You must submit this letter when requesting cabling for the cross-connect at the FastConnect location.

func (LetterOfAuthority) String ¶ 

func (m LetterOfAuthority) String() string

type LetterOfAuthorityCircuitTypeEnum ¶ 

type LetterOfAuthorityCircuitTypeEnum string

LetterOfAuthorityCircuitTypeEnum Enum with underlying type: string 

const (
	LetterOfAuthorityCircuitTypeLc LetterOfAuthorityCircuitTypeEnum = "Single_mode_LC"
	LetterOfAuthorityCircuitTypeSc LetterOfAuthorityCircuitTypeEnum = "Single_mode_SC"
)

Set of constants representing the allowable values for LetterOfAuthorityCircuitTypeEnum

func GetLetterOfAuthorityCircuitTypeEnumValues ¶ 

func GetLetterOfAuthorityCircuitTypeEnumValues() []LetterOfAuthorityCircuitTypeEnum

GetLetterOfAuthorityCircuitTypeEnumValues Enumerates the set of values for LetterOfAuthorityCircuitTypeEnum

type ListAllowedPeerRegionsForRemotePeeringRequest ¶ added in v1.2.0 

type ListAllowedPeerRegionsForRemotePeeringRequest struct {

	// 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
}

ListAllowedPeerRegionsForRemotePeeringRequest wrapper for the ListAllowedPeerRegionsForRemotePeering operation

func (ListAllowedPeerRegionsForRemotePeeringRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListAllowedPeerRegionsForRemotePeeringRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAllowedPeerRegionsForRemotePeeringRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListAllowedPeerRegionsForRemotePeeringRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListAllowedPeerRegionsForRemotePeeringRequest) String ¶ added in v1.2.0 

func (request ListAllowedPeerRegionsForRemotePeeringRequest) String() string

type ListAllowedPeerRegionsForRemotePeeringResponse ¶ added in v1.2.0 

type ListAllowedPeerRegionsForRemotePeeringResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The []PeerRegionForRemotePeering instance
	Items []PeerRegionForRemotePeering `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"`
}

ListAllowedPeerRegionsForRemotePeeringResponse wrapper for the ListAllowedPeerRegionsForRemotePeering operation

func (ListAllowedPeerRegionsForRemotePeeringResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListAllowedPeerRegionsForRemotePeeringResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListAllowedPeerRegionsForRemotePeeringResponse) String ¶ added in v1.2.0 

func (response ListAllowedPeerRegionsForRemotePeeringResponse) String() string

type ListAppCatalogListingResourceVersionsRequest ¶ 

type ListAppCatalogListingResourceVersionsRequest struct {

	// The OCID of the listing.
	ListingId *string `mandatory:"true" contributesTo:"path" name:"listingId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order
	// is case sensitive.
	SortOrder ListAppCatalogListingResourceVersionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// 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
}

ListAppCatalogListingResourceVersionsRequest wrapper for the ListAppCatalogListingResourceVersions operation

func (ListAppCatalogListingResourceVersionsRequest) HTTPRequest ¶ 

func (request ListAppCatalogListingResourceVersionsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAppCatalogListingResourceVersionsRequest) RetryPolicy ¶ 

func (request ListAppCatalogListingResourceVersionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListAppCatalogListingResourceVersionsRequest) String ¶ 

func (request ListAppCatalogListingResourceVersionsRequest) String() string

type ListAppCatalogListingResourceVersionsResponse ¶ 

type ListAppCatalogListingResourceVersionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []AppCatalogListingResourceVersionSummary instances
	Items []AppCatalogListingResourceVersionSummary `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// 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.us-phoenix-1.oraclecloud.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"`
}

ListAppCatalogListingResourceVersionsResponse wrapper for the ListAppCatalogListingResourceVersions operation

func (ListAppCatalogListingResourceVersionsResponse) HTTPResponse ¶ 

func (response ListAppCatalogListingResourceVersionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListAppCatalogListingResourceVersionsResponse) String ¶ 

func (response ListAppCatalogListingResourceVersionsResponse) String() string

type ListAppCatalogListingResourceVersionsSortOrderEnum ¶ 

type ListAppCatalogListingResourceVersionsSortOrderEnum string

ListAppCatalogListingResourceVersionsSortOrderEnum Enum with underlying type: string 

const (
	ListAppCatalogListingResourceVersionsSortOrderAsc  ListAppCatalogListingResourceVersionsSortOrderEnum = "ASC"
	ListAppCatalogListingResourceVersionsSortOrderDesc ListAppCatalogListingResourceVersionsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListAppCatalogListingResourceVersionsSortOrderEnum

func GetListAppCatalogListingResourceVersionsSortOrderEnumValues ¶ 

func GetListAppCatalogListingResourceVersionsSortOrderEnumValues() []ListAppCatalogListingResourceVersionsSortOrderEnum

GetListAppCatalogListingResourceVersionsSortOrderEnumValues Enumerates the set of values for ListAppCatalogListingResourceVersionsSortOrderEnum

type ListAppCatalogListingsRequest ¶ 

type ListAppCatalogListingsRequest struct {

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order
	// is case sensitive.
	SortOrder ListAppCatalogListingsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// A filter to return only the publisher that matches the given publisher name exactly.
	PublisherName *string `mandatory:"false" contributesTo:"query" name:"publisherName"`

	// A filter to return only publishers that match the given publisher type exactly. Valid types are OCI, ORACLE, TRUSTED, STANDARD.
	PublisherType *string `mandatory:"false" contributesTo:"query" name:"publisherType"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// 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
}

ListAppCatalogListingsRequest wrapper for the ListAppCatalogListings operation

func (ListAppCatalogListingsRequest) HTTPRequest ¶ 

func (request ListAppCatalogListingsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAppCatalogListingsRequest) RetryPolicy ¶ 

func (request ListAppCatalogListingsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListAppCatalogListingsRequest) String ¶ 

func (request ListAppCatalogListingsRequest) String() string

type ListAppCatalogListingsResponse ¶ 

type ListAppCatalogListingsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []AppCatalogListingSummary instances
	Items []AppCatalogListingSummary `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.us-phoenix-1.oraclecloud.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"`
}

ListAppCatalogListingsResponse wrapper for the ListAppCatalogListings operation

func (ListAppCatalogListingsResponse) HTTPResponse ¶ 

func (response ListAppCatalogListingsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListAppCatalogListingsResponse) String ¶ 

func (response ListAppCatalogListingsResponse) String() string

type ListAppCatalogListingsSortOrderEnum ¶ 

type ListAppCatalogListingsSortOrderEnum string

ListAppCatalogListingsSortOrderEnum Enum with underlying type: string 

const (
	ListAppCatalogListingsSortOrderAsc  ListAppCatalogListingsSortOrderEnum = "ASC"
	ListAppCatalogListingsSortOrderDesc ListAppCatalogListingsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListAppCatalogListingsSortOrderEnum

func GetListAppCatalogListingsSortOrderEnumValues ¶ 

func GetListAppCatalogListingsSortOrderEnumValues() []ListAppCatalogListingsSortOrderEnum

GetListAppCatalogListingsSortOrderEnumValues Enumerates the set of values for ListAppCatalogListingsSortOrderEnum

type ListAppCatalogSubscriptionsRequest ¶ 

type ListAppCatalogSubscriptionsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListAppCatalogSubscriptionsSortByEnum `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 ListAppCatalogSubscriptionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// A filter to return only the listings that matches the given listing id.
	ListingId *string `mandatory:"false" contributesTo:"query" name:"listingId"`

	// 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
}

ListAppCatalogSubscriptionsRequest wrapper for the ListAppCatalogSubscriptions operation

func (ListAppCatalogSubscriptionsRequest) HTTPRequest ¶ 

func (request ListAppCatalogSubscriptionsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAppCatalogSubscriptionsRequest) RetryPolicy ¶ 

func (request ListAppCatalogSubscriptionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListAppCatalogSubscriptionsRequest) String ¶ 

func (request ListAppCatalogSubscriptionsRequest) String() string

type ListAppCatalogSubscriptionsResponse ¶ 

type ListAppCatalogSubscriptionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []AppCatalogSubscriptionSummary instances
	Items []AppCatalogSubscriptionSummary `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.us-phoenix-1.oraclecloud.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"`
}

ListAppCatalogSubscriptionsResponse wrapper for the ListAppCatalogSubscriptions operation

func (ListAppCatalogSubscriptionsResponse) HTTPResponse ¶ 

func (response ListAppCatalogSubscriptionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListAppCatalogSubscriptionsResponse) String ¶ 

func (response ListAppCatalogSubscriptionsResponse) String() string

type ListAppCatalogSubscriptionsSortByEnum ¶ 

type ListAppCatalogSubscriptionsSortByEnum string

ListAppCatalogSubscriptionsSortByEnum Enum with underlying type: string 

const (
	ListAppCatalogSubscriptionsSortByTimecreated ListAppCatalogSubscriptionsSortByEnum = "TIMECREATED"
	ListAppCatalogSubscriptionsSortByDisplayname ListAppCatalogSubscriptionsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListAppCatalogSubscriptionsSortByEnum

func GetListAppCatalogSubscriptionsSortByEnumValues ¶ 

func GetListAppCatalogSubscriptionsSortByEnumValues() []ListAppCatalogSubscriptionsSortByEnum

GetListAppCatalogSubscriptionsSortByEnumValues Enumerates the set of values for ListAppCatalogSubscriptionsSortByEnum

type ListAppCatalogSubscriptionsSortOrderEnum ¶ 

type ListAppCatalogSubscriptionsSortOrderEnum string

ListAppCatalogSubscriptionsSortOrderEnum Enum with underlying type: string 

const (
	ListAppCatalogSubscriptionsSortOrderAsc  ListAppCatalogSubscriptionsSortOrderEnum = "ASC"
	ListAppCatalogSubscriptionsSortOrderDesc ListAppCatalogSubscriptionsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListAppCatalogSubscriptionsSortOrderEnum

func GetListAppCatalogSubscriptionsSortOrderEnumValues ¶ 

func GetListAppCatalogSubscriptionsSortOrderEnumValues() []ListAppCatalogSubscriptionsSortOrderEnum

GetListAppCatalogSubscriptionsSortOrderEnumValues Enumerates the set of values for ListAppCatalogSubscriptionsSortOrderEnum

type ListBootVolumeAttachmentsRequest ¶ 

type ListBootVolumeAttachmentsRequest struct {

	// The name of the availability domain.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" contributesTo:"query" name:"availabilityDomain"`

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

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

	// The OCID of the boot volume.
	BootVolumeId *string `mandatory:"false" contributesTo:"query" name:"bootVolumeId"`

	// 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
}

ListBootVolumeAttachmentsRequest wrapper for the ListBootVolumeAttachments operation

func (ListBootVolumeAttachmentsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListBootVolumeAttachmentsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBootVolumeAttachmentsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListBootVolumeAttachmentsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBootVolumeAttachmentsRequest) String ¶ 

func (request ListBootVolumeAttachmentsRequest) String() string

type ListBootVolumeAttachmentsResponse ¶ 

type ListBootVolumeAttachmentsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []BootVolumeAttachment instances
	Items []BootVolumeAttachment `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.us-phoenix-1.oraclecloud.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"`
}

ListBootVolumeAttachmentsResponse wrapper for the ListBootVolumeAttachments operation

func (ListBootVolumeAttachmentsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListBootVolumeAttachmentsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBootVolumeAttachmentsResponse) String ¶ 

func (response ListBootVolumeAttachmentsResponse) String() string

type ListBootVolumeBackupsRequest ¶ added in v1.8.0 

type ListBootVolumeBackupsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the boot volume.
	BootVolumeId *string `mandatory:"false" contributesTo:"query" name:"bootVolumeId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListBootVolumeBackupsSortByEnum `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 ListBootVolumeBackupsSortOrderEnum `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 BootVolumeBackupLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListBootVolumeBackupsRequest wrapper for the ListBootVolumeBackups operation

func (ListBootVolumeBackupsRequest) HTTPRequest ¶ added in v1.8.0 

func (request ListBootVolumeBackupsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBootVolumeBackupsRequest) RetryPolicy ¶ added in v1.8.0 

func (request ListBootVolumeBackupsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBootVolumeBackupsRequest) String ¶ added in v1.8.0 

func (request ListBootVolumeBackupsRequest) String() string

type ListBootVolumeBackupsResponse ¶ added in v1.8.0 

type ListBootVolumeBackupsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []BootVolumeBackup instances
	Items []BootVolumeBackup `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.us-phoenix-1.oraclecloud.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"`
}

ListBootVolumeBackupsResponse wrapper for the ListBootVolumeBackups operation

func (ListBootVolumeBackupsResponse) HTTPResponse ¶ added in v1.8.0 

func (response ListBootVolumeBackupsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBootVolumeBackupsResponse) String ¶ added in v1.8.0 

func (response ListBootVolumeBackupsResponse) String() string

type ListBootVolumeBackupsSortByEnum ¶ added in v1.8.0 

type ListBootVolumeBackupsSortByEnum string

ListBootVolumeBackupsSortByEnum Enum with underlying type: string 

const (
	ListBootVolumeBackupsSortByTimecreated ListBootVolumeBackupsSortByEnum = "TIMECREATED"
	ListBootVolumeBackupsSortByDisplayname ListBootVolumeBackupsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListBootVolumeBackupsSortByEnum

func GetListBootVolumeBackupsSortByEnumValues ¶ added in v1.8.0 

func GetListBootVolumeBackupsSortByEnumValues() []ListBootVolumeBackupsSortByEnum

GetListBootVolumeBackupsSortByEnumValues Enumerates the set of values for ListBootVolumeBackupsSortByEnum

type ListBootVolumeBackupsSortOrderEnum ¶ added in v1.8.0 

type ListBootVolumeBackupsSortOrderEnum string

ListBootVolumeBackupsSortOrderEnum Enum with underlying type: string 

const (
	ListBootVolumeBackupsSortOrderAsc  ListBootVolumeBackupsSortOrderEnum = "ASC"
	ListBootVolumeBackupsSortOrderDesc ListBootVolumeBackupsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListBootVolumeBackupsSortOrderEnum

func GetListBootVolumeBackupsSortOrderEnumValues ¶ added in v1.8.0 

func GetListBootVolumeBackupsSortOrderEnumValues() []ListBootVolumeBackupsSortOrderEnum

GetListBootVolumeBackupsSortOrderEnumValues Enumerates the set of values for ListBootVolumeBackupsSortOrderEnum

type ListBootVolumesRequest ¶ 

type ListBootVolumesRequest struct {

	// The name of the availability domain.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" contributesTo:"query" name:"availabilityDomain"`

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The OCID of the volume group.
	VolumeGroupId *string `mandatory:"false" contributesTo:"query" name:"volumeGroupId"`

	// 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
}

ListBootVolumesRequest wrapper for the ListBootVolumes operation

func (ListBootVolumesRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListBootVolumesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBootVolumesRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListBootVolumesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBootVolumesRequest) String ¶ 

func (request ListBootVolumesRequest) String() string

type ListBootVolumesResponse ¶ 

type ListBootVolumesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []BootVolume instances
	Items []BootVolume `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.us-phoenix-1.oraclecloud.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"`
}

ListBootVolumesResponse wrapper for the ListBootVolumes operation

func (ListBootVolumesResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListBootVolumesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBootVolumesResponse) String ¶ 

func (response ListBootVolumesResponse) String() string

type ListConsoleHistoriesRequest ¶ 

type ListConsoleHistoriesRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The name of the availability domain.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

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

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListConsoleHistoriesSortByEnum `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 ListConsoleHistoriesSortOrderEnum `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 ConsoleHistoryLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListConsoleHistoriesRequest wrapper for the ListConsoleHistories operation

func (ListConsoleHistoriesRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListConsoleHistoriesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListConsoleHistoriesRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListConsoleHistoriesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListConsoleHistoriesRequest) String ¶ 

func (request ListConsoleHistoriesRequest) String() string

type ListConsoleHistoriesResponse ¶ 

type ListConsoleHistoriesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []ConsoleHistory instances
	Items []ConsoleHistory `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.us-phoenix-1.oraclecloud.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"`
}

ListConsoleHistoriesResponse wrapper for the ListConsoleHistories operation

func (ListConsoleHistoriesResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListConsoleHistoriesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListConsoleHistoriesResponse) String ¶ 

func (response ListConsoleHistoriesResponse) String() string

type ListConsoleHistoriesSortByEnum ¶ 

type ListConsoleHistoriesSortByEnum string

ListConsoleHistoriesSortByEnum Enum with underlying type: string 

const (
	ListConsoleHistoriesSortByTimecreated ListConsoleHistoriesSortByEnum = "TIMECREATED"
	ListConsoleHistoriesSortByDisplayname ListConsoleHistoriesSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListConsoleHistoriesSortByEnum

func GetListConsoleHistoriesSortByEnumValues ¶ 

func GetListConsoleHistoriesSortByEnumValues() []ListConsoleHistoriesSortByEnum

GetListConsoleHistoriesSortByEnumValues Enumerates the set of values for ListConsoleHistoriesSortByEnum

type ListConsoleHistoriesSortOrderEnum ¶ 

type ListConsoleHistoriesSortOrderEnum string

ListConsoleHistoriesSortOrderEnum Enum with underlying type: string 

const (
	ListConsoleHistoriesSortOrderAsc  ListConsoleHistoriesSortOrderEnum = "ASC"
	ListConsoleHistoriesSortOrderDesc ListConsoleHistoriesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListConsoleHistoriesSortOrderEnum

func GetListConsoleHistoriesSortOrderEnumValues ¶ 

func GetListConsoleHistoriesSortOrderEnumValues() []ListConsoleHistoriesSortOrderEnum

GetListConsoleHistoriesSortOrderEnumValues Enumerates the set of values for ListConsoleHistoriesSortOrderEnum

type ListCpesRequest ¶ 

type ListCpesRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"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 `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
}

ListCpesRequest wrapper for the ListCpes operation

func (ListCpesRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListCpesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListCpesRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListCpesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListCpesRequest) String ¶ 

func (request ListCpesRequest) String() string

type ListCpesResponse ¶ 

type ListCpesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []Cpe instances
	Items []Cpe `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.us-phoenix-1.oraclecloud.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"`
}

ListCpesResponse wrapper for the ListCpes operation

func (ListCpesResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListCpesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListCpesResponse) String ¶ 

func (response ListCpesResponse) String() string

type ListCrossConnectGroupsRequest ¶ 

type ListCrossConnectGroupsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListCrossConnectGroupsSortByEnum `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 ListCrossConnectGroupsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
	LifecycleState CrossConnectGroupLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListCrossConnectGroupsRequest wrapper for the ListCrossConnectGroups operation

func (ListCrossConnectGroupsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListCrossConnectGroupsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListCrossConnectGroupsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListCrossConnectGroupsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListCrossConnectGroupsRequest) String ¶ 

func (request ListCrossConnectGroupsRequest) String() string

type ListCrossConnectGroupsResponse ¶ 

type ListCrossConnectGroupsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []CrossConnectGroup instances
	Items []CrossConnectGroup `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.us-phoenix-1.oraclecloud.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"`
}

ListCrossConnectGroupsResponse wrapper for the ListCrossConnectGroups operation

func (ListCrossConnectGroupsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListCrossConnectGroupsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListCrossConnectGroupsResponse) String ¶ 

func (response ListCrossConnectGroupsResponse) String() string

type ListCrossConnectGroupsSortByEnum ¶ 

type ListCrossConnectGroupsSortByEnum string

ListCrossConnectGroupsSortByEnum Enum with underlying type: string 

const (
	ListCrossConnectGroupsSortByTimecreated ListCrossConnectGroupsSortByEnum = "TIMECREATED"
	ListCrossConnectGroupsSortByDisplayname ListCrossConnectGroupsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListCrossConnectGroupsSortByEnum

func GetListCrossConnectGroupsSortByEnumValues ¶ 

func GetListCrossConnectGroupsSortByEnumValues() []ListCrossConnectGroupsSortByEnum

GetListCrossConnectGroupsSortByEnumValues Enumerates the set of values for ListCrossConnectGroupsSortByEnum

type ListCrossConnectGroupsSortOrderEnum ¶ 

type ListCrossConnectGroupsSortOrderEnum string

ListCrossConnectGroupsSortOrderEnum Enum with underlying type: string 

const (
	ListCrossConnectGroupsSortOrderAsc  ListCrossConnectGroupsSortOrderEnum = "ASC"
	ListCrossConnectGroupsSortOrderDesc ListCrossConnectGroupsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListCrossConnectGroupsSortOrderEnum

func GetListCrossConnectGroupsSortOrderEnumValues ¶ 

func GetListCrossConnectGroupsSortOrderEnumValues() []ListCrossConnectGroupsSortOrderEnum

GetListCrossConnectGroupsSortOrderEnumValues Enumerates the set of values for ListCrossConnectGroupsSortOrderEnum

type ListCrossConnectLocationsRequest ¶ 

type ListCrossConnectLocationsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"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 `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
}

ListCrossConnectLocationsRequest wrapper for the ListCrossConnectLocations operation

func (ListCrossConnectLocationsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListCrossConnectLocationsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListCrossConnectLocationsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListCrossConnectLocationsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListCrossConnectLocationsRequest) String ¶ 

func (request ListCrossConnectLocationsRequest) String() string

type ListCrossConnectLocationsResponse ¶ 

type ListCrossConnectLocationsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []CrossConnectLocation instances
	Items []CrossConnectLocation `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.us-phoenix-1.oraclecloud.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"`
}

ListCrossConnectLocationsResponse wrapper for the ListCrossConnectLocations operation

func (ListCrossConnectLocationsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListCrossConnectLocationsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListCrossConnectLocationsResponse) String ¶ 

func (response ListCrossConnectLocationsResponse) String() string

type ListCrossConnectsRequest ¶ 

type ListCrossConnectsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the cross-connect group.
	CrossConnectGroupId *string `mandatory:"false" contributesTo:"query" name:"crossConnectGroupId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListCrossConnectsSortByEnum `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 ListCrossConnectsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
	LifecycleState CrossConnectLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListCrossConnectsRequest wrapper for the ListCrossConnects operation

func (ListCrossConnectsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListCrossConnectsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListCrossConnectsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListCrossConnectsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListCrossConnectsRequest) String ¶ 

func (request ListCrossConnectsRequest) String() string

type ListCrossConnectsResponse ¶ 

type ListCrossConnectsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []CrossConnect instances
	Items []CrossConnect `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.us-phoenix-1.oraclecloud.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"`
}

ListCrossConnectsResponse wrapper for the ListCrossConnects operation

func (ListCrossConnectsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListCrossConnectsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListCrossConnectsResponse) String ¶ 

func (response ListCrossConnectsResponse) String() string

type ListCrossConnectsSortByEnum ¶ 

type ListCrossConnectsSortByEnum string

ListCrossConnectsSortByEnum Enum with underlying type: string 

const (
	ListCrossConnectsSortByTimecreated ListCrossConnectsSortByEnum = "TIMECREATED"
	ListCrossConnectsSortByDisplayname ListCrossConnectsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListCrossConnectsSortByEnum

func GetListCrossConnectsSortByEnumValues ¶ 

func GetListCrossConnectsSortByEnumValues() []ListCrossConnectsSortByEnum

GetListCrossConnectsSortByEnumValues Enumerates the set of values for ListCrossConnectsSortByEnum

type ListCrossConnectsSortOrderEnum ¶ 

type ListCrossConnectsSortOrderEnum string

ListCrossConnectsSortOrderEnum Enum with underlying type: string 

const (
	ListCrossConnectsSortOrderAsc  ListCrossConnectsSortOrderEnum = "ASC"
	ListCrossConnectsSortOrderDesc ListCrossConnectsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListCrossConnectsSortOrderEnum

func GetListCrossConnectsSortOrderEnumValues ¶ 

func GetListCrossConnectsSortOrderEnumValues() []ListCrossConnectsSortOrderEnum

GetListCrossConnectsSortOrderEnumValues Enumerates the set of values for ListCrossConnectsSortOrderEnum

type ListCrossconnectPortSpeedShapesRequest ¶ 

type ListCrossconnectPortSpeedShapesRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"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 `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
}

ListCrossconnectPortSpeedShapesRequest wrapper for the ListCrossconnectPortSpeedShapes operation

func (ListCrossconnectPortSpeedShapesRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListCrossconnectPortSpeedShapesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListCrossconnectPortSpeedShapesRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListCrossconnectPortSpeedShapesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListCrossconnectPortSpeedShapesRequest) String ¶ 

func (request ListCrossconnectPortSpeedShapesRequest) String() string

type ListCrossconnectPortSpeedShapesResponse ¶ 

type ListCrossconnectPortSpeedShapesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []CrossConnectPortSpeedShape instances
	Items []CrossConnectPortSpeedShape `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.us-phoenix-1.oraclecloud.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"`
}

ListCrossconnectPortSpeedShapesResponse wrapper for the ListCrossconnectPortSpeedShapes operation

func (ListCrossconnectPortSpeedShapesResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListCrossconnectPortSpeedShapesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListCrossconnectPortSpeedShapesResponse) String ¶ 

func (response ListCrossconnectPortSpeedShapesResponse) String() string

type ListDhcpOptionsRequest ¶ 

type ListDhcpOptionsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the VCN.
	VcnId *string `mandatory:"true" contributesTo:"query" name:"vcnId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListDhcpOptionsSortByEnum `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 ListDhcpOptionsSortOrderEnum `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 DhcpOptionsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListDhcpOptionsRequest wrapper for the ListDhcpOptions operation

func (ListDhcpOptionsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListDhcpOptionsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDhcpOptionsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListDhcpOptionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListDhcpOptionsRequest) String ¶ 

func (request ListDhcpOptionsRequest) String() string

type ListDhcpOptionsResponse ¶ 

type ListDhcpOptionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []DhcpOptions instances
	Items []DhcpOptions `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.us-phoenix-1.oraclecloud.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"`
}

ListDhcpOptionsResponse wrapper for the ListDhcpOptions operation

func (ListDhcpOptionsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListDhcpOptionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListDhcpOptionsResponse) String ¶ 

func (response ListDhcpOptionsResponse) String() string

type ListDhcpOptionsSortByEnum ¶ 

type ListDhcpOptionsSortByEnum string

ListDhcpOptionsSortByEnum Enum with underlying type: string 

const (
	ListDhcpOptionsSortByTimecreated ListDhcpOptionsSortByEnum = "TIMECREATED"
	ListDhcpOptionsSortByDisplayname ListDhcpOptionsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListDhcpOptionsSortByEnum

func GetListDhcpOptionsSortByEnumValues ¶ 

func GetListDhcpOptionsSortByEnumValues() []ListDhcpOptionsSortByEnum

GetListDhcpOptionsSortByEnumValues Enumerates the set of values for ListDhcpOptionsSortByEnum

type ListDhcpOptionsSortOrderEnum ¶ 

type ListDhcpOptionsSortOrderEnum string

ListDhcpOptionsSortOrderEnum Enum with underlying type: string 

const (
	ListDhcpOptionsSortOrderAsc  ListDhcpOptionsSortOrderEnum = "ASC"
	ListDhcpOptionsSortOrderDesc ListDhcpOptionsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDhcpOptionsSortOrderEnum

func GetListDhcpOptionsSortOrderEnumValues ¶ 

func GetListDhcpOptionsSortOrderEnumValues() []ListDhcpOptionsSortOrderEnum

GetListDhcpOptionsSortOrderEnumValues Enumerates the set of values for ListDhcpOptionsSortOrderEnum

type ListDrgAttachmentsRequest ¶ 

type ListDrgAttachmentsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the VCN.
	VcnId *string `mandatory:"false" contributesTo:"query" name:"vcnId"`

	// The OCID of the DRG.
	DrgId *string `mandatory:"false" contributesTo:"query" name:"drgId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"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 `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
}

ListDrgAttachmentsRequest wrapper for the ListDrgAttachments operation

func (ListDrgAttachmentsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListDrgAttachmentsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDrgAttachmentsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListDrgAttachmentsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListDrgAttachmentsRequest) String ¶ 

func (request ListDrgAttachmentsRequest) String() string

type ListDrgAttachmentsResponse ¶ 

type ListDrgAttachmentsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []DrgAttachment instances
	Items []DrgAttachment `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.us-phoenix-1.oraclecloud.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"`
}

ListDrgAttachmentsResponse wrapper for the ListDrgAttachments operation

func (ListDrgAttachmentsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListDrgAttachmentsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListDrgAttachmentsResponse) String ¶ 

func (response ListDrgAttachmentsResponse) String() string

type ListDrgsRequest ¶ 

type ListDrgsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"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 `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
}

ListDrgsRequest wrapper for the ListDrgs operation

func (ListDrgsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListDrgsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDrgsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListDrgsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListDrgsRequest) String ¶ 

func (request ListDrgsRequest) String() string

type ListDrgsResponse ¶ 

type ListDrgsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []Drg instances
	Items []Drg `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.us-phoenix-1.oraclecloud.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"`
}

ListDrgsResponse wrapper for the ListDrgs operation

func (ListDrgsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListDrgsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListDrgsResponse) String ¶ 

func (response ListDrgsResponse) String() string

type ListFastConnectProviderServicesRequest ¶ 

type ListFastConnectProviderServicesRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"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 `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
}

ListFastConnectProviderServicesRequest wrapper for the ListFastConnectProviderServices operation

func (ListFastConnectProviderServicesRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListFastConnectProviderServicesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListFastConnectProviderServicesRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListFastConnectProviderServicesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListFastConnectProviderServicesRequest) String ¶ 

func (request ListFastConnectProviderServicesRequest) String() string

type ListFastConnectProviderServicesResponse ¶ 

type ListFastConnectProviderServicesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []FastConnectProviderService instances
	Items []FastConnectProviderService `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.us-phoenix-1.oraclecloud.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"`
}

ListFastConnectProviderServicesResponse wrapper for the ListFastConnectProviderServices operation

func (ListFastConnectProviderServicesResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListFastConnectProviderServicesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListFastConnectProviderServicesResponse) String ¶ 

func (response ListFastConnectProviderServicesResponse) String() string

type ListFastConnectProviderVirtualCircuitBandwidthShapesRequest ¶ 

type ListFastConnectProviderVirtualCircuitBandwidthShapesRequest struct {

	// The OCID of the provider service.
	ProviderServiceId *string `mandatory:"true" contributesTo:"path" name:"providerServiceId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"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 `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
}

ListFastConnectProviderVirtualCircuitBandwidthShapesRequest wrapper for the ListFastConnectProviderVirtualCircuitBandwidthShapes operation

func (ListFastConnectProviderVirtualCircuitBandwidthShapesRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListFastConnectProviderVirtualCircuitBandwidthShapesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListFastConnectProviderVirtualCircuitBandwidthShapesRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListFastConnectProviderVirtualCircuitBandwidthShapesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListFastConnectProviderVirtualCircuitBandwidthShapesRequest) String ¶ 

func (request ListFastConnectProviderVirtualCircuitBandwidthShapesRequest) String() string

type ListFastConnectProviderVirtualCircuitBandwidthShapesResponse ¶ 

type ListFastConnectProviderVirtualCircuitBandwidthShapesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []VirtualCircuitBandwidthShape instances
	Items []VirtualCircuitBandwidthShape `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.us-phoenix-1.oraclecloud.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"`
}

ListFastConnectProviderVirtualCircuitBandwidthShapesResponse wrapper for the ListFastConnectProviderVirtualCircuitBandwidthShapes operation

func (ListFastConnectProviderVirtualCircuitBandwidthShapesResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListFastConnectProviderVirtualCircuitBandwidthShapesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListFastConnectProviderVirtualCircuitBandwidthShapesResponse) String ¶ 

func (response ListFastConnectProviderVirtualCircuitBandwidthShapesResponse) String() string

type ListIPSecConnectionsRequest ¶ 

type ListIPSecConnectionsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the DRG.
	DrgId *string `mandatory:"false" contributesTo:"query" name:"drgId"`

	// The OCID of the CPE.
	CpeId *string `mandatory:"false" contributesTo:"query" name:"cpeId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"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 `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
}

ListIPSecConnectionsRequest wrapper for the ListIPSecConnections operation

func (ListIPSecConnectionsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListIPSecConnectionsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListIPSecConnectionsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListIPSecConnectionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListIPSecConnectionsRequest) String ¶ 

func (request ListIPSecConnectionsRequest) String() string

type ListIPSecConnectionsResponse ¶ 

type ListIPSecConnectionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []IpSecConnection instances
	Items []IpSecConnection `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.us-phoenix-1.oraclecloud.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"`
}

ListIPSecConnectionsResponse wrapper for the ListIPSecConnections operation

func (ListIPSecConnectionsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListIPSecConnectionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListIPSecConnectionsResponse) String ¶ 

func (response ListIPSecConnectionsResponse) String() string

type ListImagesRequest ¶ 

type ListImagesRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The image's operating system.
	// Example: `Oracle Linux`
	OperatingSystem *string `mandatory:"false" contributesTo:"query" name:"operatingSystem"`

	// The image's operating system version.
	// Example: `7.2`
	OperatingSystemVersion *string `mandatory:"false" contributesTo:"query" name:"operatingSystemVersion"`

	// Shape name.
	Shape *string `mandatory:"false" contributesTo:"query" name:"shape"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListImagesSortByEnum `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 ListImagesSortOrderEnum `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 ImageLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListImagesRequest wrapper for the ListImages operation

func (ListImagesRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListImagesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListImagesRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListImagesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListImagesRequest) String ¶ 

func (request ListImagesRequest) String() string

type ListImagesResponse ¶ 

type ListImagesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []Image instances
	Items []Image `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.us-phoenix-1.oraclecloud.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"`
}

ListImagesResponse wrapper for the ListImages operation

func (ListImagesResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListImagesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListImagesResponse) String ¶ 

func (response ListImagesResponse) String() string

type ListImagesSortByEnum ¶ 

type ListImagesSortByEnum string

ListImagesSortByEnum Enum with underlying type: string 

const (
	ListImagesSortByTimecreated ListImagesSortByEnum = "TIMECREATED"
	ListImagesSortByDisplayname ListImagesSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListImagesSortByEnum

func GetListImagesSortByEnumValues ¶ 

func GetListImagesSortByEnumValues() []ListImagesSortByEnum

GetListImagesSortByEnumValues Enumerates the set of values for ListImagesSortByEnum

type ListImagesSortOrderEnum ¶ 

type ListImagesSortOrderEnum string

ListImagesSortOrderEnum Enum with underlying type: string 

const (
	ListImagesSortOrderAsc  ListImagesSortOrderEnum = "ASC"
	ListImagesSortOrderDesc ListImagesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListImagesSortOrderEnum

func GetListImagesSortOrderEnumValues ¶ 

func GetListImagesSortOrderEnumValues() []ListImagesSortOrderEnum

GetListImagesSortOrderEnumValues Enumerates the set of values for ListImagesSortOrderEnum

type ListInstanceConfigurationsRequest ¶ 

type ListInstanceConfigurationsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListInstanceConfigurationsSortByEnum `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 ListInstanceConfigurationsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// 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
}

ListInstanceConfigurationsRequest wrapper for the ListInstanceConfigurations operation

func (ListInstanceConfigurationsRequest) HTTPRequest ¶ 

func (request ListInstanceConfigurationsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListInstanceConfigurationsRequest) RetryPolicy ¶ 

func (request ListInstanceConfigurationsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListInstanceConfigurationsRequest) String ¶ 

func (request ListInstanceConfigurationsRequest) String() string

type ListInstanceConfigurationsResponse ¶ 

type ListInstanceConfigurationsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []InstanceConfigurationSummary instances
	Items []InstanceConfigurationSummary `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.us-phoenix-1.oraclecloud.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"`
}

ListInstanceConfigurationsResponse wrapper for the ListInstanceConfigurations operation

func (ListInstanceConfigurationsResponse) HTTPResponse ¶ 

func (response ListInstanceConfigurationsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListInstanceConfigurationsResponse) String ¶ 

func (response ListInstanceConfigurationsResponse) String() string

type ListInstanceConfigurationsSortByEnum ¶ 

type ListInstanceConfigurationsSortByEnum string

ListInstanceConfigurationsSortByEnum Enum with underlying type: string 

const (
	ListInstanceConfigurationsSortByTimecreated ListInstanceConfigurationsSortByEnum = "TIMECREATED"
	ListInstanceConfigurationsSortByDisplayname ListInstanceConfigurationsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListInstanceConfigurationsSortByEnum

func GetListInstanceConfigurationsSortByEnumValues ¶ 

func GetListInstanceConfigurationsSortByEnumValues() []ListInstanceConfigurationsSortByEnum

GetListInstanceConfigurationsSortByEnumValues Enumerates the set of values for ListInstanceConfigurationsSortByEnum

type ListInstanceConfigurationsSortOrderEnum ¶ 

type ListInstanceConfigurationsSortOrderEnum string

ListInstanceConfigurationsSortOrderEnum Enum with underlying type: string 

const (
	ListInstanceConfigurationsSortOrderAsc  ListInstanceConfigurationsSortOrderEnum = "ASC"
	ListInstanceConfigurationsSortOrderDesc ListInstanceConfigurationsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListInstanceConfigurationsSortOrderEnum

func GetListInstanceConfigurationsSortOrderEnumValues ¶ 

func GetListInstanceConfigurationsSortOrderEnumValues() []ListInstanceConfigurationsSortOrderEnum

GetListInstanceConfigurationsSortOrderEnumValues Enumerates the set of values for ListInstanceConfigurationsSortOrderEnum

type ListInstanceConsoleConnectionsRequest ¶ 

type ListInstanceConsoleConnectionsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

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

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"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 `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
}

ListInstanceConsoleConnectionsRequest wrapper for the ListInstanceConsoleConnections operation

func (ListInstanceConsoleConnectionsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListInstanceConsoleConnectionsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListInstanceConsoleConnectionsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListInstanceConsoleConnectionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListInstanceConsoleConnectionsRequest) String ¶ 

func (request ListInstanceConsoleConnectionsRequest) String() string

type ListInstanceConsoleConnectionsResponse ¶ 

type ListInstanceConsoleConnectionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []InstanceConsoleConnection instances
	Items []InstanceConsoleConnection `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.us-phoenix-1.oraclecloud.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"`
}

ListInstanceConsoleConnectionsResponse wrapper for the ListInstanceConsoleConnections operation

func (ListInstanceConsoleConnectionsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListInstanceConsoleConnectionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListInstanceConsoleConnectionsResponse) String ¶ 

func (response ListInstanceConsoleConnectionsResponse) String() string

type ListInstanceDevicesRequest ¶ 

type ListInstanceDevicesRequest struct {

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

	// A filter to return only available devices or only used devices.
	IsAvailable *bool `mandatory:"false" contributesTo:"query" name:"isAvailable"`

	// A filter to return only devices that match the given name exactly.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// 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 field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListInstanceDevicesSortByEnum `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 ListInstanceDevicesSortOrderEnum `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
}

ListInstanceDevicesRequest wrapper for the ListInstanceDevices operation

func (ListInstanceDevicesRequest) HTTPRequest ¶ 

func (request ListInstanceDevicesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListInstanceDevicesRequest) RetryPolicy ¶ 

func (request ListInstanceDevicesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListInstanceDevicesRequest) String ¶ 

func (request ListInstanceDevicesRequest) String() string

type ListInstanceDevicesResponse ¶ 

type ListInstanceDevicesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []Device instances
	Items []Device `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.us-phoenix-1.oraclecloud.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"`
}

ListInstanceDevicesResponse wrapper for the ListInstanceDevices operation

func (ListInstanceDevicesResponse) HTTPResponse ¶ 

func (response ListInstanceDevicesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListInstanceDevicesResponse) String ¶ 

func (response ListInstanceDevicesResponse) String() string

type ListInstanceDevicesSortByEnum ¶ 

type ListInstanceDevicesSortByEnum string

ListInstanceDevicesSortByEnum Enum with underlying type: string 

const (
	ListInstanceDevicesSortByTimecreated ListInstanceDevicesSortByEnum = "TIMECREATED"
	ListInstanceDevicesSortByDisplayname ListInstanceDevicesSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListInstanceDevicesSortByEnum

func GetListInstanceDevicesSortByEnumValues ¶ 

func GetListInstanceDevicesSortByEnumValues() []ListInstanceDevicesSortByEnum

GetListInstanceDevicesSortByEnumValues Enumerates the set of values for ListInstanceDevicesSortByEnum

type ListInstanceDevicesSortOrderEnum ¶ 

type ListInstanceDevicesSortOrderEnum string

ListInstanceDevicesSortOrderEnum Enum with underlying type: string 

const (
	ListInstanceDevicesSortOrderAsc  ListInstanceDevicesSortOrderEnum = "ASC"
	ListInstanceDevicesSortOrderDesc ListInstanceDevicesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListInstanceDevicesSortOrderEnum

func GetListInstanceDevicesSortOrderEnumValues ¶ 

func GetListInstanceDevicesSortOrderEnumValues() []ListInstanceDevicesSortOrderEnum

GetListInstanceDevicesSortOrderEnumValues Enumerates the set of values for ListInstanceDevicesSortOrderEnum

type ListInstancePoolInstancesRequest ¶ 

type ListInstancePoolInstancesRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the instance pool.
	InstancePoolId *string `mandatory:"true" contributesTo:"path" name:"instancePoolId"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListInstancePoolInstancesSortByEnum `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 ListInstancePoolInstancesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// 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
}

ListInstancePoolInstancesRequest wrapper for the ListInstancePoolInstances operation

func (ListInstancePoolInstancesRequest) HTTPRequest ¶ 

func (request ListInstancePoolInstancesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListInstancePoolInstancesRequest) RetryPolicy ¶ 

func (request ListInstancePoolInstancesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListInstancePoolInstancesRequest) String ¶ 

func (request ListInstancePoolInstancesRequest) String() string

type ListInstancePoolInstancesResponse ¶ 

type ListInstancePoolInstancesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []InstanceSummary instances
	Items []InstanceSummary `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.us-phoenix-1.oraclecloud.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"`
}

ListInstancePoolInstancesResponse wrapper for the ListInstancePoolInstances operation

func (ListInstancePoolInstancesResponse) HTTPResponse ¶ 

func (response ListInstancePoolInstancesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListInstancePoolInstancesResponse) String ¶ 

func (response ListInstancePoolInstancesResponse) String() string

type ListInstancePoolInstancesSortByEnum ¶ 

type ListInstancePoolInstancesSortByEnum string

ListInstancePoolInstancesSortByEnum Enum with underlying type: string 

const (
	ListInstancePoolInstancesSortByTimecreated ListInstancePoolInstancesSortByEnum = "TIMECREATED"
	ListInstancePoolInstancesSortByDisplayname ListInstancePoolInstancesSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListInstancePoolInstancesSortByEnum

func GetListInstancePoolInstancesSortByEnumValues ¶ 

func GetListInstancePoolInstancesSortByEnumValues() []ListInstancePoolInstancesSortByEnum

GetListInstancePoolInstancesSortByEnumValues Enumerates the set of values for ListInstancePoolInstancesSortByEnum

type ListInstancePoolInstancesSortOrderEnum ¶ 

type ListInstancePoolInstancesSortOrderEnum string

ListInstancePoolInstancesSortOrderEnum Enum with underlying type: string 

const (
	ListInstancePoolInstancesSortOrderAsc  ListInstancePoolInstancesSortOrderEnum = "ASC"
	ListInstancePoolInstancesSortOrderDesc ListInstancePoolInstancesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListInstancePoolInstancesSortOrderEnum

func GetListInstancePoolInstancesSortOrderEnumValues ¶ 

func GetListInstancePoolInstancesSortOrderEnumValues() []ListInstancePoolInstancesSortOrderEnum

GetListInstancePoolInstancesSortOrderEnumValues Enumerates the set of values for ListInstancePoolInstancesSortOrderEnum

type ListInstancePoolsRequest ¶ 

type ListInstancePoolsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListInstancePoolsSortByEnum `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 ListInstancePoolsSortOrderEnum `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 InstancePoolSummaryLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListInstancePoolsRequest wrapper for the ListInstancePools operation

func (ListInstancePoolsRequest) HTTPRequest ¶ 

func (request ListInstancePoolsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListInstancePoolsRequest) RetryPolicy ¶ 

func (request ListInstancePoolsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListInstancePoolsRequest) String ¶ 

func (request ListInstancePoolsRequest) String() string

type ListInstancePoolsResponse ¶ 

type ListInstancePoolsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []InstancePoolSummary instances
	Items []InstancePoolSummary `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.us-phoenix-1.oraclecloud.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"`
}

ListInstancePoolsResponse wrapper for the ListInstancePools operation

func (ListInstancePoolsResponse) HTTPResponse ¶ 

func (response ListInstancePoolsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListInstancePoolsResponse) String ¶ 

func (response ListInstancePoolsResponse) String() string

type ListInstancePoolsSortByEnum ¶ 

type ListInstancePoolsSortByEnum string

ListInstancePoolsSortByEnum Enum with underlying type: string 

const (
	ListInstancePoolsSortByTimecreated ListInstancePoolsSortByEnum = "TIMECREATED"
	ListInstancePoolsSortByDisplayname ListInstancePoolsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListInstancePoolsSortByEnum

func GetListInstancePoolsSortByEnumValues ¶ 

func GetListInstancePoolsSortByEnumValues() []ListInstancePoolsSortByEnum

GetListInstancePoolsSortByEnumValues Enumerates the set of values for ListInstancePoolsSortByEnum

type ListInstancePoolsSortOrderEnum ¶ 

type ListInstancePoolsSortOrderEnum string

ListInstancePoolsSortOrderEnum Enum with underlying type: string 

const (
	ListInstancePoolsSortOrderAsc  ListInstancePoolsSortOrderEnum = "ASC"
	ListInstancePoolsSortOrderDesc ListInstancePoolsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListInstancePoolsSortOrderEnum

func GetListInstancePoolsSortOrderEnumValues ¶ 

func GetListInstancePoolsSortOrderEnumValues() []ListInstancePoolsSortOrderEnum

GetListInstancePoolsSortOrderEnumValues Enumerates the set of values for ListInstancePoolsSortOrderEnum

type ListInstancesRequest ¶ 

type ListInstancesRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The name of the availability domain.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListInstancesSortByEnum `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 ListInstancesSortOrderEnum `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 InstanceLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListInstancesRequest wrapper for the ListInstances operation

func (ListInstancesRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListInstancesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListInstancesRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListInstancesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListInstancesRequest) String ¶ 

func (request ListInstancesRequest) String() string

type ListInstancesResponse ¶ 

type ListInstancesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []Instance instances
	Items []Instance `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.us-phoenix-1.oraclecloud.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"`
}

ListInstancesResponse wrapper for the ListInstances operation

func (ListInstancesResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListInstancesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListInstancesResponse) String ¶ 

func (response ListInstancesResponse) String() string

type ListInstancesSortByEnum ¶ 

type ListInstancesSortByEnum string

ListInstancesSortByEnum Enum with underlying type: string 

const (
	ListInstancesSortByTimecreated ListInstancesSortByEnum = "TIMECREATED"
	ListInstancesSortByDisplayname ListInstancesSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListInstancesSortByEnum

func GetListInstancesSortByEnumValues ¶ 

func GetListInstancesSortByEnumValues() []ListInstancesSortByEnum

GetListInstancesSortByEnumValues Enumerates the set of values for ListInstancesSortByEnum

type ListInstancesSortOrderEnum ¶ 

type ListInstancesSortOrderEnum string

ListInstancesSortOrderEnum Enum with underlying type: string 

const (
	ListInstancesSortOrderAsc  ListInstancesSortOrderEnum = "ASC"
	ListInstancesSortOrderDesc ListInstancesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListInstancesSortOrderEnum

func GetListInstancesSortOrderEnumValues ¶ 

func GetListInstancesSortOrderEnumValues() []ListInstancesSortOrderEnum

GetListInstancesSortOrderEnumValues Enumerates the set of values for ListInstancesSortOrderEnum

type ListInternetGatewaysRequest ¶ 

type ListInternetGatewaysRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the VCN.
	VcnId *string `mandatory:"true" contributesTo:"query" name:"vcnId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListInternetGatewaysSortByEnum `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 ListInternetGatewaysSortOrderEnum `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 InternetGatewayLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListInternetGatewaysRequest wrapper for the ListInternetGateways operation

func (ListInternetGatewaysRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListInternetGatewaysRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListInternetGatewaysRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListInternetGatewaysRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListInternetGatewaysRequest) String ¶ 

func (request ListInternetGatewaysRequest) String() string

type ListInternetGatewaysResponse ¶ 

type ListInternetGatewaysResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []InternetGateway instances
	Items []InternetGateway `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.us-phoenix-1.oraclecloud.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"`
}

ListInternetGatewaysResponse wrapper for the ListInternetGateways operation

func (ListInternetGatewaysResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListInternetGatewaysResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListInternetGatewaysResponse) String ¶ 

func (response ListInternetGatewaysResponse) String() string

type ListInternetGatewaysSortByEnum ¶ 

type ListInternetGatewaysSortByEnum string

ListInternetGatewaysSortByEnum Enum with underlying type: string 

const (
	ListInternetGatewaysSortByTimecreated ListInternetGatewaysSortByEnum = "TIMECREATED"
	ListInternetGatewaysSortByDisplayname ListInternetGatewaysSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListInternetGatewaysSortByEnum

func GetListInternetGatewaysSortByEnumValues ¶ 

func GetListInternetGatewaysSortByEnumValues() []ListInternetGatewaysSortByEnum

GetListInternetGatewaysSortByEnumValues Enumerates the set of values for ListInternetGatewaysSortByEnum

type ListInternetGatewaysSortOrderEnum ¶ 

type ListInternetGatewaysSortOrderEnum string

ListInternetGatewaysSortOrderEnum Enum with underlying type: string 

const (
	ListInternetGatewaysSortOrderAsc  ListInternetGatewaysSortOrderEnum = "ASC"
	ListInternetGatewaysSortOrderDesc ListInternetGatewaysSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListInternetGatewaysSortOrderEnum

func GetListInternetGatewaysSortOrderEnumValues ¶ 

func GetListInternetGatewaysSortOrderEnumValues() []ListInternetGatewaysSortOrderEnum

GetListInternetGatewaysSortOrderEnumValues Enumerates the set of values for ListInternetGatewaysSortOrderEnum

type ListLocalPeeringGatewaysRequest ¶ 

type ListLocalPeeringGatewaysRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the VCN.
	VcnId *string `mandatory:"true" contributesTo:"query" name:"vcnId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"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 `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
}

ListLocalPeeringGatewaysRequest wrapper for the ListLocalPeeringGateways operation

func (ListLocalPeeringGatewaysRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListLocalPeeringGatewaysRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListLocalPeeringGatewaysRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListLocalPeeringGatewaysRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListLocalPeeringGatewaysRequest) String ¶ 

func (request ListLocalPeeringGatewaysRequest) String() string

type ListLocalPeeringGatewaysResponse ¶ 

type ListLocalPeeringGatewaysResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []LocalPeeringGateway instances
	Items []LocalPeeringGateway `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.us-phoenix-1.oraclecloud.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"`
}

ListLocalPeeringGatewaysResponse wrapper for the ListLocalPeeringGateways operation

func (ListLocalPeeringGatewaysResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListLocalPeeringGatewaysResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListLocalPeeringGatewaysResponse) String ¶ 

func (response ListLocalPeeringGatewaysResponse) String() string

type ListNatGatewaysRequest ¶ 

type ListNatGatewaysRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the VCN.
	VcnId *string `mandatory:"false" contributesTo:"query" name:"vcnId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListNatGatewaysSortByEnum `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 ListNatGatewaysSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
	LifecycleState NatGatewayLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListNatGatewaysRequest wrapper for the ListNatGateways operation

func (ListNatGatewaysRequest) HTTPRequest ¶ 

func (request ListNatGatewaysRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListNatGatewaysRequest) RetryPolicy ¶ 

func (request ListNatGatewaysRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListNatGatewaysRequest) String ¶ 

func (request ListNatGatewaysRequest) String() string

type ListNatGatewaysResponse ¶ 

type ListNatGatewaysResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []NatGateway instances
	Items []NatGateway `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.us-phoenix-1.oraclecloud.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"`
}

ListNatGatewaysResponse wrapper for the ListNatGateways operation

func (ListNatGatewaysResponse) HTTPResponse ¶ 

func (response ListNatGatewaysResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListNatGatewaysResponse) String ¶ 

func (response ListNatGatewaysResponse) String() string

type ListNatGatewaysSortByEnum ¶ 

type ListNatGatewaysSortByEnum string

ListNatGatewaysSortByEnum Enum with underlying type: string 

const (
	ListNatGatewaysSortByTimecreated ListNatGatewaysSortByEnum = "TIMECREATED"
	ListNatGatewaysSortByDisplayname ListNatGatewaysSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListNatGatewaysSortByEnum

func GetListNatGatewaysSortByEnumValues ¶ 

func GetListNatGatewaysSortByEnumValues() []ListNatGatewaysSortByEnum

GetListNatGatewaysSortByEnumValues Enumerates the set of values for ListNatGatewaysSortByEnum

type ListNatGatewaysSortOrderEnum ¶ 

type ListNatGatewaysSortOrderEnum string

ListNatGatewaysSortOrderEnum Enum with underlying type: string 

const (
	ListNatGatewaysSortOrderAsc  ListNatGatewaysSortOrderEnum = "ASC"
	ListNatGatewaysSortOrderDesc ListNatGatewaysSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListNatGatewaysSortOrderEnum

func GetListNatGatewaysSortOrderEnumValues ¶ 

func GetListNatGatewaysSortOrderEnumValues() []ListNatGatewaysSortOrderEnum

GetListNatGatewaysSortOrderEnumValues Enumerates the set of values for ListNatGatewaysSortOrderEnum

type ListPrivateIpsRequest ¶ 

type ListPrivateIpsRequest struct {

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// An IP address.
	// Example: `10.0.3.3`
	IpAddress *string `mandatory:"false" contributesTo:"query" name:"ipAddress"`

	// The OCID of the subnet.
	SubnetId *string `mandatory:"false" contributesTo:"query" name:"subnetId"`

	// The OCID of the VNIC.
	VnicId *string `mandatory:"false" contributesTo:"query" name:"vnicId"`

	// 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
}

ListPrivateIpsRequest wrapper for the ListPrivateIps operation

func (ListPrivateIpsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListPrivateIpsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListPrivateIpsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListPrivateIpsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListPrivateIpsRequest) String ¶ 

func (request ListPrivateIpsRequest) String() string

type ListPrivateIpsResponse ¶ 

type ListPrivateIpsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []PrivateIp instances
	Items []PrivateIp `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.us-phoenix-1.oraclecloud.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"`
}

ListPrivateIpsResponse wrapper for the ListPrivateIps operation

func (ListPrivateIpsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListPrivateIpsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListPrivateIpsResponse) String ¶ 

func (response ListPrivateIpsResponse) String() string

type ListPublicIpsLifetimeEnum ¶ 

type ListPublicIpsLifetimeEnum string

ListPublicIpsLifetimeEnum Enum with underlying type: string 

const (
	ListPublicIpsLifetimeEphemeral ListPublicIpsLifetimeEnum = "EPHEMERAL"
	ListPublicIpsLifetimeReserved  ListPublicIpsLifetimeEnum = "RESERVED"
)

Set of constants representing the allowable values for ListPublicIpsLifetimeEnum

func GetListPublicIpsLifetimeEnumValues ¶ 

func GetListPublicIpsLifetimeEnumValues() []ListPublicIpsLifetimeEnum

GetListPublicIpsLifetimeEnumValues Enumerates the set of values for ListPublicIpsLifetimeEnum

type ListPublicIpsRequest ¶ added in v1.1.0 

type ListPublicIpsRequest struct {

	// Whether the public IP is regional or specific to a particular availability domain.
	// * `REGION`: The public IP exists within a region and is assigned to a regional entity
	// (such as a NatGateway), or can be assigned to a private IP
	// in any availability domain in the region. Reserved public IPs have `scope` = `REGION`, as do
	// ephemeral public IPs assigned to a regional entity.
	// * `AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the entity
	// it's assigned to, which is specified by the `availabilityDomain` property of the public IP object.
	// Ephemeral public IPs that are assigned to private IPs have `scope` = `AVAILABILITY_DOMAIN`.
	Scope ListPublicIpsScopeEnum `mandatory:"true" contributesTo:"query" name:"scope" omitEmpty:"true"`

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The name of the availability domain.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`

	// A filter to return only public IPs that match given lifetime.
	Lifetime ListPublicIpsLifetimeEnum `mandatory:"false" contributesTo:"query" name:"lifetime" omitEmpty:"true"`

	// 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
}

ListPublicIpsRequest wrapper for the ListPublicIps operation

func (ListPublicIpsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListPublicIpsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListPublicIpsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListPublicIpsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListPublicIpsRequest) String ¶ added in v1.1.0 

func (request ListPublicIpsRequest) String() string

type ListPublicIpsResponse ¶ added in v1.1.0 

type ListPublicIpsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []PublicIp instances
	Items []PublicIp `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.us-phoenix-1.oraclecloud.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"`
}

ListPublicIpsResponse wrapper for the ListPublicIps operation

func (ListPublicIpsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListPublicIpsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListPublicIpsResponse) String ¶ added in v1.1.0 

func (response ListPublicIpsResponse) String() string

type ListPublicIpsScopeEnum ¶ added in v1.1.0 

type ListPublicIpsScopeEnum string

ListPublicIpsScopeEnum Enum with underlying type: string 

const (
	ListPublicIpsScopeRegion             ListPublicIpsScopeEnum = "REGION"
	ListPublicIpsScopeAvailabilityDomain ListPublicIpsScopeEnum = "AVAILABILITY_DOMAIN"
)

Set of constants representing the allowable values for ListPublicIpsScopeEnum

func GetListPublicIpsScopeEnumValues ¶ added in v1.1.0 

func GetListPublicIpsScopeEnumValues() []ListPublicIpsScopeEnum

GetListPublicIpsScopeEnumValues Enumerates the set of values for ListPublicIpsScopeEnum

type ListRemotePeeringConnectionsRequest ¶ added in v1.2.0 

type ListRemotePeeringConnectionsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the DRG.
	DrgId *string `mandatory:"false" contributesTo:"query" name:"drgId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"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 `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
}

ListRemotePeeringConnectionsRequest wrapper for the ListRemotePeeringConnections operation

func (ListRemotePeeringConnectionsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListRemotePeeringConnectionsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListRemotePeeringConnectionsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListRemotePeeringConnectionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListRemotePeeringConnectionsRequest) String ¶ added in v1.2.0 

func (request ListRemotePeeringConnectionsRequest) String() string

type ListRemotePeeringConnectionsResponse ¶ added in v1.2.0 

type ListRemotePeeringConnectionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []RemotePeeringConnection instances
	Items []RemotePeeringConnection `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.us-phoenix-1.oraclecloud.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"`
}

ListRemotePeeringConnectionsResponse wrapper for the ListRemotePeeringConnections operation

func (ListRemotePeeringConnectionsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListRemotePeeringConnectionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListRemotePeeringConnectionsResponse) String ¶ added in v1.2.0 

func (response ListRemotePeeringConnectionsResponse) String() string

type ListRouteTablesRequest ¶ 

type ListRouteTablesRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the VCN.
	VcnId *string `mandatory:"true" contributesTo:"query" name:"vcnId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListRouteTablesSortByEnum `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 ListRouteTablesSortOrderEnum `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 RouteTableLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListRouteTablesRequest wrapper for the ListRouteTables operation

func (ListRouteTablesRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListRouteTablesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListRouteTablesRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListRouteTablesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListRouteTablesRequest) String ¶ 

func (request ListRouteTablesRequest) String() string

type ListRouteTablesResponse ¶ 

type ListRouteTablesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []RouteTable instances
	Items []RouteTable `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.us-phoenix-1.oraclecloud.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"`
}

ListRouteTablesResponse wrapper for the ListRouteTables operation

func (ListRouteTablesResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListRouteTablesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListRouteTablesResponse) String ¶ 

func (response ListRouteTablesResponse) String() string

type ListRouteTablesSortByEnum ¶ 

type ListRouteTablesSortByEnum string

ListRouteTablesSortByEnum Enum with underlying type: string 

const (
	ListRouteTablesSortByTimecreated ListRouteTablesSortByEnum = "TIMECREATED"
	ListRouteTablesSortByDisplayname ListRouteTablesSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListRouteTablesSortByEnum

func GetListRouteTablesSortByEnumValues ¶ 

func GetListRouteTablesSortByEnumValues() []ListRouteTablesSortByEnum

GetListRouteTablesSortByEnumValues Enumerates the set of values for ListRouteTablesSortByEnum

type ListRouteTablesSortOrderEnum ¶ 

type ListRouteTablesSortOrderEnum string

ListRouteTablesSortOrderEnum Enum with underlying type: string 

const (
	ListRouteTablesSortOrderAsc  ListRouteTablesSortOrderEnum = "ASC"
	ListRouteTablesSortOrderDesc ListRouteTablesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListRouteTablesSortOrderEnum

func GetListRouteTablesSortOrderEnumValues ¶ 

func GetListRouteTablesSortOrderEnumValues() []ListRouteTablesSortOrderEnum

GetListRouteTablesSortOrderEnumValues Enumerates the set of values for ListRouteTablesSortOrderEnum

type ListSecurityListsRequest ¶ 

type ListSecurityListsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the VCN.
	VcnId *string `mandatory:"true" contributesTo:"query" name:"vcnId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListSecurityListsSortByEnum `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 ListSecurityListsSortOrderEnum `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 SecurityListLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListSecurityListsRequest wrapper for the ListSecurityLists operation

func (ListSecurityListsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListSecurityListsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListSecurityListsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListSecurityListsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListSecurityListsRequest) String ¶ 

func (request ListSecurityListsRequest) String() string

type ListSecurityListsResponse ¶ 

type ListSecurityListsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []SecurityList instances
	Items []SecurityList `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.us-phoenix-1.oraclecloud.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"`
}

ListSecurityListsResponse wrapper for the ListSecurityLists operation

func (ListSecurityListsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListSecurityListsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListSecurityListsResponse) String ¶ 

func (response ListSecurityListsResponse) String() string

type ListSecurityListsSortByEnum ¶ 

type ListSecurityListsSortByEnum string

ListSecurityListsSortByEnum Enum with underlying type: string 

const (
	ListSecurityListsSortByTimecreated ListSecurityListsSortByEnum = "TIMECREATED"
	ListSecurityListsSortByDisplayname ListSecurityListsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListSecurityListsSortByEnum

func GetListSecurityListsSortByEnumValues ¶ 

func GetListSecurityListsSortByEnumValues() []ListSecurityListsSortByEnum

GetListSecurityListsSortByEnumValues Enumerates the set of values for ListSecurityListsSortByEnum

type ListSecurityListsSortOrderEnum ¶ 

type ListSecurityListsSortOrderEnum string

ListSecurityListsSortOrderEnum Enum with underlying type: string 

const (
	ListSecurityListsSortOrderAsc  ListSecurityListsSortOrderEnum = "ASC"
	ListSecurityListsSortOrderDesc ListSecurityListsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSecurityListsSortOrderEnum

func GetListSecurityListsSortOrderEnumValues ¶ 

func GetListSecurityListsSortOrderEnumValues() []ListSecurityListsSortOrderEnum

GetListSecurityListsSortOrderEnumValues Enumerates the set of values for ListSecurityListsSortOrderEnum

type ListServiceGatewaysRequest ¶ added in v1.8.0 

type ListServiceGatewaysRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the VCN.
	VcnId *string `mandatory:"false" contributesTo:"query" name:"vcnId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListServiceGatewaysSortByEnum `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 ListServiceGatewaysSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// A filter to return only resources that match the given lifecycle state.  The state value is case-insensitive.
	LifecycleState ServiceGatewayLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListServiceGatewaysRequest wrapper for the ListServiceGateways operation

func (ListServiceGatewaysRequest) HTTPRequest ¶ added in v1.8.0 

func (request ListServiceGatewaysRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListServiceGatewaysRequest) RetryPolicy ¶ added in v1.8.0 

func (request ListServiceGatewaysRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListServiceGatewaysRequest) String ¶ added in v1.8.0 

func (request ListServiceGatewaysRequest) String() string

type ListServiceGatewaysResponse ¶ added in v1.8.0 

type ListServiceGatewaysResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []ServiceGateway instances
	Items []ServiceGateway `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.us-phoenix-1.oraclecloud.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"`
}

ListServiceGatewaysResponse wrapper for the ListServiceGateways operation

func (ListServiceGatewaysResponse) HTTPResponse ¶ added in v1.8.0 

func (response ListServiceGatewaysResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListServiceGatewaysResponse) String ¶ added in v1.8.0 

func (response ListServiceGatewaysResponse) String() string

type ListServiceGatewaysSortByEnum ¶ added in v1.8.0 

type ListServiceGatewaysSortByEnum string

ListServiceGatewaysSortByEnum Enum with underlying type: string 

const (
	ListServiceGatewaysSortByTimecreated ListServiceGatewaysSortByEnum = "TIMECREATED"
	ListServiceGatewaysSortByDisplayname ListServiceGatewaysSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListServiceGatewaysSortByEnum

func GetListServiceGatewaysSortByEnumValues ¶ added in v1.8.0 

func GetListServiceGatewaysSortByEnumValues() []ListServiceGatewaysSortByEnum

GetListServiceGatewaysSortByEnumValues Enumerates the set of values for ListServiceGatewaysSortByEnum

type ListServiceGatewaysSortOrderEnum ¶ added in v1.8.0 

type ListServiceGatewaysSortOrderEnum string

ListServiceGatewaysSortOrderEnum Enum with underlying type: string 

const (
	ListServiceGatewaysSortOrderAsc  ListServiceGatewaysSortOrderEnum = "ASC"
	ListServiceGatewaysSortOrderDesc ListServiceGatewaysSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListServiceGatewaysSortOrderEnum

func GetListServiceGatewaysSortOrderEnumValues ¶ added in v1.8.0 

func GetListServiceGatewaysSortOrderEnumValues() []ListServiceGatewaysSortOrderEnum

GetListServiceGatewaysSortOrderEnumValues Enumerates the set of values for ListServiceGatewaysSortOrderEnum

type ListServicesRequest ¶ added in v1.8.0 

type ListServicesRequest struct {

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"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 `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
}

ListServicesRequest wrapper for the ListServices operation

func (ListServicesRequest) HTTPRequest ¶ added in v1.8.0 

func (request ListServicesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListServicesRequest) RetryPolicy ¶ added in v1.8.0 

func (request ListServicesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListServicesRequest) String ¶ added in v1.8.0 

func (request ListServicesRequest) String() string

type ListServicesResponse ¶ added in v1.8.0 

type ListServicesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []Service instances
	Items []Service `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.us-phoenix-1.oraclecloud.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"`
}

ListServicesResponse wrapper for the ListServices operation

func (ListServicesResponse) HTTPResponse ¶ added in v1.8.0 

func (response ListServicesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListServicesResponse) String ¶ added in v1.8.0 

func (response ListServicesResponse) String() string

type ListShapesRequest ¶ 

type ListShapesRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The name of the availability domain.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The OCID of an image.
	ImageId *string `mandatory:"false" contributesTo:"query" name:"imageId"`

	// 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
}

ListShapesRequest wrapper for the ListShapes operation

func (ListShapesRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListShapesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListShapesRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListShapesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListShapesRequest) String ¶ 

func (request ListShapesRequest) String() string

type ListShapesResponse ¶ 

type ListShapesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []Shape instances
	Items []Shape `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.us-phoenix-1.oraclecloud.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"`
}

ListShapesResponse wrapper for the ListShapes operation

func (ListShapesResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListShapesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListShapesResponse) String ¶ 

func (response ListShapesResponse) String() string

type ListSubnetsRequest ¶ 

type ListSubnetsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the VCN.
	VcnId *string `mandatory:"true" contributesTo:"query" name:"vcnId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListSubnetsSortByEnum `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 ListSubnetsSortOrderEnum `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 SubnetLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListSubnetsRequest wrapper for the ListSubnets operation

func (ListSubnetsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListSubnetsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListSubnetsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListSubnetsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListSubnetsRequest) String ¶ 

func (request ListSubnetsRequest) String() string

type ListSubnetsResponse ¶ 

type ListSubnetsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []Subnet instances
	Items []Subnet `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.us-phoenix-1.oraclecloud.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"`
}

ListSubnetsResponse wrapper for the ListSubnets operation

func (ListSubnetsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListSubnetsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListSubnetsResponse) String ¶ 

func (response ListSubnetsResponse) String() string

type ListSubnetsSortByEnum ¶ 

type ListSubnetsSortByEnum string

ListSubnetsSortByEnum Enum with underlying type: string 

const (
	ListSubnetsSortByTimecreated ListSubnetsSortByEnum = "TIMECREATED"
	ListSubnetsSortByDisplayname ListSubnetsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListSubnetsSortByEnum

func GetListSubnetsSortByEnumValues ¶ 

func GetListSubnetsSortByEnumValues() []ListSubnetsSortByEnum

GetListSubnetsSortByEnumValues Enumerates the set of values for ListSubnetsSortByEnum

type ListSubnetsSortOrderEnum ¶ 

type ListSubnetsSortOrderEnum string

ListSubnetsSortOrderEnum Enum with underlying type: string 

const (
	ListSubnetsSortOrderAsc  ListSubnetsSortOrderEnum = "ASC"
	ListSubnetsSortOrderDesc ListSubnetsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSubnetsSortOrderEnum

func GetListSubnetsSortOrderEnumValues ¶ 

func GetListSubnetsSortOrderEnumValues() []ListSubnetsSortOrderEnum

GetListSubnetsSortOrderEnumValues Enumerates the set of values for ListSubnetsSortOrderEnum

type ListVcnsRequest ¶ 

type ListVcnsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListVcnsSortByEnum `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 ListVcnsSortOrderEnum `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 VcnLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListVcnsRequest wrapper for the ListVcns operation

func (ListVcnsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListVcnsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListVcnsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListVcnsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListVcnsRequest) String ¶ 

func (request ListVcnsRequest) String() string

type ListVcnsResponse ¶ 

type ListVcnsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []Vcn instances
	Items []Vcn `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.us-phoenix-1.oraclecloud.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"`
}

ListVcnsResponse wrapper for the ListVcns operation

func (ListVcnsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListVcnsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListVcnsResponse) String ¶ 

func (response ListVcnsResponse) String() string

type ListVcnsSortByEnum ¶ 

type ListVcnsSortByEnum string

ListVcnsSortByEnum Enum with underlying type: string 

const (
	ListVcnsSortByTimecreated ListVcnsSortByEnum = "TIMECREATED"
	ListVcnsSortByDisplayname ListVcnsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListVcnsSortByEnum

func GetListVcnsSortByEnumValues ¶ 

func GetListVcnsSortByEnumValues() []ListVcnsSortByEnum

GetListVcnsSortByEnumValues Enumerates the set of values for ListVcnsSortByEnum

type ListVcnsSortOrderEnum ¶ 

type ListVcnsSortOrderEnum string

ListVcnsSortOrderEnum Enum with underlying type: string 

const (
	ListVcnsSortOrderAsc  ListVcnsSortOrderEnum = "ASC"
	ListVcnsSortOrderDesc ListVcnsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListVcnsSortOrderEnum

func GetListVcnsSortOrderEnumValues ¶ 

func GetListVcnsSortOrderEnumValues() []ListVcnsSortOrderEnum

GetListVcnsSortOrderEnumValues Enumerates the set of values for ListVcnsSortOrderEnum

type ListVirtualCircuitBandwidthShapesRequest ¶ 

type ListVirtualCircuitBandwidthShapesRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"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 `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
}

ListVirtualCircuitBandwidthShapesRequest wrapper for the ListVirtualCircuitBandwidthShapes operation

func (ListVirtualCircuitBandwidthShapesRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListVirtualCircuitBandwidthShapesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListVirtualCircuitBandwidthShapesRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListVirtualCircuitBandwidthShapesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListVirtualCircuitBandwidthShapesRequest) String ¶ 

func (request ListVirtualCircuitBandwidthShapesRequest) String() string

type ListVirtualCircuitBandwidthShapesResponse ¶ 

type ListVirtualCircuitBandwidthShapesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []VirtualCircuitBandwidthShape instances
	Items []VirtualCircuitBandwidthShape `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.us-phoenix-1.oraclecloud.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"`
}

ListVirtualCircuitBandwidthShapesResponse wrapper for the ListVirtualCircuitBandwidthShapes operation

func (ListVirtualCircuitBandwidthShapesResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListVirtualCircuitBandwidthShapesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListVirtualCircuitBandwidthShapesResponse) String ¶ 

func (response ListVirtualCircuitBandwidthShapesResponse) String() string

type ListVirtualCircuitPublicPrefixesRequest ¶ 

type ListVirtualCircuitPublicPrefixesRequest struct {

	// The OCID of the virtual circuit.
	VirtualCircuitId *string `mandatory:"true" contributesTo:"path" name:"virtualCircuitId"`

	// A filter to only return resources that match the given verification state.
	// The state value is case-insensitive.
	VerificationState VirtualCircuitPublicPrefixVerificationStateEnum `mandatory:"false" contributesTo:"query" name:"verificationState" omitEmpty:"true"`

	// 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
}

ListVirtualCircuitPublicPrefixesRequest wrapper for the ListVirtualCircuitPublicPrefixes operation

func (ListVirtualCircuitPublicPrefixesRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListVirtualCircuitPublicPrefixesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListVirtualCircuitPublicPrefixesRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListVirtualCircuitPublicPrefixesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListVirtualCircuitPublicPrefixesRequest) String ¶ 

func (request ListVirtualCircuitPublicPrefixesRequest) String() string

type ListVirtualCircuitPublicPrefixesResponse ¶ 

type ListVirtualCircuitPublicPrefixesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The []VirtualCircuitPublicPrefix instance
	Items []VirtualCircuitPublicPrefix `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"`
}

ListVirtualCircuitPublicPrefixesResponse wrapper for the ListVirtualCircuitPublicPrefixes operation

func (ListVirtualCircuitPublicPrefixesResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListVirtualCircuitPublicPrefixesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListVirtualCircuitPublicPrefixesResponse) String ¶ 

func (response ListVirtualCircuitPublicPrefixesResponse) String() string

type ListVirtualCircuitsRequest ¶ 

type ListVirtualCircuitsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListVirtualCircuitsSortByEnum `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 ListVirtualCircuitsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
	LifecycleState VirtualCircuitLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListVirtualCircuitsRequest wrapper for the ListVirtualCircuits operation

func (ListVirtualCircuitsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListVirtualCircuitsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListVirtualCircuitsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListVirtualCircuitsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListVirtualCircuitsRequest) String ¶ 

func (request ListVirtualCircuitsRequest) String() string

type ListVirtualCircuitsResponse ¶ 

type ListVirtualCircuitsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []VirtualCircuit instances
	Items []VirtualCircuit `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.us-phoenix-1.oraclecloud.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"`
}

ListVirtualCircuitsResponse wrapper for the ListVirtualCircuits operation

func (ListVirtualCircuitsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListVirtualCircuitsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListVirtualCircuitsResponse) String ¶ 

func (response ListVirtualCircuitsResponse) String() string

type ListVirtualCircuitsSortByEnum ¶ 

type ListVirtualCircuitsSortByEnum string

ListVirtualCircuitsSortByEnum Enum with underlying type: string 

const (
	ListVirtualCircuitsSortByTimecreated ListVirtualCircuitsSortByEnum = "TIMECREATED"
	ListVirtualCircuitsSortByDisplayname ListVirtualCircuitsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListVirtualCircuitsSortByEnum

func GetListVirtualCircuitsSortByEnumValues ¶ 

func GetListVirtualCircuitsSortByEnumValues() []ListVirtualCircuitsSortByEnum

GetListVirtualCircuitsSortByEnumValues Enumerates the set of values for ListVirtualCircuitsSortByEnum

type ListVirtualCircuitsSortOrderEnum ¶ 

type ListVirtualCircuitsSortOrderEnum string

ListVirtualCircuitsSortOrderEnum Enum with underlying type: string 

const (
	ListVirtualCircuitsSortOrderAsc  ListVirtualCircuitsSortOrderEnum = "ASC"
	ListVirtualCircuitsSortOrderDesc ListVirtualCircuitsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListVirtualCircuitsSortOrderEnum

func GetListVirtualCircuitsSortOrderEnumValues ¶ 

func GetListVirtualCircuitsSortOrderEnumValues() []ListVirtualCircuitsSortOrderEnum

GetListVirtualCircuitsSortOrderEnumValues Enumerates the set of values for ListVirtualCircuitsSortOrderEnum

type ListVnicAttachmentsRequest ¶ 

type ListVnicAttachmentsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The name of the availability domain.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`

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

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The OCID of the VNIC.
	VnicId *string `mandatory:"false" contributesTo:"query" name:"vnicId"`

	// 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
}

ListVnicAttachmentsRequest wrapper for the ListVnicAttachments operation

func (ListVnicAttachmentsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListVnicAttachmentsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListVnicAttachmentsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListVnicAttachmentsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListVnicAttachmentsRequest) String ¶ 

func (request ListVnicAttachmentsRequest) String() string

type ListVnicAttachmentsResponse ¶ 

type ListVnicAttachmentsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []VnicAttachment instances
	Items []VnicAttachment `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.us-phoenix-1.oraclecloud.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"`
}

ListVnicAttachmentsResponse wrapper for the ListVnicAttachments operation

func (ListVnicAttachmentsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListVnicAttachmentsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListVnicAttachmentsResponse) String ¶ 

func (response ListVnicAttachmentsResponse) String() string

type ListVolumeAttachmentsRequest ¶ 

type ListVolumeAttachmentsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The name of the availability domain.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

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

	// The OCID of the volume.
	VolumeId *string `mandatory:"false" contributesTo:"query" name:"volumeId"`

	// 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
}

ListVolumeAttachmentsRequest wrapper for the ListVolumeAttachments operation

func (ListVolumeAttachmentsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListVolumeAttachmentsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListVolumeAttachmentsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListVolumeAttachmentsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListVolumeAttachmentsRequest) String ¶ 

func (request ListVolumeAttachmentsRequest) String() string

type ListVolumeAttachmentsResponse ¶ 

type ListVolumeAttachmentsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []VolumeAttachment instances
	Items []VolumeAttachment `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.us-phoenix-1.oraclecloud.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"`
}

ListVolumeAttachmentsResponse wrapper for the ListVolumeAttachments operation

func (ListVolumeAttachmentsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListVolumeAttachmentsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListVolumeAttachmentsResponse) String ¶ 

func (response ListVolumeAttachmentsResponse) String() string

type ListVolumeBackupPoliciesRequest ¶ added in v1.1.0 

type ListVolumeBackupPoliciesRequest struct {

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"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 `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
}

ListVolumeBackupPoliciesRequest wrapper for the ListVolumeBackupPolicies operation

func (ListVolumeBackupPoliciesRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListVolumeBackupPoliciesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListVolumeBackupPoliciesRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListVolumeBackupPoliciesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListVolumeBackupPoliciesRequest) String ¶ added in v1.1.0 

func (request ListVolumeBackupPoliciesRequest) String() string

type ListVolumeBackupPoliciesResponse ¶ added in v1.1.0 

type ListVolumeBackupPoliciesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []VolumeBackupPolicy instances
	Items []VolumeBackupPolicy `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.us-phoenix-1.oraclecloud.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"`
}

ListVolumeBackupPoliciesResponse wrapper for the ListVolumeBackupPolicies operation

func (ListVolumeBackupPoliciesResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListVolumeBackupPoliciesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListVolumeBackupPoliciesResponse) String ¶ added in v1.1.0 

func (response ListVolumeBackupPoliciesResponse) String() string

type ListVolumeBackupsRequest ¶ 

type ListVolumeBackupsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the volume.
	VolumeId *string `mandatory:"false" contributesTo:"query" name:"volumeId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// A filter to return only resources that originated from the given source volume backup.
	SourceVolumeBackupId *string `mandatory:"false" contributesTo:"query" name:"sourceVolumeBackupId"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListVolumeBackupsSortByEnum `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 ListVolumeBackupsSortOrderEnum `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 VolumeBackupLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListVolumeBackupsRequest wrapper for the ListVolumeBackups operation

func (ListVolumeBackupsRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListVolumeBackupsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListVolumeBackupsRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListVolumeBackupsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListVolumeBackupsRequest) String ¶ 

func (request ListVolumeBackupsRequest) String() string

type ListVolumeBackupsResponse ¶ 

type ListVolumeBackupsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []VolumeBackup instances
	Items []VolumeBackup `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.us-phoenix-1.oraclecloud.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"`
}

ListVolumeBackupsResponse wrapper for the ListVolumeBackups operation

func (ListVolumeBackupsResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListVolumeBackupsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListVolumeBackupsResponse) String ¶ 

func (response ListVolumeBackupsResponse) String() string

type ListVolumeBackupsSortByEnum ¶ 

type ListVolumeBackupsSortByEnum string

ListVolumeBackupsSortByEnum Enum with underlying type: string 

const (
	ListVolumeBackupsSortByTimecreated ListVolumeBackupsSortByEnum = "TIMECREATED"
	ListVolumeBackupsSortByDisplayname ListVolumeBackupsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListVolumeBackupsSortByEnum

func GetListVolumeBackupsSortByEnumValues ¶ 

func GetListVolumeBackupsSortByEnumValues() []ListVolumeBackupsSortByEnum

GetListVolumeBackupsSortByEnumValues Enumerates the set of values for ListVolumeBackupsSortByEnum

type ListVolumeBackupsSortOrderEnum ¶ 

type ListVolumeBackupsSortOrderEnum string

ListVolumeBackupsSortOrderEnum Enum with underlying type: string 

const (
	ListVolumeBackupsSortOrderAsc  ListVolumeBackupsSortOrderEnum = "ASC"
	ListVolumeBackupsSortOrderDesc ListVolumeBackupsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListVolumeBackupsSortOrderEnum

func GetListVolumeBackupsSortOrderEnumValues ¶ 

func GetListVolumeBackupsSortOrderEnumValues() []ListVolumeBackupsSortOrderEnum

GetListVolumeBackupsSortOrderEnumValues Enumerates the set of values for ListVolumeBackupsSortOrderEnum

type ListVolumeGroupBackupsRequest ¶ added in v1.6.0 

type ListVolumeGroupBackupsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The OCID of the volume group.
	VolumeGroupId *string `mandatory:"false" contributesTo:"query" name:"volumeGroupId"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListVolumeGroupBackupsSortByEnum `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 ListVolumeGroupBackupsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// 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
}

ListVolumeGroupBackupsRequest wrapper for the ListVolumeGroupBackups operation

func (ListVolumeGroupBackupsRequest) HTTPRequest ¶ added in v1.6.0 

func (request ListVolumeGroupBackupsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListVolumeGroupBackupsRequest) RetryPolicy ¶ added in v1.6.0 

func (request ListVolumeGroupBackupsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListVolumeGroupBackupsRequest) String ¶ added in v1.6.0 

func (request ListVolumeGroupBackupsRequest) String() string

type ListVolumeGroupBackupsResponse ¶ added in v1.6.0 

type ListVolumeGroupBackupsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []VolumeGroupBackup instances
	Items []VolumeGroupBackup `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.us-phoenix-1.oraclecloud.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"`
}

ListVolumeGroupBackupsResponse wrapper for the ListVolumeGroupBackups operation

func (ListVolumeGroupBackupsResponse) HTTPResponse ¶ added in v1.6.0 

func (response ListVolumeGroupBackupsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListVolumeGroupBackupsResponse) String ¶ added in v1.6.0 

func (response ListVolumeGroupBackupsResponse) String() string

type ListVolumeGroupBackupsSortByEnum ¶ added in v1.6.0 

type ListVolumeGroupBackupsSortByEnum string

ListVolumeGroupBackupsSortByEnum Enum with underlying type: string 

const (
	ListVolumeGroupBackupsSortByTimecreated ListVolumeGroupBackupsSortByEnum = "TIMECREATED"
	ListVolumeGroupBackupsSortByDisplayname ListVolumeGroupBackupsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListVolumeGroupBackupsSortByEnum

func GetListVolumeGroupBackupsSortByEnumValues ¶ added in v1.6.0 

func GetListVolumeGroupBackupsSortByEnumValues() []ListVolumeGroupBackupsSortByEnum

GetListVolumeGroupBackupsSortByEnumValues Enumerates the set of values for ListVolumeGroupBackupsSortByEnum

type ListVolumeGroupBackupsSortOrderEnum ¶ added in v1.6.0 

type ListVolumeGroupBackupsSortOrderEnum string

ListVolumeGroupBackupsSortOrderEnum Enum with underlying type: string 

const (
	ListVolumeGroupBackupsSortOrderAsc  ListVolumeGroupBackupsSortOrderEnum = "ASC"
	ListVolumeGroupBackupsSortOrderDesc ListVolumeGroupBackupsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListVolumeGroupBackupsSortOrderEnum

func GetListVolumeGroupBackupsSortOrderEnumValues ¶ added in v1.6.0 

func GetListVolumeGroupBackupsSortOrderEnumValues() []ListVolumeGroupBackupsSortOrderEnum

GetListVolumeGroupBackupsSortOrderEnumValues Enumerates the set of values for ListVolumeGroupBackupsSortOrderEnum

type ListVolumeGroupsRequest ¶ added in v1.6.0 

type ListVolumeGroupsRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The name of the availability domain.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListVolumeGroupsSortByEnum `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 ListVolumeGroupsSortOrderEnum `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 VolumeGroupLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListVolumeGroupsRequest wrapper for the ListVolumeGroups operation

func (ListVolumeGroupsRequest) HTTPRequest ¶ added in v1.6.0 

func (request ListVolumeGroupsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListVolumeGroupsRequest) RetryPolicy ¶ added in v1.6.0 

func (request ListVolumeGroupsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListVolumeGroupsRequest) String ¶ added in v1.6.0 

func (request ListVolumeGroupsRequest) String() string

type ListVolumeGroupsResponse ¶ added in v1.6.0 

type ListVolumeGroupsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []VolumeGroup instances
	Items []VolumeGroup `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.us-phoenix-1.oraclecloud.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"`
}

ListVolumeGroupsResponse wrapper for the ListVolumeGroups operation

func (ListVolumeGroupsResponse) HTTPResponse ¶ added in v1.6.0 

func (response ListVolumeGroupsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListVolumeGroupsResponse) String ¶ added in v1.6.0 

func (response ListVolumeGroupsResponse) String() string

type ListVolumeGroupsSortByEnum ¶ added in v1.6.0 

type ListVolumeGroupsSortByEnum string

ListVolumeGroupsSortByEnum Enum with underlying type: string 

const (
	ListVolumeGroupsSortByTimecreated ListVolumeGroupsSortByEnum = "TIMECREATED"
	ListVolumeGroupsSortByDisplayname ListVolumeGroupsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListVolumeGroupsSortByEnum

func GetListVolumeGroupsSortByEnumValues ¶ added in v1.6.0 

func GetListVolumeGroupsSortByEnumValues() []ListVolumeGroupsSortByEnum

GetListVolumeGroupsSortByEnumValues Enumerates the set of values for ListVolumeGroupsSortByEnum

type ListVolumeGroupsSortOrderEnum ¶ added in v1.6.0 

type ListVolumeGroupsSortOrderEnum string

ListVolumeGroupsSortOrderEnum Enum with underlying type: string 

const (
	ListVolumeGroupsSortOrderAsc  ListVolumeGroupsSortOrderEnum = "ASC"
	ListVolumeGroupsSortOrderDesc ListVolumeGroupsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListVolumeGroupsSortOrderEnum

func GetListVolumeGroupsSortOrderEnumValues ¶ added in v1.6.0 

func GetListVolumeGroupsSortOrderEnumValues() []ListVolumeGroupsSortOrderEnum

GetListVolumeGroupsSortOrderEnumValues Enumerates the set of values for ListVolumeGroupsSortOrderEnum

type ListVolumesRequest ¶ 

type ListVolumesRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The name of the availability domain.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	// Example: `50`
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// 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.us-phoenix-1.oraclecloud.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The field to sort by. You can provide one sort order (`sortOrder`). Default order for
	// TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
	// sort order is case sensitive.
	// **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 ListVolumesSortByEnum `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 ListVolumesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The OCID of the volume group.
	VolumeGroupId *string `mandatory:"false" contributesTo:"query" name:"volumeGroupId"`

	// A filter to only return resources that match the given lifecycle state.  The state value is case-insensitive.
	LifecycleState VolumeLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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
}

ListVolumesRequest wrapper for the ListVolumes operation

func (ListVolumesRequest) HTTPRequest ¶ added in v1.3.0 

func (request ListVolumesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListVolumesRequest) RetryPolicy ¶ added in v1.3.0 

func (request ListVolumesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListVolumesRequest) String ¶ 

func (request ListVolumesRequest) String() string

type ListVolumesResponse ¶ 

type ListVolumesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []Volume instances
	Items []Volume `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.us-phoenix-1.oraclecloud.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"`
}

ListVolumesResponse wrapper for the ListVolumes operation

func (ListVolumesResponse) HTTPResponse ¶ added in v1.3.0 

func (response ListVolumesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListVolumesResponse) String ¶ 

func (response ListVolumesResponse) String() string

type ListVolumesSortByEnum ¶ 

type ListVolumesSortByEnum string

ListVolumesSortByEnum Enum with underlying type: string 

const (
	ListVolumesSortByTimecreated ListVolumesSortByEnum = "TIMECREATED"
	ListVolumesSortByDisplayname ListVolumesSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListVolumesSortByEnum

func GetListVolumesSortByEnumValues ¶ 

func GetListVolumesSortByEnumValues() []ListVolumesSortByEnum

GetListVolumesSortByEnumValues Enumerates the set of values for ListVolumesSortByEnum

type ListVolumesSortOrderEnum ¶ 

type ListVolumesSortOrderEnum string

ListVolumesSortOrderEnum Enum with underlying type: string 

const (
	ListVolumesSortOrderAsc  ListVolumesSortOrderEnum = "ASC"
	ListVolumesSortOrderDesc ListVolumesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListVolumesSortOrderEnum

func GetListVolumesSortOrderEnumValues ¶ 

func GetListVolumesSortOrderEnumValues() []ListVolumesSortOrderEnum

GetListVolumesSortOrderEnumValues Enumerates the set of values for ListVolumesSortOrderEnum

type LocalPeeringGateway ¶ 

type LocalPeeringGateway struct {

	// The OCID of the compartment containing the LPG.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid
	// entering confidential information.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The LPG's Oracle ID (OCID).
	Id *string `mandatory:"true" json:"id"`

	// Whether the VCN at the other end of the peering is in a different tenancy.
	// Example: `false`
	IsCrossTenancyPeering *bool `mandatory:"true" json:"isCrossTenancyPeering"`

	// The LPG's current lifecycle state.
	LifecycleState LocalPeeringGatewayLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Whether the LPG is peered with another LPG. `NEW` means the LPG has not yet been
	// peered. `PENDING` means the peering is being established. `REVOKED` means the
	// LPG at the other end of the peering has been deleted.
	PeeringStatus LocalPeeringGatewayPeeringStatusEnum `mandatory:"true" json:"peeringStatus"`

	// The date and time the LPG was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The OCID of the VCN the LPG belongs to.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN
	// at the other end of the peering from this LPG. See `peerAdvertisedCidrDetails` for
	// the individual CIDRs. The value is `null` if the LPG is not peered.
	// Example: `192.168.0.0/16`, or if aggregated with `172.16.0.0/24` then `128.0.0.0/1`
	PeerAdvertisedCidr *string `mandatory:"false" json:"peerAdvertisedCidr"`

	// The specific ranges of IP addresses available on or via the VCN at the other
	// end of the peering from this LPG. The value is `null` if the LPG is not peered.
	// You can use these as destination CIDRs for route rules to route a subnet's
	// traffic to this LPG.
	// Example: [`192.168.0.0/16`, `172.16.0.0/24`]
	PeerAdvertisedCidrDetails []string `mandatory:"false" json:"peerAdvertisedCidrDetails"`

	// Additional information regarding the peering status, if applicable.
	PeeringStatusDetails *string `mandatory:"false" json:"peeringStatusDetails"`

	// The OCID of the route table the LPG is using. For information about why you
	// would associate a route table with an LPG, see
	// Advanced Scenario: Transit Routing (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/transitrouting.htm).
	RouteTableId *string `mandatory:"false" json:"routeTableId"`
}

LocalPeeringGateway A local peering gateway (LPG) is an object on a VCN that lets that VCN peer with another VCN in the same region. *Peering* means that the two VCNs can communicate using private IP addresses, but without the traffic traversing the internet or routing through your on-premises network. For more information, see VCN Peering (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/VCNpeering.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (LocalPeeringGateway) String ¶ 

func (m LocalPeeringGateway) String() string

type LocalPeeringGatewayLifecycleStateEnum ¶ 

type LocalPeeringGatewayLifecycleStateEnum string

LocalPeeringGatewayLifecycleStateEnum Enum with underlying type: string 

const (
	LocalPeeringGatewayLifecycleStateProvisioning LocalPeeringGatewayLifecycleStateEnum = "PROVISIONING"
	LocalPeeringGatewayLifecycleStateAvailable    LocalPeeringGatewayLifecycleStateEnum = "AVAILABLE"
	LocalPeeringGatewayLifecycleStateTerminating  LocalPeeringGatewayLifecycleStateEnum = "TERMINATING"
	LocalPeeringGatewayLifecycleStateTerminated   LocalPeeringGatewayLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for LocalPeeringGatewayLifecycleStateEnum

func GetLocalPeeringGatewayLifecycleStateEnumValues ¶ 

func GetLocalPeeringGatewayLifecycleStateEnumValues() []LocalPeeringGatewayLifecycleStateEnum

GetLocalPeeringGatewayLifecycleStateEnumValues Enumerates the set of values for LocalPeeringGatewayLifecycleStateEnum

type LocalPeeringGatewayPeeringStatusEnum ¶ 

type LocalPeeringGatewayPeeringStatusEnum string

LocalPeeringGatewayPeeringStatusEnum Enum with underlying type: string 

const (
	LocalPeeringGatewayPeeringStatusInvalid LocalPeeringGatewayPeeringStatusEnum = "INVALID"
	LocalPeeringGatewayPeeringStatusNew     LocalPeeringGatewayPeeringStatusEnum = "NEW"
	LocalPeeringGatewayPeeringStatusPeered  LocalPeeringGatewayPeeringStatusEnum = "PEERED"
	LocalPeeringGatewayPeeringStatusPending LocalPeeringGatewayPeeringStatusEnum = "PENDING"
	LocalPeeringGatewayPeeringStatusRevoked LocalPeeringGatewayPeeringStatusEnum = "REVOKED"
)

Set of constants representing the allowable values for LocalPeeringGatewayPeeringStatusEnum

func GetLocalPeeringGatewayPeeringStatusEnumValues ¶ 

func GetLocalPeeringGatewayPeeringStatusEnumValues() []LocalPeeringGatewayPeeringStatusEnum

GetLocalPeeringGatewayPeeringStatusEnumValues Enumerates the set of values for LocalPeeringGatewayPeeringStatusEnum

type NatGateway ¶ 

type NatGateway struct {

	// The OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the compartment that contains
	// the NAT gateway.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the NAT gateway.
	Id *string `mandatory:"true" json:"id"`

	// Whether the NAT gateway blocks traffic through it. The default is `false`.
	// Example: `true`
	BlockTraffic *bool `mandatory:"true" json:"blockTraffic"`

	// The NAT gateway's current state.
	LifecycleState NatGatewayLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The IP address associated with the NAT gateway.
	NatIp *string `mandatory:"true" json:"natIp"`

	// The date and time the NAT gateway was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the VCN the NAT gateway
	// belongs to.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

NatGateway A NAT (Network Address Translation) gateway, which represents a router that lets instances without public IPs contact the public internet without exposing the instance to inbound internet traffic. For more information, see NAT Gateway (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/NATgateway.htm). To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (NatGateway) String ¶ 

func (m NatGateway) String() string

type NatGatewayLifecycleStateEnum ¶ 

type NatGatewayLifecycleStateEnum string

NatGatewayLifecycleStateEnum Enum with underlying type: string 

const (
	NatGatewayLifecycleStateProvisioning NatGatewayLifecycleStateEnum = "PROVISIONING"
	NatGatewayLifecycleStateAvailable    NatGatewayLifecycleStateEnum = "AVAILABLE"
	NatGatewayLifecycleStateTerminating  NatGatewayLifecycleStateEnum = "TERMINATING"
	NatGatewayLifecycleStateTerminated   NatGatewayLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for NatGatewayLifecycleStateEnum

func GetNatGatewayLifecycleStateEnumValues ¶ 

func GetNatGatewayLifecycleStateEnumValues() []NatGatewayLifecycleStateEnum

GetNatGatewayLifecycleStateEnumValues Enumerates the set of values for NatGatewayLifecycleStateEnum

type ParavirtualizedVolumeAttachment ¶ added in v1.2.0 

type ParavirtualizedVolumeAttachment struct {

	// The availability domain of an instance.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

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

	// The OCID of the volume attachment.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the instance the volume is attached to.
	InstanceId *string `mandatory:"true" json:"instanceId"`

	// The date and time the volume was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The OCID of the volume.
	VolumeId *string `mandatory:"true" json:"volumeId"`

	// The device name.
	Device *string `mandatory:"false" json:"device"`

	// A user-friendly name. Does not have to be unique, and it cannot be changed.
	// Avoid entering confidential information.
	// Example: `My volume attachment`
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Whether the attachment was created in read-only mode.
	IsReadOnly *bool `mandatory:"false" json:"isReadOnly"`

	// Whether the enable encryption in transit for the PV volume attachment is on or not.
	IsPvEncryptionInTransitEnabled *bool `mandatory:"false" json:"isPvEncryptionInTransitEnabled"`

	// The current state of the volume attachment.
	LifecycleState VolumeAttachmentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}

ParavirtualizedVolumeAttachment A paravirtualized volume attachment.

func (ParavirtualizedVolumeAttachment) GetAvailabilityDomain ¶ added in v1.2.0 

func (m ParavirtualizedVolumeAttachment) GetAvailabilityDomain() *string

GetAvailabilityDomain returns AvailabilityDomain

func (ParavirtualizedVolumeAttachment) GetCompartmentId ¶ added in v1.2.0 

func (m ParavirtualizedVolumeAttachment) GetCompartmentId() *string

GetCompartmentId returns CompartmentId

func (ParavirtualizedVolumeAttachment) GetDevice ¶ 

func (m ParavirtualizedVolumeAttachment) GetDevice() *string

GetDevice returns Device

func (ParavirtualizedVolumeAttachment) GetDisplayName ¶ added in v1.2.0 

func (m ParavirtualizedVolumeAttachment) GetDisplayName() *string

GetDisplayName returns DisplayName

func (ParavirtualizedVolumeAttachment) GetId ¶ added in v1.2.0 

func (m ParavirtualizedVolumeAttachment) GetId() *string

GetId returns Id

func (ParavirtualizedVolumeAttachment) GetInstanceId ¶ added in v1.2.0 

func (m ParavirtualizedVolumeAttachment) GetInstanceId() *string

GetInstanceId returns InstanceId

func (ParavirtualizedVolumeAttachment) GetIsPvEncryptionInTransitEnabled ¶ 

func (m ParavirtualizedVolumeAttachment) GetIsPvEncryptionInTransitEnabled() *bool

GetIsPvEncryptionInTransitEnabled returns IsPvEncryptionInTransitEnabled

func (ParavirtualizedVolumeAttachment) GetIsReadOnly ¶ added in v1.2.0 

func (m ParavirtualizedVolumeAttachment) GetIsReadOnly() *bool

GetIsReadOnly returns IsReadOnly

func (ParavirtualizedVolumeAttachment) GetLifecycleState ¶ added in v1.2.0 

func (m ParavirtualizedVolumeAttachment) GetLifecycleState() VolumeAttachmentLifecycleStateEnum

GetLifecycleState returns LifecycleState

func (ParavirtualizedVolumeAttachment) GetTimeCreated ¶ added in v1.2.0 

func (m ParavirtualizedVolumeAttachment) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (ParavirtualizedVolumeAttachment) GetVolumeId ¶ added in v1.2.0 

func (m ParavirtualizedVolumeAttachment) GetVolumeId() *string

GetVolumeId returns VolumeId

func (ParavirtualizedVolumeAttachment) MarshalJSON ¶ added in v1.2.0 

func (m ParavirtualizedVolumeAttachment) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ParavirtualizedVolumeAttachment) String ¶ added in v1.2.0 

func (m ParavirtualizedVolumeAttachment) String() string

type PeerRegionForRemotePeering ¶ added in v1.2.0 

type PeerRegionForRemotePeering struct {

	// The region's name.
	// Example: `us-phoenix-1`
	Name *string `mandatory:"true" json:"name"`
}

PeerRegionForRemotePeering Details about a region that supports remote VCN peering. For more information, see VCN Peering (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/VCNpeering.htm).

func (PeerRegionForRemotePeering) String ¶ added in v1.2.0 

func (m PeerRegionForRemotePeering) String() string

type PortRange ¶ 

type PortRange struct {

	// The maximum port number. Must not be lower than the minimum port number. To specify
	// a single port number, set both the min and max to the same value.
	Max *int `mandatory:"true" json:"max"`

	// The minimum port number. Must not be greater than the maximum port number.
	Min *int `mandatory:"true" json:"min"`
}

PortRange The representation of PortRange

func (PortRange) String ¶ 

func (m PortRange) String() string

type PrivateIp ¶ 

type PrivateIp struct {

	// The private IP's availability domain.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`

	// The OCID of the compartment containing the private IP.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid
	// entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The hostname for the private IP. Used for DNS. The value is the hostname
	// portion of the private IP's fully qualified domain name (FQDN)
	// (for example, `bminstance-1` in FQDN `bminstance-1.subnet123.vcn1.oraclevcn.com`).
	// Must be unique across all VNICs in the subnet and comply with
	// RFC 952 (https://tools.ietf.org/html/rfc952) and
	// RFC 1123 (https://tools.ietf.org/html/rfc1123).
	// For more information, see
	// DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
	// Example: `bminstance-1`
	HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`

	// The private IP's Oracle ID (OCID).
	Id *string `mandatory:"false" json:"id"`

	// The private IP address of the `privateIp` object. The address is within the CIDR
	// of the VNIC's subnet.
	// Example: `10.0.3.3`
	IpAddress *string `mandatory:"false" json:"ipAddress"`

	// Whether this private IP is the primary one on the VNIC. Primary private IPs
	// are unassigned and deleted automatically when the VNIC is terminated.
	// Example: `true`
	IsPrimary *bool `mandatory:"false" json:"isPrimary"`

	// The OCID of the subnet the VNIC is in.
	SubnetId *string `mandatory:"false" json:"subnetId"`

	// The date and time the private IP was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The OCID of the VNIC the private IP is assigned to. The VNIC and private IP
	// must be in the same subnet.
	VnicId *string `mandatory:"false" json:"vnicId"`
}

PrivateIp A *private IP* is a conceptual term that refers to a private IP address and related properties. The `privateIp` object is the API representation of a private IP. Each instance has a *primary private IP* that is automatically created and assigned to the primary VNIC during instance launch. If you add a secondary VNIC to the instance, it also automatically gets a primary private IP. You can't remove a primary private IP from its VNIC. The primary private IP is automatically deleted when the VNIC is terminated. You can add *secondary private IPs* to a VNIC after it's created. For more information, see the `privateIp` operations and also IP Addresses (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIPaddresses.htm). **Note:** Only ListPrivateIps and GetPrivateIp work with *primary* private IPs. To create and update primary private IPs, you instead work with instance and VNIC operations. For example, a primary private IP's properties come from the values you specify in CreateVnicDetails when calling either LaunchInstance or AttachVnic. To update the hostname for a primary private IP, you use UpdateVnic. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (PrivateIp) String ¶ 

func (m PrivateIp) String() string

type PublicIp ¶ added in v1.1.0 

type PublicIp struct {

	// The OCID of the entity the public IP is assigned to, or in the process of
	// being assigned to.
	AssignedEntityId *string `mandatory:"false" json:"assignedEntityId"`

	// The type of entity the public IP is assigned to, or in the process of being
	// assigned to.
	AssignedEntityType PublicIpAssignedEntityTypeEnum `mandatory:"false" json:"assignedEntityType,omitempty"`

	// The public IP's availability domain. This property is set only for ephemeral public IPs
	// that are assigned to a private IP (that is, when the `scope` of the public IP is set to
	// AVAILABILITY_DOMAIN). The value is the availability domain of the assigned private IP.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`

	// The OCID of the compartment containing the public IP. For an ephemeral public IP, this is
	// the compartment of its assigned entity (which can be a private IP or a regional entity such
	// as a NAT gateway). For a reserved public IP that is currently assigned,
	// its compartment can be different from the assigned private IP's.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid
	// entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The public IP's Oracle ID (OCID).
	Id *string `mandatory:"false" json:"id"`

	// The public IP address of the `publicIp` object.
	// Example: `129.146.2.1`
	IpAddress *string `mandatory:"false" json:"ipAddress"`

	// The public IP's current state.
	LifecycleState PublicIpLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// Defines when the public IP is deleted and released back to Oracle's public IP pool.
	// * `EPHEMERAL`: The lifetime is tied to the lifetime of its assigned entity. An ephemeral
	// public IP must always be assigned to an entity. If the assigned entity is a private IP,
	// the ephemeral public IP is automatically deleted when the private IP is deleted, when
	// the VNIC is terminated, or when the instance is terminated. If the assigned entity is a
	// NatGateway, the ephemeral public IP is automatically
	// deleted when the NAT gateway is terminated.
	// * `RESERVED`: You control the public IP's lifetime. You can delete a reserved public IP
	// whenever you like. It does not need to be assigned to a private IP at all times.
	// For more information and comparison of the two types,
	// see Public IP Addresses (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingpublicIPs.htm).
	Lifetime PublicIpLifetimeEnum `mandatory:"false" json:"lifetime,omitempty"`

	// Deprecated. Use `assignedEntityId` instead.
	// The OCID of the private IP that the public IP is currently assigned to, or in the
	// process of being assigned to.
	// **Note:** This is `null` if the public IP is not assigned to a private IP, or is
	// in the process of being assigned to one.
	PrivateIpId *string `mandatory:"false" json:"privateIpId"`

	// Whether the public IP is regional or specific to a particular availability domain.
	// * `REGION`: The public IP exists within a region and is assigned to a regional entity
	// (such as a NatGateway), or can be assigned to a private
	// IP in any availability domain in the region. Reserved public IPs and ephemeral public IPs
	// assigned to a regional entity have `scope` = `REGION`.
	// * `AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the entity
	// it's assigned to, which is specified by the `availabilityDomain` property of the public IP object.
	// Ephemeral public IPs that are assigned to private IPs have `scope` = `AVAILABILITY_DOMAIN`.
	Scope PublicIpScopeEnum `mandatory:"false" json:"scope,omitempty"`

	// The date and time the public IP was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

PublicIp A *public IP* is a conceptual term that refers to a public IP address and related properties. The `publicIp` object is the API representation of a public IP. There are two types of public IPs: 1. Ephemeral 2. Reserved For more information and comparison of the two types, see Public IP Addresses (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingpublicIPs.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (PublicIp) String ¶ added in v1.1.0 

func (m PublicIp) String() string

type PublicIpAssignedEntityTypeEnum ¶ 

type PublicIpAssignedEntityTypeEnum string

PublicIpAssignedEntityTypeEnum Enum with underlying type: string 

const (
	PublicIpAssignedEntityTypePrivateIp  PublicIpAssignedEntityTypeEnum = "PRIVATE_IP"
	PublicIpAssignedEntityTypeNatGateway PublicIpAssignedEntityTypeEnum = "NAT_GATEWAY"
)

Set of constants representing the allowable values for PublicIpAssignedEntityTypeEnum

func GetPublicIpAssignedEntityTypeEnumValues ¶ 

func GetPublicIpAssignedEntityTypeEnumValues() []PublicIpAssignedEntityTypeEnum

GetPublicIpAssignedEntityTypeEnumValues Enumerates the set of values for PublicIpAssignedEntityTypeEnum

type PublicIpLifecycleStateEnum ¶ added in v1.1.0 

type PublicIpLifecycleStateEnum string

PublicIpLifecycleStateEnum Enum with underlying type: string 

const (
	PublicIpLifecycleStateProvisioning PublicIpLifecycleStateEnum = "PROVISIONING"
	PublicIpLifecycleStateAvailable    PublicIpLifecycleStateEnum = "AVAILABLE"
	PublicIpLifecycleStateAssigning    PublicIpLifecycleStateEnum = "ASSIGNING"
	PublicIpLifecycleStateAssigned     PublicIpLifecycleStateEnum = "ASSIGNED"
	PublicIpLifecycleStateUnassigning  PublicIpLifecycleStateEnum = "UNASSIGNING"
	PublicIpLifecycleStateUnassigned   PublicIpLifecycleStateEnum = "UNASSIGNED"
	PublicIpLifecycleStateTerminating  PublicIpLifecycleStateEnum = "TERMINATING"
	PublicIpLifecycleStateTerminated   PublicIpLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for PublicIpLifecycleStateEnum

func GetPublicIpLifecycleStateEnumValues ¶ added in v1.1.0 

func GetPublicIpLifecycleStateEnumValues() []PublicIpLifecycleStateEnum

GetPublicIpLifecycleStateEnumValues Enumerates the set of values for PublicIpLifecycleStateEnum

type PublicIpLifetimeEnum ¶ added in v1.1.0 

type PublicIpLifetimeEnum string

PublicIpLifetimeEnum Enum with underlying type: string 

const (
	PublicIpLifetimeEphemeral PublicIpLifetimeEnum = "EPHEMERAL"
	PublicIpLifetimeReserved  PublicIpLifetimeEnum = "RESERVED"
)

Set of constants representing the allowable values for PublicIpLifetimeEnum

func GetPublicIpLifetimeEnumValues ¶ added in v1.1.0 

func GetPublicIpLifetimeEnumValues() []PublicIpLifetimeEnum

GetPublicIpLifetimeEnumValues Enumerates the set of values for PublicIpLifetimeEnum

type PublicIpScopeEnum ¶ added in v1.1.0 

type PublicIpScopeEnum string

PublicIpScopeEnum Enum with underlying type: string 

const (
	PublicIpScopeRegion             PublicIpScopeEnum = "REGION"
	PublicIpScopeAvailabilityDomain PublicIpScopeEnum = "AVAILABILITY_DOMAIN"
)

Set of constants representing the allowable values for PublicIpScopeEnum

func GetPublicIpScopeEnumValues ¶ added in v1.1.0 

func GetPublicIpScopeEnumValues() []PublicIpScopeEnum

GetPublicIpScopeEnumValues Enumerates the set of values for PublicIpScopeEnum

type RemotePeeringConnection ¶ added in v1.2.0 

type RemotePeeringConnection struct {

	// The OCID of the compartment that contains the RPC.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The OCID of the DRG that this RPC belongs to.
	DrgId *string `mandatory:"true" json:"drgId"`

	// The OCID of the RPC.
	Id *string `mandatory:"true" json:"id"`

	// Whether the VCN at the other end of the peering is in a different tenancy.
	// Example: `false`
	IsCrossTenancyPeering *bool `mandatory:"true" json:"isCrossTenancyPeering"`

	// The RPC's current lifecycle state.
	LifecycleState RemotePeeringConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Whether the RPC is peered with another RPC. `NEW` means the RPC has not yet been
	// peered. `PENDING` means the peering is being established. `REVOKED` means the
	// RPC at the other end of the peering has been deleted.
	PeeringStatus RemotePeeringConnectionPeeringStatusEnum `mandatory:"true" json:"peeringStatus"`

	// The date and time the RPC was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// If this RPC is peered, this value is the OCID of the other RPC.
	PeerId *string `mandatory:"false" json:"peerId"`

	// If this RPC is peered, this value is the region that contains the other RPC.
	// Example: `us-ashburn-1`
	PeerRegionName *string `mandatory:"false" json:"peerRegionName"`

	// If this RPC is peered, this value is the OCID of the other RPC's tenancy.
	PeerTenancyId *string `mandatory:"false" json:"peerTenancyId"`
}

RemotePeeringConnection A remote peering connection (RPC) is an object on a DRG that lets the VCN that is attached to the DRG peer with a VCN in a different region. *Peering* means that the two VCNs can communicate using private IP addresses, but without the traffic traversing the internet or routing through your on-premises network. For more information, see VCN Peering (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/VCNpeering.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (RemotePeeringConnection) String ¶ added in v1.2.0 

func (m RemotePeeringConnection) String() string

type RemotePeeringConnectionLifecycleStateEnum ¶ added in v1.2.0 

type RemotePeeringConnectionLifecycleStateEnum string

RemotePeeringConnectionLifecycleStateEnum Enum with underlying type: string 

const (
	RemotePeeringConnectionLifecycleStateAvailable    RemotePeeringConnectionLifecycleStateEnum = "AVAILABLE"
	RemotePeeringConnectionLifecycleStateProvisioning RemotePeeringConnectionLifecycleStateEnum = "PROVISIONING"
	RemotePeeringConnectionLifecycleStateTerminating  RemotePeeringConnectionLifecycleStateEnum = "TERMINATING"
	RemotePeeringConnectionLifecycleStateTerminated   RemotePeeringConnectionLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for RemotePeeringConnectionLifecycleStateEnum

func GetRemotePeeringConnectionLifecycleStateEnumValues ¶ added in v1.2.0 

func GetRemotePeeringConnectionLifecycleStateEnumValues() []RemotePeeringConnectionLifecycleStateEnum

GetRemotePeeringConnectionLifecycleStateEnumValues Enumerates the set of values for RemotePeeringConnectionLifecycleStateEnum

type RemotePeeringConnectionPeeringStatusEnum ¶ added in v1.2.0 

type RemotePeeringConnectionPeeringStatusEnum string

RemotePeeringConnectionPeeringStatusEnum Enum with underlying type: string 

const (
	RemotePeeringConnectionPeeringStatusInvalid RemotePeeringConnectionPeeringStatusEnum = "INVALID"
	RemotePeeringConnectionPeeringStatusNew     RemotePeeringConnectionPeeringStatusEnum = "NEW"
	RemotePeeringConnectionPeeringStatusPending RemotePeeringConnectionPeeringStatusEnum = "PENDING"
	RemotePeeringConnectionPeeringStatusPeered  RemotePeeringConnectionPeeringStatusEnum = "PEERED"
	RemotePeeringConnectionPeeringStatusRevoked RemotePeeringConnectionPeeringStatusEnum = "REVOKED"
)

Set of constants representing the allowable values for RemotePeeringConnectionPeeringStatusEnum

func GetRemotePeeringConnectionPeeringStatusEnumValues ¶ added in v1.2.0 

func GetRemotePeeringConnectionPeeringStatusEnumValues() []RemotePeeringConnectionPeeringStatusEnum

GetRemotePeeringConnectionPeeringStatusEnumValues Enumerates the set of values for RemotePeeringConnectionPeeringStatusEnum

type ResetInstancePoolRequest ¶ 

type ResetInstancePoolRequest struct {

	// The OCID of the instance pool.
	InstancePoolId *string `mandatory:"true" contributesTo:"path" name:"instancePoolId"`

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

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

	// 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
}

ResetInstancePoolRequest wrapper for the ResetInstancePool operation

func (ResetInstancePoolRequest) HTTPRequest ¶ 

func (request ResetInstancePoolRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ResetInstancePoolRequest) RetryPolicy ¶ 

func (request ResetInstancePoolRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ResetInstancePoolRequest) String ¶ 

func (request ResetInstancePoolRequest) String() string

type ResetInstancePoolResponse ¶ 

type ResetInstancePoolResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The InstancePool instance
	InstancePool `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"`
}

ResetInstancePoolResponse wrapper for the ResetInstancePool operation

func (ResetInstancePoolResponse) HTTPResponse ¶ 

func (response ResetInstancePoolResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ResetInstancePoolResponse) String ¶ 

func (response ResetInstancePoolResponse) String() string

type RouteRule ¶ 

type RouteRule struct {

	// The OCID for the route rule's target. For information about the type of
	// targets you can specify, see
	// Route Tables (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingroutetables.htm).
	NetworkEntityId *string `mandatory:"true" json:"networkEntityId"`

	// Deprecated. Instead use `destination` and `destinationType`. Requests that include both
	// `cidrBlock` and `destination` will be rejected.
	// A destination IP address range in CIDR notation. Matching packets will
	// be routed to the indicated network entity (the target).
	// Example: `0.0.0.0/0`
	CidrBlock *string `mandatory:"false" json:"cidrBlock"`

	// Conceptually, this is the range of IP addresses used for matching when routing
	// traffic. Required if you provide a `destinationType`.
	// Allowed values:
	//   * IP address range in CIDR notation. For example: `192.168.1.0/24`
	//   * The `cidrBlock` value for a Service, if you're
	//     setting up a route rule for traffic destined for a particular service through
	//     a service gateway. For example: `oci-phx-objectstorage`
	Destination *string `mandatory:"false" json:"destination"`

	// Type of destination for the rule. Required if you provide a `destination`.
	//   * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.
	//   * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a
	//     Service (the rule is for traffic destined for a
	//     particular service through a service gateway).
	DestinationType RouteRuleDestinationTypeEnum `mandatory:"false" json:"destinationType,omitempty"`
}

RouteRule A mapping between a destination IP address range and a virtual device to route matching packets to (a target).

func (RouteRule) String ¶ 

func (m RouteRule) String() string

type RouteRuleDestinationTypeEnum ¶ added in v1.8.0 

type RouteRuleDestinationTypeEnum string

RouteRuleDestinationTypeEnum Enum with underlying type: string 

const (
	RouteRuleDestinationTypeCidrBlock        RouteRuleDestinationTypeEnum = "CIDR_BLOCK"
	RouteRuleDestinationTypeServiceCidrBlock RouteRuleDestinationTypeEnum = "SERVICE_CIDR_BLOCK"
)

Set of constants representing the allowable values for RouteRuleDestinationTypeEnum

func GetRouteRuleDestinationTypeEnumValues ¶ added in v1.8.0 

func GetRouteRuleDestinationTypeEnumValues() []RouteRuleDestinationTypeEnum

GetRouteRuleDestinationTypeEnumValues Enumerates the set of values for RouteRuleDestinationTypeEnum

type RouteTable ¶ 

type RouteTable struct {

	// The OCID of the compartment containing the route table.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The route table's Oracle ID (OCID).
	Id *string `mandatory:"true" json:"id"`

	// The route table's current state.
	LifecycleState RouteTableLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The collection of rules for routing destination IPs to network devices.
	RouteRules []RouteRule `mandatory:"true" json:"routeRules"`

	// The OCID of the VCN the route table list belongs to.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The date and time the route table was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

RouteTable A collection of `RouteRule` objects, which are used to route packets based on destination IP to a particular network entity. For more information, see Overview of the Networking Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (RouteTable) String ¶ 

func (m RouteTable) String() string

type RouteTableLifecycleStateEnum ¶ 

type RouteTableLifecycleStateEnum string

RouteTableLifecycleStateEnum Enum with underlying type: string 

const (
	RouteTableLifecycleStateProvisioning RouteTableLifecycleStateEnum = "PROVISIONING"
	RouteTableLifecycleStateAvailable    RouteTableLifecycleStateEnum = "AVAILABLE"
	RouteTableLifecycleStateTerminating  RouteTableLifecycleStateEnum = "TERMINATING"
	RouteTableLifecycleStateTerminated   RouteTableLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for RouteTableLifecycleStateEnum

func GetRouteTableLifecycleStateEnumValues ¶ 

func GetRouteTableLifecycleStateEnumValues() []RouteTableLifecycleStateEnum

GetRouteTableLifecycleStateEnumValues Enumerates the set of values for RouteTableLifecycleStateEnum

type SecurityList ¶ 

type SecurityList struct {

	// The OCID of the compartment containing the security list.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// Rules for allowing egress IP packets.
	EgressSecurityRules []EgressSecurityRule `mandatory:"true" json:"egressSecurityRules"`

	// The security list's Oracle Cloud ID (OCID).
	Id *string `mandatory:"true" json:"id"`

	// Rules for allowing ingress IP packets.
	IngressSecurityRules []IngressSecurityRule `mandatory:"true" json:"ingressSecurityRules"`

	// The security list's current state.
	LifecycleState SecurityListLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The date and time the security list was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The OCID of the VCN the security list belongs to.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

SecurityList A set of virtual firewall rules for your VCN. Security lists are configured at the subnet level, but the rules are applied to the ingress and egress traffic for the individual instances in the subnet. The rules can be stateful or stateless. For more information, see Security Lists (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/securitylists.htm). **Important:** Oracle Cloud Infrastructure Compute service images automatically include firewall rules (for example, Linux iptables, Windows firewall). If there are issues with some type of access to an instance, make sure both the security lists associated with the instance's subnet and the instance's firewall rules are set correctly. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (SecurityList) String ¶ 

func (m SecurityList) String() string

type SecurityListLifecycleStateEnum ¶ 

type SecurityListLifecycleStateEnum string

SecurityListLifecycleStateEnum Enum with underlying type: string 

const (
	SecurityListLifecycleStateProvisioning SecurityListLifecycleStateEnum = "PROVISIONING"
	SecurityListLifecycleStateAvailable    SecurityListLifecycleStateEnum = "AVAILABLE"
	SecurityListLifecycleStateTerminating  SecurityListLifecycleStateEnum = "TERMINATING"
	SecurityListLifecycleStateTerminated   SecurityListLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for SecurityListLifecycleStateEnum

func GetSecurityListLifecycleStateEnumValues ¶ 

func GetSecurityListLifecycleStateEnumValues() []SecurityListLifecycleStateEnum

GetSecurityListLifecycleStateEnumValues Enumerates the set of values for SecurityListLifecycleStateEnum

type Service ¶ added in v1.8.0 

type Service struct {

	// A string that represents the public endpoints for the service. When you set up a route rule
	// to route traffic to the service gateway, use this value as the destination CIDR block for
	// the rule. See RouteTable.
	CidrBlock *string `mandatory:"true" json:"cidrBlock"`

	// Description of the service.
	Description *string `mandatory:"true" json:"description"`

	// The service's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
	Id *string `mandatory:"true" json:"id"`

	// Name of the service. This name can change and is not guaranteed to be unique.
	Name *string `mandatory:"true" json:"name"`
}

Service Information about a service that is accessible through a service gateway.

func (Service) String ¶ added in v1.8.0 

func (m Service) String() string

type ServiceGateway ¶ added in v1.8.0 

type ServiceGateway struct {

	// Whether the service gateway blocks all traffic through it. The default is `false`. When
	// this is `true`, traffic is not routed to any services, regardless of route rules.
	// Example: `true`
	BlockTraffic *bool `mandatory:"true" json:"blockTraffic"`

	// The OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the compartment that contains the
	// service gateway.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the service gateway.
	Id *string `mandatory:"true" json:"id"`

	// The service gateway's current state.
	LifecycleState ServiceGatewayLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// List of the services enabled on this service gateway. The list can be empty.
	// You can enable a particular service by using
	// AttachServiceId.
	Services []ServiceIdResponseDetails `mandatory:"true" json:"services"`

	// The OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the VCN the service gateway
	// belongs to.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The date and time the service gateway was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

ServiceGateway Represents a router that connects the edge of a VCN with public Oracle Cloud Infrastructure services such as Object Storage. Traffic leaving the VCN and destined for a supported public service (see ListServices) is routed through the service gateway and does not traverse the internet. The instances in the VCN do not need to have public IP addresses nor be in a public subnet. The VCN does not need an internet gateway for this traffic. For more information, see Access to Object Storage: Service Gateway (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/servicegateway.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (ServiceGateway) String ¶ added in v1.8.0 

func (m ServiceGateway) String() string

type ServiceGatewayLifecycleStateEnum ¶ added in v1.8.0 

type ServiceGatewayLifecycleStateEnum string

ServiceGatewayLifecycleStateEnum Enum with underlying type: string 

const (
	ServiceGatewayLifecycleStateProvisioning ServiceGatewayLifecycleStateEnum = "PROVISIONING"
	ServiceGatewayLifecycleStateAvailable    ServiceGatewayLifecycleStateEnum = "AVAILABLE"
	ServiceGatewayLifecycleStateTerminating  ServiceGatewayLifecycleStateEnum = "TERMINATING"
	ServiceGatewayLifecycleStateTerminated   ServiceGatewayLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for ServiceGatewayLifecycleStateEnum

func GetServiceGatewayLifecycleStateEnumValues ¶ added in v1.8.0 

func GetServiceGatewayLifecycleStateEnumValues() []ServiceGatewayLifecycleStateEnum

GetServiceGatewayLifecycleStateEnumValues Enumerates the set of values for ServiceGatewayLifecycleStateEnum

type ServiceIdRequestDetails ¶ added in v1.8.0 

type ServiceIdRequestDetails struct {

	// The OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the service.
	ServiceId *string `mandatory:"true" json:"serviceId"`
}

ServiceIdRequestDetails The representation of ServiceIdRequestDetails

func (ServiceIdRequestDetails) String ¶ added in v1.8.0 

func (m ServiceIdRequestDetails) String() string

type ServiceIdResponseDetails ¶ added in v1.8.0 

type ServiceIdResponseDetails struct {

	// The OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm) of the service.
	ServiceId *string `mandatory:"true" json:"serviceId"`

	// The name of the service.
	ServiceName *string `mandatory:"true" json:"serviceName"`
}

ServiceIdResponseDetails The representation of ServiceIdResponseDetails

func (ServiceIdResponseDetails) String ¶ added in v1.8.0 

func (m ServiceIdResponseDetails) String() string

type Shape ¶ 

type Shape struct {

	// The name of the shape. You can enumerate all available shapes by calling
	// ListShapes.
	Shape *string `mandatory:"true" json:"shape"`
}

Shape A compute instance shape that can be used in LaunchInstance. For more information, see Overview of the Compute Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Compute/Concepts/computeoverview.htm).

func (Shape) String ¶ 

func (m Shape) String() string

type SoftresetInstancePoolRequest ¶ 

type SoftresetInstancePoolRequest struct {

	// The OCID of the instance pool.
	InstancePoolId *string `mandatory:"true" contributesTo:"path" name:"instancePoolId"`

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

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

	// 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
}

SoftresetInstancePoolRequest wrapper for the SoftresetInstancePool operation

func (SoftresetInstancePoolRequest) HTTPRequest ¶ 

func (request SoftresetInstancePoolRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (SoftresetInstancePoolRequest) RetryPolicy ¶ 

func (request SoftresetInstancePoolRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (SoftresetInstancePoolRequest) String ¶ 

func (request SoftresetInstancePoolRequest) String() string

type SoftresetInstancePoolResponse ¶ 

type SoftresetInstancePoolResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The InstancePool instance
	InstancePool `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"`
}

SoftresetInstancePoolResponse wrapper for the SoftresetInstancePool operation

func (SoftresetInstancePoolResponse) HTTPResponse ¶ 

func (response SoftresetInstancePoolResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (SoftresetInstancePoolResponse) String ¶ 

func (response SoftresetInstancePoolResponse) String() string

type StartInstancePoolRequest ¶ 

type StartInstancePoolRequest struct {

	// The OCID of the instance pool.
	InstancePoolId *string `mandatory:"true" contributesTo:"path" name:"instancePoolId"`

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

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

	// 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
}

StartInstancePoolRequest wrapper for the StartInstancePool operation

func (StartInstancePoolRequest) HTTPRequest ¶ 

func (request StartInstancePoolRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StartInstancePoolRequest) RetryPolicy ¶ 

func (request StartInstancePoolRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (StartInstancePoolRequest) String ¶ 

func (request StartInstancePoolRequest) String() string

type StartInstancePoolResponse ¶ 

type StartInstancePoolResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The InstancePool instance
	InstancePool `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"`
}

StartInstancePoolResponse wrapper for the StartInstancePool operation

func (StartInstancePoolResponse) HTTPResponse ¶ 

func (response StartInstancePoolResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (StartInstancePoolResponse) String ¶ 

func (response StartInstancePoolResponse) String() string

type StopInstancePoolRequest ¶ 

type StopInstancePoolRequest struct {

	// The OCID of the instance pool.
	InstancePoolId *string `mandatory:"true" contributesTo:"path" name:"instancePoolId"`

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

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

	// 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
}

StopInstancePoolRequest wrapper for the StopInstancePool operation

func (StopInstancePoolRequest) HTTPRequest ¶ 

func (request StopInstancePoolRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StopInstancePoolRequest) RetryPolicy ¶ 

func (request StopInstancePoolRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (StopInstancePoolRequest) String ¶ 

func (request StopInstancePoolRequest) String() string

type StopInstancePoolResponse ¶ 

type StopInstancePoolResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The InstancePool instance
	InstancePool `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"`
}

StopInstancePoolResponse wrapper for the StopInstancePool operation

func (StopInstancePoolResponse) HTTPResponse ¶ 

func (response StopInstancePoolResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (StopInstancePoolResponse) String ¶ 

func (response StopInstancePoolResponse) String() string

type Subnet ¶ 

type Subnet struct {

	// The subnet's availability domain.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The subnet's CIDR block.
	// Example: `172.16.1.0/24`
	CidrBlock *string `mandatory:"true" json:"cidrBlock"`

	// The OCID of the compartment containing the subnet.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The subnet's Oracle ID (OCID).
	Id *string `mandatory:"true" json:"id"`

	// The subnet's current state.
	LifecycleState SubnetLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The OCID of the route table that the subnet uses.
	RouteTableId *string `mandatory:"true" json:"routeTableId"`

	// The OCID of the VCN the subnet is in.
	VcnId *string `mandatory:"true" json:"vcnId"`

	// The IP address of the virtual router.
	// Example: `10.0.14.1`
	VirtualRouterIp *string `mandatory:"true" json:"virtualRouterIp"`

	// The MAC address of the virtual router.
	// Example: `00:00:17:B6:4D:DD`
	VirtualRouterMac *string `mandatory:"true" json:"virtualRouterMac"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// The OCID of the set of DHCP options that the subnet uses.
	DhcpOptionsId *string `mandatory:"false" json:"dhcpOptionsId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// A DNS label for the subnet, used in conjunction with the VNIC's hostname and
	// VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC
	// within this subnet (for example, `bminstance-1.subnet123.vcn1.oraclevcn.com`).
	// Must be an alphanumeric string that begins with a letter and is unique within the VCN.
	// The value cannot be changed.
	// The absence of this parameter means the Internet and VCN Resolver
	// will not resolve hostnames of instances in this subnet.
	// For more information, see
	// DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
	// Example: `subnet123`
	DnsLabel *string `mandatory:"false" json:"dnsLabel"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Whether VNICs within this subnet can have public IP addresses.
	// Defaults to false, which means VNICs created in this subnet will
	// automatically be assigned public IP addresses unless specified
	// otherwise during instance launch or VNIC creation (with the
	// `assignPublicIp` flag in
	// CreateVnicDetails).
	// If `prohibitPublicIpOnVnic` is set to true, VNICs created in this
	// subnet cannot have public IP addresses (that is, it's a private
	// subnet).
	// Example: `true`
	ProhibitPublicIpOnVnic *bool `mandatory:"false" json:"prohibitPublicIpOnVnic"`

	// The OCIDs of the security list or lists that the subnet uses. Remember
	// that security lists are associated *with the subnet*, but the
	// rules are applied to the individual VNICs in the subnet.
	SecurityListIds []string `mandatory:"false" json:"securityListIds"`

	// The subnet's domain name, which consists of the subnet's DNS label,
	// the VCN's DNS label, and the `oraclevcn.com` domain.
	// For more information, see
	// DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
	// Example: `subnet123.vcn1.oraclevcn.com`
	SubnetDomainName *string `mandatory:"false" json:"subnetDomainName"`

	// The date and time the subnet was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

Subnet A logical subdivision of a VCN. Each subnet exists in a single availability domain and consists of a contiguous range of IP addresses that do not overlap with other subnets in the VCN. Example: 172.16.1.0/24. For more information, see Overview of the Networking Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm) and VCNs and Subnets (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVCNs.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (Subnet) String ¶ 

func (m Subnet) String() string

type SubnetLifecycleStateEnum ¶ 

type SubnetLifecycleStateEnum string

SubnetLifecycleStateEnum Enum with underlying type: string 

const (
	SubnetLifecycleStateProvisioning SubnetLifecycleStateEnum = "PROVISIONING"
	SubnetLifecycleStateAvailable    SubnetLifecycleStateEnum = "AVAILABLE"
	SubnetLifecycleStateTerminating  SubnetLifecycleStateEnum = "TERMINATING"
	SubnetLifecycleStateTerminated   SubnetLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for SubnetLifecycleStateEnum

func GetSubnetLifecycleStateEnumValues ¶ 

func GetSubnetLifecycleStateEnumValues() []SubnetLifecycleStateEnum

GetSubnetLifecycleStateEnumValues Enumerates the set of values for SubnetLifecycleStateEnum

type TcpOptions ¶ 

type TcpOptions struct {

	// An inclusive range of allowed destination ports. Use the same number for the min and max
	// to indicate a single port. Defaults to all ports if not specified.
	DestinationPortRange *PortRange `mandatory:"false" json:"destinationPortRange"`

	// An inclusive range of allowed source ports. Use the same number for the min and max to
	// indicate a single port. Defaults to all ports if not specified.
	SourcePortRange *PortRange `mandatory:"false" json:"sourcePortRange"`
}

TcpOptions Optional object to specify ports for a TCP rule. If you specify TCP as the protocol but omit this object, then all ports are allowed.

func (TcpOptions) String ¶ 

func (m TcpOptions) String() string

type TerminateInstancePoolRequest ¶ 

type TerminateInstancePoolRequest struct {

	// The OCID of the instance pool.
	InstancePoolId *string `mandatory:"true" contributesTo:"path" name:"instancePoolId"`

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

	// 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
}

TerminateInstancePoolRequest wrapper for the TerminateInstancePool operation

func (TerminateInstancePoolRequest) HTTPRequest ¶ 

func (request TerminateInstancePoolRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (TerminateInstancePoolRequest) RetryPolicy ¶ 

func (request TerminateInstancePoolRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (TerminateInstancePoolRequest) String ¶ 

func (request TerminateInstancePoolRequest) String() string

type TerminateInstancePoolResponse ¶ 

type TerminateInstancePoolResponse 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"`
}

TerminateInstancePoolResponse wrapper for the TerminateInstancePool operation

func (TerminateInstancePoolResponse) HTTPResponse ¶ 

func (response TerminateInstancePoolResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (TerminateInstancePoolResponse) String ¶ 

func (response TerminateInstancePoolResponse) String() string

type TerminateInstanceRequest ¶ 

type TerminateInstanceRequest struct {

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

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

	// Specifies whether to delete or preserve the boot volume when terminating an instance.
	// The default value is false.
	PreserveBootVolume *bool `mandatory:"false" contributesTo:"query" name:"preserveBootVolume"`

	// 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
}

TerminateInstanceRequest wrapper for the TerminateInstance operation

func (TerminateInstanceRequest) HTTPRequest ¶ added in v1.3.0 

func (request TerminateInstanceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (TerminateInstanceRequest) RetryPolicy ¶ added in v1.3.0 

func (request TerminateInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (TerminateInstanceRequest) String ¶ 

func (request TerminateInstanceRequest) String() string

type TerminateInstanceResponse ¶ 

type TerminateInstanceResponse 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"`
}

TerminateInstanceResponse wrapper for the TerminateInstance operation

func (TerminateInstanceResponse) HTTPResponse ¶ added in v1.3.0 

func (response TerminateInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (TerminateInstanceResponse) String ¶ 

func (response TerminateInstanceResponse) String() string

type TunnelConfig ¶ 

type TunnelConfig struct {

	// The IP address of Oracle's VPN headend.
	// Example: `129.146.17.50`
	IpAddress *string `mandatory:"true" json:"ipAddress"`

	// The shared secret of the IPSec tunnel.
	// Example: `vFG2IF6TWq4UToUiLSRDoJEUs6j1c.p8G.dVQxiMfMO0yXMLi.lZTbYIWhGu4V8o`
	SharedSecret *string `mandatory:"true" json:"sharedSecret"`

	// The date and time the IPSec connection was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}

TunnelConfig Specific connection details for an IPSec tunnel.

func (TunnelConfig) String ¶ 

func (m TunnelConfig) String() string

type TunnelStatus ¶ 

type TunnelStatus struct {

	// The IP address of Oracle's VPN headend.
	// Example: `129.146.17.50`
	IpAddress *string `mandatory:"true" json:"ipAddress"`

	// The tunnel's current state.
	LifecycleState TunnelStatusLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The date and time the IPSec connection was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// When the state of the tunnel last changed, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeStateModified *common.SDKTime `mandatory:"false" json:"timeStateModified"`
}

TunnelStatus Specific connection details for an IPSec tunnel.

func (TunnelStatus) String ¶ 

func (m TunnelStatus) String() string

type TunnelStatusLifecycleStateEnum ¶ 

type TunnelStatusLifecycleStateEnum string

TunnelStatusLifecycleStateEnum Enum with underlying type: string 

const (
	TunnelStatusLifecycleStateUp                 TunnelStatusLifecycleStateEnum = "UP"
	TunnelStatusLifecycleStateDown               TunnelStatusLifecycleStateEnum = "DOWN"
	TunnelStatusLifecycleStateDownForMaintenance TunnelStatusLifecycleStateEnum = "DOWN_FOR_MAINTENANCE"
)

Set of constants representing the allowable values for TunnelStatusLifecycleStateEnum

func GetTunnelStatusLifecycleStateEnumValues ¶ 

func GetTunnelStatusLifecycleStateEnumValues() []TunnelStatusLifecycleStateEnum

GetTunnelStatusLifecycleStateEnumValues Enumerates the set of values for TunnelStatusLifecycleStateEnum

type UdpOptions ¶ 

type UdpOptions struct {

	// An inclusive range of allowed destination ports. Use the same number for the min and max
	// to indicate a single port. Defaults to all ports if not specified.
	DestinationPortRange *PortRange `mandatory:"false" json:"destinationPortRange"`

	// An inclusive range of allowed source ports. Use the same number for the min and max to
	// indicate a single port. Defaults to all ports if not specified.
	SourcePortRange *PortRange `mandatory:"false" json:"sourcePortRange"`
}

UdpOptions Optional object to specify ports for a UDP rule. If you specify UDP as the protocol but omit this object, then all ports are allowed.

func (UdpOptions) String ¶ 

func (m UdpOptions) String() string

type UpdateBootVolumeBackupDetails ¶ added in v1.8.0 

type UpdateBootVolumeBackupDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A friendly user-specified name for the boot volume backup.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

UpdateBootVolumeBackupDetails The representation of UpdateBootVolumeBackupDetails

func (UpdateBootVolumeBackupDetails) String ¶ added in v1.8.0 

func (m UpdateBootVolumeBackupDetails) String() string

type UpdateBootVolumeBackupRequest ¶ added in v1.8.0 

type UpdateBootVolumeBackupRequest struct {

	// The OCID of the boot volume backup.
	BootVolumeBackupId *string `mandatory:"true" contributesTo:"path" name:"bootVolumeBackupId"`

	// Update boot volume backup fields
	UpdateBootVolumeBackupDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateBootVolumeBackupRequest wrapper for the UpdateBootVolumeBackup operation

func (UpdateBootVolumeBackupRequest) HTTPRequest ¶ added in v1.8.0 

func (request UpdateBootVolumeBackupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateBootVolumeBackupRequest) RetryPolicy ¶ added in v1.8.0 

func (request UpdateBootVolumeBackupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateBootVolumeBackupRequest) String ¶ added in v1.8.0 

func (request UpdateBootVolumeBackupRequest) String() string

type UpdateBootVolumeBackupResponse ¶ added in v1.8.0 

type UpdateBootVolumeBackupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BootVolumeBackup instance
	BootVolumeBackup `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateBootVolumeBackupResponse wrapper for the UpdateBootVolumeBackup operation

func (UpdateBootVolumeBackupResponse) HTTPResponse ¶ added in v1.8.0 

func (response UpdateBootVolumeBackupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateBootVolumeBackupResponse) String ¶ added in v1.8.0 

func (response UpdateBootVolumeBackupResponse) String() string

type UpdateBootVolumeDetails ¶ 

type UpdateBootVolumeDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The size to resize the volume to in GBs. Has to be larger than the current size.
	SizeInGBs *int64 `mandatory:"false" json:"sizeInGBs"`
}

UpdateBootVolumeDetails The representation of UpdateBootVolumeDetails

func (UpdateBootVolumeDetails) String ¶ 

func (m UpdateBootVolumeDetails) String() string

type UpdateBootVolumeKmsKeyDetails ¶ 

type UpdateBootVolumeKmsKeyDetails struct {

	// The new kms key which will be used to protect the specific volume.
	// This key has to be a valid kms key ocid, and user must have key delegation policy to allow them to access this key.
	// Even if this new kms key is the same as the previous kms key id, block storage service will use it to regenerate a new volume encryption key.
	// Example: `{"kmsKeyId": "ocid1.key.region1.sea.afnl2n7daag4s.abzwkljs6uevhlgcznhmh7oiatyrxngrywc3tje3uk3g77hzmewqiieuk75f"}`
	KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
}

UpdateBootVolumeKmsKeyDetails The representation of UpdateBootVolumeKmsKeyDetails

func (UpdateBootVolumeKmsKeyDetails) String ¶ 

func (m UpdateBootVolumeKmsKeyDetails) String() string

type UpdateBootVolumeKmsKeyRequest ¶ 

type UpdateBootVolumeKmsKeyRequest struct {

	// The OCID of the boot volume.
	BootVolumeId *string `mandatory:"true" contributesTo:"path" name:"bootVolumeId"`

	// Update kms key id for the specific boot volume.
	UpdateBootVolumeKmsKeyDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateBootVolumeKmsKeyRequest wrapper for the UpdateBootVolumeKmsKey operation

func (UpdateBootVolumeKmsKeyRequest) HTTPRequest ¶ 

func (request UpdateBootVolumeKmsKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateBootVolumeKmsKeyRequest) RetryPolicy ¶ 

func (request UpdateBootVolumeKmsKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateBootVolumeKmsKeyRequest) String ¶ 

func (request UpdateBootVolumeKmsKeyRequest) String() string

type UpdateBootVolumeKmsKeyResponse ¶ 

type UpdateBootVolumeKmsKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BootVolumeKmsKey instance
	BootVolumeKmsKey `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"`
}

UpdateBootVolumeKmsKeyResponse wrapper for the UpdateBootVolumeKmsKey operation

func (UpdateBootVolumeKmsKeyResponse) HTTPResponse ¶ 

func (response UpdateBootVolumeKmsKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateBootVolumeKmsKeyResponse) String ¶ 

func (response UpdateBootVolumeKmsKeyResponse) String() string

type UpdateBootVolumeRequest ¶ 

type UpdateBootVolumeRequest struct {

	// The OCID of the boot volume.
	BootVolumeId *string `mandatory:"true" contributesTo:"path" name:"bootVolumeId"`

	// Update boot volume's display name.
	UpdateBootVolumeDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateBootVolumeRequest wrapper for the UpdateBootVolume operation

func (UpdateBootVolumeRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateBootVolumeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateBootVolumeRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateBootVolumeRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateBootVolumeRequest) String ¶ 

func (request UpdateBootVolumeRequest) String() string

type UpdateBootVolumeResponse ¶ 

type UpdateBootVolumeResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BootVolume instance
	BootVolume `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"`
}

UpdateBootVolumeResponse wrapper for the UpdateBootVolume operation

func (UpdateBootVolumeResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateBootVolumeResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateBootVolumeResponse) String ¶ 

func (response UpdateBootVolumeResponse) String() string

type UpdateConsoleHistoryDetails ¶ 

type UpdateConsoleHistoryDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

UpdateConsoleHistoryDetails The representation of UpdateConsoleHistoryDetails

func (UpdateConsoleHistoryDetails) String ¶ 

func (m UpdateConsoleHistoryDetails) String() string

type UpdateConsoleHistoryRequest ¶ 

type UpdateConsoleHistoryRequest struct {

	// The OCID of the console history.
	InstanceConsoleHistoryId *string `mandatory:"true" contributesTo:"path" name:"instanceConsoleHistoryId"`

	// Update instance fields
	UpdateConsoleHistoryDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateConsoleHistoryRequest wrapper for the UpdateConsoleHistory operation

func (UpdateConsoleHistoryRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateConsoleHistoryRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateConsoleHistoryRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateConsoleHistoryRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateConsoleHistoryRequest) String ¶ 

func (request UpdateConsoleHistoryRequest) String() string

type UpdateConsoleHistoryResponse ¶ 

type UpdateConsoleHistoryResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ConsoleHistory instance
	ConsoleHistory `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"`
}

UpdateConsoleHistoryResponse wrapper for the UpdateConsoleHistory operation

func (UpdateConsoleHistoryResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateConsoleHistoryResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateConsoleHistoryResponse) String ¶ 

func (response UpdateConsoleHistoryResponse) String() string

type UpdateCpeDetails ¶ 

type UpdateCpeDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

UpdateCpeDetails The representation of UpdateCpeDetails

func (UpdateCpeDetails) String ¶ 

func (m UpdateCpeDetails) String() string

type UpdateCpeRequest ¶ 

type UpdateCpeRequest struct {

	// The OCID of the CPE.
	CpeId *string `mandatory:"true" contributesTo:"path" name:"cpeId"`

	// Details object for updating a CPE.
	UpdateCpeDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateCpeRequest wrapper for the UpdateCpe operation

func (UpdateCpeRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateCpeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateCpeRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateCpeRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateCpeRequest) String ¶ 

func (request UpdateCpeRequest) String() string

type UpdateCpeResponse ¶ 

type UpdateCpeResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Cpe instance
	Cpe `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"`
}

UpdateCpeResponse wrapper for the UpdateCpe operation

func (UpdateCpeResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateCpeResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateCpeResponse) String ¶ 

func (response UpdateCpeResponse) String() string

type UpdateCrossConnectDetails ¶ 

type UpdateCrossConnectDetails struct {

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Set to true to activate the cross-connect. You activate it after the physical cabling
	// is complete, and you've confirmed the cross-connect's light levels are good and your side
	// of the interface is up. Activation indicates to Oracle that the physical connection is ready.
	// Example: `true`
	IsActive *bool `mandatory:"false" json:"isActive"`
}

UpdateCrossConnectDetails Update a CrossConnect

func (UpdateCrossConnectDetails) String ¶ 

func (m UpdateCrossConnectDetails) String() string

type UpdateCrossConnectGroupDetails ¶ 

type UpdateCrossConnectGroupDetails struct {

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`
}

UpdateCrossConnectGroupDetails The representation of UpdateCrossConnectGroupDetails

func (UpdateCrossConnectGroupDetails) String ¶ 

func (m UpdateCrossConnectGroupDetails) String() string

type UpdateCrossConnectGroupRequest ¶ 

type UpdateCrossConnectGroupRequest struct {

	// The OCID of the cross-connect group.
	CrossConnectGroupId *string `mandatory:"true" contributesTo:"path" name:"crossConnectGroupId"`

	// Update CrossConnectGroup fields
	UpdateCrossConnectGroupDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateCrossConnectGroupRequest wrapper for the UpdateCrossConnectGroup operation

func (UpdateCrossConnectGroupRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateCrossConnectGroupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateCrossConnectGroupRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateCrossConnectGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateCrossConnectGroupRequest) String ¶ 

func (request UpdateCrossConnectGroupRequest) String() string

type UpdateCrossConnectGroupResponse ¶ 

type UpdateCrossConnectGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The CrossConnectGroup instance
	CrossConnectGroup `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"`
}

UpdateCrossConnectGroupResponse wrapper for the UpdateCrossConnectGroup operation

func (UpdateCrossConnectGroupResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateCrossConnectGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateCrossConnectGroupResponse) String ¶ 

func (response UpdateCrossConnectGroupResponse) String() string

type UpdateCrossConnectRequest ¶ 

type UpdateCrossConnectRequest struct {

	// The OCID of the cross-connect.
	CrossConnectId *string `mandatory:"true" contributesTo:"path" name:"crossConnectId"`

	// Update CrossConnect fields.
	UpdateCrossConnectDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateCrossConnectRequest wrapper for the UpdateCrossConnect operation

func (UpdateCrossConnectRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateCrossConnectRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateCrossConnectRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateCrossConnectRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateCrossConnectRequest) String ¶ 

func (request UpdateCrossConnectRequest) String() string

type UpdateCrossConnectResponse ¶ 

type UpdateCrossConnectResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The CrossConnect instance
	CrossConnect `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"`
}

UpdateCrossConnectResponse wrapper for the UpdateCrossConnect operation

func (UpdateCrossConnectResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateCrossConnectResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateCrossConnectResponse) String ¶ 

func (response UpdateCrossConnectResponse) String() string

type UpdateDhcpDetails ¶ 

type UpdateDhcpDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	Options []DhcpOption `mandatory:"false" json:"options"`
}

UpdateDhcpDetails The representation of UpdateDhcpDetails

func (UpdateDhcpDetails) String ¶ 

func (m UpdateDhcpDetails) String() string

func (*UpdateDhcpDetails) UnmarshalJSON ¶ 

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

UnmarshalJSON unmarshals from json

type UpdateDhcpOptionsRequest ¶ 

type UpdateDhcpOptionsRequest struct {

	// The OCID for the set of DHCP options.
	DhcpId *string `mandatory:"true" contributesTo:"path" name:"dhcpId"`

	// Request object for updating a set of DHCP options.
	UpdateDhcpDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateDhcpOptionsRequest wrapper for the UpdateDhcpOptions operation

func (UpdateDhcpOptionsRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateDhcpOptionsRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateDhcpOptionsRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateDhcpOptionsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateDhcpOptionsRequest) String ¶ 

func (request UpdateDhcpOptionsRequest) String() string

type UpdateDhcpOptionsResponse ¶ 

type UpdateDhcpOptionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DhcpOptions instance
	DhcpOptions `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"`
}

UpdateDhcpOptionsResponse wrapper for the UpdateDhcpOptions operation

func (UpdateDhcpOptionsResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateDhcpOptionsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateDhcpOptionsResponse) String ¶ 

func (response UpdateDhcpOptionsResponse) String() string

type UpdateDrgAttachmentDetails ¶ 

type UpdateDrgAttachmentDetails struct {

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The OCID of the route table the DRG attachment will use. For information about why you
	// would associate a route table with a DRG attachment, see
	// Advanced Scenario: Transit Routing (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/transitrouting.htm).
	RouteTableId *string `mandatory:"false" json:"routeTableId"`
}

UpdateDrgAttachmentDetails The representation of UpdateDrgAttachmentDetails

func (UpdateDrgAttachmentDetails) String ¶ 

func (m UpdateDrgAttachmentDetails) String() string

type UpdateDrgAttachmentRequest ¶ 

type UpdateDrgAttachmentRequest struct {

	// The OCID of the DRG attachment.
	DrgAttachmentId *string `mandatory:"true" contributesTo:"path" name:"drgAttachmentId"`

	// Details object for updating a `DrgAttachment`.
	UpdateDrgAttachmentDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateDrgAttachmentRequest wrapper for the UpdateDrgAttachment operation

func (UpdateDrgAttachmentRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateDrgAttachmentRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateDrgAttachmentRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateDrgAttachmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateDrgAttachmentRequest) String ¶ 

func (request UpdateDrgAttachmentRequest) String() string

type UpdateDrgAttachmentResponse ¶ 

type UpdateDrgAttachmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DrgAttachment instance
	DrgAttachment `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"`
}

UpdateDrgAttachmentResponse wrapper for the UpdateDrgAttachment operation

func (UpdateDrgAttachmentResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateDrgAttachmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateDrgAttachmentResponse) String ¶ 

func (response UpdateDrgAttachmentResponse) String() string

type UpdateDrgDetails ¶ 

type UpdateDrgDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

UpdateDrgDetails The representation of UpdateDrgDetails

func (UpdateDrgDetails) String ¶ 

func (m UpdateDrgDetails) String() string

type UpdateDrgRequest ¶ 

type UpdateDrgRequest struct {

	// The OCID of the DRG.
	DrgId *string `mandatory:"true" contributesTo:"path" name:"drgId"`

	// Details object for updating a DRG.
	UpdateDrgDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateDrgRequest wrapper for the UpdateDrg operation

func (UpdateDrgRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateDrgRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateDrgRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateDrgRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateDrgRequest) String ¶ 

func (request UpdateDrgRequest) String() string

type UpdateDrgResponse ¶ 

type UpdateDrgResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Drg instance
	Drg `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"`
}

UpdateDrgResponse wrapper for the UpdateDrg operation

func (UpdateDrgResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateDrgResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateDrgResponse) String ¶ 

func (response UpdateDrgResponse) String() string

type UpdateIPSecConnectionRequest ¶ 

type UpdateIPSecConnectionRequest struct {

	// The OCID of the IPSec connection.
	IpscId *string `mandatory:"true" contributesTo:"path" name:"ipscId"`

	// Details object for updating a IPSec connection.
	UpdateIpSecConnectionDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateIPSecConnectionRequest wrapper for the UpdateIPSecConnection operation

func (UpdateIPSecConnectionRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateIPSecConnectionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateIPSecConnectionRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateIPSecConnectionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateIPSecConnectionRequest) String ¶ 

func (request UpdateIPSecConnectionRequest) String() string

type UpdateIPSecConnectionResponse ¶ 

type UpdateIPSecConnectionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The IpSecConnection instance
	IpSecConnection `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"`
}

UpdateIPSecConnectionResponse wrapper for the UpdateIPSecConnection operation

func (UpdateIPSecConnectionResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateIPSecConnectionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateIPSecConnectionResponse) String ¶ 

func (response UpdateIPSecConnectionResponse) String() string

type UpdateImageDetails ¶ 

type UpdateImageDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	// Example: `My custom Oracle Linux image`
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

UpdateImageDetails The representation of UpdateImageDetails

func (UpdateImageDetails) String ¶ 

func (m UpdateImageDetails) String() string

type UpdateImageRequest ¶ 

type UpdateImageRequest struct {

	// The OCID of the image.
	ImageId *string `mandatory:"true" contributesTo:"path" name:"imageId"`

	// Updates the image display name field. Avoid entering confidential information.
	UpdateImageDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

	// 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
}

UpdateImageRequest wrapper for the UpdateImage operation

func (UpdateImageRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateImageRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateImageRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateImageRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateImageRequest) String ¶ 

func (request UpdateImageRequest) String() string

type UpdateImageResponse ¶ 

type UpdateImageResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Image instance
	Image `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"`
}

UpdateImageResponse wrapper for the UpdateImage operation

func (UpdateImageResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateImageResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateImageResponse) String ¶ 

func (response UpdateImageResponse) String() string

type UpdateInstanceConfigurationDetails ¶ 

type UpdateInstanceConfigurationDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	// Example: `My instance configuration`
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

UpdateInstanceConfigurationDetails The representation of UpdateInstanceConfigurationDetails

func (UpdateInstanceConfigurationDetails) String ¶ 

func (m UpdateInstanceConfigurationDetails) String() string

type UpdateInstanceConfigurationRequest ¶ 

type UpdateInstanceConfigurationRequest struct {

	// The OCID of the instance configuration.
	InstanceConfigurationId *string `mandatory:"true" contributesTo:"path" name:"instanceConfigurationId"`

	// Updates the freeFormTags, definedTags, and display name of an instance configuration.
	UpdateInstanceConfigurationDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

	// 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
}

UpdateInstanceConfigurationRequest wrapper for the UpdateInstanceConfiguration operation

func (UpdateInstanceConfigurationRequest) HTTPRequest ¶ 

func (request UpdateInstanceConfigurationRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateInstanceConfigurationRequest) RetryPolicy ¶ 

func (request UpdateInstanceConfigurationRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateInstanceConfigurationRequest) String ¶ 

func (request UpdateInstanceConfigurationRequest) String() string

type UpdateInstanceConfigurationResponse ¶ 

type UpdateInstanceConfigurationResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The InstanceConfiguration instance
	InstanceConfiguration `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"`
}

UpdateInstanceConfigurationResponse wrapper for the UpdateInstanceConfiguration operation

func (UpdateInstanceConfigurationResponse) HTTPResponse ¶ 

func (response UpdateInstanceConfigurationResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateInstanceConfigurationResponse) String ¶ 

func (response UpdateInstanceConfigurationResponse) String() string

type UpdateInstanceDetails ¶ 

type UpdateInstanceDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	// Example: `My bare metal instance`
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Custom metadata key/value string pairs that you provide. Any set of key/value pairs
	// provided here will completely replace the current set of key/value pairs in the 'metadata'
	// field on the instance.
	// Both the 'user_data' and 'ssh_authorized_keys' fields cannot be changed after an instance
	// has launched. Any request which updates, removes, or adds either of these fields will be
	// rejected. You must provide the same values for 'user_data' and 'ssh_authorized_keys' that
	// already exist on the instance.
	Metadata map[string]string `mandatory:"false" json:"metadata"`

	// Additional metadata key/value pairs that you provide. They serve the same purpose and
	// functionality as fields in the 'metadata' object.
	// They are distinguished from 'metadata' fields in that these can be nested JSON objects
	// (whereas 'metadata' fields are string/string maps only).
	// Both the 'user_data' and 'ssh_authorized_keys' fields cannot be changed after an instance
	// has launched. Any request which updates, removes, or adds either of these fields will be
	// rejected. You must provide the same values for 'user_data' and 'ssh_authorized_keys' that
	// already exist on the instance.
	ExtendedMetadata map[string]interface{} `mandatory:"false" json:"extendedMetadata"`
}

UpdateInstanceDetails The representation of UpdateInstanceDetails

func (UpdateInstanceDetails) String ¶ 

func (m UpdateInstanceDetails) String() string

type UpdateInstancePoolDetails ¶ 

type UpdateInstancePoolDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// The user-friendly name.  Does not have to be unique.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The OCID of the instance configuration associated to the intance pool.
	InstanceConfigurationId *string `mandatory:"false" json:"instanceConfigurationId"`

	// The placement configurations for the instance pool.
	// There should be 1 placement configuration for each desired AD.
	PlacementConfigurations []UpdateInstancePoolPlacementConfigurationDetails `mandatory:"false" json:"placementConfigurations"`

	// The number of instances that should be in the instance pool.
	Size *int `mandatory:"false" json:"size"`
}

UpdateInstancePoolDetails The data to update an instance pool.

func (UpdateInstancePoolDetails) String ¶ 

func (m UpdateInstancePoolDetails) String() string

type UpdateInstancePoolPlacementConfigurationDetails ¶ 

type UpdateInstancePoolPlacementConfigurationDetails struct {

	// The availability domain to place instances.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The OCID of the primary subnet to place instances.
	PrimarySubnetId *string `mandatory:"true" json:"primarySubnetId"`

	// The set of subnet OCIDs for secondary VNICs for instances in the pool.
	SecondaryVnicSubnets []InstancePoolPlacementSecondaryVnicSubnet `mandatory:"false" json:"secondaryVnicSubnets"`
}

UpdateInstancePoolPlacementConfigurationDetails The location for where an instance pool will place instances.

func (UpdateInstancePoolPlacementConfigurationDetails) String ¶ 

func (m UpdateInstancePoolPlacementConfigurationDetails) String() string

type UpdateInstancePoolRequest ¶ 

type UpdateInstancePoolRequest struct {

	// The OCID of the instance pool.
	InstancePoolId *string `mandatory:"true" contributesTo:"path" name:"instancePoolId"`

	// Update instance pool configuration
	UpdateInstancePoolDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

	// 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
}

UpdateInstancePoolRequest wrapper for the UpdateInstancePool operation

func (UpdateInstancePoolRequest) HTTPRequest ¶ 

func (request UpdateInstancePoolRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateInstancePoolRequest) RetryPolicy ¶ 

func (request UpdateInstancePoolRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateInstancePoolRequest) String ¶ 

func (request UpdateInstancePoolRequest) String() string

type UpdateInstancePoolResponse ¶ 

type UpdateInstancePoolResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The InstancePool instance
	InstancePool `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"`
}

UpdateInstancePoolResponse wrapper for the UpdateInstancePool operation

func (UpdateInstancePoolResponse) HTTPResponse ¶ 

func (response UpdateInstancePoolResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateInstancePoolResponse) String ¶ 

func (response UpdateInstancePoolResponse) String() string

type UpdateInstanceRequest ¶ 

type UpdateInstanceRequest struct {

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

	// Update instance fields
	UpdateInstanceDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of executing that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations (for example, if a resource
	// has been deleted and purged from the system, then a retry of the original creation request
	// may be rejected).
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

	// 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
}

UpdateInstanceRequest wrapper for the UpdateInstance operation

func (UpdateInstanceRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateInstanceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateInstanceRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateInstanceRequest) String ¶ 

func (request UpdateInstanceRequest) String() string

type UpdateInstanceResponse ¶ 

type UpdateInstanceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Instance instance
	Instance `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"`
}

UpdateInstanceResponse wrapper for the UpdateInstance operation

func (UpdateInstanceResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateInstanceResponse) String ¶ 

func (response UpdateInstanceResponse) String() string

type UpdateInternetGatewayDetails ¶ 

type UpdateInternetGatewayDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Whether the gateway is enabled.
	IsEnabled *bool `mandatory:"false" json:"isEnabled"`
}

UpdateInternetGatewayDetails The representation of UpdateInternetGatewayDetails

func (UpdateInternetGatewayDetails) String ¶ 

func (m UpdateInternetGatewayDetails) String() string

type UpdateInternetGatewayRequest ¶ 

type UpdateInternetGatewayRequest struct {

	// The OCID of the internet gateway.
	IgId *string `mandatory:"true" contributesTo:"path" name:"igId"`

	// Details for updating the internet gateway.
	UpdateInternetGatewayDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateInternetGatewayRequest wrapper for the UpdateInternetGateway operation

func (UpdateInternetGatewayRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateInternetGatewayRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateInternetGatewayRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateInternetGatewayRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateInternetGatewayRequest) String ¶ 

func (request UpdateInternetGatewayRequest) String() string

type UpdateInternetGatewayResponse ¶ 

type UpdateInternetGatewayResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The InternetGateway instance
	InternetGateway `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"`
}

UpdateInternetGatewayResponse wrapper for the UpdateInternetGateway operation

func (UpdateInternetGatewayResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateInternetGatewayResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateInternetGatewayResponse) String ¶ 

func (response UpdateInternetGatewayResponse) String() string

type UpdateIpSecConnectionDetails ¶ 

type UpdateIpSecConnectionDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

UpdateIpSecConnectionDetails The representation of UpdateIpSecConnectionDetails

func (UpdateIpSecConnectionDetails) String ¶ 

func (m UpdateIpSecConnectionDetails) String() string

type UpdateLocalPeeringGatewayDetails ¶ 

type UpdateLocalPeeringGatewayDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid
	// entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The OCID of the route table the LPG will use. For information about why you
	// would associate a route table with an LPG, see
	// Advanced Scenario: Transit Routing (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/transitrouting.htm).
	RouteTableId *string `mandatory:"false" json:"routeTableId"`
}

UpdateLocalPeeringGatewayDetails The representation of UpdateLocalPeeringGatewayDetails

func (UpdateLocalPeeringGatewayDetails) String ¶ 

func (m UpdateLocalPeeringGatewayDetails) String() string

type UpdateLocalPeeringGatewayRequest ¶ 

type UpdateLocalPeeringGatewayRequest struct {

	// The OCID of the local peering gateway.
	LocalPeeringGatewayId *string `mandatory:"true" contributesTo:"path" name:"localPeeringGatewayId"`

	// Details object for updating a local peering gateway.
	UpdateLocalPeeringGatewayDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateLocalPeeringGatewayRequest wrapper for the UpdateLocalPeeringGateway operation

func (UpdateLocalPeeringGatewayRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateLocalPeeringGatewayRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateLocalPeeringGatewayRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateLocalPeeringGatewayRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateLocalPeeringGatewayRequest) String ¶ 

func (request UpdateLocalPeeringGatewayRequest) String() string

type UpdateLocalPeeringGatewayResponse ¶ 

type UpdateLocalPeeringGatewayResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The LocalPeeringGateway instance
	LocalPeeringGateway `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"`
}

UpdateLocalPeeringGatewayResponse wrapper for the UpdateLocalPeeringGateway operation

func (UpdateLocalPeeringGatewayResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateLocalPeeringGatewayResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateLocalPeeringGatewayResponse) String ¶ 

func (response UpdateLocalPeeringGatewayResponse) String() string

type UpdateNatGatewayDetails ¶ 

type UpdateNatGatewayDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Whether the NAT gateway blocks traffic through it. The default is `false`.
	// Example: `true`
	BlockTraffic *bool `mandatory:"false" json:"blockTraffic"`
}

UpdateNatGatewayDetails The representation of UpdateNatGatewayDetails

func (UpdateNatGatewayDetails) String ¶ 

func (m UpdateNatGatewayDetails) String() string

type UpdateNatGatewayRequest ¶ 

type UpdateNatGatewayRequest struct {

	// The NAT gateway's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
	NatGatewayId *string `mandatory:"true" contributesTo:"path" name:"natGatewayId"`

	// Details object for updating a NAT gateway.
	UpdateNatGatewayDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateNatGatewayRequest wrapper for the UpdateNatGateway operation

func (UpdateNatGatewayRequest) HTTPRequest ¶ 

func (request UpdateNatGatewayRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateNatGatewayRequest) RetryPolicy ¶ 

func (request UpdateNatGatewayRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateNatGatewayRequest) String ¶ 

func (request UpdateNatGatewayRequest) String() string

type UpdateNatGatewayResponse ¶ 

type UpdateNatGatewayResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The NatGateway instance
	NatGateway `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"`
}

UpdateNatGatewayResponse wrapper for the UpdateNatGateway operation

func (UpdateNatGatewayResponse) HTTPResponse ¶ 

func (response UpdateNatGatewayResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateNatGatewayResponse) String ¶ 

func (response UpdateNatGatewayResponse) String() string

type UpdatePrivateIpDetails ¶ 

type UpdatePrivateIpDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid
	// entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The hostname for the private IP. Used for DNS. The value
	// is the hostname portion of the private IP's fully qualified domain name (FQDN)
	// (for example, `bminstance-1` in FQDN `bminstance-1.subnet123.vcn1.oraclevcn.com`).
	// Must be unique across all VNICs in the subnet and comply with
	// RFC 952 (https://tools.ietf.org/html/rfc952) and
	// RFC 1123 (https://tools.ietf.org/html/rfc1123).
	// For more information, see
	// DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
	// Example: `bminstance-1`
	HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`

	// The OCID of the VNIC to reassign the private IP to. The VNIC must
	// be in the same subnet as the current VNIC.
	VnicId *string `mandatory:"false" json:"vnicId"`
}

UpdatePrivateIpDetails The representation of UpdatePrivateIpDetails

func (UpdatePrivateIpDetails) String ¶ 

func (m UpdatePrivateIpDetails) String() string

type UpdatePrivateIpRequest ¶ 

type UpdatePrivateIpRequest struct {

	// The OCID of the private IP.
	PrivateIpId *string `mandatory:"true" contributesTo:"path" name:"privateIpId"`

	// Private IP details.
	UpdatePrivateIpDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdatePrivateIpRequest wrapper for the UpdatePrivateIp operation

func (UpdatePrivateIpRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdatePrivateIpRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdatePrivateIpRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdatePrivateIpRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdatePrivateIpRequest) String ¶ 

func (request UpdatePrivateIpRequest) String() string

type UpdatePrivateIpResponse ¶ 

type UpdatePrivateIpResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The PrivateIp instance
	PrivateIp `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"`
}

UpdatePrivateIpResponse wrapper for the UpdatePrivateIp operation

func (UpdatePrivateIpResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdatePrivateIpResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdatePrivateIpResponse) String ¶ 

func (response UpdatePrivateIpResponse) String() string

type UpdatePublicIpDetails ¶ added in v1.1.0 

type UpdatePublicIpDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable. Avoid
	// entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The OCID of the private IP to assign the public IP to.
	// * If the public IP is already assigned to a different private IP, it will be unassigned
	// and then reassigned to the specified private IP.
	// * If you set this field to an empty string, the public IP will be unassigned from the
	// private IP it is currently assigned to.
	PrivateIpId *string `mandatory:"false" json:"privateIpId"`
}

UpdatePublicIpDetails The representation of UpdatePublicIpDetails

func (UpdatePublicIpDetails) String ¶ added in v1.1.0 

func (m UpdatePublicIpDetails) String() string

type UpdatePublicIpRequest ¶ added in v1.1.0 

type UpdatePublicIpRequest struct {

	// The OCID of the public IP.
	PublicIpId *string `mandatory:"true" contributesTo:"path" name:"publicIpId"`

	// Public IP details.
	UpdatePublicIpDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdatePublicIpRequest wrapper for the UpdatePublicIp operation

func (UpdatePublicIpRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdatePublicIpRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdatePublicIpRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdatePublicIpRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdatePublicIpRequest) String ¶ added in v1.1.0 

func (request UpdatePublicIpRequest) String() string

type UpdatePublicIpResponse ¶ added in v1.1.0 

type UpdatePublicIpResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The PublicIp instance
	PublicIp `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"`
}

UpdatePublicIpResponse wrapper for the UpdatePublicIp operation

func (UpdatePublicIpResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdatePublicIpResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdatePublicIpResponse) String ¶ added in v1.1.0 

func (response UpdatePublicIpResponse) String() string

type UpdateRemotePeeringConnectionDetails ¶ added in v1.2.0 

type UpdateRemotePeeringConnectionDetails struct {

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`
}

UpdateRemotePeeringConnectionDetails The representation of UpdateRemotePeeringConnectionDetails

func (UpdateRemotePeeringConnectionDetails) String ¶ added in v1.2.0 

func (m UpdateRemotePeeringConnectionDetails) String() string

type UpdateRemotePeeringConnectionRequest ¶ added in v1.2.0 

type UpdateRemotePeeringConnectionRequest struct {

	// The OCID of the remote peering connection (RPC).
	RemotePeeringConnectionId *string `mandatory:"true" contributesTo:"path" name:"remotePeeringConnectionId"`

	// Request to the update the peering connection to remote region
	UpdateRemotePeeringConnectionDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateRemotePeeringConnectionRequest wrapper for the UpdateRemotePeeringConnection operation

func (UpdateRemotePeeringConnectionRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateRemotePeeringConnectionRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateRemotePeeringConnectionRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateRemotePeeringConnectionRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateRemotePeeringConnectionRequest) String ¶ added in v1.2.0 

func (request UpdateRemotePeeringConnectionRequest) String() string

type UpdateRemotePeeringConnectionResponse ¶ added in v1.2.0 

type UpdateRemotePeeringConnectionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The RemotePeeringConnection instance
	RemotePeeringConnection `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"`
}

UpdateRemotePeeringConnectionResponse wrapper for the UpdateRemotePeeringConnection operation

func (UpdateRemotePeeringConnectionResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateRemotePeeringConnectionResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateRemotePeeringConnectionResponse) String ¶ added in v1.2.0 

func (response UpdateRemotePeeringConnectionResponse) String() string

type UpdateRouteTableDetails ¶ 

type UpdateRouteTableDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The collection of rules used for routing destination IPs to network devices.
	RouteRules []RouteRule `mandatory:"false" json:"routeRules"`
}

UpdateRouteTableDetails The representation of UpdateRouteTableDetails

func (UpdateRouteTableDetails) String ¶ 

func (m UpdateRouteTableDetails) String() string

type UpdateRouteTableRequest ¶ 

type UpdateRouteTableRequest struct {

	// The OCID of the route table.
	RtId *string `mandatory:"true" contributesTo:"path" name:"rtId"`

	// Details object for updating a route table.
	UpdateRouteTableDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateRouteTableRequest wrapper for the UpdateRouteTable operation

func (UpdateRouteTableRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateRouteTableRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateRouteTableRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateRouteTableRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateRouteTableRequest) String ¶ 

func (request UpdateRouteTableRequest) String() string

type UpdateRouteTableResponse ¶ 

type UpdateRouteTableResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The RouteTable instance
	RouteTable `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"`
}

UpdateRouteTableResponse wrapper for the UpdateRouteTable operation

func (UpdateRouteTableResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateRouteTableResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateRouteTableResponse) String ¶ 

func (response UpdateRouteTableResponse) String() string

type UpdateSecurityListDetails ¶ 

type UpdateSecurityListDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Rules for allowing egress IP packets.
	EgressSecurityRules []EgressSecurityRule `mandatory:"false" json:"egressSecurityRules"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Rules for allowing ingress IP packets.
	IngressSecurityRules []IngressSecurityRule `mandatory:"false" json:"ingressSecurityRules"`
}

UpdateSecurityListDetails The representation of UpdateSecurityListDetails

func (UpdateSecurityListDetails) String ¶ 

func (m UpdateSecurityListDetails) String() string

type UpdateSecurityListRequest ¶ 

type UpdateSecurityListRequest struct {

	// The OCID of the security list.
	SecurityListId *string `mandatory:"true" contributesTo:"path" name:"securityListId"`

	// Updated details for the security list.
	UpdateSecurityListDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateSecurityListRequest wrapper for the UpdateSecurityList operation

func (UpdateSecurityListRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateSecurityListRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateSecurityListRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateSecurityListRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateSecurityListRequest) String ¶ 

func (request UpdateSecurityListRequest) String() string

type UpdateSecurityListResponse ¶ 

type UpdateSecurityListResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The SecurityList instance
	SecurityList `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"`
}

UpdateSecurityListResponse wrapper for the UpdateSecurityList operation

func (UpdateSecurityListResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateSecurityListResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateSecurityListResponse) String ¶ 

func (response UpdateSecurityListResponse) String() string

type UpdateServiceGatewayDetails ¶ added in v1.8.0 

type UpdateServiceGatewayDetails struct {

	// Whether the service gateway blocks all traffic through it. The default is `false`. When
	// this is `true`, traffic is not routed to any services, regardless of route rules.
	// Example: `true`
	BlockTraffic *bool `mandatory:"false" json:"blockTraffic"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// List of all the services you want enabled on this service gateway. Sending an empty list
	// means you want to disable all services. Omitting this parameter entirely keeps the
	// existing list of services intact.
	// You can also enable or disable a particular service by using
	// AttachServiceId and
	// DetachServiceId.
	// For each enabled service, make sure there's a route rule with the service's `cidrBlock`
	// as the rule's destination CIDR and the service gateway as the rule's target. See
	// RouteTable.
	Services []ServiceIdRequestDetails `mandatory:"false" json:"services"`
}

UpdateServiceGatewayDetails The representation of UpdateServiceGatewayDetails

func (UpdateServiceGatewayDetails) String ¶ added in v1.8.0 

func (m UpdateServiceGatewayDetails) String() string

type UpdateServiceGatewayRequest ¶ added in v1.8.0 

type UpdateServiceGatewayRequest struct {

	// The service gateway's OCID (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
	ServiceGatewayId *string `mandatory:"true" contributesTo:"path" name:"serviceGatewayId"`

	// Details object for updating a service gateway.
	UpdateServiceGatewayDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateServiceGatewayRequest wrapper for the UpdateServiceGateway operation

func (UpdateServiceGatewayRequest) HTTPRequest ¶ added in v1.8.0 

func (request UpdateServiceGatewayRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateServiceGatewayRequest) RetryPolicy ¶ added in v1.8.0 

func (request UpdateServiceGatewayRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateServiceGatewayRequest) String ¶ added in v1.8.0 

func (request UpdateServiceGatewayRequest) String() string

type UpdateServiceGatewayResponse ¶ added in v1.8.0 

type UpdateServiceGatewayResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ServiceGateway instance
	ServiceGateway `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"`
}

UpdateServiceGatewayResponse wrapper for the UpdateServiceGateway operation

func (UpdateServiceGatewayResponse) HTTPResponse ¶ added in v1.8.0 

func (response UpdateServiceGatewayResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateServiceGatewayResponse) String ¶ added in v1.8.0 

func (response UpdateServiceGatewayResponse) String() string

type UpdateSubnetDetails ¶ 

type UpdateSubnetDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// The OCID of the set of DHCP options the subnet will use.
	DhcpOptionsId *string `mandatory:"false" json:"dhcpOptionsId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The OCID of the route table the subnet will use.
	RouteTableId *string `mandatory:"false" json:"routeTableId"`

	// The OCIDs of the security list or lists the subnet will use. This
	// replaces the entire current set of security lists. Remember that
	// security lists are associated *with the subnet*, but the rules are
	// applied to the individual VNICs in the subnet.
	SecurityListIds []string `mandatory:"false" json:"securityListIds"`
}

UpdateSubnetDetails The representation of UpdateSubnetDetails

func (UpdateSubnetDetails) String ¶ 

func (m UpdateSubnetDetails) String() string

type UpdateSubnetRequest ¶ 

type UpdateSubnetRequest struct {

	// The OCID of the subnet.
	SubnetId *string `mandatory:"true" contributesTo:"path" name:"subnetId"`

	// Details object for updating a subnet.
	UpdateSubnetDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateSubnetRequest wrapper for the UpdateSubnet operation

func (UpdateSubnetRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateSubnetRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateSubnetRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateSubnetRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateSubnetRequest) String ¶ 

func (request UpdateSubnetRequest) String() string

type UpdateSubnetResponse ¶ 

type UpdateSubnetResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Subnet instance
	Subnet `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"`
}

UpdateSubnetResponse wrapper for the UpdateSubnet operation

func (UpdateSubnetResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateSubnetResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateSubnetResponse) String ¶ 

func (response UpdateSubnetResponse) String() string

type UpdateVcnDetails ¶ 

type UpdateVcnDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

UpdateVcnDetails The representation of UpdateVcnDetails

func (UpdateVcnDetails) String ¶ 

func (m UpdateVcnDetails) String() string

type UpdateVcnRequest ¶ 

type UpdateVcnRequest struct {

	// The OCID of the VCN.
	VcnId *string `mandatory:"true" contributesTo:"path" name:"vcnId"`

	// Details object for updating a VCN.
	UpdateVcnDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateVcnRequest wrapper for the UpdateVcn operation

func (UpdateVcnRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateVcnRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateVcnRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateVcnRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateVcnRequest) String ¶ 

func (request UpdateVcnRequest) String() string

type UpdateVcnResponse ¶ 

type UpdateVcnResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Vcn instance
	Vcn `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"`
}

UpdateVcnResponse wrapper for the UpdateVcn operation

func (UpdateVcnResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateVcnResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateVcnResponse) String ¶ 

func (response UpdateVcnResponse) String() string

type UpdateVirtualCircuitDetails ¶ 

type UpdateVirtualCircuitDetails struct {

	// The provisioned data rate of the connection. To get a list of the
	// available bandwidth levels (that is, shapes), see
	// ListFastConnectProviderVirtualCircuitBandwidthShapes.
	// To be updated only by the customer who owns the virtual circuit.
	BandwidthShapeName *string `mandatory:"false" json:"bandwidthShapeName"`

	// An array of mappings, each containing properties for a cross-connect or
	// cross-connect group associated with this virtual circuit.
	// The customer and provider can update different properties in the mapping
	// depending on the situation. See the description of the
	// CrossConnectMapping.
	CrossConnectMappings []CrossConnectMapping `mandatory:"false" json:"crossConnectMappings"`

	// The BGP ASN of the network at the other end of the BGP
	// session from Oracle.
	// If the BGP session is from the customer's edge router to Oracle, the
	// required value is the customer's ASN, and it can be updated only
	// by the customer.
	// If the BGP session is from the provider's edge router to Oracle, the
	// required value is the provider's ASN, and it can be updated only
	// by the provider.
	CustomerBgpAsn *int `mandatory:"false" json:"customerBgpAsn"`

	// A user-friendly name. Does not have to be unique.
	// Avoid entering confidential information.
	// To be updated only by the customer who owns the virtual circuit.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The OCID of the Drg
	// that this private virtual circuit uses.
	// To be updated only by the customer who owns the virtual circuit.
	GatewayId *string `mandatory:"false" json:"gatewayId"`

	// The provider's state in relation to this virtual circuit. Relevant only
	// if the customer is using FastConnect via a provider.  ACTIVE
	// means the provider has provisioned the virtual circuit from their
	// end. INACTIVE means the provider has not yet provisioned the virtual
	// circuit, or has de-provisioned it.
	// To be updated only by the provider.
	ProviderState UpdateVirtualCircuitDetailsProviderStateEnum `mandatory:"false" json:"providerState,omitempty"`

	// Provider-supplied reference information about this virtual circuit.
	// Relevant only if the customer is using FastConnect via a provider.
	// To be updated only by the provider.
	ReferenceComment *string `mandatory:"false" json:"referenceComment"`
}

UpdateVirtualCircuitDetails The representation of UpdateVirtualCircuitDetails

func (UpdateVirtualCircuitDetails) String ¶ 

func (m UpdateVirtualCircuitDetails) String() string

type UpdateVirtualCircuitDetailsProviderStateEnum ¶ 

type UpdateVirtualCircuitDetailsProviderStateEnum string

UpdateVirtualCircuitDetailsProviderStateEnum Enum with underlying type: string 

const (
	UpdateVirtualCircuitDetailsProviderStateActive   UpdateVirtualCircuitDetailsProviderStateEnum = "ACTIVE"
	UpdateVirtualCircuitDetailsProviderStateInactive UpdateVirtualCircuitDetailsProviderStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for UpdateVirtualCircuitDetailsProviderStateEnum

func GetUpdateVirtualCircuitDetailsProviderStateEnumValues ¶ 

func GetUpdateVirtualCircuitDetailsProviderStateEnumValues() []UpdateVirtualCircuitDetailsProviderStateEnum

GetUpdateVirtualCircuitDetailsProviderStateEnumValues Enumerates the set of values for UpdateVirtualCircuitDetailsProviderStateEnum

type UpdateVirtualCircuitRequest ¶ 

type UpdateVirtualCircuitRequest struct {

	// The OCID of the virtual circuit.
	VirtualCircuitId *string `mandatory:"true" contributesTo:"path" name:"virtualCircuitId"`

	// Update VirtualCircuit fields.
	UpdateVirtualCircuitDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateVirtualCircuitRequest wrapper for the UpdateVirtualCircuit operation

func (UpdateVirtualCircuitRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateVirtualCircuitRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateVirtualCircuitRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateVirtualCircuitRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateVirtualCircuitRequest) String ¶ 

func (request UpdateVirtualCircuitRequest) String() string

type UpdateVirtualCircuitResponse ¶ 

type UpdateVirtualCircuitResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VirtualCircuit instance
	VirtualCircuit `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"`
}

UpdateVirtualCircuitResponse wrapper for the UpdateVirtualCircuit operation

func (UpdateVirtualCircuitResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateVirtualCircuitResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateVirtualCircuitResponse) String ¶ 

func (response UpdateVirtualCircuitResponse) String() string

type UpdateVnicDetails ¶ 

type UpdateVnicDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname
	// portion of the primary private IP's fully qualified domain name (FQDN)
	// (for example, `bminstance-1` in FQDN `bminstance-1.subnet123.vcn1.oraclevcn.com`).
	// Must be unique across all VNICs in the subnet and comply with
	// RFC 952 (https://tools.ietf.org/html/rfc952) and
	// RFC 1123 (https://tools.ietf.org/html/rfc1123).
	// The value appears in the Vnic object and also the
	// PrivateIp object returned by
	// ListPrivateIps and
	// GetPrivateIp.
	// For more information, see
	// DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
	HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`

	// Whether the source/destination check is disabled on the VNIC.
	// Defaults to `false`, which means the check is performed. For information
	// about why you would skip the source/destination check, see
	// Using a Private IP as a Route Target (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingroutetables.htm#privateip).
	// Example: `true`
	SkipSourceDestCheck *bool `mandatory:"false" json:"skipSourceDestCheck"`
}

UpdateVnicDetails The representation of UpdateVnicDetails

func (UpdateVnicDetails) String ¶ 

func (m UpdateVnicDetails) String() string

type UpdateVnicRequest ¶ 

type UpdateVnicRequest struct {

	// The OCID of the VNIC.
	VnicId *string `mandatory:"true" contributesTo:"path" name:"vnicId"`

	// Details object for updating a VNIC.
	UpdateVnicDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateVnicRequest wrapper for the UpdateVnic operation

func (UpdateVnicRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateVnicRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateVnicRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateVnicRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateVnicRequest) String ¶ 

func (request UpdateVnicRequest) String() string

type UpdateVnicResponse ¶ 

type UpdateVnicResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Vnic instance
	Vnic `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"`
}

UpdateVnicResponse wrapper for the UpdateVnic operation

func (UpdateVnicResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateVnicResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateVnicResponse) String ¶ 

func (response UpdateVnicResponse) String() string

type UpdateVolumeBackupDetails ¶ 

type UpdateVolumeBackupDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A friendly user-specified name for the volume backup.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

UpdateVolumeBackupDetails The representation of UpdateVolumeBackupDetails

func (UpdateVolumeBackupDetails) String ¶ 

func (m UpdateVolumeBackupDetails) String() string

type UpdateVolumeBackupRequest ¶ 

type UpdateVolumeBackupRequest struct {

	// The OCID of the volume backup.
	VolumeBackupId *string `mandatory:"true" contributesTo:"path" name:"volumeBackupId"`

	// Update volume backup fields
	UpdateVolumeBackupDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateVolumeBackupRequest wrapper for the UpdateVolumeBackup operation

func (UpdateVolumeBackupRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateVolumeBackupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateVolumeBackupRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateVolumeBackupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateVolumeBackupRequest) String ¶ 

func (request UpdateVolumeBackupRequest) String() string

type UpdateVolumeBackupResponse ¶ 

type UpdateVolumeBackupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VolumeBackup instance
	VolumeBackup `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateVolumeBackupResponse wrapper for the UpdateVolumeBackup operation

func (UpdateVolumeBackupResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateVolumeBackupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateVolumeBackupResponse) String ¶ 

func (response UpdateVolumeBackupResponse) String() string

type UpdateVolumeDetails ¶ 

type UpdateVolumeDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The size to resize the volume to in GBs. Has to be larger than the current size.
	SizeInGBs *int64 `mandatory:"false" json:"sizeInGBs"`
}

UpdateVolumeDetails The representation of UpdateVolumeDetails

func (UpdateVolumeDetails) String ¶ 

func (m UpdateVolumeDetails) String() string

type UpdateVolumeGroupBackupDetails ¶ added in v1.6.0 

type UpdateVolumeGroupBackupDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A friendly user-specified name for the volume group backup.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

UpdateVolumeGroupBackupDetails The representation of UpdateVolumeGroupBackupDetails

func (UpdateVolumeGroupBackupDetails) String ¶ added in v1.6.0 

func (m UpdateVolumeGroupBackupDetails) String() string

type UpdateVolumeGroupBackupRequest ¶ added in v1.6.0 

type UpdateVolumeGroupBackupRequest struct {

	// The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.
	VolumeGroupBackupId *string `mandatory:"true" contributesTo:"path" name:"volumeGroupBackupId"`

	// Update volume group backup fields
	UpdateVolumeGroupBackupDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateVolumeGroupBackupRequest wrapper for the UpdateVolumeGroupBackup operation

func (UpdateVolumeGroupBackupRequest) HTTPRequest ¶ added in v1.6.0 

func (request UpdateVolumeGroupBackupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateVolumeGroupBackupRequest) RetryPolicy ¶ added in v1.6.0 

func (request UpdateVolumeGroupBackupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateVolumeGroupBackupRequest) String ¶ added in v1.6.0 

func (request UpdateVolumeGroupBackupRequest) String() string

type UpdateVolumeGroupBackupResponse ¶ added in v1.6.0 

type UpdateVolumeGroupBackupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VolumeGroupBackup instance
	VolumeGroupBackup `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

UpdateVolumeGroupBackupResponse wrapper for the UpdateVolumeGroupBackup operation

func (UpdateVolumeGroupBackupResponse) HTTPResponse ¶ added in v1.6.0 

func (response UpdateVolumeGroupBackupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateVolumeGroupBackupResponse) String ¶ added in v1.6.0 

func (response UpdateVolumeGroupBackupResponse) String() string

type UpdateVolumeGroupDetails ¶ added in v1.6.0 

type UpdateVolumeGroupDetails struct {

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name for the volume group.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// OCIDs for the volumes in this volume group.
	VolumeIds []string `mandatory:"false" json:"volumeIds"`
}

UpdateVolumeGroupDetails The representation of UpdateVolumeGroupDetails

func (UpdateVolumeGroupDetails) String ¶ added in v1.6.0 

func (m UpdateVolumeGroupDetails) String() string

type UpdateVolumeGroupRequest ¶ added in v1.6.0 

type UpdateVolumeGroupRequest struct {

	// The Oracle Cloud ID (OCID) that uniquely identifies the volume group.
	VolumeGroupId *string `mandatory:"true" contributesTo:"path" name:"volumeGroupId"`

	// Update volume group's set of volumes and/or display name
	UpdateVolumeGroupDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateVolumeGroupRequest wrapper for the UpdateVolumeGroup operation

func (UpdateVolumeGroupRequest) HTTPRequest ¶ added in v1.6.0 

func (request UpdateVolumeGroupRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateVolumeGroupRequest) RetryPolicy ¶ added in v1.6.0 

func (request UpdateVolumeGroupRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateVolumeGroupRequest) String ¶ added in v1.6.0 

func (request UpdateVolumeGroupRequest) String() string

type UpdateVolumeGroupResponse ¶ added in v1.6.0 

type UpdateVolumeGroupResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VolumeGroup instance
	VolumeGroup `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"`
}

UpdateVolumeGroupResponse wrapper for the UpdateVolumeGroup operation

func (UpdateVolumeGroupResponse) HTTPResponse ¶ added in v1.6.0 

func (response UpdateVolumeGroupResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateVolumeGroupResponse) String ¶ added in v1.6.0 

func (response UpdateVolumeGroupResponse) String() string

type UpdateVolumeKmsKeyDetails ¶ 

type UpdateVolumeKmsKeyDetails struct {

	// The new kms key which will be used to protect the specific volume.
	// This key has to be a valid kms key ocid, and user must have key delegation policy to allow them to access this key.
	// Even if this new kms key is the same as the previous kms key id, block storage service will use it to regenerate a new volume encryption key.
	// Example: `{"kmsKeyId": "ocid1.key.region1.sea.afnl2n7daag4s.abzwkljs6uevhlgcznhmh7oiatyrxngrywc3tje3uk3g77hzmewqiieuk75f"}`
	KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
}

UpdateVolumeKmsKeyDetails The representation of UpdateVolumeKmsKeyDetails

func (UpdateVolumeKmsKeyDetails) String ¶ 

func (m UpdateVolumeKmsKeyDetails) String() string

type UpdateVolumeKmsKeyRequest ¶ 

type UpdateVolumeKmsKeyRequest struct {

	// The OCID of the volume.
	VolumeId *string `mandatory:"true" contributesTo:"path" name:"volumeId"`

	// Update kms key id for the specific volume.
	UpdateVolumeKmsKeyDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateVolumeKmsKeyRequest wrapper for the UpdateVolumeKmsKey operation

func (UpdateVolumeKmsKeyRequest) HTTPRequest ¶ 

func (request UpdateVolumeKmsKeyRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateVolumeKmsKeyRequest) RetryPolicy ¶ 

func (request UpdateVolumeKmsKeyRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateVolumeKmsKeyRequest) String ¶ 

func (request UpdateVolumeKmsKeyRequest) String() string

type UpdateVolumeKmsKeyResponse ¶ 

type UpdateVolumeKmsKeyResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VolumeKmsKey instance
	VolumeKmsKey `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"`
}

UpdateVolumeKmsKeyResponse wrapper for the UpdateVolumeKmsKey operation

func (UpdateVolumeKmsKeyResponse) HTTPResponse ¶ 

func (response UpdateVolumeKmsKeyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateVolumeKmsKeyResponse) String ¶ 

func (response UpdateVolumeKmsKeyResponse) String() string

type UpdateVolumeRequest ¶ 

type UpdateVolumeRequest struct {

	// The OCID of the volume.
	VolumeId *string `mandatory:"true" contributesTo:"path" name:"volumeId"`

	// Update volume's display name. Avoid entering confidential information.
	UpdateVolumeDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
	// parameter to the value of the etag from a previous GET or POST response for that resource.  The resource
	// will be updated or deleted only if the etag you provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// 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
}

UpdateVolumeRequest wrapper for the UpdateVolume operation

func (UpdateVolumeRequest) HTTPRequest ¶ added in v1.3.0 

func (request UpdateVolumeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateVolumeRequest) RetryPolicy ¶ added in v1.3.0 

func (request UpdateVolumeRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateVolumeRequest) String ¶ 

func (request UpdateVolumeRequest) String() string

type UpdateVolumeResponse ¶ 

type UpdateVolumeResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Volume instance
	Volume `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"`
}

UpdateVolumeResponse wrapper for the UpdateVolume operation

func (UpdateVolumeResponse) HTTPResponse ¶ added in v1.3.0 

func (response UpdateVolumeResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateVolumeResponse) String ¶ 

func (response UpdateVolumeResponse) String() string

type Vcn ¶ 

type Vcn struct {

	// The CIDR IP address block of the VCN.
	// Example: `172.16.0.0/16`
	CidrBlock *string `mandatory:"true" json:"cidrBlock"`

	// The OCID of the compartment containing the VCN.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The VCN's Oracle ID (OCID).
	Id *string `mandatory:"true" json:"id"`

	// The VCN's current state.
	LifecycleState VcnLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The OCID for the VCN's default set of DHCP options.
	DefaultDhcpOptionsId *string `mandatory:"false" json:"defaultDhcpOptionsId"`

	// The OCID for the VCN's default route table.
	DefaultRouteTableId *string `mandatory:"false" json:"defaultRouteTableId"`

	// The OCID for the VCN's default security list.
	DefaultSecurityListId *string `mandatory:"false" json:"defaultSecurityListId"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// A DNS label for the VCN, used in conjunction with the VNIC's hostname and
	// subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC
	// within this subnet (for example, `bminstance-1.subnet123.vcn1.oraclevcn.com`).
	// Must be an alphanumeric string that begins with a letter.
	// The value cannot be changed.
	// The absence of this parameter means the Internet and VCN Resolver will
	// not work for this VCN.
	// For more information, see
	// DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
	// Example: `vcn1`
	DnsLabel *string `mandatory:"false" json:"dnsLabel"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The date and time the VCN was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The VCN's domain name, which consists of the VCN's DNS label, and the
	// `oraclevcn.com` domain.
	// For more information, see
	// DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
	// Example: `vcn1.oraclevcn.com`
	VcnDomainName *string `mandatory:"false" json:"vcnDomainName"`
}

Vcn A virtual cloud network (VCN). For more information, see Overview of the Networking Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (Vcn) String ¶ 

func (m Vcn) String() string

type VcnLifecycleStateEnum ¶ 

type VcnLifecycleStateEnum string

VcnLifecycleStateEnum Enum with underlying type: string 

const (
	VcnLifecycleStateProvisioning VcnLifecycleStateEnum = "PROVISIONING"
	VcnLifecycleStateAvailable    VcnLifecycleStateEnum = "AVAILABLE"
	VcnLifecycleStateTerminating  VcnLifecycleStateEnum = "TERMINATING"
	VcnLifecycleStateTerminated   VcnLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for VcnLifecycleStateEnum

func GetVcnLifecycleStateEnumValues ¶ 

func GetVcnLifecycleStateEnumValues() []VcnLifecycleStateEnum

GetVcnLifecycleStateEnumValues Enumerates the set of values for VcnLifecycleStateEnum

type VirtualCircuit ¶ 

type VirtualCircuit struct {

	// The provisioned data rate of the connection.  To get a list of the
	// available bandwidth levels (that is, shapes), see
	// ListFastConnectProviderVirtualCircuitBandwidthShapes.
	// Example: `10 Gbps`
	BandwidthShapeName *string `mandatory:"false" json:"bandwidthShapeName"`

	// BGP management option.
	BgpManagement VirtualCircuitBgpManagementEnum `mandatory:"false" json:"bgpManagement,omitempty"`

	// The state of the BGP session associated with the virtual circuit.
	BgpSessionState VirtualCircuitBgpSessionStateEnum `mandatory:"false" json:"bgpSessionState,omitempty"`

	// The OCID of the compartment containing the virtual circuit.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// An array of mappings, each containing properties for a
	// cross-connect or cross-connect group that is associated with this
	// virtual circuit.
	CrossConnectMappings []CrossConnectMapping `mandatory:"false" json:"crossConnectMappings"`

	// The BGP ASN of the network at the other end of the BGP
	// session from Oracle. If the session is between the customer's
	// edge router and Oracle, the value is the customer's ASN. If the BGP
	// session is between the provider's edge router and Oracle, the value
	// is the provider's ASN.
	CustomerBgpAsn *int `mandatory:"false" json:"customerBgpAsn"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The OCID of the customer's Drg
	// that this virtual circuit uses. Applicable only to private virtual circuits.
	GatewayId *string `mandatory:"false" json:"gatewayId"`

	// The virtual circuit's Oracle ID (OCID).
	Id *string `mandatory:"false" json:"id"`

	// The virtual circuit's current state. For information about
	// the different states, see
	// FastConnect Overview (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm).
	LifecycleState VirtualCircuitLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The Oracle BGP ASN.
	OracleBgpAsn *int `mandatory:"false" json:"oracleBgpAsn"`

	// Deprecated. Instead use `providerServiceId`.
	ProviderName *string `mandatory:"false" json:"providerName"`

	// The OCID of the service offered by the provider (if the customer is connecting via a provider).
	ProviderServiceId *string `mandatory:"false" json:"providerServiceId"`

	// Deprecated. Instead use `providerServiceId`.
	ProviderServiceName *string `mandatory:"false" json:"providerServiceName"`

	// The provider's state in relation to this virtual circuit (if the
	// customer is connecting via a provider). ACTIVE means
	// the provider has provisioned the virtual circuit from their end.
	// INACTIVE means the provider has not yet provisioned the virtual
	// circuit, or has de-provisioned it.
	ProviderState VirtualCircuitProviderStateEnum `mandatory:"false" json:"providerState,omitempty"`

	// For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to
	// advertise across the connection. Each prefix must be /31 or less specific.
	PublicPrefixes []string `mandatory:"false" json:"publicPrefixes"`

	// Provider-supplied reference information about this virtual circuit
	// (if the customer is connecting via a provider).
	ReferenceComment *string `mandatory:"false" json:"referenceComment"`

	// The Oracle Cloud Infrastructure region where this virtual
	// circuit is located.
	Region *string `mandatory:"false" json:"region"`

	// Provider service type.
	ServiceType VirtualCircuitServiceTypeEnum `mandatory:"false" json:"serviceType,omitempty"`

	// The date and time the virtual circuit was created,
	// in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// Whether the virtual circuit supports private or public peering. For more information,
	// see FastConnect Overview (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm).
	Type VirtualCircuitTypeEnum `mandatory:"false" json:"type,omitempty"`
}

VirtualCircuit For use with Oracle Cloud Infrastructure FastConnect. A virtual circuit is an isolated network path that runs over one or more physical network connections to provide a single, logical connection between the edge router on the customer's existing network and Oracle Cloud Infrastructure. *Private* virtual circuits support private peering, and *public* virtual circuits support public peering. For more information, see FastConnect Overview (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm). Each virtual circuit is made up of information shared between a customer, Oracle, and a provider (if the customer is using FastConnect via a provider). Who fills in a given property of a virtual circuit depends on whether the BGP session related to that virtual circuit goes from the customer's edge router to Oracle, or from the provider's edge router to Oracle. Also, in the case where the customer is using a provider, values for some of the properties may not be present immediately, but may get filled in as the provider and Oracle each do their part to provision the virtual circuit. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (VirtualCircuit) String ¶ 

func (m VirtualCircuit) String() string

type VirtualCircuitBandwidthShape ¶ 

type VirtualCircuitBandwidthShape struct {

	// The name of the bandwidth shape.
	// Example: `10 Gbps`
	Name *string `mandatory:"true" json:"name"`

	// The bandwidth in Mbps.
	// Example: `10000`
	BandwidthInMbps *int `mandatory:"false" json:"bandwidthInMbps"`
}

VirtualCircuitBandwidthShape An individual bandwidth level for virtual circuits.

func (VirtualCircuitBandwidthShape) String ¶ 

func (m VirtualCircuitBandwidthShape) String() string

type VirtualCircuitBgpManagementEnum ¶ 

type VirtualCircuitBgpManagementEnum string

VirtualCircuitBgpManagementEnum Enum with underlying type: string 

const (
	VirtualCircuitBgpManagementCustomerManaged VirtualCircuitBgpManagementEnum = "CUSTOMER_MANAGED"
	VirtualCircuitBgpManagementProviderManaged VirtualCircuitBgpManagementEnum = "PROVIDER_MANAGED"
	VirtualCircuitBgpManagementOracleManaged   VirtualCircuitBgpManagementEnum = "ORACLE_MANAGED"
)

Set of constants representing the allowable values for VirtualCircuitBgpManagementEnum

func GetVirtualCircuitBgpManagementEnumValues ¶ 

func GetVirtualCircuitBgpManagementEnumValues() []VirtualCircuitBgpManagementEnum

GetVirtualCircuitBgpManagementEnumValues Enumerates the set of values for VirtualCircuitBgpManagementEnum

type VirtualCircuitBgpSessionStateEnum ¶ 

type VirtualCircuitBgpSessionStateEnum string

VirtualCircuitBgpSessionStateEnum Enum with underlying type: string 

const (
	VirtualCircuitBgpSessionStateUp   VirtualCircuitBgpSessionStateEnum = "UP"
	VirtualCircuitBgpSessionStateDown VirtualCircuitBgpSessionStateEnum = "DOWN"
)

Set of constants representing the allowable values for VirtualCircuitBgpSessionStateEnum

func GetVirtualCircuitBgpSessionStateEnumValues ¶ 

func GetVirtualCircuitBgpSessionStateEnumValues() []VirtualCircuitBgpSessionStateEnum

GetVirtualCircuitBgpSessionStateEnumValues Enumerates the set of values for VirtualCircuitBgpSessionStateEnum

type VirtualCircuitLifecycleStateEnum ¶ 

type VirtualCircuitLifecycleStateEnum string

VirtualCircuitLifecycleStateEnum Enum with underlying type: string 

const (
	VirtualCircuitLifecycleStatePendingProvider VirtualCircuitLifecycleStateEnum = "PENDING_PROVIDER"
	VirtualCircuitLifecycleStateVerifying       VirtualCircuitLifecycleStateEnum = "VERIFYING"
	VirtualCircuitLifecycleStateProvisioning    VirtualCircuitLifecycleStateEnum = "PROVISIONING"
	VirtualCircuitLifecycleStateProvisioned     VirtualCircuitLifecycleStateEnum = "PROVISIONED"
	VirtualCircuitLifecycleStateFailed          VirtualCircuitLifecycleStateEnum = "FAILED"
	VirtualCircuitLifecycleStateInactive        VirtualCircuitLifecycleStateEnum = "INACTIVE"
	VirtualCircuitLifecycleStateTerminating     VirtualCircuitLifecycleStateEnum = "TERMINATING"
	VirtualCircuitLifecycleStateTerminated      VirtualCircuitLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for VirtualCircuitLifecycleStateEnum

func GetVirtualCircuitLifecycleStateEnumValues ¶ 

func GetVirtualCircuitLifecycleStateEnumValues() []VirtualCircuitLifecycleStateEnum

GetVirtualCircuitLifecycleStateEnumValues Enumerates the set of values for VirtualCircuitLifecycleStateEnum

type VirtualCircuitProviderStateEnum ¶ 

type VirtualCircuitProviderStateEnum string

VirtualCircuitProviderStateEnum Enum with underlying type: string 

const (
	VirtualCircuitProviderStateActive   VirtualCircuitProviderStateEnum = "ACTIVE"
	VirtualCircuitProviderStateInactive VirtualCircuitProviderStateEnum = "INACTIVE"
)

Set of constants representing the allowable values for VirtualCircuitProviderStateEnum

func GetVirtualCircuitProviderStateEnumValues ¶ 

func GetVirtualCircuitProviderStateEnumValues() []VirtualCircuitProviderStateEnum

GetVirtualCircuitProviderStateEnumValues Enumerates the set of values for VirtualCircuitProviderStateEnum

type VirtualCircuitPublicPrefix ¶ 

type VirtualCircuitPublicPrefix struct {

	// Publix IP prefix (CIDR) that the customer specified.
	CidrBlock *string `mandatory:"true" json:"cidrBlock"`

	// Oracle must verify that the customer owns the public IP prefix before traffic
	// for that prefix can flow across the virtual circuit. Verification can take a
	// few business days. `IN_PROGRESS` means Oracle is verifying the prefix. `COMPLETED`
	// means verification succeeded. `FAILED` means verification failed and traffic for
	// this prefix will not flow across the connection.
	VerificationState VirtualCircuitPublicPrefixVerificationStateEnum `mandatory:"true" json:"verificationState"`
}

VirtualCircuitPublicPrefix A public IP prefix and its details. With a public virtual circuit, the customer specifies the customer-owned public IP prefixes to advertise across the connection. For more information, see FastConnect Overview (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm).

func (VirtualCircuitPublicPrefix) String ¶ 

func (m VirtualCircuitPublicPrefix) String() string

type VirtualCircuitPublicPrefixVerificationStateEnum ¶ 

type VirtualCircuitPublicPrefixVerificationStateEnum string

VirtualCircuitPublicPrefixVerificationStateEnum Enum with underlying type: string 

const (
	VirtualCircuitPublicPrefixVerificationStateInProgress VirtualCircuitPublicPrefixVerificationStateEnum = "IN_PROGRESS"
	VirtualCircuitPublicPrefixVerificationStateCompleted  VirtualCircuitPublicPrefixVerificationStateEnum = "COMPLETED"
	VirtualCircuitPublicPrefixVerificationStateFailed     VirtualCircuitPublicPrefixVerificationStateEnum = "FAILED"
)

Set of constants representing the allowable values for VirtualCircuitPublicPrefixVerificationStateEnum

func GetVirtualCircuitPublicPrefixVerificationStateEnumValues ¶ 

func GetVirtualCircuitPublicPrefixVerificationStateEnumValues() []VirtualCircuitPublicPrefixVerificationStateEnum

GetVirtualCircuitPublicPrefixVerificationStateEnumValues Enumerates the set of values for VirtualCircuitPublicPrefixVerificationStateEnum

type VirtualCircuitServiceTypeEnum ¶ 

type VirtualCircuitServiceTypeEnum string

VirtualCircuitServiceTypeEnum Enum with underlying type: string 

const (
	VirtualCircuitServiceTypeColocated VirtualCircuitServiceTypeEnum = "COLOCATED"
	VirtualCircuitServiceTypeLayer2    VirtualCircuitServiceTypeEnum = "LAYER2"
	VirtualCircuitServiceTypeLayer3    VirtualCircuitServiceTypeEnum = "LAYER3"
)

Set of constants representing the allowable values for VirtualCircuitServiceTypeEnum

func GetVirtualCircuitServiceTypeEnumValues ¶ 

func GetVirtualCircuitServiceTypeEnumValues() []VirtualCircuitServiceTypeEnum

GetVirtualCircuitServiceTypeEnumValues Enumerates the set of values for VirtualCircuitServiceTypeEnum

type VirtualCircuitTypeEnum ¶ 

type VirtualCircuitTypeEnum string

VirtualCircuitTypeEnum Enum with underlying type: string 

const (
	VirtualCircuitTypePublic  VirtualCircuitTypeEnum = "PUBLIC"
	VirtualCircuitTypePrivate VirtualCircuitTypeEnum = "PRIVATE"
)

Set of constants representing the allowable values for VirtualCircuitTypeEnum

func GetVirtualCircuitTypeEnumValues ¶ 

func GetVirtualCircuitTypeEnumValues() []VirtualCircuitTypeEnum

GetVirtualCircuitTypeEnumValues Enumerates the set of values for VirtualCircuitTypeEnum

type VirtualNetworkClient ¶ 

type VirtualNetworkClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

VirtualNetworkClient a client for VirtualNetwork

func NewVirtualNetworkClientWithConfigurationProvider ¶ 

func NewVirtualNetworkClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client VirtualNetworkClient, err error)

NewVirtualNetworkClientWithConfigurationProvider Creates a new default VirtualNetwork client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func (VirtualNetworkClient) AttachServiceId ¶ added in v1.8.0 

func (client VirtualNetworkClient) AttachServiceId(ctx context.Context, request AttachServiceIdRequest) (response AttachServiceIdResponse, err error)

AttachServiceId Enables the specified service on the specified gateway. In other words, enables the service gateway to send traffic to the specified service. You must also set up a route rule with the service's `cidrBlock` as the rule's destination CIDR and the gateway as the rule's target. See RouteTable. **Note:** The `AttachServiceId` operation is an easy way to enable an individual service on the service gateway. Compare it with UpdateServiceGateway, which also lets you enable an individual service. However, with `UpdateServiceGateway`, you must specify the *entire* list of services you want enabled on the service gateway.

func (VirtualNetworkClient) BulkAddVirtualCircuitPublicPrefixes ¶ 

func (client VirtualNetworkClient) BulkAddVirtualCircuitPublicPrefixes(ctx context.Context, request BulkAddVirtualCircuitPublicPrefixesRequest) (err error)

BulkAddVirtualCircuitPublicPrefixes Adds one or more customer public IP prefixes to the specified public virtual circuit. Use this operation (and not UpdateVirtualCircuit) to add prefixes to the virtual circuit. Oracle must verify the customer's ownership of each prefix before traffic for that prefix will flow across the virtual circuit.

func (VirtualNetworkClient) BulkDeleteVirtualCircuitPublicPrefixes ¶ 

func (client VirtualNetworkClient) BulkDeleteVirtualCircuitPublicPrefixes(ctx context.Context, request BulkDeleteVirtualCircuitPublicPrefixesRequest) (err error)

BulkDeleteVirtualCircuitPublicPrefixes Removes one or more customer public IP prefixes from the specified public virtual circuit. Use this operation (and not UpdateVirtualCircuit) to remove prefixes from the virtual circuit. When the virtual circuit's state switches back to PROVISIONED, Oracle stops advertising the specified prefixes across the connection.

func (*VirtualNetworkClient) ConfigurationProvider ¶ 

func (client *VirtualNetworkClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (VirtualNetworkClient) ConnectLocalPeeringGateways ¶ 

func (client VirtualNetworkClient) ConnectLocalPeeringGateways(ctx context.Context, request ConnectLocalPeeringGatewaysRequest) (response ConnectLocalPeeringGatewaysResponse, err error)

ConnectLocalPeeringGateways Connects this local peering gateway (LPG) to another one in the same region. This operation must be called by the VCN administrator who is designated as the *requestor* in the peering relationship. The *acceptor* must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to LPGs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/VCNpeering.htm).

func (VirtualNetworkClient) ConnectRemotePeeringConnections ¶ added in v1.2.0 

func (client VirtualNetworkClient) ConnectRemotePeeringConnections(ctx context.Context, request ConnectRemotePeeringConnectionsRequest) (response ConnectRemotePeeringConnectionsResponse, err error)

ConnectRemotePeeringConnections Connects this RPC to another one in a different region. This operation must be called by the VCN administrator who is designated as the *requestor* in the peering relationship. The *acceptor* must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to RPCs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/VCNpeering.htm).

func (VirtualNetworkClient) CreateCpe ¶ 

func (client VirtualNetworkClient) CreateCpe(ctx context.Context, request CreateCpeRequest) (response CreateCpeResponse, err error)

CreateCpe Creates a new virtual customer-premises equipment (CPE) object in the specified compartment. For more information, see IPSec VPNs (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIPsec.htm). For the purposes of access control, you must provide the OCID of the compartment where you want the CPE to reside. Notice that the CPE doesn't have to be in the same compartment as the IPSec connection or other Networking Service components. If you're not sure which compartment to use, put the CPE in the same compartment as the DRG. For more information about compartments and access control, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs, see Resource Identifiers (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm). You must provide the public IP address of your on-premises router. See Configuring Your On-Premises Router for an IPSec VPN (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/configuringCPE.htm). You may optionally specify a *display name* for the CPE, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

func (VirtualNetworkClient) CreateCrossConnect ¶ 

func (client VirtualNetworkClient) CreateCrossConnect(ctx context.Context, request CreateCrossConnectRequest) (response CreateCrossConnectResponse, err error)

CreateCrossConnect Creates a new cross-connect. Oracle recommends you create each cross-connect in a CrossConnectGroup so you can use link aggregation with the connection. After creating the `CrossConnect` object, you need to go the FastConnect location and request to have the physical cable installed. For more information, see FastConnect Overview (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm). For the purposes of access control, you must provide the OCID of the compartment where you want the cross-connect to reside. If you're not sure which compartment to use, put the cross-connect in the same compartment with your VCN. For more information about compartments and access control, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs, see Resource Identifiers (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the cross-connect. It does not have to be unique, and you can change it. Avoid entering confidential information.

func (VirtualNetworkClient) CreateCrossConnectGroup ¶ 

func (client VirtualNetworkClient) CreateCrossConnectGroup(ctx context.Context, request CreateCrossConnectGroupRequest) (response CreateCrossConnectGroupResponse, err error)

CreateCrossConnectGroup Creates a new cross-connect group to use with Oracle Cloud Infrastructure FastConnect. For more information, see FastConnect Overview (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm). For the purposes of access control, you must provide the OCID of the compartment where you want the cross-connect group to reside. If you're not sure which compartment to use, put the cross-connect group in the same compartment with your VCN. For more information about compartments and access control, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs, see Resource Identifiers (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the cross-connect group. It does not have to be unique, and you can change it. Avoid entering confidential information.

func (VirtualNetworkClient) CreateDhcpOptions ¶ 

func (client VirtualNetworkClient) CreateDhcpOptions(ctx context.Context, request CreateDhcpOptionsRequest) (response CreateDhcpOptionsResponse, err error)

CreateDhcpOptions Creates a new set of DHCP options for the specified VCN. For more information, see DhcpOptions. For the purposes of access control, you must provide the OCID of the compartment where you want the set of DHCP options to reside. Notice that the set of options doesn't have to be in the same compartment as the VCN, subnets, or other Networking Service components. If you're not sure which compartment to use, put the set of DHCP options in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs, see Resource Identifiers (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the set of DHCP options, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

func (VirtualNetworkClient) CreateDrg ¶ 

func (client VirtualNetworkClient) CreateDrg(ctx context.Context, request CreateDrgRequest) (response CreateDrgResponse, err error)

CreateDrg Creates a new dynamic routing gateway (DRG) in the specified compartment. For more information, see Dynamic Routing Gateways (DRGs) (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingDRGs.htm). For the purposes of access control, you must provide the OCID of the compartment where you want the DRG to reside. Notice that the DRG doesn't have to be in the same compartment as the VCN, the DRG attachment, or other Networking Service components. If you're not sure which compartment to use, put the DRG in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs, see Resource Identifiers (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the DRG, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

func (VirtualNetworkClient) CreateDrgAttachment ¶ 

func (client VirtualNetworkClient) CreateDrgAttachment(ctx context.Context, request CreateDrgAttachmentRequest) (response CreateDrgAttachmentResponse, err error)

CreateDrgAttachment Attaches the specified DRG to the specified VCN. A VCN can be attached to only one DRG at a time, and vice versa. The response includes a `DrgAttachment` object with its own OCID. For more information about DRGs, see Dynamic Routing Gateways (DRGs) (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingDRGs.htm). You may optionally specify a *display name* for the attachment, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. For the purposes of access control, the DRG attachment is automatically placed into the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm).

func (VirtualNetworkClient) CreateIPSecConnection ¶ 

func (client VirtualNetworkClient) CreateIPSecConnection(ctx context.Context, request CreateIPSecConnectionRequest) (response CreateIPSecConnectionResponse, err error)

CreateIPSecConnection Creates a new IPSec connection between the specified DRG and CPE. For more information, see IPSec VPNs (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIPsec.htm). In the request, you must include at least one static route to the CPE object (you're allowed a maximum of 10). For example: 10.0.8.0/16. For the purposes of access control, you must provide the OCID of the compartment where you want the IPSec connection to reside. Notice that the IPSec connection doesn't have to be in the same compartment as the DRG, CPE, or other Networking Service components. If you're not sure which compartment to use, put the IPSec connection in the same compartment as the DRG. For more information about compartments and access control, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs, see Resource Identifiers (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the IPSec connection, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. After creating the IPSec connection, you need to configure your on-premises router with tunnel-specific information returned by GetIPSecConnectionDeviceConfig. For each tunnel, that operation gives you the IP address of Oracle's VPN headend and the shared secret (that is, the pre-shared key). For more information, see Configuring Your On-Premises Router for an IPSec VPN (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/configuringCPE.htm). To get the status of the tunnels (whether they're up or down), use GetIPSecConnectionDeviceStatus.

func (VirtualNetworkClient) CreateInternetGateway ¶ 

func (client VirtualNetworkClient) CreateInternetGateway(ctx context.Context, request CreateInternetGatewayRequest) (response CreateInternetGatewayResponse, err error)

CreateInternetGateway Creates a new internet gateway for the specified VCN. For more information, see Access to the Internet (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIGs.htm). For the purposes of access control, you must provide the OCID of the compartment where you want the Internet Gateway to reside. Notice that the internet gateway doesn't have to be in the same compartment as the VCN or other Networking Service components. If you're not sure which compartment to use, put the Internet Gateway in the same compartment with the VCN. For more information about compartments and access control, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs, see Resource Identifiers (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the internet gateway, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. For traffic to flow between a subnet and an internet gateway, you must create a route rule accordingly in the subnet's route table (for example, 0.0.0.0/0 > internet gateway). See UpdateRouteTable. You must specify whether the internet gateway is enabled when you create it. If it's disabled, that means no traffic will flow to/from the internet even if there's a route rule that enables that traffic. You can later use UpdateInternetGateway to easily disable/enable the gateway without changing the route rule.

func (VirtualNetworkClient) CreateLocalPeeringGateway ¶ 

func (client VirtualNetworkClient) CreateLocalPeeringGateway(ctx context.Context, request CreateLocalPeeringGatewayRequest) (response CreateLocalPeeringGatewayResponse, err error)

CreateLocalPeeringGateway Creates a new local peering gateway (LPG) for the specified VCN.

func (VirtualNetworkClient) CreateNatGateway ¶ 

func (client VirtualNetworkClient) CreateNatGateway(ctx context.Context, request CreateNatGatewayRequest) (response CreateNatGatewayResponse, err error)

CreateNatGateway Creates a new NAT gateway for the specified VCN. You must also set up a route rule with the NAT gateway as the rule's target. See RouteTable.

func (VirtualNetworkClient) CreatePrivateIp ¶ 

func (client VirtualNetworkClient) CreatePrivateIp(ctx context.Context, request CreatePrivateIpRequest) (response CreatePrivateIpResponse, err error)

CreatePrivateIp Creates a secondary private IP for the specified VNIC. For more information about secondary private IPs, see IP Addresses (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIPaddresses.htm).

func (VirtualNetworkClient) CreatePublicIp ¶ added in v1.1.0 

func (client VirtualNetworkClient) CreatePublicIp(ctx context.Context, request CreatePublicIpRequest) (response CreatePublicIpResponse, err error)

CreatePublicIp Creates a public IP. Use the `lifetime` property to specify whether it's an ephemeral or reserved public IP. For information about limits on how many you can create, see Public IP Addresses (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingpublicIPs.htm). * **For an ephemeral public IP assigned to a private IP:** You must also specify a `privateIpId` with the OCID of the primary private IP you want to assign the public IP to. The public IP is created in the same availability domain as the private IP. An ephemeral public IP must always be assigned to a private IP, and only to the *primary* private IP on a VNIC, not a secondary private IP. Exception: If you create a NatGateway, Oracle automatically assigns the NAT gateway a regional ephemeral public IP that you cannot remove. * **For a reserved public IP:** You may also optionally assign the public IP to a private IP by specifying `privateIpId`. Or you can later assign the public IP with UpdatePublicIp. **Note:** When assigning a public IP to a private IP, the private IP must not already have a public IP with `lifecycleState` = ASSIGNING or ASSIGNED. If it does, an error is returned. Also, for reserved public IPs, the optional assignment part of this operation is asynchronous. Poll the public IP's `lifecycleState` to determine if the assignment succeeded.

func (VirtualNetworkClient) CreateRemotePeeringConnection ¶ added in v1.2.0 

func (client VirtualNetworkClient) CreateRemotePeeringConnection(ctx context.Context, request CreateRemotePeeringConnectionRequest) (response CreateRemotePeeringConnectionResponse, err error)

CreateRemotePeeringConnection Creates a new remote peering connection (RPC) for the specified DRG.

func (VirtualNetworkClient) CreateRouteTable ¶ 

func (client VirtualNetworkClient) CreateRouteTable(ctx context.Context, request CreateRouteTableRequest) (response CreateRouteTableResponse, err error)

CreateRouteTable Creates a new route table for the specified VCN. In the request you must also include at least one route rule for the new route table. For information on the number of rules you can have in a route table, see Service Limits (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/servicelimits.htm). For general information about route tables in your VCN and the types of targets you can use in route rules, see Route Tables (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingroutetables.htm). For the purposes of access control, you must provide the OCID of the compartment where you want the route table to reside. Notice that the route table doesn't have to be in the same compartment as the VCN, subnets, or other Networking Service components. If you're not sure which compartment to use, put the route table in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs, see Resource Identifiers (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the route table, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

func (VirtualNetworkClient) CreateSecurityList ¶ 

func (client VirtualNetworkClient) CreateSecurityList(ctx context.Context, request CreateSecurityListRequest) (response CreateSecurityListResponse, err error)

CreateSecurityList Creates a new security list for the specified VCN. For more information about security lists, see Security Lists (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/securitylists.htm). For information on the number of rules you can have in a security list, see Service Limits (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/servicelimits.htm). For the purposes of access control, you must provide the OCID of the compartment where you want the security list to reside. Notice that the security list doesn't have to be in the same compartment as the VCN, subnets, or other Networking Service components. If you're not sure which compartment to use, put the security list in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs, see Resource Identifiers (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the security list, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

func (VirtualNetworkClient) CreateServiceGateway ¶ added in v1.8.0 

func (client VirtualNetworkClient) CreateServiceGateway(ctx context.Context, request CreateServiceGatewayRequest) (response CreateServiceGatewayResponse, err error)

CreateServiceGateway Creates a new service gateway in the specified compartment. For the purposes of access control, you must provide the OCID of the compartment where you want the service gateway to reside. For more information about compartments and access control, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs, see Resource Identifiers (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the service gateway, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

func (VirtualNetworkClient) CreateSubnet ¶ 

func (client VirtualNetworkClient) CreateSubnet(ctx context.Context, request CreateSubnetRequest) (response CreateSubnetResponse, err error)

CreateSubnet Creates a new subnet in the specified VCN. You can't change the size of the subnet after creation, so it's important to think about the size of subnets you need before creating them. For more information, see VCNs and Subnets (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVCNs.htm). For information on the number of subnets you can have in a VCN, see Service Limits (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/servicelimits.htm). For the purposes of access control, you must provide the OCID of the compartment where you want the subnet to reside. Notice that the subnet doesn't have to be in the same compartment as the VCN, route tables, or other Networking Service components. If you're not sure which compartment to use, put the subnet in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs, see Resource Identifiers (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm). You may optionally associate a route table with the subnet. If you don't, the subnet will use the VCN's default route table. For more information about route tables, see Route Tables (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingroutetables.htm). You may optionally associate a security list with the subnet. If you don't, the subnet will use the VCN's default security list. For more information about security lists, see Security Lists (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/securitylists.htm). You may optionally associate a set of DHCP options with the subnet. If you don't, the subnet will use the VCN's default set. For more information about DHCP options, see DHCP Options (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingDHCP.htm). You may optionally specify a *display name* for the subnet, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. You can also add a DNS label for the subnet, which is required if you want the Internet and VCN Resolver to resolve hostnames for instances in the subnet. For more information, see DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).

func (VirtualNetworkClient) CreateVcn ¶ 

func (client VirtualNetworkClient) CreateVcn(ctx context.Context, request CreateVcnRequest) (response CreateVcnResponse, err error)

CreateVcn Creates a new virtual cloud network (VCN). For more information, see VCNs and Subnets (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVCNs.htm). For the VCN you must specify a single, contiguous IPv4 CIDR block. Oracle recommends using one of the private IP address ranges specified in RFC 1918 (https://tools.ietf.org/html/rfc1918) (10.0.0.0/8, 172.16/12, and 192.168/16). Example: 172.16.0.0/16. The CIDR block can range from /16 to /30, and it must not overlap with your on-premises network. You can't change the size of the VCN after creation. For the purposes of access control, you must provide the OCID of the compartment where you want the VCN to reside. Consult an Oracle Cloud Infrastructure administrator in your organization if you're not sure which compartment to use. Notice that the VCN doesn't have to be in the same compartment as the subnets or other Networking Service components. For more information about compartments and access control, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs, see Resource Identifiers (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the VCN, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. You can also add a DNS label for the VCN, which is required if you want the instances to use the Interent and VCN Resolver option for DNS in the VCN. For more information, see DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm). The VCN automatically comes with a default route table, default security list, and default set of DHCP options. The OCID for each is returned in the response. You can't delete these default objects, but you can change their contents (that is, change the route rules, security list rules, and so on). The VCN and subnets you create are not accessible until you attach an internet gateway or set up an IPSec VPN or FastConnect. For more information, see Overview of the Networking Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm).

func (VirtualNetworkClient) CreateVirtualCircuit ¶ 

func (client VirtualNetworkClient) CreateVirtualCircuit(ctx context.Context, request CreateVirtualCircuitRequest) (response CreateVirtualCircuitResponse, err error)

CreateVirtualCircuit Creates a new virtual circuit to use with Oracle Cloud Infrastructure FastConnect. For more information, see FastConnect Overview (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm). For the purposes of access control, you must provide the OCID of the compartment where you want the virtual circuit to reside. If you're not sure which compartment to use, put the virtual circuit in the same compartment with the DRG it's using. For more information about compartments and access control, see Overview of the IAM Service (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs, see Resource Identifiers (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the virtual circuit. It does not have to be unique, and you can change it. Avoid entering confidential information. **Important:** When creating a virtual circuit, you specify a DRG for the traffic to flow through. Make sure you attach the DRG to your VCN and confirm the VCN's routing sends traffic to the DRG. Otherwise traffic will not flow. For more information, see Route Tables (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingroutetables.htm).

func (VirtualNetworkClient) DeleteCpe ¶ 

func (client VirtualNetworkClient) DeleteCpe(ctx context.Context, request DeleteCpeRequest) (response DeleteCpeResponse, err error)

DeleteCpe Deletes the specified CPE object. The CPE must not be connected to a DRG. This is an asynchronous operation. The CPE's `lifecycleState` will change to TERMINATING temporarily until the CPE is completely removed.

func (VirtualNetworkClient) DeleteCrossConnect ¶ 

func (client VirtualNetworkClient) DeleteCrossConnect(ctx context.Context, request DeleteCrossConnectRequest) (response DeleteCrossConnectResponse, err error)

DeleteCrossConnect Deletes the specified cross-connect. It must not be mapped to a VirtualCircuit.

func (VirtualNetworkClient) DeleteCrossConnectGroup ¶ 

func (client VirtualNetworkClient) DeleteCrossConnectGroup(ctx context.Context, request DeleteCrossConnectGroupRequest) (response DeleteCrossConnectGroupResponse, err error)

DeleteCrossConnectGroup Deletes the specified cross-connect group. It must not contain any cross-connects, and it cannot be mapped to a VirtualCircuit.

func (VirtualNetworkClient) DeleteDhcpOptions ¶ 

func (client VirtualNetworkClient) DeleteDhcpOptions(ctx context.Context, request DeleteDhcpOptionsRequest) (response DeleteDhcpOptionsResponse, err error)

DeleteDhcpOptions Deletes the specified set of DHCP options, but only if it's not associated with a subnet. You can't delete a VCN's default set of DHCP options. This is an asynchronous operation. The state of the set of options will switch to TERMINATING temporarily until the set is completely removed.

func (VirtualNetworkClient) DeleteDrg ¶ 

func (client VirtualNetworkClient) DeleteDrg(ctx context.Context, request DeleteDrgRequest) (response DeleteDrgResponse, err error)

DeleteDrg Deletes the specified DRG. The DRG must not be attached to a VCN or be connected to your on-premise network. Also, there must not be a route table that lists the DRG as a target. This is an asynchronous operation. The DRG's `lifecycleState` will change to TERMINATING temporarily until the DRG is completely removed.

func (VirtualNetworkClient) DeleteDrgAttachment ¶ 

func (client VirtualNetworkClient) DeleteDrgAttachment(ctx context.Context, request DeleteDrgAttachmentRequest) (response DeleteDrgAttachmentResponse, err error)

DeleteDrgAttachment Detaches a DRG from a VCN by deleting the corresponding `DrgAttachment`. This is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily until the attachment is completely removed.

func (VirtualNetworkClient) DeleteIPSecConnection ¶ 

func (client VirtualNetworkClient) DeleteIPSecConnection(ctx context.Context, request DeleteIPSecConnectionRequest) (response DeleteIPSecConnectionResponse, err error)

DeleteIPSecConnection Deletes the specified IPSec connection. If your goal is to disable the IPSec VPN between your VCN and on-premises network, it's easiest to simply detach the DRG but keep all the IPSec VPN components intact. If you were to delete all the components and then later need to create an IPSec VPN again, you would need to configure your on-premises router again with the new information returned from CreateIPSecConnection. This is an asynchronous operation. The connection's `lifecycleState` will change to TERMINATING temporarily until the connection is completely removed.

func (VirtualNetworkClient) DeleteInternetGateway ¶ 

func (client VirtualNetworkClient) DeleteInternetGateway(ctx context.Context, request DeleteInternetGatewayRequest) (response DeleteInternetGatewayResponse, err error)

DeleteInternetGateway Deletes the specified internet gateway. The internet gateway does not have to be disabled, but there must not be a route table that lists it as a target. This is an asynchronous operation. The gateway's `lifecycleState` will change to TERMINATING temporarily until the gateway is completely removed.

func (VirtualNetworkClient) DeleteLocalPeeringGateway ¶ 

func (client VirtualNetworkClient) DeleteLocalPeeringGateway(ctx context.Context, request DeleteLocalPeeringGatewayRequest) (response DeleteLocalPeeringGatewayResponse, err error)

DeleteLocalPeeringGateway Deletes the specified local peering gateway (LPG). This is an asynchronous operation; the local peering gateway's `lifecycleState` changes to TERMINATING temporarily until the local peering gateway is completely removed.

func (VirtualNetworkClient) DeleteNatGateway ¶ 

func (client VirtualNetworkClient) DeleteNatGateway(ctx context.Context, request DeleteNatGatewayRequest) (response DeleteNatGatewayResponse, err error)

DeleteNatGateway Deletes the specified NAT gateway. The NAT gateway does not have to be disabled, but there must not be a route rule that lists the NAT gateway as a target. This is an asynchronous operation. The NAT gateway's `lifecycleState` will change to TERMINATING temporarily until the NAT gateway is completely removed.

func (VirtualNetworkClient) DeletePrivateIp ¶ 

func (client VirtualNetworkClient) DeletePrivateIp(ctx context.Context, request DeletePrivateIpRequest) (response DeletePrivateIpResponse, err error)

DeletePrivateIp Unassigns and deletes the specified private IP. You must specify the object's OCID. The private IP address is returned to the subnet's pool of available addresses. This operation cannot be used with primary private IPs, which are automatically unassigned and deleted when the VNIC is terminated. **Important:** If a secondary private IP is the target of a route rule (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingroutetables.htm#privateip), unassigning it from the VNIC causes that route rule to blackhole and the traffic will be dropped.

func (VirtualNetworkClient) DeletePublicIp ¶ added in v1.1.0 

func (client VirtualNetworkClient) DeletePublicIp(ctx context.Context, request DeletePublicIpRequest) (response DeletePublicIpResponse, err error)

DeletePublicIp Unassigns and deletes the specified public IP (either ephemeral or reserved). You must specify the object's OCID. The public IP address is returned to the Oracle Cloud Infrastructure public IP pool. **Note:** You cannot update, unassign, or delete the public IP that Oracle automatically assigned to an entity for you (such as a load balancer or NAT gateway). The public IP is automatically deleted if the assigned entity is terminated. For an assigned reserved public IP, the initial unassignment portion of this operation is asynchronous. Poll the public IP's `lifecycleState` to determine if the operation succeeded. If you want to simply unassign a reserved public IP and return it to your pool of reserved public IPs, instead use UpdatePublicIp.

func (VirtualNetworkClient) DeleteRemotePeeringConnection ¶ added in v1.2.0 

func (client VirtualNetworkClient) DeleteRemotePeeringConnection(ctx context.Context, request DeleteRemotePeeringConnectionRequest) (response DeleteRemotePeeringConnectionResponse, err error)

DeleteRemotePeeringConnection Deletes the remote peering connection (RPC). This is an asynchronous operation; the RPC's `lifecycleState` changes to TERMINATING temporarily until the RPC is completely removed.

func (VirtualNetworkClient) DeleteRouteTable ¶ 

func (client VirtualNetworkClient) DeleteRouteTable(ctx context.Context, request DeleteRouteTableRequest) (response DeleteRouteTableResponse, err error)

DeleteRouteTable Deletes the specified route table, but only if it's not associated with a subnet. You can't delete a VCN's default route table. This is an asynchronous operation. The route table's `lifecycleState` will change to TERMINATING temporarily until the route table is completely removed.

func (VirtualNetworkClient) DeleteSecurityList ¶ 

func (client VirtualNetworkClient) DeleteSecurityList(ctx context.Context, request DeleteSecurityListRequest) (response DeleteSecurityListResponse, err error)

DeleteSecurityList Deletes the specified security list, but only if it's not associated with a subnet. You can't delete a VCN's default security list. This is an asynchronous operation. The security list's `lifecycleState` will change to TERMINATING temporarily until the security list is completely removed.

func (VirtualNetworkClient) DeleteServiceGateway ¶ added in v1.8.0 

func (client VirtualNetworkClient) DeleteServiceGateway(ctx context.Context, request DeleteServiceGatewayRequest) (response DeleteServiceGatewayResponse, err error)

DeleteServiceGateway Deletes the specified service gateway. There must not be a route table that lists the service gateway as a target.

func (VirtualNetworkClient) DeleteSubnet ¶ 

func (client VirtualNetworkClient) DeleteSubnet(ctx context.Context, request DeleteSubnetRequest) (response DeleteSubnetResponse, err error)

DeleteSubnet Deletes the specified subnet, but only if there are no instances in the subnet. This is an asynchronous operation. The subnet's `lifecycleState` will change to TERMINATING temporarily. If there are any instances in the subnet, the state will instead change back to AVAILABLE.

func (VirtualNetworkClient) DeleteVcn ¶ 

func (client VirtualNetworkClient) DeleteVcn(ctx context.Context, request DeleteVcnRequest) (response DeleteVcnResponse, err error)

DeleteVcn Deletes the specified VCN. The VCN must be empty and have no attached gateways. This is an asynchronous operation. The VCN's `lifecycleState` will change to TERMINATING temporarily until the VCN is completely removed.

func (VirtualNetworkClient) DeleteVirtualCircuit ¶ 

func (client VirtualNetworkClient) DeleteVirtualCircuit(ctx context.Context, request DeleteVirtualCircuitRequest) (response DeleteVirtualCircuitResponse, err error)

DeleteVirtualCircuit Deletes the specified virtual circuit. **Important:** If you're using FastConnect via a provider, make sure to also terminate the connection with the provider, or else the provider may continue to bill you.

func (VirtualNetworkClient) DetachServiceId ¶ added in v1.8.0 

func (client VirtualNetworkClient) DetachServiceId(ctx context.Context, request DetachServiceIdRequest) (response DetachServiceIdResponse, err error)

DetachServiceId Disables the specified service on the specified gateway. In other words, stops the service gateway from sending traffic to the specified service. You do not need to remove any route rules that specify this service's `cidrBlock` as the destination CIDR. However, consider removing the rules if your intent is to permanently disable use of the service through this service gateway. **Note:** The `DetachServiceId` operation is an easy way to disable an individual service on the service gateway. Compare it with UpdateServiceGateway, which also lets you disable an individual service. However, with `UpdateServiceGateway`, you must specify the *entire* list of services you want enabled on the service gateway. `UpdateServiceGateway` also lets you block all traffic through the service gateway without having to disable each of the individual services.

func (VirtualNetworkClient) GetCpe ¶ 

func (client VirtualNetworkClient) GetCpe(ctx context.Context, request GetCpeRequest) (response GetCpeResponse, err error)

GetCpe Gets the specified CPE's information.

func (VirtualNetworkClient) GetCrossConnect ¶ 

func (client VirtualNetworkClient) GetCrossConnect(ctx context.Context, request GetCrossConnectRequest) (response GetCrossConnectResponse, err error)

GetCrossConnect Gets the specified cross-connect's information.

func (VirtualNetworkClient) GetCrossConnectGroup ¶ 

func (client VirtualNetworkClient) GetCrossConnectGroup(ctx context.Context, request GetCrossConnectGroupRequest) (response GetCrossConnectGroupResponse, err error)

GetCrossConnectGroup Gets the specified cross-connect group's information.

func (VirtualNetworkClient) GetCrossConnectLetterOfAuthority ¶ 

func (client VirtualNetworkClient) GetCrossConnectLetterOfAuthority(ctx context.Context, request GetCrossConnectLetterOfAuthorityRequest) (response GetCrossConnectLetterOfAuthorityResponse, err error)

GetCrossConnectLetterOfAuthority Gets the Letter of Authority for the specified cross-connect.

func (VirtualNetworkClient) GetCrossConnectStatus ¶ 

func (client VirtualNetworkClient) GetCrossConnectStatus(ctx context.Context, request GetCrossConnectStatusRequest) (response GetCrossConnectStatusResponse, err error)

GetCrossConnectStatus Gets the status of the specified cross-connect.

func (VirtualNetworkClient) GetDhcpOptions ¶ 

func (client VirtualNetworkClient) GetDhcpOptions(ctx context.Context, request GetDhcpOptionsRequest) (response GetDhcpOptionsResponse, err error)

GetDhcpOptions Gets the specified set of DHCP options.

func (VirtualNetworkClient) GetDrg ¶ 

func (client VirtualNetworkClient) GetDrg(ctx context.Context, request GetDrgRequest) (response GetDrgResponse, err error)

GetDrg Gets the specified DRG's information.

func (VirtualNetworkClient) GetDrgAttachment ¶ 

func (client VirtualNetworkClient) GetDrgAttachment(ctx context.Context, request GetDrgAttachmentRequest) (response GetDrgAttachmentResponse, err error)

GetDrgAttachment Gets the information for the specified `DrgAttachment`.

func (VirtualNetworkClient) GetFastConnectProviderService ¶ 

func (client VirtualNetworkClient) GetFastConnectProviderService(ctx context.Context, request GetFastConnectProviderServiceRequest) (response GetFastConnectProviderServiceResponse, err error)

GetFastConnectProviderService Gets the specified provider service. For more information, see FastConnect Overview (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm).

func (VirtualNetworkClient) GetIPSecConnection ¶ 

func (client VirtualNetworkClient) GetIPSecConnection(ctx context.Context, request GetIPSecConnectionRequest) (response GetIPSecConnectionResponse, err error)

GetIPSecConnection Gets the specified IPSec connection's basic information, including the static routes for the on-premises router. If you want the status of the connection (whether it's up or down), use GetIPSecConnectionDeviceStatus.

func (VirtualNetworkClient) GetIPSecConnectionDeviceConfig ¶ 

func (client VirtualNetworkClient) GetIPSecConnectionDeviceConfig(ctx context.Context, request GetIPSecConnectionDeviceConfigRequest) (response GetIPSecConnectionDeviceConfigResponse, err error)

GetIPSecConnectionDeviceConfig Gets the configuration information for the specified IPSec connection. For each tunnel, the response includes the IP address of Oracle's VPN headend and the shared secret.

func (VirtualNetworkClient) GetIPSecConnectionDeviceStatus ¶ 

func (client VirtualNetworkClient) GetIPSecConnectionDeviceStatus(ctx context.Context, request GetIPSecConnectionDeviceStatusRequest) (response GetIPSecConnectionDeviceStatusResponse, err error)

GetIPSecConnectionDeviceStatus Gets the status of the specified IPSec connection (whether it's up or down).

func (VirtualNetworkClient) GetInternetGateway ¶ 

func (client VirtualNetworkClient) GetInternetGateway(ctx context.Context, request GetInternetGatewayRequest) (response GetInternetGatewayResponse, err error)

GetInternetGateway Gets the specified internet gateway's information.

func (VirtualNetworkClient) GetLocalPeeringGateway ¶ 

func (client VirtualNetworkClient) GetLocalPeeringGateway(ctx context.Context, request GetLocalPeeringGatewayRequest) (response GetLocalPeeringGatewayResponse, err error)

GetLocalPeeringGateway Gets the specified local peering gateway's information.

func (VirtualNetworkClient) GetNatGateway ¶ 

func (client VirtualNetworkClient) GetNatGateway(ctx context.Context, request GetNatGatewayRequest) (response GetNatGatewayResponse, err error)

GetNatGateway Gets the specified NAT gateway's information.

func (VirtualNetworkClient) GetPrivateIp ¶ 

func (client VirtualNetworkClient) GetPrivateIp(ctx context.Context, request GetPrivateIpRequest) (response GetPrivateIpResponse, err error)

GetPrivateIp Gets the specified private IP. You must specify the object's OCID. Alternatively, you can get the object by using ListPrivateIps with the private IP address (for example, 10.0.3.3) and subnet OCID.

func (VirtualNetworkClient) GetPublicIp ¶ added in v1.1.0 

func (client VirtualNetworkClient) GetPublicIp(ctx context.Context, request GetPublicIpRequest) (response GetPublicIpResponse, err error)

GetPublicIp Gets the specified public IP. You must specify the object's OCID. Alternatively, you can get the object by using GetPublicIpByIpAddress with the public IP address (for example, 129.146.2.1). Or you can use GetPublicIpByPrivateIpId with the OCID of the private IP that the public IP is assigned to. **Note:** If you're fetching a reserved public IP that is in the process of being moved to a different private IP, the service returns the public IP object with `lifecycleState` = ASSIGNING and `assignedEntityId` = OCID of the target private IP.

func (VirtualNetworkClient) GetPublicIpByIpAddress ¶ added in v1.1.0 

func (client VirtualNetworkClient) GetPublicIpByIpAddress(ctx context.Context, request GetPublicIpByIpAddressRequest) (response GetPublicIpByIpAddressResponse, err error)

GetPublicIpByIpAddress Gets the public IP based on the public IP address (for example, 129.146.2.1). **Note:** If you're fetching a reserved public IP that is in the process of being moved to a different private IP, the service returns the public IP object with `lifecycleState` = ASSIGNING and `assignedEntityId` = OCID of the target private IP.

func (VirtualNetworkClient) GetPublicIpByPrivateIpId ¶ added in v1.1.0 

func (client VirtualNetworkClient) GetPublicIpByPrivateIpId(ctx context.Context, request GetPublicIpByPrivateIpIdRequest) (response GetPublicIpByPrivateIpIdResponse, err error)

GetPublicIpByPrivateIpId Gets the public IP assigned to the specified private IP. You must specify the OCID of the private IP. If no public IP is assigned, a 404 is returned. **Note:** If you're fetching a reserved public IP that is in the process of being moved to a different private IP, and you provide the OCID of the original private IP, this operation returns a 404. If you instead provide the OCID of the target private IP, or if you instead call GetPublicIp or GetPublicIpByIpAddress, the service returns the public IP object with `lifecycleState` = ASSIGNING and `assignedEntityId` = OCID of the target private IP.

func (VirtualNetworkClient) GetRemotePeeringConnection ¶ added in v1.2.0 

func (client VirtualNetworkClient) GetRemotePeeringConnection(ctx context.Context, request GetRemotePeeringConnectionRequest) (response GetRemotePeeringConnectionResponse, err error)

GetRemotePeeringConnection Get the specified remote peering connection's information.

func (VirtualNetworkClient) GetRouteTable ¶ 

func (client VirtualNetworkClient) GetRouteTable(ctx context.Context, request GetRouteTableRequest) (response GetRouteTableResponse, err error)

GetRouteTable Gets the specified route table's information.

func (VirtualNetworkClient) GetSecurityList ¶ 

func (client VirtualNetworkClient) GetSecurityList(ctx context.Context, request GetSecurityListRequest) (response GetSecurityListResponse, err error)

GetSecurityList Gets the specified security list's information.

func (VirtualNetworkClient) GetService ¶ added in v1.8.0 

func (client VirtualNetworkClient) GetService(ctx context.Context, request GetServiceRequest) (response GetServiceResponse, err error)

GetService Gets the specified service's information.

func (VirtualNetworkClient) GetServiceGateway ¶ added in v1.8.0 

func (client VirtualNetworkClient) GetServiceGateway(ctx context.Context, request GetServiceGatewayRequest) (response GetServiceGatewayResponse, err error)

GetServiceGateway Gets the specified service gateway's information.

func (VirtualNetworkClient) GetSubnet ¶ 

func (client VirtualNetworkClient) GetSubnet(ctx context.Context, request GetSubnetRequest) (response GetSubnetResponse, err error)

GetSubnet Gets the specified subnet's information.

func (VirtualNetworkClient) GetVcn ¶ 

func (client VirtualNetworkClient) GetVcn(ctx context.Context, request GetVcnRequest) (response GetVcnResponse, err error)

GetVcn Gets the specified VCN's information.

func (VirtualNetworkClient) GetVirtualCircuit ¶ 

func (client VirtualNetworkClient) GetVirtualCircuit(ctx context.Context, request GetVirtualCircuitRequest) (response GetVirtualCircuitResponse, err error)

GetVirtualCircuit Gets the specified virtual circuit's information.

func (VirtualNetworkClient) GetVnic ¶ 

func (client VirtualNetworkClient) GetVnic(ctx context.Context, request GetVnicRequest) (response GetVnicResponse, err error)

GetVnic Gets the information for the specified virtual network interface card (VNIC). You can get the VNIC OCID from the ListVnicAttachments operation.

func (VirtualNetworkClient) ListAllowedPeerRegionsForRemotePeering ¶ added in v1.2.0 

func (client VirtualNetworkClient) ListAllowedPeerRegionsForRemotePeering(ctx context.Context, request ListAllowedPeerRegionsForRemotePeeringRequest) (response ListAllowedPeerRegionsForRemotePeeringResponse, err error)

ListAllowedPeerRegionsForRemotePeering Lists the regions that support remote VCN peering (which is peering across regions). For more information, see VCN Peering (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/VCNpeering.htm).

func (VirtualNetworkClient) ListCpes ¶ 

func (client VirtualNetworkClient) ListCpes(ctx context.Context, request ListCpesRequest) (response ListCpesResponse, err error)

ListCpes Lists the customer-premises equipment objects (CPEs) in the specified compartment.

func (VirtualNetworkClient) ListCrossConnectGroups ¶ 

func (client VirtualNetworkClient) ListCrossConnectGroups(ctx context.Context, request ListCrossConnectGroupsRequest) (response ListCrossConnectGroupsResponse, err error)

ListCrossConnectGroups Lists the cross-connect groups in the specified compartment.

func (VirtualNetworkClient) ListCrossConnectLocations ¶ 

func (client VirtualNetworkClient) ListCrossConnectLocations(ctx context.Context, request ListCrossConnectLocationsRequest) (response ListCrossConnectLocationsResponse, err error)

ListCrossConnectLocations Lists the available FastConnect locations for cross-connect installation. You need this information so you can specify your desired location when you create a cross-connect.

func (VirtualNetworkClient) ListCrossConnects ¶ 

func (client VirtualNetworkClient) ListCrossConnects(ctx context.Context, request ListCrossConnectsRequest) (response ListCrossConnectsResponse, err error)

ListCrossConnects Lists the cross-connects in the specified compartment. You can filter the list by specifying the OCID of a cross-connect group.

func (VirtualNetworkClient) ListCrossconnectPortSpeedShapes ¶ 

func (client VirtualNetworkClient) ListCrossconnectPortSpeedShapes(ctx context.Context, request ListCrossconnectPortSpeedShapesRequest) (response ListCrossconnectPortSpeedShapesResponse, err error)

ListCrossconnectPortSpeedShapes Lists the available port speeds for cross-connects. You need this information so you can specify your desired port speed (that is, shape) when you create a cross-connect.

func (VirtualNetworkClient) ListDhcpOptions ¶ 

func (client VirtualNetworkClient) ListDhcpOptions(ctx context.Context, request ListDhcpOptionsRequest) (response ListDhcpOptionsResponse, err error)

ListDhcpOptions Lists the sets of DHCP options in the specified VCN and specified compartment. The response includes the default set of options that automatically comes with each VCN, plus any other sets you've created.

func (VirtualNetworkClient) ListDrgAttachments ¶ 

func (client VirtualNetworkClient) ListDrgAttachments(ctx context.Context, request ListDrgAttachmentsRequest) (response ListDrgAttachmentsResponse, err error)

ListDrgAttachments Lists the `DrgAttachment` objects for the specified compartment. You can filter the results by VCN or DRG.

func (VirtualNetworkClient) ListDrgs ¶ 

func (client VirtualNetworkClient) ListDrgs(ctx context.Context, request ListDrgsRequest) (response ListDrgsResponse, err error)

ListDrgs Lists the DRGs in the specified compartment.

func (VirtualNetworkClient) ListFastConnectProviderServices ¶ 

func (client VirtualNetworkClient) ListFastConnectProviderServices(ctx context.Context, request ListFastConnectProviderServicesRequest) (response ListFastConnectProviderServicesResponse, err error)

ListFastConnectProviderServices Lists the service offerings from supported providers. You need this information so you can specify your desired provider and service offering when you create a virtual circuit. For the compartment ID, provide the OCID of your tenancy (the root compartment). For more information, see FastConnect Overview (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm).

func (VirtualNetworkClient) ListFastConnectProviderVirtualCircuitBandwidthShapes ¶ 

func (client VirtualNetworkClient) ListFastConnectProviderVirtualCircuitBandwidthShapes(ctx context.Context, request ListFastConnectProviderVirtualCircuitBandwidthShapesRequest) (response ListFastConnectProviderVirtualCircuitBandwidthShapesResponse, err error)

ListFastConnectProviderVirtualCircuitBandwidthShapes Gets the list of available virtual circuit bandwidth levels for a provider. You need this information so you can specify your desired bandwidth level (shape) when you create a virtual circuit. For more information about virtual circuits, see FastConnect Overview (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm).

func (VirtualNetworkClient) ListIPSecConnections ¶ 

func (client VirtualNetworkClient) ListIPSecConnections(ctx context.Context, request ListIPSecConnectionsRequest) (response ListIPSecConnectionsResponse, err error)

ListIPSecConnections Lists the IPSec connections for the specified compartment. You can filter the results by DRG or CPE.

func (VirtualNetworkClient) ListInternetGateways ¶ 

func (client VirtualNetworkClient) ListInternetGateways(ctx context.Context, request ListInternetGatewaysRequest) (response ListInternetGatewaysResponse, err error)

ListInternetGateways Lists the internet gateways in the specified VCN and the specified compartment.

func (VirtualNetworkClient) ListLocalPeeringGateways ¶ 

func (client VirtualNetworkClient) ListLocalPeeringGateways(ctx context.Context, request ListLocalPeeringGatewaysRequest) (response ListLocalPeeringGatewaysResponse, err error)

ListLocalPeeringGateways Lists the local peering gateways (LPGs) for the specified VCN and compartment (the LPG's compartment).

func (VirtualNetworkClient) ListNatGateways ¶ 

func (client VirtualNetworkClient) ListNatGateways(ctx context.Context, request ListNatGatewaysRequest) (response ListNatGatewaysResponse, err error)

ListNatGateways Lists the NAT gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN.

func (VirtualNetworkClient) ListPrivateIps ¶ 

func (client VirtualNetworkClient) ListPrivateIps(ctx context.Context, request ListPrivateIpsRequest) (response ListPrivateIpsResponse, err error)

ListPrivateIps Lists the PrivateIp objects based on one of these filters:

  • Subnet OCID.
  • VNIC OCID.
  • Both private IP address and subnet OCID: This lets you get a `privateIP` object based on its private IP address (for example, 10.0.3.3) and not its OCID. For comparison, GetPrivateIp requires the OCID.

If you're listing all the private IPs associated with a given subnet or VNIC, the response includes both primary and secondary private IPs.

func (VirtualNetworkClient) ListPublicIps ¶ added in v1.1.0 

func (client VirtualNetworkClient) ListPublicIps(ctx context.Context, request ListPublicIpsRequest) (response ListPublicIpsResponse, err error)

ListPublicIps Lists the PublicIp objects in the specified compartment. You can filter the list by using query parameters. To list your reserved public IPs:

  • Set `scope` = `REGION` (required)
  • Leave the `availabilityDomain` parameter empty
  • Set `lifetime` = `RESERVED`

To list the ephemeral public IPs assigned to a regional entity such as a NAT gateway:

  • Set `scope` = `REGION` (required)
  • Leave the `availabilityDomain` parameter empty
  • Set `lifetime` = `EPHEMERAL`

To list the ephemeral public IPs assigned to private IPs:

  • Set `scope` = `AVAILABILITY_DOMAIN` (required)
  • Set the `availabilityDomain` parameter to the desired availability domain (required)
  • Set `lifetime` = `EPHEMERAL`

**Note:** An ephemeral public IP assigned to a private IP is always in the same availability domain and compartment as the private IP.

func (VirtualNetworkClient) ListRemotePeeringConnections ¶ added in v1.2.0 

func (client VirtualNetworkClient) ListRemotePeeringConnections(ctx context.Context, request ListRemotePeeringConnectionsRequest) (response ListRemotePeeringConnectionsResponse, err error)

ListRemotePeeringConnections Lists the remote peering connections (RPCs) for the specified DRG and compartment (the RPC's compartment).

func (VirtualNetworkClient) ListRouteTables ¶ 

func (client VirtualNetworkClient) ListRouteTables(ctx context.Context, request ListRouteTablesRequest) (response ListRouteTablesResponse, err error)

ListRouteTables Lists the route tables in the specified VCN and specified compartment. The response includes the default route table that automatically comes with each VCN, plus any route tables you've created.

func (VirtualNetworkClient) ListSecurityLists ¶ 

func (client VirtualNetworkClient) ListSecurityLists(ctx context.Context, request ListSecurityListsRequest) (response ListSecurityListsResponse, err error)

ListSecurityLists Lists the security lists in the specified VCN and compartment.

func (VirtualNetworkClient) ListServiceGateways ¶ added in v1.8.0 

func (client VirtualNetworkClient) ListServiceGateways(ctx context.Context, request ListServiceGatewaysRequest) (response ListServiceGatewaysResponse, err error)

ListServiceGateways Lists the service gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN.

func (VirtualNetworkClient) ListServices ¶ added in v1.8.0 

func (client VirtualNetworkClient) ListServices(ctx context.Context, request ListServicesRequest) (response ListServicesResponse, err error)

ListServices Lists the available services that you can access through a service gateway in this region.

func (VirtualNetworkClient) ListSubnets ¶ 

func (client VirtualNetworkClient) ListSubnets(ctx context.Context, request ListSubnetsRequest) (response ListSubnetsResponse, err error)

ListSubnets Lists the subnets in the specified VCN and the specified compartment.

func (VirtualNetworkClient) ListVcns ¶ 

func (client VirtualNetworkClient) ListVcns(ctx context.Context, request ListVcnsRequest) (response ListVcnsResponse, err error)

ListVcns Lists the virtual cloud networks (VCNs) in the specified compartment.

func (VirtualNetworkClient) ListVirtualCircuitBandwidthShapes ¶ 

func (client VirtualNetworkClient) ListVirtualCircuitBandwidthShapes(ctx context.Context, request ListVirtualCircuitBandwidthShapesRequest) (response ListVirtualCircuitBandwidthShapesResponse, err error)

ListVirtualCircuitBandwidthShapes The deprecated operation lists available bandwidth levels for virtual circuits. For the compartment ID, provide the OCID of your tenancy (the root compartment).

func (VirtualNetworkClient) ListVirtualCircuitPublicPrefixes ¶ 

func (client VirtualNetworkClient) ListVirtualCircuitPublicPrefixes(ctx context.Context, request ListVirtualCircuitPublicPrefixesRequest) (response ListVirtualCircuitPublicPrefixesResponse, err error)

ListVirtualCircuitPublicPrefixes Lists the public IP prefixes and their details for the specified public virtual circuit.

func (VirtualNetworkClient) ListVirtualCircuits ¶ 

func (client VirtualNetworkClient) ListVirtualCircuits(ctx context.Context, request ListVirtualCircuitsRequest) (response ListVirtualCircuitsResponse, err error)

ListVirtualCircuits Lists the virtual circuits in the specified compartment.

func (*VirtualNetworkClient) SetRegion ¶ 

func (client *VirtualNetworkClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (VirtualNetworkClient) UpdateCpe ¶ 

func (client VirtualNetworkClient) UpdateCpe(ctx context.Context, request UpdateCpeRequest) (response UpdateCpeResponse, err error)

UpdateCpe Updates the specified CPE's display name or tags. Avoid entering confidential information.

func (VirtualNetworkClient) UpdateCrossConnect ¶ 

func (client VirtualNetworkClient) UpdateCrossConnect(ctx context.Context, request UpdateCrossConnectRequest) (response UpdateCrossConnectResponse, err error)

UpdateCrossConnect Updates the specified cross-connect.

func (VirtualNetworkClient) UpdateCrossConnectGroup ¶ 

func (client VirtualNetworkClient) UpdateCrossConnectGroup(ctx context.Context, request UpdateCrossConnectGroupRequest) (response UpdateCrossConnectGroupResponse, err error)

UpdateCrossConnectGroup Updates the specified cross-connect group's display name. Avoid entering confidential information.

func (VirtualNetworkClient) UpdateDhcpOptions ¶ 

func (client VirtualNetworkClient) UpdateDhcpOptions(ctx context.Context, request UpdateDhcpOptionsRequest) (response UpdateDhcpOptionsResponse, err error)

UpdateDhcpOptions Updates the specified set of DHCP options. You can update the display name or the options themselves. Avoid entering confidential information. Note that the `options` object you provide replaces the entire existing set of options.

func (VirtualNetworkClient) UpdateDrg ¶ 

func (client VirtualNetworkClient) UpdateDrg(ctx context.Context, request UpdateDrgRequest) (response UpdateDrgResponse, err error)

UpdateDrg Updates the specified DRG's display name or tags. Avoid entering confidential information.

func (VirtualNetworkClient) UpdateDrgAttachment ¶ 

func (client VirtualNetworkClient) UpdateDrgAttachment(ctx context.Context, request UpdateDrgAttachmentRequest) (response UpdateDrgAttachmentResponse, err error)

UpdateDrgAttachment Updates the display name for the specified `DrgAttachment`. Avoid entering confidential information.

func (VirtualNetworkClient) UpdateIPSecConnection ¶ 

func (client VirtualNetworkClient) UpdateIPSecConnection(ctx context.Context, request UpdateIPSecConnectionRequest) (response UpdateIPSecConnectionResponse, err error)

UpdateIPSecConnection Updates the display name or tags for the specified IPSec connection. Avoid entering confidential information.

func (VirtualNetworkClient) UpdateInternetGateway ¶ 

func (client VirtualNetworkClient) UpdateInternetGateway(ctx context.Context, request UpdateInternetGatewayRequest) (response UpdateInternetGatewayResponse, err error)

UpdateInternetGateway Updates the specified internet gateway. You can disable/enable it, or change its display name or tags. Avoid entering confidential information. If the gateway is disabled, that means no traffic will flow to/from the internet even if there's a route rule that enables that traffic.

func (VirtualNetworkClient) UpdateLocalPeeringGateway ¶ 

func (client VirtualNetworkClient) UpdateLocalPeeringGateway(ctx context.Context, request UpdateLocalPeeringGatewayRequest) (response UpdateLocalPeeringGatewayResponse, err error)

UpdateLocalPeeringGateway Updates the specified local peering gateway (LPG).

func (VirtualNetworkClient) UpdateNatGateway ¶ 

func (client VirtualNetworkClient) UpdateNatGateway(ctx context.Context, request UpdateNatGatewayRequest) (response UpdateNatGatewayResponse, err error)

UpdateNatGateway Updates the specified NAT gateway.

func (VirtualNetworkClient) UpdatePrivateIp ¶ 

func (client VirtualNetworkClient) UpdatePrivateIp(ctx context.Context, request UpdatePrivateIpRequest) (response UpdatePrivateIpResponse, err error)

UpdatePrivateIp Updates the specified private IP. You must specify the object's OCID. Use this operation if you want to:

  • Move a secondary private IP to a different VNIC in the same subnet.
  • Change the display name for a secondary private IP.
  • Change the hostname for a secondary private IP.

This operation cannot be used with primary private IPs. To update the hostname for the primary IP on a VNIC, use UpdateVnic.

func (VirtualNetworkClient) UpdatePublicIp ¶ added in v1.1.0 

func (client VirtualNetworkClient) UpdatePublicIp(ctx context.Context, request UpdatePublicIpRequest) (response UpdatePublicIpResponse, err error)

UpdatePublicIp Updates the specified public IP. You must specify the object's OCID. Use this operation if you want to: * Assign a reserved public IP in your pool to a private IP. * Move a reserved public IP to a different private IP. * Unassign a reserved public IP from a private IP (which returns it to your pool of reserved public IPs). * Change the display name or tags for a public IP. Assigning, moving, and unassigning a reserved public IP are asynchronous operations. Poll the public IP's `lifecycleState` to determine if the operation succeeded. **Note:** When moving a reserved public IP, the target private IP must not already have a public IP with `lifecycleState` = ASSIGNING or ASSIGNED. If it does, an error is returned. Also, the initial unassignment from the original private IP always succeeds, but the assignment to the target private IP is asynchronous and could fail silently (for example, if the target private IP is deleted or has a different public IP assigned to it in the interim). If that occurs, the public IP remains unassigned and its `lifecycleState` switches to AVAILABLE (it is not reassigned to its original private IP). You must poll the public IP's `lifecycleState` to determine if the move succeeded. Regarding ephemeral public IPs: * If you want to assign an ephemeral public IP to a primary private IP, use CreatePublicIp. * You can't move an ephemeral public IP to a different private IP. * If you want to unassign an ephemeral public IP from its private IP, use DeletePublicIp, which unassigns and deletes the ephemeral public IP. **Note:** If a public IP is assigned to a secondary private IP (see PrivateIp), and you move that secondary private IP to another VNIC, the public IP moves with it. **Note:** There's a limit to the number of PublicIp a VNIC or instance can have. If you try to move a reserved public IP to a VNIC or instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see Public IP Addresses (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingpublicIPs.htm).

func (VirtualNetworkClient) UpdateRemotePeeringConnection ¶ added in v1.2.0 

func (client VirtualNetworkClient) UpdateRemotePeeringConnection(ctx context.Context, request UpdateRemotePeeringConnectionRequest) (response UpdateRemotePeeringConnectionResponse, err error)

UpdateRemotePeeringConnection Updates the specified remote peering connection (RPC).

func (VirtualNetworkClient) UpdateRouteTable ¶ 

func (client VirtualNetworkClient) UpdateRouteTable(ctx context.Context, request UpdateRouteTableRequest) (response UpdateRouteTableResponse, err error)

UpdateRouteTable Updates the specified route table's display name or route rules. Avoid entering confidential information. Note that the `routeRules` object you provide replaces the entire existing set of rules.

func (VirtualNetworkClient) UpdateSecurityList ¶ 

func (client VirtualNetworkClient) UpdateSecurityList(ctx context.Context, request UpdateSecurityListRequest) (response UpdateSecurityListResponse, err error)

UpdateSecurityList Updates the specified security list's display name or rules. Avoid entering confidential information. Note that the `egressSecurityRules` or `ingressSecurityRules` objects you provide replace the entire existing objects.

func (VirtualNetworkClient) UpdateServiceGateway ¶ added in v1.8.0 

func (client VirtualNetworkClient) UpdateServiceGateway(ctx context.Context, request UpdateServiceGatewayRequest) (response UpdateServiceGatewayResponse, err error)

UpdateServiceGateway Updates the specified service gateway. The information you provide overwrites the existing attributes of the gateway.

func (VirtualNetworkClient) UpdateSubnet ¶ 

func (client VirtualNetworkClient) UpdateSubnet(ctx context.Context, request UpdateSubnetRequest) (response UpdateSubnetResponse, err error)

UpdateSubnet Updates the specified subnet.

func (VirtualNetworkClient) UpdateVcn ¶ 

func (client VirtualNetworkClient) UpdateVcn(ctx context.Context, request UpdateVcnRequest) (response UpdateVcnResponse, err error)

UpdateVcn Updates the specified VCN.

func (VirtualNetworkClient) UpdateVirtualCircuit ¶ 

func (client VirtualNetworkClient) UpdateVirtualCircuit(ctx context.Context, request UpdateVirtualCircuitRequest) (response UpdateVirtualCircuitResponse, err error)

UpdateVirtualCircuit Updates the specified virtual circuit. This can be called by either the customer who owns the virtual circuit, or the provider (when provisioning or de-provisioning the virtual circuit from their end). The documentation for UpdateVirtualCircuitDetails indicates who can update each property of the virtual circuit. **Important:** If the virtual circuit is working and in the PROVISIONED state, updating any of the network-related properties (such as the DRG being used, the BGP ASN, and so on) will cause the virtual circuit's state to switch to PROVISIONING and the related BGP session to go down. After Oracle re-provisions the virtual circuit, its state will return to PROVISIONED. Make sure you confirm that the associated BGP session is back up. For more information about the various states and how to test connectivity, see FastConnect Overview (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm). To change the list of public IP prefixes for a public virtual circuit, use BulkAddVirtualCircuitPublicPrefixes and BulkDeleteVirtualCircuitPublicPrefixes. Updating the list of prefixes does NOT cause the BGP session to go down. However, Oracle must verify the customer's ownership of each added prefix before traffic for that prefix will flow across the virtual circuit.

func (VirtualNetworkClient) UpdateVnic ¶ 

func (client VirtualNetworkClient) UpdateVnic(ctx context.Context, request UpdateVnicRequest) (response UpdateVnicResponse, err error)

UpdateVnic Updates the specified VNIC.

type Vnic ¶ 

type Vnic struct {

	// The VNIC's availability domain.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The OCID of the compartment containing the VNIC.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the VNIC.
	Id *string `mandatory:"true" json:"id"`

	// The current state of the VNIC.
	LifecycleState VnicLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The OCID of the subnet the VNIC is in.
	SubnetId *string `mandatory:"true" json:"subnetId"`

	// The date and time the VNIC was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// A user-friendly name. Does not have to be unique.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname
	// portion of the primary private IP's fully qualified domain name (FQDN)
	// (for example, `bminstance-1` in FQDN `bminstance-1.subnet123.vcn1.oraclevcn.com`).
	// Must be unique across all VNICs in the subnet and comply with
	// RFC 952 (https://tools.ietf.org/html/rfc952) and
	// RFC 1123 (https://tools.ietf.org/html/rfc1123).
	// For more information, see
	// DNS in Your Virtual Cloud Network (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
	// Example: `bminstance-1`
	HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`

	// Whether the VNIC is the primary VNIC (the VNIC that is automatically created
	// and attached during instance launch).
	IsPrimary *bool `mandatory:"false" json:"isPrimary"`

	// The MAC address of the VNIC.
	// Example: `00:00:17:B6:4D:DD`
	MacAddress *string `mandatory:"false" json:"macAddress"`

	// The private IP address of the primary `privateIp` object on the VNIC.
	// The address is within the CIDR of the VNIC's subnet.
	// Example: `10.0.3.3`
	PrivateIp *string `mandatory:"false" json:"privateIp"`

	// The public IP address of the VNIC, if one is assigned.
	PublicIp *string `mandatory:"false" json:"publicIp"`

	// Whether the source/destination check is disabled on the VNIC.
	// Defaults to `false`, which means the check is performed. For information
	// about why you would skip the source/destination check, see
	// Using a Private IP as a Route Target (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingroutetables.htm#privateip).
	// Example: `true`
	SkipSourceDestCheck *bool `mandatory:"false" json:"skipSourceDestCheck"`
}

Vnic A virtual network interface card. Each VNIC resides in a subnet in a VCN. An instance attaches to a VNIC to obtain a network connection into the VCN through that subnet. Each instance has a *primary VNIC* that is automatically created and attached during launch. You can add *secondary VNICs* to an instance after it's launched. For more information, see Virtual Network Interface Cards (VNICs) (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm). Each VNIC has a *primary private IP* that is automatically assigned during launch. You can add *secondary private IPs* to a VNIC after it's created. For more information, see CreatePrivateIp and IP Addresses (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIPaddresses.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (Vnic) String ¶ 

func (m Vnic) String() string

type VnicAttachment ¶ 

type VnicAttachment struct {

	// The availability domain of the instance.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The OCID of the compartment the VNIC attachment is in, which is the same
	// compartment the instance is in.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of the VNIC attachment.
	Id *string `mandatory:"true" json:"id"`

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

	// The current state of the VNIC attachment.
	LifecycleState VnicAttachmentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The OCID of the VNIC's subnet.
	SubnetId *string `mandatory:"true" json:"subnetId"`

	// The date and time the VNIC attachment was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// A user-friendly name. Does not have to be unique.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Which physical network interface card (NIC) the VNIC uses.
	// Certain bare metal instance shapes have two active physical NICs (0 and 1). If
	// you add a secondary VNIC to one of these instances, you can specify which NIC
	// the VNIC will use. For more information, see
	// Virtual Network Interface Cards (VNICs) (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm).
	NicIndex *int `mandatory:"false" json:"nicIndex"`

	// The Oracle-assigned VLAN tag of the attached VNIC. Available after the
	// attachment process is complete.
	// Example: `0`
	VlanTag *int `mandatory:"false" json:"vlanTag"`

	// The OCID of the VNIC. Available after the attachment process is complete.
	VnicId *string `mandatory:"false" json:"vnicId"`
}

VnicAttachment Represents an attachment between a VNIC and an instance. For more information, see Virtual Network Interface Cards (VNICs) (https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (VnicAttachment) String ¶ 

func (m VnicAttachment) String() string

type VnicAttachmentLifecycleStateEnum ¶ 

type VnicAttachmentLifecycleStateEnum string

VnicAttachmentLifecycleStateEnum Enum with underlying type: string 

const (
	VnicAttachmentLifecycleStateAttaching VnicAttachmentLifecycleStateEnum = "ATTACHING"
	VnicAttachmentLifecycleStateAttached  VnicAttachmentLifecycleStateEnum = "ATTACHED"
	VnicAttachmentLifecycleStateDetaching VnicAttachmentLifecycleStateEnum = "DETACHING"
	VnicAttachmentLifecycleStateDetached  VnicAttachmentLifecycleStateEnum = "DETACHED"
)

Set of constants representing the allowable values for VnicAttachmentLifecycleStateEnum

func GetVnicAttachmentLifecycleStateEnumValues ¶ 

func GetVnicAttachmentLifecycleStateEnumValues() []VnicAttachmentLifecycleStateEnum

GetVnicAttachmentLifecycleStateEnumValues Enumerates the set of values for VnicAttachmentLifecycleStateEnum

type VnicLifecycleStateEnum ¶ 

type VnicLifecycleStateEnum string

VnicLifecycleStateEnum Enum with underlying type: string 

const (
	VnicLifecycleStateProvisioning VnicLifecycleStateEnum = "PROVISIONING"
	VnicLifecycleStateAvailable    VnicLifecycleStateEnum = "AVAILABLE"
	VnicLifecycleStateTerminating  VnicLifecycleStateEnum = "TERMINATING"
	VnicLifecycleStateTerminated   VnicLifecycleStateEnum = "TERMINATED"
)

Set of constants representing the allowable values for VnicLifecycleStateEnum

func GetVnicLifecycleStateEnumValues ¶ 

func GetVnicLifecycleStateEnumValues() []VnicLifecycleStateEnum

GetVnicLifecycleStateEnumValues Enumerates the set of values for VnicLifecycleStateEnum

type Volume ¶ 

type Volume struct {

	// The availability domain of the volume.
	// Example: `Uocm:PHX-AD-1`
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The OCID of the compartment that contains the volume.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The OCID of the volume.
	Id *string `mandatory:"true" json:"id"`

	// The current state of a volume.
	LifecycleState VolumeLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead.
	SizeInMBs *int64 `mandatory:"true" json:"sizeInMBs"`

	// The date and time the volume was created. Format defined by RFC3339.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Specifies whether the cloned volume's data has finished copying from the source volume or backup.
	IsHydrated *bool `mandatory:"false" json:"isHydrated"`

	// The OCID of the KMS key which is the master encryption key for the volume.
	KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`

	// The size of the volume in GBs.
	SizeInGBs *int64 `mandatory:"false" json:"sizeInGBs"`

	// The volume source, either an existing volume in the same availability domain or a volume backup.
	// If null, an empty volume is created.
	SourceDetails VolumeSourceDetails `mandatory:"false" json:"sourceDetails"`

	// The OCID of the source volume group.
	VolumeGroupId *string `mandatory:"false" json:"volumeGroupId"`
}

Volume A detachable block volume device that allows you to dynamically expand the storage capacity of an instance. For more information, see Overview of Cloud Volume Storage (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/overview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (Volume) String ¶ 

func (m Volume) String() string

func (*Volume) UnmarshalJSON ¶ 

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

UnmarshalJSON unmarshals from json

type VolumeAttachment ¶ 

type VolumeAttachment interface {

	// The availability domain of an instance.
	// Example: `Uocm:PHX-AD-1`
	GetAvailabilityDomain() *string

	// The OCID of the compartment.
	GetCompartmentId() *string

	// The OCID of the volume attachment.
	GetId() *string

	// The OCID of the instance the volume is attached to.
	GetInstanceId() *string

	// The current state of the volume attachment.
	GetLifecycleState() VolumeAttachmentLifecycleStateEnum

	// The date and time the volume was created, in the format defined by RFC3339.
	// Example: `2016-08-25T21:10:29.600Z`
	GetTimeCreated() *common.SDKTime

	// The OCID of the volume.
	GetVolumeId() *string

	// The device name.
	GetDevice() *string

	// A user-friendly name. Does not have to be unique, and it cannot be changed.
	// Avoid entering confidential information.
	// Example: `My volume attachment`
	GetDisplayName() *string

	// Whether the attachment was created in read-only mode.
	GetIsReadOnly() *bool

	// Whether the enable encryption in transit for the PV volume attachment is on or not.
	GetIsPvEncryptionInTransitEnabled() *bool
}

VolumeAttachment A base object for all types of attachments between a storage volume and an instance. For specific details about iSCSI attachments, see IScsiVolumeAttachment. For general information about volume attachments, see Overview of Block Volume Storage (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/overview.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

type VolumeAttachmentLifecycleStateEnum ¶ 

type VolumeAttachmentLifecycleStateEnum string

VolumeAttachmentLifecycleStateEnum Enum with underlying type: string 

const (
	VolumeAttachmentLifecycleStateAttaching VolumeAttachmentLifecycleStateEnum = "ATTACHING"
	VolumeAttachmentLifecycleStateAttached  VolumeAttachmentLifecycleStateEnum = "ATTACHED"
	VolumeAttachmentLifecycleStateDetaching VolumeAttachmentLifecycleStateEnum = "DETACHING"
	VolumeAttachmentLifecycleStateDetached  VolumeAttachmentLifecycleStateEnum = "DETACHED"
)

Set of constants representing the allowable values for VolumeAttachmentLifecycleStateEnum

func GetVolumeAttachmentLifecycleStateEnumValues ¶ 

func GetVolumeAttachmentLifecycleStateEnumValues() []VolumeAttachmentLifecycleStateEnum

GetVolumeAttachmentLifecycleStateEnumValues Enumerates the set of values for VolumeAttachmentLifecycleStateEnum

type VolumeBackup ¶ 

type VolumeBackup struct {

	// The OCID of the compartment that contains the volume backup.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A user-friendly name for the volume backup. Does not have to be unique and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The OCID of the volume backup.
	Id *string `mandatory:"true" json:"id"`

	// The current state of a volume backup.
	LifecycleState VolumeBackupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The date and time the volume backup was created. This is the time the actual point-in-time image
	// of the volume data was taken. Format defined by RFC3339.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The type of a volume backup.
	Type VolumeBackupTypeEnum `mandatory:"true" json:"type"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// The date and time the volume backup will expire and be automatically deleted.
	// Format defined by RFC3339. This parameter will always be present for backups that
	// were created automatically by a scheduled-backup policy. For manually created backups,
	// it will be absent, signifying that there is no expiration time and the backup will
	// last forever until manually deleted.
	ExpirationTime *common.SDKTime `mandatory:"false" json:"expirationTime"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The size of the volume, in GBs.
	SizeInGBs *int64 `mandatory:"false" json:"sizeInGBs"`

	// The size of the volume in MBs. The value must be a multiple of 1024.
	// This field is deprecated. Please use sizeInGBs.
	SizeInMBs *int64 `mandatory:"false" json:"sizeInMBs"`

	// Specifies whether the backup was created manually, or via scheduled backup policy.
	SourceType VolumeBackupSourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`

	// The OCID of the source volume backup.
	SourceVolumeBackupId *string `mandatory:"false" json:"sourceVolumeBackupId"`

	// The date and time the request to create the volume backup was received. Format defined by RFC3339.
	TimeRequestReceived *common.SDKTime `mandatory:"false" json:"timeRequestReceived"`

	// The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space
	// consumed on the volume and whether the backup is full or incremental.
	UniqueSizeInGBs *int64 `mandatory:"false" json:"uniqueSizeInGBs"`

	// The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space
	// consumed on the volume and whether the backup is full or incremental.
	// This field is deprecated. Please use uniqueSizeInGBs.
	UniqueSizeInMbs *int64 `mandatory:"false" json:"uniqueSizeInMbs"`

	// The OCID of the volume.
	VolumeId *string `mandatory:"false" json:"volumeId"`
}

VolumeBackup A point-in-time copy of a volume that can then be used to create a new block volume or recover a block volume. For more information, see Overview of Cloud Volume Storage (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/overview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (VolumeBackup) String ¶ 

func (m VolumeBackup) String() string

type VolumeBackupLifecycleStateEnum ¶ 

type VolumeBackupLifecycleStateEnum string

VolumeBackupLifecycleStateEnum Enum with underlying type: string 

const (
	VolumeBackupLifecycleStateCreating        VolumeBackupLifecycleStateEnum = "CREATING"
	VolumeBackupLifecycleStateAvailable       VolumeBackupLifecycleStateEnum = "AVAILABLE"
	VolumeBackupLifecycleStateTerminating     VolumeBackupLifecycleStateEnum = "TERMINATING"
	VolumeBackupLifecycleStateTerminated      VolumeBackupLifecycleStateEnum = "TERMINATED"
	VolumeBackupLifecycleStateFaulty          VolumeBackupLifecycleStateEnum = "FAULTY"
	VolumeBackupLifecycleStateRequestReceived VolumeBackupLifecycleStateEnum = "REQUEST_RECEIVED"
)

Set of constants representing the allowable values for VolumeBackupLifecycleStateEnum

func GetVolumeBackupLifecycleStateEnumValues ¶ 

func GetVolumeBackupLifecycleStateEnumValues() []VolumeBackupLifecycleStateEnum

GetVolumeBackupLifecycleStateEnumValues Enumerates the set of values for VolumeBackupLifecycleStateEnum

type VolumeBackupPolicy ¶ added in v1.1.0 

type VolumeBackupPolicy struct {

	// A user-friendly name for the volume backup policy. Does not have to be unique and it's changeable.
	// Avoid entering confidential information.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The OCID of the volume backup policy.
	Id *string `mandatory:"true" json:"id"`

	// The collection of schedules that this policy will apply.
	Schedules []VolumeBackupSchedule `mandatory:"true" json:"schedules"`

	// The date and time the volume backup policy was created. Format defined by RFC3339.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
}

VolumeBackupPolicy A policy for automatically creating volume backups according to a recurring schedule. Has a set of one or more schedules that control when and how backups are created. **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (VolumeBackupPolicy) String ¶ added in v1.1.0 

func (m VolumeBackupPolicy) String() string

type VolumeBackupPolicyAssignment ¶ added in v1.1.0 

type VolumeBackupPolicyAssignment struct {

	// The OCID of the asset (e.g. a volume) to which the policy has been assigned.
	AssetId *string `mandatory:"true" json:"assetId"`

	// The OCID of the volume backup policy assignment.
	Id *string `mandatory:"true" json:"id"`

	// The OCID of the volume backup policy that has been assigned to an asset.
	PolicyId *string `mandatory:"true" json:"policyId"`

	// The date and time the volume backup policy assignment was created. Format defined by RFC3339.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
}

VolumeBackupPolicyAssignment Specifies that a particular volume backup policy is assigned to an asset such as a volume.

func (VolumeBackupPolicyAssignment) String ¶ added in v1.1.0 

func (m VolumeBackupPolicyAssignment) String() string

type VolumeBackupSchedule ¶ added in v1.1.0 

type VolumeBackupSchedule struct {

	// The type of backup to create.
	BackupType VolumeBackupScheduleBackupTypeEnum `mandatory:"true" json:"backupType"`

	// The number of seconds (positive or negative) that the backup time should be shifted from the default interval boundaries specified by the period. Backup time = Frequency start time + Offset.
	OffsetSeconds *int `mandatory:"true" json:"offsetSeconds"`

	// How often the backup should occur.
	Period VolumeBackupSchedulePeriodEnum `mandatory:"true" json:"period"`

	// How long, in seconds, backups created by this schedule should be kept until being automatically deleted.
	RetentionSeconds *int `mandatory:"true" json:"retentionSeconds"`
}

VolumeBackupSchedule Defines a chronological recurrence pattern for creating scheduled backups at a particular periodicity.

func (VolumeBackupSchedule) String ¶ added in v1.1.0 

func (m VolumeBackupSchedule) String() string

type VolumeBackupScheduleBackupTypeEnum ¶ added in v1.1.0 

type VolumeBackupScheduleBackupTypeEnum string

VolumeBackupScheduleBackupTypeEnum Enum with underlying type: string 

const (
	VolumeBackupScheduleBackupTypeFull        VolumeBackupScheduleBackupTypeEnum = "FULL"
	VolumeBackupScheduleBackupTypeIncremental VolumeBackupScheduleBackupTypeEnum = "INCREMENTAL"
)

Set of constants representing the allowable values for VolumeBackupScheduleBackupTypeEnum

func GetVolumeBackupScheduleBackupTypeEnumValues ¶ added in v1.1.0 

func GetVolumeBackupScheduleBackupTypeEnumValues() []VolumeBackupScheduleBackupTypeEnum

GetVolumeBackupScheduleBackupTypeEnumValues Enumerates the set of values for VolumeBackupScheduleBackupTypeEnum

type VolumeBackupSchedulePeriodEnum ¶ added in v1.1.0 

type VolumeBackupSchedulePeriodEnum string

VolumeBackupSchedulePeriodEnum Enum with underlying type: string 

const (
	VolumeBackupSchedulePeriodHour  VolumeBackupSchedulePeriodEnum = "ONE_HOUR"
	VolumeBackupSchedulePeriodDay   VolumeBackupSchedulePeriodEnum = "ONE_DAY"
	VolumeBackupSchedulePeriodWeek  VolumeBackupSchedulePeriodEnum = "ONE_WEEK"
	VolumeBackupSchedulePeriodMonth VolumeBackupSchedulePeriodEnum = "ONE_MONTH"
	VolumeBackupSchedulePeriodYear  VolumeBackupSchedulePeriodEnum = "ONE_YEAR"
)

Set of constants representing the allowable values for VolumeBackupSchedulePeriodEnum

func GetVolumeBackupSchedulePeriodEnumValues ¶ added in v1.1.0 

func GetVolumeBackupSchedulePeriodEnumValues() []VolumeBackupSchedulePeriodEnum

GetVolumeBackupSchedulePeriodEnumValues Enumerates the set of values for VolumeBackupSchedulePeriodEnum

type VolumeBackupSourceTypeEnum ¶ added in v1.1.0 

type VolumeBackupSourceTypeEnum string

VolumeBackupSourceTypeEnum Enum with underlying type: string 

const (
	VolumeBackupSourceTypeManual    VolumeBackupSourceTypeEnum = "MANUAL"
	VolumeBackupSourceTypeScheduled VolumeBackupSourceTypeEnum = "SCHEDULED"
)

Set of constants representing the allowable values for VolumeBackupSourceTypeEnum

func GetVolumeBackupSourceTypeEnumValues ¶ added in v1.1.0 

func GetVolumeBackupSourceTypeEnumValues() []VolumeBackupSourceTypeEnum

GetVolumeBackupSourceTypeEnumValues Enumerates the set of values for VolumeBackupSourceTypeEnum

type VolumeBackupTypeEnum ¶ added in v1.1.0 

type VolumeBackupTypeEnum string

VolumeBackupTypeEnum Enum with underlying type: string 

const (
	VolumeBackupTypeFull        VolumeBackupTypeEnum = "FULL"
	VolumeBackupTypeIncremental VolumeBackupTypeEnum = "INCREMENTAL"
)

Set of constants representing the allowable values for VolumeBackupTypeEnum

func GetVolumeBackupTypeEnumValues ¶ added in v1.1.0 

func GetVolumeBackupTypeEnumValues() []VolumeBackupTypeEnum

GetVolumeBackupTypeEnumValues Enumerates the set of values for VolumeBackupTypeEnum

type VolumeGroup ¶ added in v1.6.0 

type VolumeGroup struct {

	// The availability domain of the volume group.
	AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`

	// The OCID of the compartment that contains the volume group.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A user-friendly name for the volume group. Does not have to be unique, and it's changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The OCID for the volume group.
	Id *string `mandatory:"true" json:"id"`

	// The aggregate size of the volume group in MBs.
	SizeInMBs *int64 `mandatory:"true" json:"sizeInMBs"`

	// The date and time the volume group was created. Format defined by RFC3339.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// OCIDs for the volumes in this volume group.
	VolumeIds []string `mandatory:"true" json:"volumeIds"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The current state of a volume group.
	LifecycleState VolumeGroupLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The aggregate size of the volume group in GBs.
	SizeInGBs *int64 `mandatory:"false" json:"sizeInGBs"`

	// The volume group source. The source is either another a list of
	// volume IDs in the same availability domain, another volume group, or a volume group backup.
	SourceDetails VolumeGroupSourceDetails `mandatory:"false" json:"sourceDetails"`

	// Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
	IsHydrated *bool `mandatory:"false" json:"isHydrated"`
}

VolumeGroup Specifies a volume group which is a collection of volumes. For more information, see Volume Groups (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/volumegroups.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (VolumeGroup) String ¶ added in v1.6.0 

func (m VolumeGroup) String() string

func (*VolumeGroup) UnmarshalJSON ¶ added in v1.6.0 

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

UnmarshalJSON unmarshals from json

type VolumeGroupBackup ¶ added in v1.6.0 

type VolumeGroupBackup struct {

	// The OCID of the compartment that contains the volume group backup.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A user-friendly name for the volume group backup. Does not have to be unique and it's changeable. Avoid entering confidential information.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The OCID of the volume group backup.
	Id *string `mandatory:"true" json:"id"`

	// The current state of a volume group backup.
	LifecycleState VolumeGroupBackupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The date and time the volume group backup was created. This is the time the actual point-in-time image
	// of the volume group data was taken. Format defined by RFC3339.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The type of backup.
	Type VolumeGroupBackupTypeEnum `mandatory:"true" json:"type"`

	// OCIDs for the volume backups in this volume group backup.
	VolumeBackupIds []string `mandatory:"true" json:"volumeBackupIds"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no
	// predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// The aggregate size of the volume group backup, in MBs.
	SizeInMBs *int64 `mandatory:"false" json:"sizeInMBs"`

	// The aggregate size of the volume group backup, in GBs.
	SizeInGBs *int64 `mandatory:"false" json:"sizeInGBs"`

	// The date and time the request to create the volume group backup was received. Format defined by RFC3339.
	TimeRequestReceived *common.SDKTime `mandatory:"false" json:"timeRequestReceived"`

	// The aggregate size used by the volume group backup, in MBs.
	// It is typically smaller than sizeInMBs, depending on the space
	// consumed on the volume group and whether the volume backup is full or incremental.
	UniqueSizeInMbs *int64 `mandatory:"false" json:"uniqueSizeInMbs"`

	// The aggregate size used by the volume group backup, in GBs.
	// It is typically smaller than sizeInGBs, depending on the space
	// consumed on the volume group and whether the volume backup is full or incremental.
	UniqueSizeInGbs *int64 `mandatory:"false" json:"uniqueSizeInGbs"`

	// The OCID of the source volume group.
	VolumeGroupId *string `mandatory:"false" json:"volumeGroupId"`
}

VolumeGroupBackup A point-in-time copy of a volume group that can then be used to create a new volume group or restore a volume group. For more information, see Volume Groups (https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/volumegroups.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

func (VolumeGroupBackup) String ¶ added in v1.6.0 

func (m VolumeGroupBackup) String() string

type VolumeGroupBackupLifecycleStateEnum ¶ added in v1.6.0 

type VolumeGroupBackupLifecycleStateEnum string

VolumeGroupBackupLifecycleStateEnum Enum with underlying type: string 

const (
	VolumeGroupBackupLifecycleStateCreating        VolumeGroupBackupLifecycleStateEnum = "CREATING"
	VolumeGroupBackupLifecycleStateCommitted       VolumeGroupBackupLifecycleStateEnum = "COMMITTED"
	VolumeGroupBackupLifecycleStateAvailable       VolumeGroupBackupLifecycleStateEnum = "AVAILABLE"
	VolumeGroupBackupLifecycleStateTerminating     VolumeGroupBackupLifecycleStateEnum = "TERMINATING"
	VolumeGroupBackupLifecycleStateTerminated      VolumeGroupBackupLifecycleStateEnum = "TERMINATED"
	VolumeGroupBackupLifecycleStateFaulty          VolumeGroupBackupLifecycleStateEnum = "FAULTY"
	VolumeGroupBackupLifecycleStateRequestReceived VolumeGroupBackupLifecycleStateEnum = "REQUEST_RECEIVED"
)

Set of constants representing the allowable values for VolumeGroupBackupLifecycleStateEnum

func GetVolumeGroupBackupLifecycleStateEnumValues ¶ added in v1.6.0 

func GetVolumeGroupBackupLifecycleStateEnumValues() []VolumeGroupBackupLifecycleStateEnum

GetVolumeGroupBackupLifecycleStateEnumValues Enumerates the set of values for VolumeGroupBackupLifecycleStateEnum

type VolumeGroupBackupTypeEnum ¶ added in v1.6.0 

type VolumeGroupBackupTypeEnum string

VolumeGroupBackupTypeEnum Enum with underlying type: string 

const (
	VolumeGroupBackupTypeFull        VolumeGroupBackupTypeEnum = "FULL"
	VolumeGroupBackupTypeIncremental VolumeGroupBackupTypeEnum = "INCREMENTAL"
)

Set of constants representing the allowable values for VolumeGroupBackupTypeEnum

func GetVolumeGroupBackupTypeEnumValues ¶ added in v1.6.0 

func GetVolumeGroupBackupTypeEnumValues() []VolumeGroupBackupTypeEnum

GetVolumeGroupBackupTypeEnumValues Enumerates the set of values for VolumeGroupBackupTypeEnum

type VolumeGroupLifecycleStateEnum ¶ added in v1.6.0 

type VolumeGroupLifecycleStateEnum string

VolumeGroupLifecycleStateEnum Enum with underlying type: string 

const (
	VolumeGroupLifecycleStateProvisioning VolumeGroupLifecycleStateEnum = "PROVISIONING"
	VolumeGroupLifecycleStateAvailable    VolumeGroupLifecycleStateEnum = "AVAILABLE"
	VolumeGroupLifecycleStateTerminating  VolumeGroupLifecycleStateEnum = "TERMINATING"
	VolumeGroupLifecycleStateTerminated   VolumeGroupLifecycleStateEnum = "TERMINATED"
	VolumeGroupLifecycleStateFaulty       VolumeGroupLifecycleStateEnum = "FAULTY"
)

Set of constants representing the allowable values for VolumeGroupLifecycleStateEnum

func GetVolumeGroupLifecycleStateEnumValues ¶ added in v1.6.0 

func GetVolumeGroupLifecycleStateEnumValues() []VolumeGroupLifecycleStateEnum

GetVolumeGroupLifecycleStateEnumValues Enumerates the set of values for VolumeGroupLifecycleStateEnum

type VolumeGroupSourceDetails ¶ added in v1.6.0 

type VolumeGroupSourceDetails interface {
}

VolumeGroupSourceDetails Specifies the source for a volume group.

type VolumeGroupSourceFromVolumeGroupBackupDetails ¶ added in v1.6.0 

type VolumeGroupSourceFromVolumeGroupBackupDetails struct {

	// The OCID of the volume group backup to restore from.
	VolumeGroupBackupId *string `mandatory:"true" json:"volumeGroupBackupId"`
}

VolumeGroupSourceFromVolumeGroupBackupDetails Specifies the volume group backup to restore from.

func (VolumeGroupSourceFromVolumeGroupBackupDetails) MarshalJSON ¶ added in v1.6.0 

func (m VolumeGroupSourceFromVolumeGroupBackupDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (VolumeGroupSourceFromVolumeGroupBackupDetails) String ¶ added in v1.6.0 

func (m VolumeGroupSourceFromVolumeGroupBackupDetails) String() string

type VolumeGroupSourceFromVolumeGroupDetails ¶ added in v1.6.0 

type VolumeGroupSourceFromVolumeGroupDetails struct {

	// The OCID of the volume group to clone from.
	VolumeGroupId *string `mandatory:"true" json:"volumeGroupId"`
}

VolumeGroupSourceFromVolumeGroupDetails Specifies the volume group to clone from.

func (VolumeGroupSourceFromVolumeGroupDetails) MarshalJSON ¶ added in v1.6.0 

func (m VolumeGroupSourceFromVolumeGroupDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (VolumeGroupSourceFromVolumeGroupDetails) String ¶ added in v1.6.0 

func (m VolumeGroupSourceFromVolumeGroupDetails) String() string

type VolumeGroupSourceFromVolumesDetails ¶ added in v1.6.0 

type VolumeGroupSourceFromVolumesDetails struct {

	// OCIDs for the volumes in this volume group.
	VolumeIds []string `mandatory:"true" json:"volumeIds"`
}

VolumeGroupSourceFromVolumesDetails Specifies the volumes in a volume group.

func (VolumeGroupSourceFromVolumesDetails) MarshalJSON ¶ added in v1.6.0 

func (m VolumeGroupSourceFromVolumesDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (VolumeGroupSourceFromVolumesDetails) String ¶ added in v1.6.0 

func (m VolumeGroupSourceFromVolumesDetails) String() string

type VolumeKmsKey ¶ 

type VolumeKmsKey struct {

	// Kms key id associated with this volume. If volume is not using KMS, then kmsKeyId will be null string.
	KmsKeyId *string `mandatory:"false" json:"kmsKeyId"`
}

VolumeKmsKey Kms key id associated with this volume.

func (VolumeKmsKey) String ¶ 

func (m VolumeKmsKey) String() string

type VolumeLifecycleStateEnum ¶ 

type VolumeLifecycleStateEnum string

VolumeLifecycleStateEnum Enum with underlying type: string 

const (
	VolumeLifecycleStateProvisioning VolumeLifecycleStateEnum = "PROVISIONING"
	VolumeLifecycleStateRestoring    VolumeLifecycleStateEnum = "RESTORING"
	VolumeLifecycleStateAvailable    VolumeLifecycleStateEnum = "AVAILABLE"
	VolumeLifecycleStateTerminating  VolumeLifecycleStateEnum = "TERMINATING"
	VolumeLifecycleStateTerminated   VolumeLifecycleStateEnum = "TERMINATED"
	VolumeLifecycleStateFaulty       VolumeLifecycleStateEnum = "FAULTY"
)

Set of constants representing the allowable values for VolumeLifecycleStateEnum

func GetVolumeLifecycleStateEnumValues ¶ 

func GetVolumeLifecycleStateEnumValues() []VolumeLifecycleStateEnum

GetVolumeLifecycleStateEnumValues Enumerates the set of values for VolumeLifecycleStateEnum

type VolumeSourceDetails ¶ 

type VolumeSourceDetails interface {
}

VolumeSourceDetails The representation of VolumeSourceDetails

type VolumeSourceFromVolumeBackupDetails ¶ 

type VolumeSourceFromVolumeBackupDetails struct {

	// The OCID of the volume backup.
	Id *string `mandatory:"true" json:"id"`
}

VolumeSourceFromVolumeBackupDetails Specifies the volume backup.

func (VolumeSourceFromVolumeBackupDetails) MarshalJSON ¶ 

func (m VolumeSourceFromVolumeBackupDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (VolumeSourceFromVolumeBackupDetails) String ¶ 

func (m VolumeSourceFromVolumeBackupDetails) String() string

type VolumeSourceFromVolumeDetails ¶ 

type VolumeSourceFromVolumeDetails struct {

	// The OCID of the volume.
	Id *string `mandatory:"true" json:"id"`
}

VolumeSourceFromVolumeDetails Specifies the source volume.

func (VolumeSourceFromVolumeDetails) MarshalJSON ¶ 

func (m VolumeSourceFromVolumeDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (VolumeSourceFromVolumeDetails) String ¶ 

func (m VolumeSourceFromVolumeDetails) String() string

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.