datasafe

package
Version: v24.3.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Sep 8, 2020 License: Apache-2.0, UPL-1.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ChangeDataSafePrivateEndpointCompartmentDetails

type ChangeDataSafePrivateEndpointCompartmentDetails struct {

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

ChangeDataSafePrivateEndpointCompartmentDetails The details used to change the compartment of a Data Safe private endpoint.

func (ChangeDataSafePrivateEndpointCompartmentDetails) String

type ChangeDataSafePrivateEndpointCompartmentRequest

type ChangeDataSafePrivateEndpointCompartmentRequest struct {

	// The OCID of the private endpoint.
	DataSafePrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"dataSafePrivateEndpointId"`

	// The details used to change the compartment of a Data Safe private endpoint.
	ChangeDataSafePrivateEndpointCompartmentDetails `contributesTo:"body"`

	// Unique identifier for the request.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ChangeDataSafePrivateEndpointCompartmentRequest wrapper for the ChangeDataSafePrivateEndpointCompartment operation

func (ChangeDataSafePrivateEndpointCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeDataSafePrivateEndpointCompartmentRequest) RetryPolicy

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

func (ChangeDataSafePrivateEndpointCompartmentRequest) String

type ChangeDataSafePrivateEndpointCompartmentResponse

type ChangeDataSafePrivateEndpointCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID of the work request. Use GetWorkRequest with this OCID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ChangeDataSafePrivateEndpointCompartmentResponse wrapper for the ChangeDataSafePrivateEndpointCompartment operation

func (ChangeDataSafePrivateEndpointCompartmentResponse) HTTPResponse

HTTPResponse implements the OCIResponse interface

func (ChangeDataSafePrivateEndpointCompartmentResponse) String

type CreateDataSafePrivateEndpointDetails

type CreateDataSafePrivateEndpointDetails struct {

	// The display name for the private endpoint. The name does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"true" json:"displayName"`

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

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

	// The OCID of the subnet.
	SubnetId *string `mandatory:"true" json:"subnetId"`

	// The private IP address of the private endpoint.
	PrivateEndpointIp *string `mandatory:"false" json:"privateEndpointIp"`

	// The description of the private endpoint.
	Description *string `mandatory:"false" json:"description"`

	// The OCIDs of the network security groups that the private endpoint belongs to.
	NsgIds []string `mandatory:"false" json:"nsgIds"`

	// 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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm)
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm)
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateDataSafePrivateEndpointDetails The details used to create a new Data Safe private endpoint.

func (CreateDataSafePrivateEndpointDetails) String

type CreateDataSafePrivateEndpointRequest

type CreateDataSafePrivateEndpointRequest struct {

	// Details to create a new private endpoint.
	CreateDataSafePrivateEndpointDetails `contributesTo:"body"`

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

	// Unique identifier for the request.
	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
}

CreateDataSafePrivateEndpointRequest wrapper for the CreateDataSafePrivateEndpoint operation

func (CreateDataSafePrivateEndpointRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateDataSafePrivateEndpointRequest) RetryPolicy

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

func (CreateDataSafePrivateEndpointRequest) String

type CreateDataSafePrivateEndpointResponse

type CreateDataSafePrivateEndpointResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID of the work request. Use GetWorkRequest with this OCID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateDataSafePrivateEndpointResponse wrapper for the CreateDataSafePrivateEndpoint operation

func (CreateDataSafePrivateEndpointResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateDataSafePrivateEndpointResponse) String

type DataSafeClient

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

DataSafeClient a client for DataSafe

func NewDataSafeClientWithConfigurationProvider

func NewDataSafeClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DataSafeClient, err error)

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

func NewDataSafeClientWithOboToken

func NewDataSafeClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DataSafeClient, err error)

NewDataSafeClientWithOboToken Creates a new default DataSafe client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer

as well as reading the region

func (DataSafeClient) ChangeDataSafePrivateEndpointCompartment

func (client DataSafeClient) ChangeDataSafePrivateEndpointCompartment(ctx context.Context, request ChangeDataSafePrivateEndpointCompartmentRequest) (response ChangeDataSafePrivateEndpointCompartmentResponse, err error)

ChangeDataSafePrivateEndpointCompartment Moves the Data Safe private endpoint and its dependent resources to the specified compartment.

func (*DataSafeClient) ConfigurationProvider

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

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

func (DataSafeClient) CreateDataSafePrivateEndpoint

func (client DataSafeClient) CreateDataSafePrivateEndpoint(ctx context.Context, request CreateDataSafePrivateEndpointRequest) (response CreateDataSafePrivateEndpointResponse, err error)

CreateDataSafePrivateEndpoint Creates a new Data Safe private endpoint.

func (DataSafeClient) DeleteDataSafePrivateEndpoint

func (client DataSafeClient) DeleteDataSafePrivateEndpoint(ctx context.Context, request DeleteDataSafePrivateEndpointRequest) (response DeleteDataSafePrivateEndpointResponse, err error)

DeleteDataSafePrivateEndpoint Deletes the specified Data Safe private endpoint.

func (DataSafeClient) EnableDataSafeConfiguration

func (client DataSafeClient) EnableDataSafeConfiguration(ctx context.Context, request EnableDataSafeConfigurationRequest) (response EnableDataSafeConfigurationResponse, err error)

EnableDataSafeConfiguration Enables Data Safe in the tenancy and region.

func (DataSafeClient) GetDataSafeConfiguration

func (client DataSafeClient) GetDataSafeConfiguration(ctx context.Context, request GetDataSafeConfigurationRequest) (response GetDataSafeConfigurationResponse, err error)

GetDataSafeConfiguration Gets the details of the Data Safe configuration.

func (DataSafeClient) GetDataSafePrivateEndpoint

func (client DataSafeClient) GetDataSafePrivateEndpoint(ctx context.Context, request GetDataSafePrivateEndpointRequest) (response GetDataSafePrivateEndpointResponse, err error)

GetDataSafePrivateEndpoint Gets the details of the specified Data Safe private endpoint.

func (DataSafeClient) GetWorkRequest

func (client DataSafeClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)

GetWorkRequest Gets the details of the specified work request.

func (DataSafeClient) ListDataSafePrivateEndpoints

func (client DataSafeClient) ListDataSafePrivateEndpoints(ctx context.Context, request ListDataSafePrivateEndpointsRequest) (response ListDataSafePrivateEndpointsResponse, err error)

ListDataSafePrivateEndpoints Gets a list of Data Safe private endpoints.

func (DataSafeClient) ListWorkRequestErrors

func (client DataSafeClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)

ListWorkRequestErrors Gets a list of errors for the specified work request.

func (DataSafeClient) ListWorkRequestLogs

func (client DataSafeClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)

ListWorkRequestLogs Gets a list of log entries for the specified work request.

func (DataSafeClient) ListWorkRequests

func (client DataSafeClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)

ListWorkRequests Gets a list of work requests.

func (*DataSafeClient) SetRegion

func (client *DataSafeClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (DataSafeClient) UpdateDataSafePrivateEndpoint

func (client DataSafeClient) UpdateDataSafePrivateEndpoint(ctx context.Context, request UpdateDataSafePrivateEndpointRequest) (response UpdateDataSafePrivateEndpointResponse, err error)

UpdateDataSafePrivateEndpoint Updates one or more attributes of the specified Data Safe private endpoint.

type DataSafeConfiguration

type DataSafeConfiguration struct {

	// Indicates if Data Safe is enabled.
	IsEnabled *bool `mandatory:"false" json:"isEnabled"`

	// The URL of the Data Safe service.
	Url *string `mandatory:"false" json:"url"`

	// The OCID of the tenancy used to enable Data Safe.
	CompartmentId *string `mandatory:"false" json:"compartmentId"`

	// The specific time when Data Safe configuration was enabled.
	TimeEnabled *common.SDKTime `mandatory:"false" json:"timeEnabled"`

	// The current state of Data Safe configuration.
	LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// 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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm)
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm)
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

DataSafeConfiguration A Data Safe Configuration that allows customer to enable Data Safe in their tenancy.

func (DataSafeConfiguration) String

func (m DataSafeConfiguration) String() string

type DataSafePrivateEndpoint

type DataSafePrivateEndpoint struct {

	// The OCID of the Data Safe private endpoint.
	Id *string `mandatory:"true" json:"id"`

	// The display name of the private endpoint.
	DisplayName *string `mandatory:"true" json:"displayName"`

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

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

	// The OCID of the subnet.
	SubnetId *string `mandatory:"true" json:"subnetId"`

	// The OCID of the underlying private endpoint.
	PrivateEndpointId *string `mandatory:"true" json:"privateEndpointId"`

	// The private IP address of the private endpoint.
	PrivateEndpointIp *string `mandatory:"false" json:"privateEndpointIp"`

	// The three-label fully qualified domain name (FQDN) of the private endpoint. The customer VCN's DNS records are updated with this FQDN.
	EndpointFqdn *string `mandatory:"false" json:"endpointFqdn"`

	// The description of the private endpoint.
	Description *string `mandatory:"false" json:"description"`

	// The date and time the private endpoint was created, in the format defined by RFC3339.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The current state of the private endpoint.
	LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

	// The OCIDs of the network security groups that the private endpoint belongs to.
	NsgIds []string `mandatory:"false" json:"nsgIds"`

	// 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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm)
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm)
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

DataSafePrivateEndpoint A Data Safe private endpoint that allows Data Safe to connect to databases in a customer's virtual cloud network (VCN).

func (DataSafePrivateEndpoint) String

func (m DataSafePrivateEndpoint) String() string

type DataSafePrivateEndpointSummary

type DataSafePrivateEndpointSummary struct {

	// The OCID of the Data Safe private endpoint.
	Id *string `mandatory:"true" json:"id"`

	// The display name of the private endpoint.
	DisplayName *string `mandatory:"true" json:"displayName"`

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

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

	// The OCID of the subnet.
	SubnetId *string `mandatory:"true" json:"subnetId"`

	// The OCID of the private endpoint.
	PrivateEndpointId *string `mandatory:"true" json:"privateEndpointId"`

	// The description of the private endpoint.
	Description *string `mandatory:"false" json:"description"`

	// The date and time the private endpoint was created, in the format defined by RFC3339.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The current state of the private endpoint.
	LifecycleState LifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}

DataSafePrivateEndpointSummary Summary of a Data Safe private endpoint.

func (DataSafePrivateEndpointSummary) String

type DeleteDataSafePrivateEndpointRequest

type DeleteDataSafePrivateEndpointRequest struct {

	// The OCID of the private endpoint.
	DataSafePrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"dataSafePrivateEndpointId"`

	// 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 identifier for the request.
	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
}

DeleteDataSafePrivateEndpointRequest wrapper for the DeleteDataSafePrivateEndpoint operation

func (DeleteDataSafePrivateEndpointRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteDataSafePrivateEndpointRequest) RetryPolicy

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

func (DeleteDataSafePrivateEndpointRequest) String

type DeleteDataSafePrivateEndpointResponse

type DeleteDataSafePrivateEndpointResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID of the work request. Use GetWorkRequest with this OCID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteDataSafePrivateEndpointResponse wrapper for the DeleteDataSafePrivateEndpoint operation

func (DeleteDataSafePrivateEndpointResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteDataSafePrivateEndpointResponse) String

type EnableDataSafeConfigurationDetails

type EnableDataSafeConfigurationDetails struct {

	// Indicates if Data Safe is enabled.
	IsEnabled *bool `mandatory:"false" json:"isEnabled"`

	// 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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm)
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm)
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

EnableDataSafeConfigurationDetails The information needed to enable Data Safe in the tenancy.

func (EnableDataSafeConfigurationDetails) String

type EnableDataSafeConfigurationRequest

type EnableDataSafeConfigurationRequest struct {

	// The details used to enable Data Safe.
	EnableDataSafeConfigurationDetails `contributesTo:"body"`

	// A filter to return only resources that match the specified compartment OCID.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// 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 identifier for the request.
	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
}

EnableDataSafeConfigurationRequest wrapper for the EnableDataSafeConfiguration operation

func (EnableDataSafeConfigurationRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (EnableDataSafeConfigurationRequest) RetryPolicy

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

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

func (EnableDataSafeConfigurationRequest) String

func (request EnableDataSafeConfigurationRequest) String() string

type EnableDataSafeConfigurationResponse

type EnableDataSafeConfigurationResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID of the work request. Use GetWorkRequest with this OCID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

EnableDataSafeConfigurationResponse wrapper for the EnableDataSafeConfiguration operation

func (EnableDataSafeConfigurationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (EnableDataSafeConfigurationResponse) String

func (response EnableDataSafeConfigurationResponse) String() string

type GetDataSafeConfigurationRequest

type GetDataSafeConfigurationRequest struct {

	// A filter to return only resources that match the specified compartment OCID.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// Unique identifier for the request.
	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
}

GetDataSafeConfigurationRequest wrapper for the GetDataSafeConfiguration operation

func (GetDataSafeConfigurationRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetDataSafeConfigurationRequest) RetryPolicy

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

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

func (GetDataSafeConfigurationRequest) String

func (request GetDataSafeConfigurationRequest) String() string

type GetDataSafeConfigurationResponse

type GetDataSafeConfigurationResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DataSafeConfiguration instance
	DataSafeConfiguration `presentIn:"body"`

	// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven)
	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"`
}

GetDataSafeConfigurationResponse wrapper for the GetDataSafeConfiguration operation

func (GetDataSafeConfigurationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetDataSafeConfigurationResponse) String

func (response GetDataSafeConfigurationResponse) String() string

type GetDataSafePrivateEndpointRequest

type GetDataSafePrivateEndpointRequest struct {

	// The OCID of the private endpoint.
	DataSafePrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"dataSafePrivateEndpointId"`

	// Unique identifier for the request.
	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
}

GetDataSafePrivateEndpointRequest wrapper for the GetDataSafePrivateEndpoint operation

func (GetDataSafePrivateEndpointRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetDataSafePrivateEndpointRequest) RetryPolicy

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

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

func (GetDataSafePrivateEndpointRequest) String

func (request GetDataSafePrivateEndpointRequest) String() string

type GetDataSafePrivateEndpointResponse

type GetDataSafePrivateEndpointResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The DataSafePrivateEndpoint instance
	DataSafePrivateEndpoint `presentIn:"body"`

	// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven)
	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"`
}

GetDataSafePrivateEndpointResponse wrapper for the GetDataSafePrivateEndpoint operation

func (GetDataSafePrivateEndpointResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetDataSafePrivateEndpointResponse) String

func (response GetDataSafePrivateEndpointResponse) String() string

type GetWorkRequestRequest

type GetWorkRequestRequest struct {

	// The OCID of the work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// Unique identifier for the request.
	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
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

func (GetWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy

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

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

func (GetWorkRequestRequest) String

func (request GetWorkRequestRequest) String() string

type GetWorkRequestResponse

type GetWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The WorkRequest instance
	WorkRequest `presentIn:"body"`

	// For optimistic concurrency control. See ETags for Optimistic Concurrency Control (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#eleven)
	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"`

	// A non-negative integer representing the number of seconds the client should wait before polling this endpoint again.
	RetryAfter *int `presentIn:"header" name:"retry-after"`
}

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type LifecycleStateEnum

type LifecycleStateEnum string

LifecycleStateEnum Enum with underlying type: string

const (
	LifecycleStateCreating LifecycleStateEnum = "CREATING"
	LifecycleStateUpdating LifecycleStateEnum = "UPDATING"
	LifecycleStateActive   LifecycleStateEnum = "ACTIVE"
	LifecycleStateDeleting LifecycleStateEnum = "DELETING"
	LifecycleStateDeleted  LifecycleStateEnum = "DELETED"
	LifecycleStateFailed   LifecycleStateEnum = "FAILED"
	LifecycleStateNa       LifecycleStateEnum = "NA"
)

Set of constants representing the allowable values for LifecycleStateEnum

func GetLifecycleStateEnumValues

func GetLifecycleStateEnumValues() []LifecycleStateEnum

GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum

type ListDataSafePrivateEndpointsLifecycleStateEnum

type ListDataSafePrivateEndpointsLifecycleStateEnum string

ListDataSafePrivateEndpointsLifecycleStateEnum Enum with underlying type: string

const (
	ListDataSafePrivateEndpointsLifecycleStateCreating ListDataSafePrivateEndpointsLifecycleStateEnum = "CREATING"
	ListDataSafePrivateEndpointsLifecycleStateUpdating ListDataSafePrivateEndpointsLifecycleStateEnum = "UPDATING"
	ListDataSafePrivateEndpointsLifecycleStateActive   ListDataSafePrivateEndpointsLifecycleStateEnum = "ACTIVE"
	ListDataSafePrivateEndpointsLifecycleStateDeleting ListDataSafePrivateEndpointsLifecycleStateEnum = "DELETING"
	ListDataSafePrivateEndpointsLifecycleStateDeleted  ListDataSafePrivateEndpointsLifecycleStateEnum = "DELETED"
	ListDataSafePrivateEndpointsLifecycleStateFailed   ListDataSafePrivateEndpointsLifecycleStateEnum = "FAILED"
	ListDataSafePrivateEndpointsLifecycleStateNa       ListDataSafePrivateEndpointsLifecycleStateEnum = "NA"
)

Set of constants representing the allowable values for ListDataSafePrivateEndpointsLifecycleStateEnum

func GetListDataSafePrivateEndpointsLifecycleStateEnumValues

func GetListDataSafePrivateEndpointsLifecycleStateEnumValues() []ListDataSafePrivateEndpointsLifecycleStateEnum

GetListDataSafePrivateEndpointsLifecycleStateEnumValues Enumerates the set of values for ListDataSafePrivateEndpointsLifecycleStateEnum

type ListDataSafePrivateEndpointsRequest

type ListDataSafePrivateEndpointsRequest struct {

	// A filter to return only resources that match the specified compartment OCID.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// A filter to return only resources that match the specified display name.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// A filter to return only the private endpoints that match the specified VCN OCID.
	VcnId *string `mandatory:"false" contributesTo:"query" name:"vcnId"`

	// A filter to return only resources that match the specified lifecycle state.
	LifecycleState ListDataSafePrivateEndpointsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The beginning page from which the results start retrieving.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either ascending (ASC) or descending (DESC).
	SortOrder ListDataSafePrivateEndpointsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. You can specify only one sort order (sortOrder). The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
	SortBy ListDataSafePrivateEndpointsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// Unique identifier for the request.
	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
}

ListDataSafePrivateEndpointsRequest wrapper for the ListDataSafePrivateEndpoints operation

func (ListDataSafePrivateEndpointsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListDataSafePrivateEndpointsRequest) RetryPolicy

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

func (ListDataSafePrivateEndpointsRequest) String

type ListDataSafePrivateEndpointsResponse

type ListDataSafePrivateEndpointsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []DataSafePrivateEndpointSummary instances
	Items []DataSafePrivateEndpointSummary `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListDataSafePrivateEndpointsResponse wrapper for the ListDataSafePrivateEndpoints operation

func (ListDataSafePrivateEndpointsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListDataSafePrivateEndpointsResponse) String

func (response ListDataSafePrivateEndpointsResponse) String() string

type ListDataSafePrivateEndpointsSortByEnum

type ListDataSafePrivateEndpointsSortByEnum string

ListDataSafePrivateEndpointsSortByEnum Enum with underlying type: string

const (
	ListDataSafePrivateEndpointsSortByTimecreated ListDataSafePrivateEndpointsSortByEnum = "TIMECREATED"
	ListDataSafePrivateEndpointsSortByDisplayname ListDataSafePrivateEndpointsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListDataSafePrivateEndpointsSortByEnum

func GetListDataSafePrivateEndpointsSortByEnumValues

func GetListDataSafePrivateEndpointsSortByEnumValues() []ListDataSafePrivateEndpointsSortByEnum

GetListDataSafePrivateEndpointsSortByEnumValues Enumerates the set of values for ListDataSafePrivateEndpointsSortByEnum

type ListDataSafePrivateEndpointsSortOrderEnum

type ListDataSafePrivateEndpointsSortOrderEnum string

ListDataSafePrivateEndpointsSortOrderEnum Enum with underlying type: string

const (
	ListDataSafePrivateEndpointsSortOrderAsc  ListDataSafePrivateEndpointsSortOrderEnum = "ASC"
	ListDataSafePrivateEndpointsSortOrderDesc ListDataSafePrivateEndpointsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDataSafePrivateEndpointsSortOrderEnum

func GetListDataSafePrivateEndpointsSortOrderEnumValues

func GetListDataSafePrivateEndpointsSortOrderEnumValues() []ListDataSafePrivateEndpointsSortOrderEnum

GetListDataSafePrivateEndpointsSortOrderEnumValues Enumerates the set of values for ListDataSafePrivateEndpointsSortOrderEnum

type ListWorkRequestErrorsRequest

type ListWorkRequestErrorsRequest struct {

	// The OCID of the work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// Unique identifier for the request.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// The beginning page from which the results start retrieving.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy

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

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

func (ListWorkRequestErrorsRequest) String

func (request ListWorkRequestErrorsRequest) String() string

type ListWorkRequestErrorsResponse

type ListWorkRequestErrorsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []WorkRequestError instances
	Items []WorkRequestError `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestLogsRequest

type ListWorkRequestLogsRequest struct {

	// The OCID of the work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// Unique identifier for the request.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// The beginning page from which the results start retrieving.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy

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

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

func (ListWorkRequestLogsRequest) String

func (request ListWorkRequestLogsRequest) String() string

type ListWorkRequestLogsResponse

type ListWorkRequestLogsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []WorkRequestLogEntry instances
	Items []WorkRequestLogEntry `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestsRequest

type ListWorkRequestsRequest struct {

	// A filter to return only resources that match the specified compartment OCID.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// A filter to return only work requests that match the specified resource OCID.
	ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`

	// Unique identifier for the request.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// The beginning page from which the results start retrieving.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

func (ListWorkRequestsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy

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

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

func (ListWorkRequestsRequest) String

func (request ListWorkRequestsRequest) String() string

type ListWorkRequestsResponse

type ListWorkRequestsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []WorkRequestSummary instances
	Items []WorkRequestSummary `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For list pagination. When this header appears in the response, additional pages of results remain. Include opc-next-page value as the page parameter for the subsequent GET request to get the next batch of items. For details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type ServiceListEnum

type ServiceListEnum string

ServiceListEnum Enum with underlying type: string

const (
	ServiceListDataSafe      ServiceListEnum = "DataSafe"
	ServiceListDataSafeDev   ServiceListEnum = "DataSafe-dev"
	ServiceListDataSafeDev1  ServiceListEnum = "DataSafe-dev1"
	ServiceListDataSafeDev2  ServiceListEnum = "DataSafe-dev2"
	ServiceListDataSafeDev3  ServiceListEnum = "DataSafe-dev3"
	ServiceListDataSafeLrg1  ServiceListEnum = "DataSafe-lrg1"
	ServiceListDataSafeLrg2  ServiceListEnum = "DataSafe-lrg2"
	ServiceListDataSafeLrg3  ServiceListEnum = "DataSafe-lrg3"
	ServiceListDataSafeLrg4  ServiceListEnum = "DataSafe-lrg4"
	ServiceListDataSafePtest ServiceListEnum = "DataSafe-ptest"
	ServiceListDataSafeStest ServiceListEnum = "DataSafe-stest"
	ServiceListDataSafeStage ServiceListEnum = "DataSafe-stage"
)

Set of constants representing the allowable values for ServiceListEnum

func GetServiceListEnumValues

func GetServiceListEnumValues() []ServiceListEnum

GetServiceListEnumValues Enumerates the set of values for ServiceListEnum

type UpdateDataSafePrivateEndpointDetails

type UpdateDataSafePrivateEndpointDetails struct {

	// The display name of the private endpoint.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The description of the private endpoint.
	Description *string `mandatory:"false" json:"description"`

	// The OCIDs of the network security groups that the private endpoint belongs to.
	NsgIds []string `mandatory:"false" json:"nsgIds"`

	// 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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm)
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm)
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateDataSafePrivateEndpointDetails The details used to update a Data Safe private endpoint.

func (UpdateDataSafePrivateEndpointDetails) String

type UpdateDataSafePrivateEndpointRequest

type UpdateDataSafePrivateEndpointRequest struct {

	// The OCID of the private endpoint.
	DataSafePrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"dataSafePrivateEndpointId"`

	// The details used to update a Data Safe private endpoint.
	UpdateDataSafePrivateEndpointDetails `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 identifier for the request.
	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
}

UpdateDataSafePrivateEndpointRequest wrapper for the UpdateDataSafePrivateEndpoint operation

func (UpdateDataSafePrivateEndpointRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateDataSafePrivateEndpointRequest) RetryPolicy

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

func (UpdateDataSafePrivateEndpointRequest) String

type UpdateDataSafePrivateEndpointResponse

type UpdateDataSafePrivateEndpointResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID of the work request. Use GetWorkRequest with this OCID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateDataSafePrivateEndpointResponse wrapper for the UpdateDataSafePrivateEndpoint operation

func (UpdateDataSafePrivateEndpointResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateDataSafePrivateEndpointResponse) String

type WorkRequest

type WorkRequest struct {

	// The asynchronous operation tracked by this work request.
	OperationType WorkRequestOperationTypeEnum `mandatory:"true" json:"operationType"`

	// The status of the work request.
	Status WorkRequestStatusEnum `mandatory:"true" json:"status"`

	// The OCID of the work request.
	Id *string `mandatory:"true" json:"id"`

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

	// The resources that are affected by this work request.
	Resources []WorkRequestResource `mandatory:"true" json:"resources"`

	// Progress of the request in percentage.
	PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

	// The date and time the work request was created, in the format defined by RFC3339.
	TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

	// The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, in the format defined by RFC3339.
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The date and time the work request reached a terminal state, either FAILED or SUCCEEDED. Format is defined by RFC3339.
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

WorkRequest An asynchronous work request.

func (WorkRequest) String

func (m WorkRequest) String() string

type WorkRequestError

type WorkRequestError struct {

	// A machine-usable code for the error that occured. Error codes are listed on
	// (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)
	Code *string `mandatory:"true" json:"code"`

	// A human-readable error string.
	Message *string `mandatory:"true" json:"message"`

	// The date and time the error occurred, in the format defined by RFC3339.
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

WorkRequestError An error encountered while executing an operation that is tracked by a work request.

func (WorkRequestError) String

func (m WorkRequestError) String() string

type WorkRequestLogEntry

type WorkRequestLogEntry struct {

	// Human-readable log message.
	Message *string `mandatory:"true" json:"message"`

	// The time when the log message was created, in the format defined by RFC3339.
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

WorkRequestLogEntry A log message from the execution of a work request.

func (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

type WorkRequestOperationTypeEnum

type WorkRequestOperationTypeEnum string

WorkRequestOperationTypeEnum Enum with underlying type: string

const (
	WorkRequestOperationTypeEnableDataSafeConfiguration      WorkRequestOperationTypeEnum = "ENABLE_DATA_SAFE_CONFIGURATION"
	WorkRequestOperationTypeCreatePrivateEndpoint            WorkRequestOperationTypeEnum = "CREATE_PRIVATE_ENDPOINT"
	WorkRequestOperationTypeUpdatePrivateEndpoint            WorkRequestOperationTypeEnum = "UPDATE_PRIVATE_ENDPOINT"
	WorkRequestOperationTypeDeletePrivateEndpoint            WorkRequestOperationTypeEnum = "DELETE_PRIVATE_ENDPOINT"
	WorkRequestOperationTypeChangePrivateEndpointCompartment WorkRequestOperationTypeEnum = "CHANGE_PRIVATE_ENDPOINT_COMPARTMENT"
)

Set of constants representing the allowable values for WorkRequestOperationTypeEnum

func GetWorkRequestOperationTypeEnumValues

func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum

GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum

type WorkRequestResource

type WorkRequestResource struct {

	// The resource type impacted by the work request.
	EntityType *string `mandatory:"true" json:"entityType"`

	// The way in which this resource was affected by the operation that spawned the work request.
	// A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
	// work is complete for that resource at which point it will transition to CREATED, UPDATED,
	// or DELETED, respectively.
	ActionType WorkRequestResourceActionTypeEnum `mandatory:"true" json:"actionType"`

	// An OCID or other unique identifier for the resource.
	Identifier *string `mandatory:"true" json:"identifier"`

	// The URI path that the user can use for a GET request to access the resource metadata.
	EntityUri *string `mandatory:"false" json:"entityUri"`
}

WorkRequestResource A resource that is created or operated on by an asynchronous operation that is tracked by a work request.

func (WorkRequestResource) String

func (m WorkRequestResource) String() string

type WorkRequestResourceActionTypeEnum

type WorkRequestResourceActionTypeEnum string

WorkRequestResourceActionTypeEnum Enum with underlying type: string

const (
	WorkRequestResourceActionTypeCreated    WorkRequestResourceActionTypeEnum = "CREATED"
	WorkRequestResourceActionTypeUpdated    WorkRequestResourceActionTypeEnum = "UPDATED"
	WorkRequestResourceActionTypeDeleted    WorkRequestResourceActionTypeEnum = "DELETED"
	WorkRequestResourceActionTypeInProgress WorkRequestResourceActionTypeEnum = "IN_PROGRESS"
)

Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum

func GetWorkRequestResourceActionTypeEnumValues

func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum

GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum

type WorkRequestStatusEnum

type WorkRequestStatusEnum string

WorkRequestStatusEnum Enum with underlying type: string

const (
	WorkRequestStatusAccepted   WorkRequestStatusEnum = "ACCEPTED"
	WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
	WorkRequestStatusFailed     WorkRequestStatusEnum = "FAILED"
	WorkRequestStatusSucceeded  WorkRequestStatusEnum = "SUCCEEDED"
)

Set of constants representing the allowable values for WorkRequestStatusEnum

func GetWorkRequestStatusEnumValues

func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum

GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum

type WorkRequestSummary

type WorkRequestSummary struct {

	// The asynchronous operation tracked by this work request.
	OperationType WorkRequestSummaryOperationTypeEnum `mandatory:"true" json:"operationType"`

	// The status of the work request.
	Status WorkRequestSummaryStatusEnum `mandatory:"true" json:"status"`

	// The OCID of the work request.
	Id *string `mandatory:"true" json:"id"`

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

	// The resources impacted by the work request.
	Resources []WorkRequestResource `mandatory:"true" json:"resources"`

	// Progress of the request in percentage.
	PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

	// The date and time the work request was created, in the format defined by RFC3339.
	TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

	// The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, in the format defined by RFC3339.
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, in the format defined by RFC3339.
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

WorkRequestSummary A summary of the work request status.

func (WorkRequestSummary) String

func (m WorkRequestSummary) String() string

type WorkRequestSummaryOperationTypeEnum

type WorkRequestSummaryOperationTypeEnum string

WorkRequestSummaryOperationTypeEnum Enum with underlying type: string

const (
	WorkRequestSummaryOperationTypeEnableDataSafeConfiguration      WorkRequestSummaryOperationTypeEnum = "ENABLE_DATA_SAFE_CONFIGURATION"
	WorkRequestSummaryOperationTypeCreatePrivateEndpoint            WorkRequestSummaryOperationTypeEnum = "CREATE_PRIVATE_ENDPOINT"
	WorkRequestSummaryOperationTypeUpdatePrivateEndpoint            WorkRequestSummaryOperationTypeEnum = "UPDATE_PRIVATE_ENDPOINT"
	WorkRequestSummaryOperationTypeDeletePrivateEndpoint            WorkRequestSummaryOperationTypeEnum = "DELETE_PRIVATE_ENDPOINT"
	WorkRequestSummaryOperationTypeChangePrivateEndpointCompartment WorkRequestSummaryOperationTypeEnum = "CHANGE_PRIVATE_ENDPOINT_COMPARTMENT"
)

Set of constants representing the allowable values for WorkRequestSummaryOperationTypeEnum

func GetWorkRequestSummaryOperationTypeEnumValues

func GetWorkRequestSummaryOperationTypeEnumValues() []WorkRequestSummaryOperationTypeEnum

GetWorkRequestSummaryOperationTypeEnumValues Enumerates the set of values for WorkRequestSummaryOperationTypeEnum

type WorkRequestSummaryStatusEnum

type WorkRequestSummaryStatusEnum string

WorkRequestSummaryStatusEnum Enum with underlying type: string

const (
	WorkRequestSummaryStatusAccepted   WorkRequestSummaryStatusEnum = "ACCEPTED"
	WorkRequestSummaryStatusInProgress WorkRequestSummaryStatusEnum = "IN_PROGRESS"
	WorkRequestSummaryStatusFailed     WorkRequestSummaryStatusEnum = "FAILED"
	WorkRequestSummaryStatusSucceeded  WorkRequestSummaryStatusEnum = "SUCCEEDED"
)

Set of constants representing the allowable values for WorkRequestSummaryStatusEnum

func GetWorkRequestSummaryStatusEnumValues

func GetWorkRequestSummaryStatusEnumValues() []WorkRequestSummaryStatusEnum

GetWorkRequestSummaryStatusEnumValues Enumerates the set of values for WorkRequestSummaryStatusEnum

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL