oci-go-sdk: github.com/oracle/oci-go-sdk/oce Index | Files

package oce

import "github.com/oracle/oci-go-sdk/oce"

Index

Package Files

change_oce_instance_compartment_details.go change_oce_instance_compartment_request_response.go create_oce_instance_details.go create_oce_instance_request_response.go delete_oce_instance_request_response.go get_oce_instance_request_response.go get_work_request_request_response.go identity_stripe_details.go list_oce_instances_request_response.go list_work_request_errors_request_response.go list_work_request_logs_request_response.go list_work_requests_request_response.go oce_instance.go oce_instance_summary.go oce_oceinstance_client.go update_oce_instance_details.go update_oce_instance_request_response.go work_request.go work_request_error.go work_request_log_entry.go work_request_resource.go workflow_monitor.go workflow_step.go

type ChangeOceInstanceCompartmentDetails Uses

type ChangeOceInstanceCompartmentDetails struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
    // into which the OceInstance should be moved.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeOceInstanceCompartmentDetails The information about compartment details.

func (ChangeOceInstanceCompartmentDetails) String Uses

func (m ChangeOceInstanceCompartmentDetails) String() string

type ChangeOceInstanceCompartmentRequest Uses

type ChangeOceInstanceCompartmentRequest struct {

    // unique OceInstance identifier
    OceInstanceId *string `mandatory:"true" contributesTo:"path" name:"oceInstanceId"`

    // The information about compartment details to be moved.
    ChangeOceInstanceCompartmentDetails `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"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

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

ChangeOceInstanceCompartmentRequest wrapper for the ChangeOceInstanceCompartment operation

func (ChangeOceInstanceCompartmentRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ChangeOceInstanceCompartmentRequest) RetryPolicy Uses

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

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

func (ChangeOceInstanceCompartmentRequest) String Uses

func (request ChangeOceInstanceCompartmentRequest) String() string

type ChangeOceInstanceCompartmentResponse Uses

type ChangeOceInstanceCompartmentResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
    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"`
}

ChangeOceInstanceCompartmentResponse wrapper for the ChangeOceInstanceCompartment operation

func (ChangeOceInstanceCompartmentResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ChangeOceInstanceCompartmentResponse) String Uses

func (response ChangeOceInstanceCompartmentResponse) String() string

type CreateOceInstanceDetails Uses

type CreateOceInstanceDetails struct {

    // Compartment Identifier
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // OceInstance Name
    Name *string `mandatory:"true" json:"name"`

    // Tenancy Identifier
    TenancyId *string `mandatory:"true" json:"tenancyId"`

    // Identity Cloud Service access token identifying a stripe and service administrator user
    IdcsAccessToken *string `mandatory:"true" json:"idcsAccessToken"`

    // Tenancy Name
    TenancyName *string `mandatory:"true" json:"tenancyName"`

    // Object Storage Namespace of Tenancy
    ObjectStorageNamespace *string `mandatory:"true" json:"objectStorageNamespace"`

    // Admin Email for Notification
    AdminEmail *string `mandatory:"true" json:"adminEmail"`

    // OceInstance description
    Description *string `mandatory:"false" json:"description"`

    IdentityStripe *IdentityStripeDetails `mandatory:"false" json:"identityStripe"`

    // Instance type based on its usage
    InstanceUsageType CreateOceInstanceDetailsInstanceUsageTypeEnum `mandatory:"false" json:"instanceUsageType,omitempty"`

    // Web Application Firewall(WAF) primary domain
    WafPrimaryDomain *string `mandatory:"false" json:"wafPrimaryDomain"`

    // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
    // Example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Usage of predefined tag keys. These predefined keys are scoped to namespaces.
    // Example: `{"foo-namespace": {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateOceInstanceDetails The information about new OceInstance.

func (CreateOceInstanceDetails) String Uses

func (m CreateOceInstanceDetails) String() string

type CreateOceInstanceDetailsInstanceUsageTypeEnum Uses

type CreateOceInstanceDetailsInstanceUsageTypeEnum string

CreateOceInstanceDetailsInstanceUsageTypeEnum Enum with underlying type: string

const (
    CreateOceInstanceDetailsInstanceUsageTypePrimary    CreateOceInstanceDetailsInstanceUsageTypeEnum = "PRIMARY"
    CreateOceInstanceDetailsInstanceUsageTypeNonprimary CreateOceInstanceDetailsInstanceUsageTypeEnum = "NONPRIMARY"
)

Set of constants representing the allowable values for CreateOceInstanceDetailsInstanceUsageTypeEnum

func GetCreateOceInstanceDetailsInstanceUsageTypeEnumValues Uses

func GetCreateOceInstanceDetailsInstanceUsageTypeEnumValues() []CreateOceInstanceDetailsInstanceUsageTypeEnum

GetCreateOceInstanceDetailsInstanceUsageTypeEnumValues Enumerates the set of values for CreateOceInstanceDetailsInstanceUsageTypeEnum

type CreateOceInstanceRequest Uses

type CreateOceInstanceRequest struct {

    // Details for the new OceInstance.
    CreateOceInstanceDetails `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"`

    // The client request ID for tracing.
    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
}

CreateOceInstanceRequest wrapper for the CreateOceInstance operation

func (CreateOceInstanceRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CreateOceInstanceRequest) RetryPolicy Uses

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

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

func (CreateOceInstanceRequest) String Uses

func (request CreateOceInstanceRequest) String() string

type CreateOceInstanceResponse Uses

type CreateOceInstanceResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
    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"`
}

CreateOceInstanceResponse wrapper for the CreateOceInstance operation

func (CreateOceInstanceResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateOceInstanceResponse) String Uses

func (response CreateOceInstanceResponse) String() string

type DeleteOceInstanceRequest Uses

type DeleteOceInstanceRequest struct {

    // unique OceInstance identifier
    OceInstanceId *string `mandatory:"true" contributesTo:"path" name:"oceInstanceId"`

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

    // The client request ID for tracing.
    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
}

DeleteOceInstanceRequest wrapper for the DeleteOceInstance operation

func (DeleteOceInstanceRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (DeleteOceInstanceRequest) RetryPolicy Uses

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

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

func (DeleteOceInstanceRequest) String Uses

func (request DeleteOceInstanceRequest) String() string

type DeleteOceInstanceResponse Uses

type DeleteOceInstanceResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
    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"`
}

DeleteOceInstanceResponse wrapper for the DeleteOceInstance operation

func (DeleteOceInstanceResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteOceInstanceResponse) String Uses

func (response DeleteOceInstanceResponse) String() string

type GetOceInstanceRequest Uses

type GetOceInstanceRequest struct {

    // unique OceInstance identifier
    OceInstanceId *string `mandatory:"true" contributesTo:"path" name:"oceInstanceId"`

    // The client request ID for tracing.
    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
}

GetOceInstanceRequest wrapper for the GetOceInstance operation

func (GetOceInstanceRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetOceInstanceRequest) RetryPolicy Uses

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

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

func (GetOceInstanceRequest) String Uses

func (request GetOceInstanceRequest) String() string

type GetOceInstanceResponse Uses

type GetOceInstanceResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

GetOceInstanceResponse wrapper for the GetOceInstance operation

func (GetOceInstanceResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetOceInstanceResponse) String Uses

func (response GetOceInstanceResponse) String() string

type GetWorkRequestRequest Uses

type GetWorkRequestRequest struct {

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

    // The client request ID for tracing.
    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 Uses

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy Uses

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

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

func (GetWorkRequestRequest) String Uses

func (request GetWorkRequestRequest) String() string

type GetWorkRequestResponse Uses

type GetWorkRequestResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // some decimal number representing the number of seconds the client should wait before polling this endpoint again
    RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String Uses

func (response GetWorkRequestResponse) String() string

type IdentityStripeDetails Uses

type IdentityStripeDetails struct {

    // Name of the Identity Cloud Service instance in My Services to be used.
    // Example: `secondstripe`
    ServiceName *string `mandatory:"true" json:"serviceName"`

    // Value of the Identity Cloud Service tenancy.
    // Example: `idcs-8416ebdd0d674f84803f4193cce026e9`
    Tenancy *string `mandatory:"true" json:"tenancy"`
}

IdentityStripeDetails Identity Stripe

func (IdentityStripeDetails) String Uses

func (m IdentityStripeDetails) String() string

type ListOceInstancesLifecycleStateEnum Uses

type ListOceInstancesLifecycleStateEnum string

ListOceInstancesLifecycleStateEnum Enum with underlying type: string

const (
    ListOceInstancesLifecycleStateCreating ListOceInstancesLifecycleStateEnum = "CREATING"
    ListOceInstancesLifecycleStateUpdating ListOceInstancesLifecycleStateEnum = "UPDATING"
    ListOceInstancesLifecycleStateActive   ListOceInstancesLifecycleStateEnum = "ACTIVE"
    ListOceInstancesLifecycleStateDeleting ListOceInstancesLifecycleStateEnum = "DELETING"
    ListOceInstancesLifecycleStateDeleted  ListOceInstancesLifecycleStateEnum = "DELETED"
    ListOceInstancesLifecycleStateFailed   ListOceInstancesLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ListOceInstancesLifecycleStateEnum

func GetListOceInstancesLifecycleStateEnumValues Uses

func GetListOceInstancesLifecycleStateEnumValues() []ListOceInstancesLifecycleStateEnum

GetListOceInstancesLifecycleStateEnumValues Enumerates the set of values for ListOceInstancesLifecycleStateEnum

type ListOceInstancesRequest Uses

type ListOceInstancesRequest struct {

    // The ID of the compartment in which to list resources.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

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

    // The maximum number of items to return.
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The sort order to use, either 'asc' or 'desc'.
    SortOrder ListOceInstancesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
    SortBy ListOceInstancesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

    // Filter results on lifecycleState.
    LifecycleState ListOceInstancesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

    // The client request ID for tracing.
    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
}

ListOceInstancesRequest wrapper for the ListOceInstances operation

func (ListOceInstancesRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListOceInstancesRequest) RetryPolicy Uses

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

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

func (ListOceInstancesRequest) String Uses

func (request ListOceInstancesRequest) String() string

type ListOceInstancesResponse Uses

type ListOceInstancesResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []OceInstanceSummary instances
    Items []OceInstanceSummary `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 pagination of a list of `OceInstance`s. If this header appears in the response, then this
    // is a partial list of OceInstances. Include this value as the `page` parameter in a subsequent
    // GET request to get the next batch of OceInstances.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListOceInstancesResponse wrapper for the ListOceInstances operation

func (ListOceInstancesResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListOceInstancesResponse) String Uses

func (response ListOceInstancesResponse) String() string

type ListOceInstancesSortByEnum Uses

type ListOceInstancesSortByEnum string

ListOceInstancesSortByEnum Enum with underlying type: string

const (
    ListOceInstancesSortByTimecreated ListOceInstancesSortByEnum = "timeCreated"
    ListOceInstancesSortByDisplayname ListOceInstancesSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListOceInstancesSortByEnum

func GetListOceInstancesSortByEnumValues Uses

func GetListOceInstancesSortByEnumValues() []ListOceInstancesSortByEnum

GetListOceInstancesSortByEnumValues Enumerates the set of values for ListOceInstancesSortByEnum

type ListOceInstancesSortOrderEnum Uses

type ListOceInstancesSortOrderEnum string

ListOceInstancesSortOrderEnum Enum with underlying type: string

const (
    ListOceInstancesSortOrderAsc  ListOceInstancesSortOrderEnum = "ASC"
    ListOceInstancesSortOrderDesc ListOceInstancesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListOceInstancesSortOrderEnum

func GetListOceInstancesSortOrderEnumValues Uses

func GetListOceInstancesSortOrderEnumValues() []ListOceInstancesSortOrderEnum

GetListOceInstancesSortOrderEnumValues Enumerates the set of values for ListOceInstancesSortOrderEnum

type ListWorkRequestErrorsRequest Uses

type ListWorkRequestErrorsRequest struct {

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

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The maximum number of items to return.
    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 Uses

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy Uses

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

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

func (ListWorkRequestErrorsRequest) String Uses

func (request ListWorkRequestErrorsRequest) String() string

type ListWorkRequestErrorsResponse Uses

type ListWorkRequestErrorsResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For pagination of a list of items. When paging through a list, if this header appears in the response,
    // then there might be additional items still to get. Include this value as the `page` parameter for the
    // subsequent GET request.
    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"`
}

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String Uses

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestLogsRequest Uses

type ListWorkRequestLogsRequest struct {

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

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The maximum number of items to return.
    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 Uses

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy Uses

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

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

func (ListWorkRequestLogsRequest) String Uses

func (request ListWorkRequestLogsRequest) String() string

type ListWorkRequestLogsResponse Uses

type ListWorkRequestLogsResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For pagination of a list of items. When paging through a list, if this header appears in the response,
    // then there might be additional items still to get. Include this value as the `page` parameter for the
    // subsequent GET request.
    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"`
}

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String Uses

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestsRequest Uses

type ListWorkRequestsRequest struct {

    // The ID of the compartment in which to list resources.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The resource Identifier for which to list resources.
    ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`

    // The client request ID for tracing.
    OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

    // The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The maximum number of items to return.
    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 Uses

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy Uses

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

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

func (ListWorkRequestsRequest) String Uses

func (request ListWorkRequestsRequest) String() string

type ListWorkRequestsResponse Uses

type ListWorkRequestsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of []WorkRequest instances
    Items []WorkRequest `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 pagination of a list of items. When paging through a list, if this header appears in the response,
    // then a partial list might have been returned. Include this value as the `page` parameter for the
    // subsequent GET request to get the next batch of items.
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String Uses

func (response ListWorkRequestsResponse) String() string

type OceInstance Uses

type OceInstance struct {

    // Unique identifier that is immutable on creation
    Id  *string `mandatory:"true" json:"id"`

    // Unique GUID identifier that is immutable on creation
    Guid *string `mandatory:"true" json:"guid"`

    // Compartment Identifier
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // OceInstance Name
    Name *string `mandatory:"true" json:"name"`

    // Tenancy Identifier
    TenancyId *string `mandatory:"true" json:"tenancyId"`

    // IDCS Tenancy Identifier
    IdcsTenancy *string `mandatory:"true" json:"idcsTenancy"`

    // Tenancy Name
    TenancyName *string `mandatory:"true" json:"tenancyName"`

    // Object Storage Namespace of tenancy
    ObjectStorageNamespace *string `mandatory:"true" json:"objectStorageNamespace"`

    // Admin Email for Notification
    AdminEmail *string `mandatory:"true" json:"adminEmail"`

    // OceInstance description, can be updated
    Description *string `mandatory:"false" json:"description"`

    IdentityStripe *IdentityStripeDetails `mandatory:"false" json:"identityStripe"`

    // Instance type based on its usage
    InstanceUsageType OceInstanceInstanceUsageTypeEnum `mandatory:"false" json:"instanceUsageType,omitempty"`

    // Web Application Firewall(WAF) primary domain
    WafPrimaryDomain *string `mandatory:"false" json:"wafPrimaryDomain"`

    // The time the the OceInstance was created. An RFC3339 formatted datetime string
    TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

    // The time the OceInstance was updated. An RFC3339 formatted datetime string
    TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

    // The current state of the file system.
    LifecycleState OceInstanceLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    StateMessage *string `mandatory:"false" json:"stateMessage"`

    // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
    // Example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Usage of predefined tag keys. These predefined keys are scoped to namespaces.
    // Example: `{"foo-namespace": {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // SERVICE data.
    // Example: `{"service": {"IDCS": "value"}}`
    Service map[string]interface{} `mandatory:"false" json:"service"`
}

OceInstance Details of OceInstance.

func (OceInstance) String Uses

func (m OceInstance) String() string

type OceInstanceClient Uses

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

OceInstanceClient a client for OceInstance

func NewOceInstanceClientWithConfigurationProvider Uses

func NewOceInstanceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OceInstanceClient, err error)

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

func NewOceInstanceClientWithOboToken Uses

func NewOceInstanceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OceInstanceClient, err error)

NewOceInstanceClientWithOboToken Creates a new default OceInstance 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 (OceInstanceClient) ChangeOceInstanceCompartment Uses

func (client OceInstanceClient) ChangeOceInstanceCompartment(ctx context.Context, request ChangeOceInstanceCompartmentRequest) (response ChangeOceInstanceCompartmentResponse, err error)

ChangeOceInstanceCompartment Moves a OceInstance into a different compartment

func (*OceInstanceClient) ConfigurationProvider Uses

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

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

func (OceInstanceClient) CreateOceInstance Uses

func (client OceInstanceClient) CreateOceInstance(ctx context.Context, request CreateOceInstanceRequest) (response CreateOceInstanceResponse, err error)

CreateOceInstance Creates a new OceInstance.

func (OceInstanceClient) DeleteOceInstance Uses

func (client OceInstanceClient) DeleteOceInstance(ctx context.Context, request DeleteOceInstanceRequest) (response DeleteOceInstanceResponse, err error)

DeleteOceInstance Deletes a OceInstance resource by identifier

func (OceInstanceClient) GetOceInstance Uses

func (client OceInstanceClient) GetOceInstance(ctx context.Context, request GetOceInstanceRequest) (response GetOceInstanceResponse, err error)

GetOceInstance Gets a OceInstance by identifier

func (OceInstanceClient) GetWorkRequest Uses

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

GetWorkRequest Gets the status of the work request with the given ID.

func (OceInstanceClient) ListOceInstances Uses

func (client OceInstanceClient) ListOceInstances(ctx context.Context, request ListOceInstancesRequest) (response ListOceInstancesResponse, err error)

ListOceInstances Returns a list of OceInstances.

func (OceInstanceClient) ListWorkRequestErrors Uses

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

ListWorkRequestErrors Return a (paginated) list of errors for a given work request.

func (OceInstanceClient) ListWorkRequestLogs Uses

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

ListWorkRequestLogs Return a (paginated) list of logs for a given work request.

func (OceInstanceClient) ListWorkRequests Uses

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

ListWorkRequests Lists the work requests in a compartment.

func (*OceInstanceClient) SetRegion Uses

func (client *OceInstanceClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (OceInstanceClient) UpdateOceInstance Uses

func (client OceInstanceClient) UpdateOceInstance(ctx context.Context, request UpdateOceInstanceRequest) (response UpdateOceInstanceResponse, err error)

UpdateOceInstance Updates the OceInstance

type OceInstanceInstanceUsageTypeEnum Uses

type OceInstanceInstanceUsageTypeEnum string

OceInstanceInstanceUsageTypeEnum Enum with underlying type: string

const (
    OceInstanceInstanceUsageTypePrimary    OceInstanceInstanceUsageTypeEnum = "PRIMARY"
    OceInstanceInstanceUsageTypeNonprimary OceInstanceInstanceUsageTypeEnum = "NONPRIMARY"
)

Set of constants representing the allowable values for OceInstanceInstanceUsageTypeEnum

func GetOceInstanceInstanceUsageTypeEnumValues Uses

func GetOceInstanceInstanceUsageTypeEnumValues() []OceInstanceInstanceUsageTypeEnum

GetOceInstanceInstanceUsageTypeEnumValues Enumerates the set of values for OceInstanceInstanceUsageTypeEnum

type OceInstanceLifecycleStateEnum Uses

type OceInstanceLifecycleStateEnum string

OceInstanceLifecycleStateEnum Enum with underlying type: string

const (
    OceInstanceLifecycleStateCreating OceInstanceLifecycleStateEnum = "CREATING"
    OceInstanceLifecycleStateUpdating OceInstanceLifecycleStateEnum = "UPDATING"
    OceInstanceLifecycleStateActive   OceInstanceLifecycleStateEnum = "ACTIVE"
    OceInstanceLifecycleStateDeleting OceInstanceLifecycleStateEnum = "DELETING"
    OceInstanceLifecycleStateDeleted  OceInstanceLifecycleStateEnum = "DELETED"
    OceInstanceLifecycleStateFailed   OceInstanceLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for OceInstanceLifecycleStateEnum

func GetOceInstanceLifecycleStateEnumValues Uses

func GetOceInstanceLifecycleStateEnumValues() []OceInstanceLifecycleStateEnum

GetOceInstanceLifecycleStateEnumValues Enumerates the set of values for OceInstanceLifecycleStateEnum

type OceInstanceSummary Uses

type OceInstanceSummary struct {

    // Unique identifier that is immutable on creation
    Id  *string `mandatory:"true" json:"id"`

    // Unique GUID identifier that is immutable on creation
    Guid *string `mandatory:"true" json:"guid"`

    // Compartment Identifier
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // OceInstance Name
    Name *string `mandatory:"true" json:"name"`

    // Tenancy Identifier
    TenancyId *string `mandatory:"true" json:"tenancyId"`

    // IDCS Tenancy Identifier
    IdcsTenancy *string `mandatory:"true" json:"idcsTenancy"`

    // Tenancy Name
    TenancyName *string `mandatory:"true" json:"tenancyName"`

    // Object Storage Namespace of tenancy
    ObjectStorageNamespace *string `mandatory:"true" json:"objectStorageNamespace"`

    // Admin Email for Notification
    AdminEmail *string `mandatory:"true" json:"adminEmail"`

    // OceInstance description, can be updated
    Description *string `mandatory:"false" json:"description"`

    // Instance type based on its usage
    InstanceUsageType OceInstanceSummaryInstanceUsageTypeEnum `mandatory:"false" json:"instanceUsageType,omitempty"`

    // Web Application Firewall(WAF) primary domain
    WafPrimaryDomain *string `mandatory:"false" json:"wafPrimaryDomain"`

    // The time the the OceInstance was created. An RFC3339 formatted datetime string
    TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

    // The time the OceInstance was updated. An RFC3339 formatted datetime string
    TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

    // The current state of the file system.
    LifecycleState OceInstanceSummaryLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    StateMessage *string `mandatory:"false" json:"stateMessage"`

    // SERVICE data.
    // Example: `{"service": {"IDCS": "value"}}`
    Service map[string]interface{} `mandatory:"false" json:"service"`

    // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
    // Example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Usage of predefined tag keys. These predefined keys are scoped to namespaces.
    // Example: `{"foo-namespace": {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

OceInstanceSummary Summary of the OceInstance.

func (OceInstanceSummary) String Uses

func (m OceInstanceSummary) String() string

type OceInstanceSummaryInstanceUsageTypeEnum Uses

type OceInstanceSummaryInstanceUsageTypeEnum string

OceInstanceSummaryInstanceUsageTypeEnum Enum with underlying type: string

const (
    OceInstanceSummaryInstanceUsageTypePrimary    OceInstanceSummaryInstanceUsageTypeEnum = "PRIMARY"
    OceInstanceSummaryInstanceUsageTypeNonprimary OceInstanceSummaryInstanceUsageTypeEnum = "NONPRIMARY"
)

Set of constants representing the allowable values for OceInstanceSummaryInstanceUsageTypeEnum

func GetOceInstanceSummaryInstanceUsageTypeEnumValues Uses

func GetOceInstanceSummaryInstanceUsageTypeEnumValues() []OceInstanceSummaryInstanceUsageTypeEnum

GetOceInstanceSummaryInstanceUsageTypeEnumValues Enumerates the set of values for OceInstanceSummaryInstanceUsageTypeEnum

type OceInstanceSummaryLifecycleStateEnum Uses

type OceInstanceSummaryLifecycleStateEnum string

OceInstanceSummaryLifecycleStateEnum Enum with underlying type: string

const (
    OceInstanceSummaryLifecycleStateCreating OceInstanceSummaryLifecycleStateEnum = "CREATING"
    OceInstanceSummaryLifecycleStateUpdating OceInstanceSummaryLifecycleStateEnum = "UPDATING"
    OceInstanceSummaryLifecycleStateActive   OceInstanceSummaryLifecycleStateEnum = "ACTIVE"
    OceInstanceSummaryLifecycleStateDeleting OceInstanceSummaryLifecycleStateEnum = "DELETING"
    OceInstanceSummaryLifecycleStateDeleted  OceInstanceSummaryLifecycleStateEnum = "DELETED"
    OceInstanceSummaryLifecycleStateFailed   OceInstanceSummaryLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for OceInstanceSummaryLifecycleStateEnum

func GetOceInstanceSummaryLifecycleStateEnumValues Uses

func GetOceInstanceSummaryLifecycleStateEnumValues() []OceInstanceSummaryLifecycleStateEnum

GetOceInstanceSummaryLifecycleStateEnumValues Enumerates the set of values for OceInstanceSummaryLifecycleStateEnum

type UpdateOceInstanceDetails Uses

type UpdateOceInstanceDetails struct {

    // OceInstance description
    Description *string `mandatory:"false" json:"description"`

    // Web Application Firewall(WAF) primary domain
    WafPrimaryDomain *string `mandatory:"false" json:"wafPrimaryDomain"`

    // Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
    // Example: `{"bar-key": "value"}`
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // Usage of predefined tag keys. These predefined keys are scoped to namespaces.
    // Example: `{"foo-namespace": {"bar-key": "value"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateOceInstanceDetails The information to be updated.

func (UpdateOceInstanceDetails) String Uses

func (m UpdateOceInstanceDetails) String() string

type UpdateOceInstanceRequest Uses

type UpdateOceInstanceRequest struct {

    // unique OceInstance identifier
    OceInstanceId *string `mandatory:"true" contributesTo:"path" name:"oceInstanceId"`

    // The information to be updated.
    UpdateOceInstanceDetails `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"`

    // The client request ID for tracing.
    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
}

UpdateOceInstanceRequest wrapper for the UpdateOceInstance operation

func (UpdateOceInstanceRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (UpdateOceInstanceRequest) RetryPolicy Uses

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

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

func (UpdateOceInstanceRequest) String Uses

func (request UpdateOceInstanceRequest) String() string

type UpdateOceInstanceResponse Uses

type UpdateOceInstanceResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
    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"`
}

UpdateOceInstanceResponse wrapper for the UpdateOceInstance operation

func (UpdateOceInstanceResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (UpdateOceInstanceResponse) String Uses

func (response UpdateOceInstanceResponse) String() string

type WorkRequest Uses

type WorkRequest struct {

    // type of the work request
    OperationType WorkRequestOperationTypeEnum `mandatory:"true" json:"operationType"`

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

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

    // The ocid of the compartment that contains the work request. Work requests should be scoped to
    // the same compartment as the resource the work request affects. If the work request affects multiple resources,
    // and those resources are not in the same compartment, it is up to the service team to pick the primary
    // resource whose compartment should be used
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

    // Percentage of the request completed.
    PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

    // The date and time the request was created, as described in
    // RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
    TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

    WorkflowMonitor *WorkflowMonitor `mandatory:"false" json:"workflowMonitor"`

    // The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
    // section 14.29.
    TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

    // The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
    TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

WorkRequest A description of workrequest status

func (WorkRequest) String Uses

func (m WorkRequest) String() string

type WorkRequestError Uses

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 description of the issue encountered.
    Message *string `mandatory:"true" json:"message"`

    // The time the error occured. An RFC3339 formatted datetime string.
    Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

WorkRequestError An error encountered while executing a work request.

func (WorkRequestError) String Uses

func (m WorkRequestError) String() string

type WorkRequestLogEntry Uses

type WorkRequestLogEntry struct {

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

    // The time the log message was written. An RFC3339 formatted datetime string
    Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

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

func (WorkRequestLogEntry) String Uses

func (m WorkRequestLogEntry) String() string

type WorkRequestOperationTypeEnum Uses

type WorkRequestOperationTypeEnum string

WorkRequestOperationTypeEnum Enum with underlying type: string

const (
    WorkRequestOperationTypeCreateOceInstance WorkRequestOperationTypeEnum = "CREATE_OCE_INSTANCE"
    WorkRequestOperationTypeUpdateOceInstance WorkRequestOperationTypeEnum = "UPDATE_OCE_INSTANCE"
    WorkRequestOperationTypeDeleteOceInstance WorkRequestOperationTypeEnum = "DELETE_OCE_INSTANCE"
)

Set of constants representing the allowable values for WorkRequestOperationTypeEnum

func GetWorkRequestOperationTypeEnumValues Uses

func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum

GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum

type WorkRequestResource Uses

type WorkRequestResource struct {

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

    // The way in which this resource is affected by the work tracked in 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"`

    // The identifier of the resource the work request affects.
    Identifier *string `mandatory:"true" json:"identifier"`

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

WorkRequestResource A resource created or operated on by a work request.

func (WorkRequestResource) String Uses

func (m WorkRequestResource) String() string

type WorkRequestResourceActionTypeEnum Uses

type WorkRequestResourceActionTypeEnum string

WorkRequestResourceActionTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum

func GetWorkRequestResourceActionTypeEnumValues Uses

func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum

GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum

type WorkRequestStatusEnum Uses

type WorkRequestStatusEnum string

WorkRequestStatusEnum Enum with underlying type: string

const (
    WorkRequestStatusAccepted   WorkRequestStatusEnum = "ACCEPTED"
    WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
    WorkRequestStatusFailed     WorkRequestStatusEnum = "FAILED"
    WorkRequestStatusSucceeded  WorkRequestStatusEnum = "SUCCEEDED"
    WorkRequestStatusCanceling  WorkRequestStatusEnum = "CANCELING"
    WorkRequestStatusCanceled   WorkRequestStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for WorkRequestStatusEnum

func GetWorkRequestStatusEnumValues Uses

func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum

GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum

type WorkflowMonitor Uses

type WorkflowMonitor struct {

    // workflow name for this work request
    WorkflowName *string `mandatory:"false" json:"workflowName"`

    // resource name for this work request
    ResourceName *string `mandatory:"false" json:"resourceName"`

    // Workflow step of workflow monitor.
    WorkflowSteps []WorkflowStep `mandatory:"false" json:"workflowSteps"`
}

WorkflowMonitor The workflow monitor for this work request.

func (WorkflowMonitor) String Uses

func (m WorkflowMonitor) String() string

type WorkflowStep Uses

type WorkflowStep struct {

    // workflow step name
    StepName *string `mandatory:"false" json:"stepName"`

    // workflow step status
    Status *string `mandatory:"false" json:"status"`
}

WorkflowStep Workflow step of workflow monitor.

func (WorkflowStep) String Uses

func (m WorkflowStep) String() string

Package oce imports 4 packages (graph). Updated 2020-04-06. Refresh now. Tools for package owners.