func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetApplicationLifecycleStateEnumStringValues() []string
GetApplicationLifecycleStateEnumStringValues Enumerates the set of values in String for ApplicationLifecycleStateEnum
func GetApplicationLoggingConfigLineFormatEnumStringValues() []string
GetApplicationLoggingConfigLineFormatEnumStringValues Enumerates the set of values in String for ApplicationLoggingConfigLineFormatEnum
func GetApplicationShapeEnumStringValues() []string
GetApplicationShapeEnumStringValues Enumerates the set of values in String for ApplicationShapeEnum
func GetApplicationSummaryShapeEnumStringValues() []string
GetApplicationSummaryShapeEnumStringValues Enumerates the set of values in String for ApplicationSummaryShapeEnum
func GetArchiveSourceDetailsArchiveSourceTypeEnumStringValues() []string
GetArchiveSourceDetailsArchiveSourceTypeEnumStringValues Enumerates the set of values in String for ArchiveSourceDetailsArchiveSourceTypeEnum
func GetCreateApplicationDetailsShapeEnumStringValues() []string
GetCreateApplicationDetailsShapeEnumStringValues Enumerates the set of values in String for CreateApplicationDetailsShapeEnum
func GetCreateArchiveSourceDetailsArchiveSourceTypeEnumStringValues() []string
GetCreateArchiveSourceDetailsArchiveSourceTypeEnumStringValues Enumerates the set of values in String for CreateArchiveSourceDetailsArchiveSourceTypeEnum
func GetCreateFunctionSourceDetailsSourceTypeEnumStringValues() []string
GetCreateFunctionSourceDetailsSourceTypeEnumStringValues Enumerates the set of values in String for CreateFunctionSourceDetailsSourceTypeEnum
func GetCreateRuntimeConfigRuntimeConfigTypeEnumStringValues() []string
GetCreateRuntimeConfigRuntimeConfigTypeEnumStringValues Enumerates the set of values in String for CreateRuntimeConfigRuntimeConfigTypeEnum
func GetFailureDestinationDetailsKindEnumStringValues() []string
GetFailureDestinationDetailsKindEnumStringValues Enumerates the set of values in String for FailureDestinationDetailsKindEnum
func GetFunctionLifecycleStateEnumStringValues() []string
GetFunctionLifecycleStateEnumStringValues Enumerates the set of values in String for FunctionLifecycleStateEnum
func GetFunctionProvisionedConcurrencyConfigStrategyEnumStringValues() []string
GetFunctionProvisionedConcurrencyConfigStrategyEnumStringValues Enumerates the set of values in String for FunctionProvisionedConcurrencyConfigStrategyEnum
func GetFunctionShapeEnumStringValues() []string
GetFunctionShapeEnumStringValues Enumerates the set of values in String for FunctionShapeEnum
func GetFunctionSourceDetailsSourceTypeEnumStringValues() []string
GetFunctionSourceDetailsSourceTypeEnumStringValues Enumerates the set of values in String for FunctionSourceDetailsSourceTypeEnum
func GetFunctionSummaryShapeEnumStringValues() []string
GetFunctionSummaryShapeEnumStringValues Enumerates the set of values in String for FunctionSummaryShapeEnum
func GetFunctionsRuntimeLifecycleStateEnumStringValues() []string
GetFunctionsRuntimeLifecycleStateEnumStringValues Enumerates the set of values in String for FunctionsRuntimeLifecycleStateEnum
func GetFunctionsRuntimeVersionLifecycleStateEnumStringValues() []string
GetFunctionsRuntimeVersionLifecycleStateEnumStringValues Enumerates the set of values in String for FunctionsRuntimeVersionLifecycleStateEnum
func GetFunctionsRuntimeVersionSummarySupportedArchitecturesEnumStringValues() []string
GetFunctionsRuntimeVersionSummarySupportedArchitecturesEnumStringValues Enumerates the set of values in String for FunctionsRuntimeVersionSummarySupportedArchitecturesEnum
func GetFunctionsRuntimeVersionSupportedArchitecturesEnumStringValues() []string
GetFunctionsRuntimeVersionSupportedArchitecturesEnumStringValues Enumerates the set of values in String for FunctionsRuntimeVersionSupportedArchitecturesEnum
func GetInvokeFunctionFnIntentEnumStringValues() []string
GetInvokeFunctionFnIntentEnumStringValues Enumerates the set of values in String for InvokeFunctionFnIntentEnum
func GetInvokeFunctionFnInvokeTypeEnumStringValues() []string
GetInvokeFunctionFnInvokeTypeEnumStringValues Enumerates the set of values in String for InvokeFunctionFnInvokeTypeEnum
func GetListApplicationsSortByEnumStringValues() []string
GetListApplicationsSortByEnumStringValues Enumerates the set of values in String for ListApplicationsSortByEnum
func GetListApplicationsSortOrderEnumStringValues() []string
GetListApplicationsSortOrderEnumStringValues Enumerates the set of values in String for ListApplicationsSortOrderEnum
func GetListFunctionsRuntimeVersionsSortByEnumStringValues() []string
GetListFunctionsRuntimeVersionsSortByEnumStringValues Enumerates the set of values in String for ListFunctionsRuntimeVersionsSortByEnum
func GetListFunctionsRuntimeVersionsSortOrderEnumStringValues() []string
GetListFunctionsRuntimeVersionsSortOrderEnumStringValues Enumerates the set of values in String for ListFunctionsRuntimeVersionsSortOrderEnum
func GetListFunctionsRuntimesSortByEnumStringValues() []string
GetListFunctionsRuntimesSortByEnumStringValues Enumerates the set of values in String for ListFunctionsRuntimesSortByEnum
func GetListFunctionsRuntimesSortOrderEnumStringValues() []string
GetListFunctionsRuntimesSortOrderEnumStringValues Enumerates the set of values in String for ListFunctionsRuntimesSortOrderEnum
func GetListFunctionsSortByEnumStringValues() []string
GetListFunctionsSortByEnumStringValues Enumerates the set of values in String for ListFunctionsSortByEnum
func GetListFunctionsSortOrderEnumStringValues() []string
GetListFunctionsSortOrderEnumStringValues Enumerates the set of values in String for ListFunctionsSortOrderEnum
func GetListPbfListingVersionsSortByEnumStringValues() []string
GetListPbfListingVersionsSortByEnumStringValues Enumerates the set of values in String for ListPbfListingVersionsSortByEnum
func GetListPbfListingVersionsSortOrderEnumStringValues() []string
GetListPbfListingVersionsSortOrderEnumStringValues Enumerates the set of values in String for ListPbfListingVersionsSortOrderEnum
func GetListPbfListingsSortByEnumStringValues() []string
GetListPbfListingsSortByEnumStringValues Enumerates the set of values in String for ListPbfListingsSortByEnum
func GetListPbfListingsSortOrderEnumStringValues() []string
GetListPbfListingsSortOrderEnumStringValues Enumerates the set of values in String for ListPbfListingsSortOrderEnum
func GetListTriggersSortOrderEnumStringValues() []string
GetListTriggersSortOrderEnumStringValues Enumerates the set of values in String for ListTriggersSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetPbfListingLifecycleStateEnumStringValues() []string
GetPbfListingLifecycleStateEnumStringValues Enumerates the set of values in String for PbfListingLifecycleStateEnum
func GetPbfListingVersionLifecycleStateEnumStringValues() []string
GetPbfListingVersionLifecycleStateEnumStringValues Enumerates the set of values in String for PbfListingVersionLifecycleStateEnum
func GetRuntimeConfigRuntimeConfigTypeEnumStringValues() []string
GetRuntimeConfigRuntimeConfigTypeEnumStringValues Enumerates the set of values in String for RuntimeConfigRuntimeConfigTypeEnum
func GetSuccessDestinationDetailsKindEnumStringValues() []string
GetSuccessDestinationDetailsKindEnumStringValues Enumerates the set of values in String for SuccessDestinationDetailsKindEnum
func GetUpdateArchiveSourceDetailsArchiveSourceTypeEnumStringValues() []string
GetUpdateArchiveSourceDetailsArchiveSourceTypeEnumStringValues Enumerates the set of values in String for UpdateArchiveSourceDetailsArchiveSourceTypeEnum
func GetUpdateFunctionSourceDetailsSourceTypeEnumStringValues() []string
GetUpdateFunctionSourceDetailsSourceTypeEnumStringValues Enumerates the set of values in String for UpdateFunctionSourceDetailsSourceTypeEnum
func GetUpdateRuntimeConfigRuntimeConfigTypeEnumStringValues() []string
GetUpdateRuntimeConfigRuntimeConfigTypeEnumStringValues Enumerates the set of values in String for UpdateRuntimeConfigRuntimeConfigTypeEnum
func GetWorkRequestResourceMetadataKeyEnumStringValues() []string
GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
Application An application contains functions and defined attributes shared between those functions, such as network configuration and configuration. Avoid entering confidential information.
type Application struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains the application.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The display name of the application. The display name is unique within the compartment containing the application.
DisplayName *string `mandatory:"false" json:"displayName"`
// The current state of the application.
LifecycleState ApplicationLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Application configuration for functions in this application (passed as environment variables). Can be overridden by function configuration.
// Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters.
// Example: `{"MY_FUNCTION_CONFIG": "ConfVal"}`
// The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8.
Config map[string]string `mandatory:"false" json:"config"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the subnets in which to run functions in the application.
SubnetIds []string `mandatory:"false" json:"subnetIds"`
// Valid values are `GENERIC_X86`, `GENERIC_ARM` and `GENERIC_X86_ARM`. Default is `GENERIC_X86`. Setting this to `GENERIC_X86`, will run the functions in the application on X86 processor architecture.
// Setting this to `GENERIC_ARM`, will run the functions in the application on ARM processor architecture.
// When set to `GENERIC_X86_ARM`, functions in the application are run on either X86 or ARM processor architecture.
// Accepted values are:
// `GENERIC_X86`, `GENERIC_ARM`, `GENERIC_X86_ARM`
Shape ApplicationShapeEnum `mandatory:"false" json:"shape,omitempty"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the Network Security Groups to add the application to.
NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`
// A syslog URL to which to send all function logs. Supports tcp, udp, and tcp+tls.
// The syslog URL must be reachable from all of the subnets configured for the application.
// Note: If you enable the OCI Logging service for this application, the syslogUrl value is ignored. Function logs are sent to the OCI Logging service, and not to the syslog URL.
// Example: `tcp://logserver.myserver:1234`
SyslogUrl *string `mandatory:"false" json:"syslogUrl"`
TraceConfig *ApplicationTraceConfig `mandatory:"false" json:"traceConfig"`
Logging *ApplicationLoggingConfig `mandatory:"false" json:"logging"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The time the application was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2018-09-12T22:47:12.613Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the application was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2018-09-12T22:47:12.613Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
ImagePolicyConfig *ImagePolicyConfig `mandatory:"false" json:"imagePolicyConfig"`
// Security attributes for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
SecurityAttributes map[string]map[string]interface{} `mandatory:"false" json:"securityAttributes"`
}
func (m Application) String() string
func (m Application) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ApplicationLifecycleStateEnum Enum with underlying type: string
type ApplicationLifecycleStateEnum string
Set of constants representing the allowable values for ApplicationLifecycleStateEnum
const (
ApplicationLifecycleStateCreating ApplicationLifecycleStateEnum = "CREATING"
ApplicationLifecycleStateActive ApplicationLifecycleStateEnum = "ACTIVE"
ApplicationLifecycleStateInactive ApplicationLifecycleStateEnum = "INACTIVE"
ApplicationLifecycleStateUpdating ApplicationLifecycleStateEnum = "UPDATING"
ApplicationLifecycleStateDeleting ApplicationLifecycleStateEnum = "DELETING"
ApplicationLifecycleStateDeleted ApplicationLifecycleStateEnum = "DELETED"
ApplicationLifecycleStateFailed ApplicationLifecycleStateEnum = "FAILED"
)
func GetApplicationLifecycleStateEnumValues() []ApplicationLifecycleStateEnum
GetApplicationLifecycleStateEnumValues Enumerates the set of values for ApplicationLifecycleStateEnum
func GetMappingApplicationLifecycleStateEnum(val string) (ApplicationLifecycleStateEnum, bool)
GetMappingApplicationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ApplicationLoggingConfig Set logging configuration for an application. This is only used if Service Logs for the application are enabled in the OCI Logging service.
type ApplicationLoggingConfig struct {
// Specify the format of log lines emitted by functions in this application.
LineFormat ApplicationLoggingConfigLineFormatEnum `mandatory:"false" json:"lineFormat,omitempty"`
}
func (m ApplicationLoggingConfig) String() string
func (m ApplicationLoggingConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ApplicationLoggingConfigLineFormatEnum Enum with underlying type: string
type ApplicationLoggingConfigLineFormatEnum string
Set of constants representing the allowable values for ApplicationLoggingConfigLineFormatEnum
const (
ApplicationLoggingConfigLineFormatJson ApplicationLoggingConfigLineFormatEnum = "JSON"
ApplicationLoggingConfigLineFormatPlainText ApplicationLoggingConfigLineFormatEnum = "PLAIN_TEXT"
)
func GetApplicationLoggingConfigLineFormatEnumValues() []ApplicationLoggingConfigLineFormatEnum
GetApplicationLoggingConfigLineFormatEnumValues Enumerates the set of values for ApplicationLoggingConfigLineFormatEnum
func GetMappingApplicationLoggingConfigLineFormatEnum(val string) (ApplicationLoggingConfigLineFormatEnum, bool)
GetMappingApplicationLoggingConfigLineFormatEnum performs case Insensitive comparison on enum value and return the desired enum
ApplicationShapeEnum Enum with underlying type: string
type ApplicationShapeEnum string
Set of constants representing the allowable values for ApplicationShapeEnum
const (
ApplicationShapeX86 ApplicationShapeEnum = "GENERIC_X86"
ApplicationShapeArm ApplicationShapeEnum = "GENERIC_ARM"
ApplicationShapeX86Arm ApplicationShapeEnum = "GENERIC_X86_ARM"
)
func GetApplicationShapeEnumValues() []ApplicationShapeEnum
GetApplicationShapeEnumValues Enumerates the set of values for ApplicationShapeEnum
func GetMappingApplicationShapeEnum(val string) (ApplicationShapeEnum, bool)
GetMappingApplicationShapeEnum performs case Insensitive comparison on enum value and return the desired enum
ApplicationSummary Summary of an application.
type ApplicationSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains the application.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The display name of the application. The display name is unique within the compartment containing the application.
DisplayName *string `mandatory:"false" json:"displayName"`
// The current state of the application.
LifecycleState ApplicationLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the subnets in which to run functions in the application.
SubnetIds []string `mandatory:"false" json:"subnetIds"`
// Valid values are `GENERIC_X86`, `GENERIC_ARM` and `GENERIC_X86_ARM`. Default is `GENERIC_X86`. Setting this to `GENERIC_X86`, will run the functions in the application on X86 processor architecture.
// Setting this to `GENERIC_ARM`, will run the functions in the application on ARM processor architecture.
// When set to `GENERIC_X86_ARM`, functions in the application are run on either X86 or ARM processor architecture.
// Accepted values are:
// `GENERIC_X86`, `GENERIC_ARM`, `GENERIC_X86_ARM`
Shape ApplicationSummaryShapeEnum `mandatory:"false" json:"shape,omitempty"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the Network Security Groups to add the application to.
NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`
TraceConfig *ApplicationTraceConfig `mandatory:"false" json:"traceConfig"`
Logging *ApplicationLoggingConfig `mandatory:"false" json:"logging"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The time the application was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2018-09-12T22:47:12.613Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the application was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2018-09-12T22:47:12.613Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
ImagePolicyConfig *ImagePolicyConfig `mandatory:"false" json:"imagePolicyConfig"`
// Security attributes for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
SecurityAttributes map[string]map[string]interface{} `mandatory:"false" json:"securityAttributes"`
}
func (m ApplicationSummary) String() string
func (m ApplicationSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ApplicationSummaryShapeEnum Enum with underlying type: string
type ApplicationSummaryShapeEnum string
Set of constants representing the allowable values for ApplicationSummaryShapeEnum
const (
ApplicationSummaryShapeX86 ApplicationSummaryShapeEnum = "GENERIC_X86"
ApplicationSummaryShapeArm ApplicationSummaryShapeEnum = "GENERIC_ARM"
ApplicationSummaryShapeX86Arm ApplicationSummaryShapeEnum = "GENERIC_X86_ARM"
)
func GetApplicationSummaryShapeEnumValues() []ApplicationSummaryShapeEnum
GetApplicationSummaryShapeEnumValues Enumerates the set of values for ApplicationSummaryShapeEnum
func GetMappingApplicationSummaryShapeEnum(val string) (ApplicationSummaryShapeEnum, bool)
GetMappingApplicationSummaryShapeEnum performs case Insensitive comparison on enum value and return the desired enum
ApplicationTraceConfig Define the tracing configuration for an application.
type ApplicationTraceConfig struct {
// Define if tracing is enabled for the resource.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// The OCID of the collector (e.g. an APM Domain) trace events will be sent to.
DomainId *string `mandatory:"false" json:"domainId"`
}
func (m ApplicationTraceConfig) String() string
func (m ApplicationTraceConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ArchiveFunctionSourceDetails Object capturing fields required for creating an archive based function.
type ArchiveFunctionSourceDetails struct {
ArchiveSourceDetails ArchiveSourceDetails `mandatory:"true" json:"archiveSourceDetails"`
RuntimeConfig RuntimeConfig `mandatory:"true" json:"runtimeConfig"`
// The function handler that is executed when the function is invoked. The value of this field depends on the runtime used
Handler *string `mandatory:"false" json:"handler"`
// The SHA256 hash of the function source code archive, base64-encoded.
SourceCodeSha256 *string `mandatory:"false" json:"sourceCodeSha256"`
}
func (m ArchiveFunctionSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ArchiveFunctionSourceDetails) String() string
func (m *ArchiveFunctionSourceDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ArchiveFunctionSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ArchiveSourceDetails The details for the Archive source of the Function. This mode is used when the function code is provided as an archive, either from Object Storage or directly uploaded by the API caller. It is suitable for scenarios where the function code is packaged as a single archive file.
type ArchiveSourceDetails interface {
}
ArchiveSourceDetailsArchiveSourceTypeEnum Enum with underlying type: string
type ArchiveSourceDetailsArchiveSourceTypeEnum string
Set of constants representing the allowable values for ArchiveSourceDetailsArchiveSourceTypeEnum
const (
ArchiveSourceDetailsArchiveSourceTypeObjectStorageArchive ArchiveSourceDetailsArchiveSourceTypeEnum = "OBJECT_STORAGE_ARCHIVE"
ArchiveSourceDetailsArchiveSourceTypeDirectArchive ArchiveSourceDetailsArchiveSourceTypeEnum = "DIRECT_ARCHIVE"
)
func GetArchiveSourceDetailsArchiveSourceTypeEnumValues() []ArchiveSourceDetailsArchiveSourceTypeEnum
GetArchiveSourceDetailsArchiveSourceTypeEnumValues Enumerates the set of values for ArchiveSourceDetailsArchiveSourceTypeEnum
func GetMappingArchiveSourceDetailsArchiveSourceTypeEnum(val string) (ArchiveSourceDetailsArchiveSourceTypeEnum, bool)
GetMappingArchiveSourceDetailsArchiveSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.
type CancelWorkRequestRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// 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 unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelWorkRequestRequest) String() string
func (request CancelWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelWorkRequestResponse wrapper for the CancelWorkRequest operation
type CancelWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelWorkRequestResponse) String() string
ChangeApplicationCompartmentDetails Properties to change the compartment of an application.
type ChangeApplicationCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment
// into which the resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeApplicationCompartmentDetails) String() string
func (m ChangeApplicationCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeApplicationCompartmentRequest wrapper for the ChangeApplicationCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ChangeApplicationCompartment.go.html to see an example of how to use ChangeApplicationCompartmentRequest.
type ChangeApplicationCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this application.
ApplicationId *string `mandatory:"true" contributesTo:"path" name:"applicationId"`
// Properties to change the compartment of an application.
ChangeApplicationCompartmentDetails `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 unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeApplicationCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeApplicationCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeApplicationCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeApplicationCompartmentRequest) String() string
func (request ChangeApplicationCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeApplicationCompartmentResponse wrapper for the ChangeApplicationCompartment operation
type ChangeApplicationCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response ChangeApplicationCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeApplicationCompartmentResponse) String() string
ConfigDetails Details about the required and optional Function configurations needed for proper performance of the PBF.
type ConfigDetails struct {
// The key name of the config param.
Key *string `mandatory:"true" json:"key"`
// Details about why this config is required and what it will be used for.
Description *string `mandatory:"true" json:"description"`
// Is this a required config or an optional one. Requests with required config params missing will be rejected.
IsOptional *bool `mandatory:"false" json:"isOptional"`
}
func (m ConfigDetails) String() string
func (m ConfigDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ConstantProvisionedConcurrencyConfig Configuration specifying a constant amount of provisioned concurrency.
type ConstantProvisionedConcurrencyConfig struct {
// Configuration specifying a constant amount of provisioned concurrency.
Count *int `mandatory:"true" json:"count"`
}
func (m ConstantProvisionedConcurrencyConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ConstantProvisionedConcurrencyConfig) String() string
func (m ConstantProvisionedConcurrencyConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ContainerImageFunctionSourceDetails Source details of a container image based function.
type ContainerImageFunctionSourceDetails struct {
// The qualified name of the Docker image to use in the function, including the image tag.
// The image should be in the OCI Registry that is in the same region as the function itself.
// Example: `phx.ocir.io/ten/functions/function:0.0.1`
Image *string `mandatory:"false" json:"image"`
// The image digest for the version of the image that will be pulled when invoking this function.
// If no value is specified, the digest currently associated with the image in the OCI Registry will be used.
// Example: `sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7`
ImageDigest *string `mandatory:"false" json:"imageDigest"`
}
func (m ContainerImageFunctionSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ContainerImageFunctionSourceDetails) String() string
func (m ContainerImageFunctionSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateApplicationDetails Properties for a new application.
type CreateApplicationDetails struct {
// The OCID of the compartment to create the application within.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The display name of the application. The display name must be unique within the compartment containing the application. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the subnets in which to run functions in the application.
SubnetIds []string `mandatory:"true" json:"subnetIds"`
// Application configuration. These values are passed on to the function as environment variables, functions may override application configuration.
// Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters.
// Example: `{"MY_FUNCTION_CONFIG": "ConfVal"}`
// The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8.
Config map[string]string `mandatory:"false" json:"config"`
// Valid values are `GENERIC_X86`, `GENERIC_ARM` and `GENERIC_X86_ARM`. Default is `GENERIC_X86`. Setting this to `GENERIC_X86`, will run the functions in the application on X86 processor architecture.
// Setting this to `GENERIC_ARM`, will run the functions in the application on ARM processor architecture.
// When set to `GENERIC_X86_ARM`, functions in the application are run on either X86 or ARM processor architecture.
// Accepted values are:
// `GENERIC_X86`, `GENERIC_ARM`, `GENERIC_X86_ARM`
Shape CreateApplicationDetailsShapeEnum `mandatory:"false" json:"shape,omitempty"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the Network Security Groups to add the application to.
NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`
// A syslog URL to which to send all function logs. Supports tcp, udp, and tcp+tls.
// The syslog URL must be reachable from all of the subnets configured for the application.
// Note: If you enable the OCI Logging service for this application, the syslogUrl value is ignored. Function logs are sent to the OCI Logging service, and not to the syslog URL.
// Example: `tcp://logserver.myserver:1234`
SyslogUrl *string `mandatory:"false" json:"syslogUrl"`
TraceConfig *ApplicationTraceConfig `mandatory:"false" json:"traceConfig"`
Logging *ApplicationLoggingConfig `mandatory:"false" json:"logging"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
ImagePolicyConfig *ImagePolicyConfig `mandatory:"false" json:"imagePolicyConfig"`
// Security attributes for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
SecurityAttributes map[string]map[string]interface{} `mandatory:"false" json:"securityAttributes"`
}
func (m CreateApplicationDetails) String() string
func (m CreateApplicationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateApplicationDetailsShapeEnum Enum with underlying type: string
type CreateApplicationDetailsShapeEnum string
Set of constants representing the allowable values for CreateApplicationDetailsShapeEnum
const (
CreateApplicationDetailsShapeX86 CreateApplicationDetailsShapeEnum = "GENERIC_X86"
CreateApplicationDetailsShapeArm CreateApplicationDetailsShapeEnum = "GENERIC_ARM"
CreateApplicationDetailsShapeX86Arm CreateApplicationDetailsShapeEnum = "GENERIC_X86_ARM"
)
func GetCreateApplicationDetailsShapeEnumValues() []CreateApplicationDetailsShapeEnum
GetCreateApplicationDetailsShapeEnumValues Enumerates the set of values for CreateApplicationDetailsShapeEnum
func GetMappingCreateApplicationDetailsShapeEnum(val string) (CreateApplicationDetailsShapeEnum, bool)
GetMappingCreateApplicationDetailsShapeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateApplicationRequest wrapper for the CreateApplication operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/CreateApplication.go.html to see an example of how to use CreateApplicationRequest.
type CreateApplicationRequest struct {
// Specification of the application to create
CreateApplicationDetails `contributesTo:"body"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateApplicationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateApplicationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateApplicationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateApplicationRequest) String() string
func (request CreateApplicationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateApplicationResponse wrapper for the CreateApplication operation
type CreateApplicationResponse struct {
// The underlying http response
RawResponse *http.Response
// The Application instance
Application `presentIn:"body"`
// For optimistic concurrency control. Add this value to the `if-match` parameter
// in a PUT or DELETE operation. The resource will be updated only if the value you
// provide matches the `etag` on the resource.
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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CreateApplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateApplicationResponse) String() string
CreateArchiveFunctionSourceDetails Source details for creating an archive‑based function.
type CreateArchiveFunctionSourceDetails struct {
ArchiveSourceDetails CreateArchiveSourceDetails `mandatory:"true" json:"archiveSourceDetails"`
RuntimeConfig CreateRuntimeConfig `mandatory:"true" json:"runtimeConfig"`
// The function handler that is executed when the function is invoked. The value of this field depends on the runtime used
Handler *string `mandatory:"false" json:"handler"`
}
func (m CreateArchiveFunctionSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateArchiveFunctionSourceDetails) String() string
func (m *CreateArchiveFunctionSourceDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateArchiveFunctionSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateArchiveSourceDetails The details required to create an Archive-based function source. This mode is used when the function code is provided as an archive, either from Object Storage or directly uploaded by the API caller. It is suitable for scenarios where the function code is packaged as a single archive file.
type CreateArchiveSourceDetails interface {
}
CreateArchiveSourceDetailsArchiveSourceTypeEnum Enum with underlying type: string
type CreateArchiveSourceDetailsArchiveSourceTypeEnum string
Set of constants representing the allowable values for CreateArchiveSourceDetailsArchiveSourceTypeEnum
const (
CreateArchiveSourceDetailsArchiveSourceTypeObjectStorageArchive CreateArchiveSourceDetailsArchiveSourceTypeEnum = "OBJECT_STORAGE_ARCHIVE"
CreateArchiveSourceDetailsArchiveSourceTypeDirectArchive CreateArchiveSourceDetailsArchiveSourceTypeEnum = "DIRECT_ARCHIVE"
)
func GetCreateArchiveSourceDetailsArchiveSourceTypeEnumValues() []CreateArchiveSourceDetailsArchiveSourceTypeEnum
GetCreateArchiveSourceDetailsArchiveSourceTypeEnumValues Enumerates the set of values for CreateArchiveSourceDetailsArchiveSourceTypeEnum
func GetMappingCreateArchiveSourceDetailsArchiveSourceTypeEnum(val string) (CreateArchiveSourceDetailsArchiveSourceTypeEnum, bool)
GetMappingCreateArchiveSourceDetailsArchiveSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateContainerImageFunctionSourceDetails Source details for creating a container image based function.
type CreateContainerImageFunctionSourceDetails struct {
// The qualified name of the Docker image to use in the function, including the image tag.
// The image should be in the OCI Registry that is in the same region as the function itself.
// Example: `phx.ocir.io/ten/functions/function:0.0.1`
Image *string `mandatory:"true" json:"image"`
// The image digest for the version of the image that will be pulled when invoking this function.
// If no value is specified, the digest currently associated with the image in the OCI Registry will be used.
// Example: `sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7`
ImageDigest *string `mandatory:"false" json:"imageDigest"`
}
func (m CreateContainerImageFunctionSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateContainerImageFunctionSourceDetails) String() string
func (m CreateContainerImageFunctionSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateDirectArchiveSourceDetails Source details for creating the archive based function from Direct Archive. This allows the API caller to directly upload the function code as a base64-encoded archive file. It is useful when the caller wants to provide the code inline during function creation.
type CreateDirectArchiveSourceDetails struct {
// The base64-encoded archive file of the function code. The archive file must contain all the files for the function. Please refer to functions documentation for maximum allowed size and supported archive formats.
ArchiveFile []byte `mandatory:"true" json:"archiveFile"`
}
func (m CreateDirectArchiveSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDirectArchiveSourceDetails) String() string
func (m CreateDirectArchiveSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateFunctionDetails Properties to create a new function.
type CreateFunctionDetails struct {
// The display name of the function. The display name must be unique within the application containing the function. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the application this function belongs to.
ApplicationId *string `mandatory:"true" json:"applicationId"`
SourceDetails CreateFunctionSourceDetails `mandatory:"true" json:"sourceDetails"`
// Maximum usable memory for the function (MiB).
MemoryInMBs *int64 `mandatory:"true" json:"memoryInMBs"`
// Function configuration. These values are passed on to the function as environment variables, this overrides application configuration values.
// Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters.
// Example: `{"MY_FUNCTION_CONFIG": "ConfVal"}`
// The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8.
Config map[string]string `mandatory:"false" json:"config"`
// Timeout for executions of the function. Value in seconds.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
ProvisionedConcurrencyConfig FunctionProvisionedConcurrencyConfig `mandatory:"false" json:"provisionedConcurrencyConfig"`
// Timeout for detached function invocations. Value in seconds.
DetachedModeTimeoutInSeconds *int `mandatory:"false" json:"detachedModeTimeoutInSeconds"`
FailureDestination FailureDestinationDetails `mandatory:"false" json:"failureDestination"`
SuccessDestination SuccessDestinationDetails `mandatory:"false" json:"successDestination"`
TraceConfig *FunctionTraceConfig `mandatory:"false" json:"traceConfig"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateFunctionDetails) String() string
func (m *CreateFunctionDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateFunctionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateFunctionRequest wrapper for the CreateFunction operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/CreateFunction.go.html to see an example of how to use CreateFunctionRequest.
type CreateFunctionRequest struct {
// Specification of the function to create
CreateFunctionDetails `contributesTo:"body"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateFunctionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateFunctionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateFunctionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateFunctionRequest) String() string
func (request CreateFunctionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateFunctionResponse wrapper for the CreateFunction operation
type CreateFunctionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Function instance
Function `presentIn:"body"`
// For optimistic concurrency control. Add this value to the `if-match` parameter
// in a PUT or DELETE operation. The resource will be updated only if the value you
// provide matches the `etag` on the resource.
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"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CreateFunctionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateFunctionResponse) String() string
CreateFunctionSourceDetails The source details for creating the Function. The function can be created from various sources.
type CreateFunctionSourceDetails interface {
}
CreateFunctionSourceDetailsSourceTypeEnum Enum with underlying type: string
type CreateFunctionSourceDetailsSourceTypeEnum string
Set of constants representing the allowable values for CreateFunctionSourceDetailsSourceTypeEnum
const (
CreateFunctionSourceDetailsSourceTypePreBuiltFunctions CreateFunctionSourceDetailsSourceTypeEnum = "PRE_BUILT_FUNCTIONS"
CreateFunctionSourceDetailsSourceTypeArchive CreateFunctionSourceDetailsSourceTypeEnum = "ARCHIVE"
CreateFunctionSourceDetailsSourceTypeContainerImage CreateFunctionSourceDetailsSourceTypeEnum = "CONTAINER_IMAGE"
)
func GetCreateFunctionSourceDetailsSourceTypeEnumValues() []CreateFunctionSourceDetailsSourceTypeEnum
GetCreateFunctionSourceDetailsSourceTypeEnumValues Enumerates the set of values for CreateFunctionSourceDetailsSourceTypeEnum
func GetMappingCreateFunctionSourceDetailsSourceTypeEnum(val string) (CreateFunctionSourceDetailsSourceTypeEnum, bool)
GetMappingCreateFunctionSourceDetailsSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateFunctionUpdateRuntimeConfig FunctionsRuntime configuration for creating a function with 'FUNCTION_UPDATE' Runtime Update strategy.
type CreateFunctionUpdateRuntimeConfig struct {
// The name of the FunctionsRuntime this function is to be associated with.
FunctionsRuntimeName *string `mandatory:"true" json:"functionsRuntimeName"`
}
func (m CreateFunctionUpdateRuntimeConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateFunctionUpdateRuntimeConfig) String() string
func (m CreateFunctionUpdateRuntimeConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateManualRuntimeConfig FunctionsRuntime configuration for creating a function with 'MANUAL' Runtime Update strategy.
type CreateManualRuntimeConfig struct {
// The name of the FunctionsRuntime this function is to be associated with.
FunctionsRuntimeName *string `mandatory:"true" json:"functionsRuntimeName"`
// The OCID of the FunctionsRuntimeVersion to use for the Function in manual mode.
FunctionsRuntimeVersionId *string `mandatory:"true" json:"functionsRuntimeVersionId"`
}
func (m CreateManualRuntimeConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateManualRuntimeConfig) String() string
func (m CreateManualRuntimeConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateObjectStorageArchiveSourceDetails Source details for creating the archive based function from Object Storage. This is used when the function code is stored in Object Storage. It is suitable for scenarios where the function code is uploaded as an archive file to a specific bucket and namespace
type CreateObjectStorageArchiveSourceDetails struct {
// The name of the Object Storage bucket.
BucketName *string `mandatory:"true" json:"bucketName"`
// The Object Storage namespace.
Namespace *string `mandatory:"true" json:"namespace"`
// The name of the Object Storage object.
ObjectName *string `mandatory:"true" json:"objectName"`
// VersionId used to identify a particular version of the object. If not specified, the latest version of the object is used.
ObjectVersionId *string `mandatory:"false" json:"objectVersionId"`
}
func (m CreateObjectStorageArchiveSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateObjectStorageArchiveSourceDetails) String() string
func (m CreateObjectStorageArchiveSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreatePreBuiltFunctionSourceDetails Source details for creating a function from a Pre‑Built Functions listing (PbfListing).
type CreatePreBuiltFunctionSourceDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PbfListing this
// function is sourced from.
PbfListingId *string `mandatory:"true" json:"pbfListingId"`
}
func (m CreatePreBuiltFunctionSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreatePreBuiltFunctionSourceDetails) String() string
func (m CreatePreBuiltFunctionSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateRuntimeConfig FunctionsRuntime configuration used to create a function.
type CreateRuntimeConfig interface {
}
CreateRuntimeConfigRuntimeConfigTypeEnum Enum with underlying type: string
type CreateRuntimeConfigRuntimeConfigTypeEnum string
Set of constants representing the allowable values for CreateRuntimeConfigRuntimeConfigTypeEnum
const (
CreateRuntimeConfigRuntimeConfigTypeFunctionUpdate CreateRuntimeConfigRuntimeConfigTypeEnum = "FUNCTION_UPDATE"
CreateRuntimeConfigRuntimeConfigTypeManual CreateRuntimeConfigRuntimeConfigTypeEnum = "MANUAL"
)
func GetCreateRuntimeConfigRuntimeConfigTypeEnumValues() []CreateRuntimeConfigRuntimeConfigTypeEnum
GetCreateRuntimeConfigRuntimeConfigTypeEnumValues Enumerates the set of values for CreateRuntimeConfigRuntimeConfigTypeEnum
func GetMappingCreateRuntimeConfigRuntimeConfigTypeEnum(val string) (CreateRuntimeConfigRuntimeConfigTypeEnum, bool)
GetMappingCreateRuntimeConfigRuntimeConfigTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DeleteApplicationRequest wrapper for the DeleteApplication operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/DeleteApplication.go.html to see an example of how to use DeleteApplicationRequest.
type DeleteApplicationRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this application.
ApplicationId *string `mandatory:"true" contributesTo:"path" name:"applicationId"`
// 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 unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteApplicationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteApplicationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteApplicationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteApplicationRequest) String() string
func (request DeleteApplicationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteApplicationResponse wrapper for the DeleteApplication operation
type DeleteApplicationResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response DeleteApplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteApplicationResponse) String() string
DeleteFunctionRequest wrapper for the DeleteFunction operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/DeleteFunction.go.html to see an example of how to use DeleteFunctionRequest.
type DeleteFunctionRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this function.
FunctionId *string `mandatory:"true" contributesTo:"path" name:"functionId"`
// 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 unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteFunctionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteFunctionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteFunctionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteFunctionRequest) String() string
func (request DeleteFunctionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteFunctionResponse wrapper for the DeleteFunction operation
type DeleteFunctionResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response DeleteFunctionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteFunctionResponse) String() string
DirectArchiveSourceDetails The details for the Archive source of the Function from Direct Archive. This allows the API caller to directly upload the function code as a base64-encoded archive file. It is useful when the caller wants to provide the code inline during function creation.
type DirectArchiveSourceDetails struct {
}
func (m DirectArchiveSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DirectArchiveSourceDetails) String() string
func (m DirectArchiveSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FailureDestinationDetails An object that represents the destination to which Oracle Functions will send an invocation record with the details of the error of the failed detached function invocation. A notification is an example of a failure destination. Example: `{"kind": "NOTIFICATION", "topicId": "topic_OCID"}`
type FailureDestinationDetails interface {
}
FailureDestinationDetailsKindEnum Enum with underlying type: string
type FailureDestinationDetailsKindEnum string
Set of constants representing the allowable values for FailureDestinationDetailsKindEnum
const (
FailureDestinationDetailsKindNotification FailureDestinationDetailsKindEnum = "NOTIFICATION"
FailureDestinationDetailsKindQueue FailureDestinationDetailsKindEnum = "QUEUE"
FailureDestinationDetailsKindStream FailureDestinationDetailsKindEnum = "STREAM"
FailureDestinationDetailsKindNone FailureDestinationDetailsKindEnum = "NONE"
)
func GetFailureDestinationDetailsKindEnumValues() []FailureDestinationDetailsKindEnum
GetFailureDestinationDetailsKindEnumValues Enumerates the set of values for FailureDestinationDetailsKindEnum
func GetMappingFailureDestinationDetailsKindEnum(val string) (FailureDestinationDetailsKindEnum, bool)
GetMappingFailureDestinationDetailsKindEnum performs case Insensitive comparison on enum value and return the desired enum
Function A function resource defines the code (Docker image) and configuration for a specific function. Functions are defined in applications. Avoid entering confidential information.
type Function struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the function.
Id *string `mandatory:"true" json:"id"`
SourceDetails FunctionSourceDetails `mandatory:"true" json:"sourceDetails"`
// The display name of the function. The display name is unique within the application containing the function.
DisplayName *string `mandatory:"false" json:"displayName"`
// The current state of the function.
LifecycleState FunctionLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The OCID of the application the function belongs to.
ApplicationId *string `mandatory:"false" json:"applicationId"`
// The OCID of the compartment that contains the function.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The processor shape (`GENERIC_X86`/`GENERIC_ARM`) on which to run functions in the application, extracted from the image manifest.
Shape FunctionShapeEnum `mandatory:"false" json:"shape,omitempty"`
// Maximum usable memory for the function (MiB).
MemoryInMBs *int64 `mandatory:"false" json:"memoryInMBs"`
// Function configuration. Overrides application configuration.
// Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters.
// Example: `{"MY_FUNCTION_CONFIG": "ConfVal"}`
// The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8.
Config map[string]string `mandatory:"false" json:"config"`
// Timeout for executions of the function. Value in seconds.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
ProvisionedConcurrencyConfig FunctionProvisionedConcurrencyConfig `mandatory:"false" json:"provisionedConcurrencyConfig"`
// Timeout for detached function invocations. Value in seconds.
// Example: `{"detachedModeTimeoutInSeconds": 900}`
DetachedModeTimeoutInSeconds *int `mandatory:"false" json:"detachedModeTimeoutInSeconds"`
FailureDestination FailureDestinationDetails `mandatory:"false" json:"failureDestination"`
SuccessDestination SuccessDestinationDetails `mandatory:"false" json:"successDestination"`
TraceConfig *FunctionTraceConfig `mandatory:"false" json:"traceConfig"`
// 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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The base https invoke URL to set on a client in order to invoke a function. This URL will never change over the lifetime of the function and can be cached.
InvokeEndpoint *string `mandatory:"false" json:"invokeEndpoint"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The time the function was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2018-09-12T22:47:12.613Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the function was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2018-09-12T22:47:12.613Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m Function) String() string
func (m *Function) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m Function) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FunctionLifecycleStateEnum Enum with underlying type: string
type FunctionLifecycleStateEnum string
Set of constants representing the allowable values for FunctionLifecycleStateEnum
const (
FunctionLifecycleStateCreating FunctionLifecycleStateEnum = "CREATING"
FunctionLifecycleStateActive FunctionLifecycleStateEnum = "ACTIVE"
FunctionLifecycleStateInactive FunctionLifecycleStateEnum = "INACTIVE"
FunctionLifecycleStateUpdating FunctionLifecycleStateEnum = "UPDATING"
FunctionLifecycleStateDeleting FunctionLifecycleStateEnum = "DELETING"
FunctionLifecycleStateDeleted FunctionLifecycleStateEnum = "DELETED"
FunctionLifecycleStateFailed FunctionLifecycleStateEnum = "FAILED"
)
func GetFunctionLifecycleStateEnumValues() []FunctionLifecycleStateEnum
GetFunctionLifecycleStateEnumValues Enumerates the set of values for FunctionLifecycleStateEnum
func GetMappingFunctionLifecycleStateEnum(val string) (FunctionLifecycleStateEnum, bool)
GetMappingFunctionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
FunctionProvisionedConcurrencyConfig Define the strategy for provisioned concurrency for the function.
type FunctionProvisionedConcurrencyConfig interface {
}
FunctionProvisionedConcurrencyConfigStrategyEnum Enum with underlying type: string
type FunctionProvisionedConcurrencyConfigStrategyEnum string
Set of constants representing the allowable values for FunctionProvisionedConcurrencyConfigStrategyEnum
const (
FunctionProvisionedConcurrencyConfigStrategyConstant FunctionProvisionedConcurrencyConfigStrategyEnum = "CONSTANT"
FunctionProvisionedConcurrencyConfigStrategyNone FunctionProvisionedConcurrencyConfigStrategyEnum = "NONE"
)
func GetFunctionProvisionedConcurrencyConfigStrategyEnumValues() []FunctionProvisionedConcurrencyConfigStrategyEnum
GetFunctionProvisionedConcurrencyConfigStrategyEnumValues Enumerates the set of values for FunctionProvisionedConcurrencyConfigStrategyEnum
func GetMappingFunctionProvisionedConcurrencyConfigStrategyEnum(val string) (FunctionProvisionedConcurrencyConfigStrategyEnum, bool)
GetMappingFunctionProvisionedConcurrencyConfigStrategyEnum performs case Insensitive comparison on enum value and return the desired enum
FunctionShapeEnum Enum with underlying type: string
type FunctionShapeEnum string
Set of constants representing the allowable values for FunctionShapeEnum
const (
FunctionShapeX86 FunctionShapeEnum = "GENERIC_X86"
FunctionShapeArm FunctionShapeEnum = "GENERIC_ARM"
FunctionShapeX86Arm FunctionShapeEnum = "GENERIC_X86_ARM"
)
func GetFunctionShapeEnumValues() []FunctionShapeEnum
GetFunctionShapeEnumValues Enumerates the set of values for FunctionShapeEnum
func GetMappingFunctionShapeEnum(val string) (FunctionShapeEnum, bool)
GetMappingFunctionShapeEnum performs case Insensitive comparison on enum value and return the desired enum
FunctionSourceDetails The source details for the Function. The function can be created from various sources.
type FunctionSourceDetails interface {
}
FunctionSourceDetailsSourceTypeEnum Enum with underlying type: string
type FunctionSourceDetailsSourceTypeEnum string
Set of constants representing the allowable values for FunctionSourceDetailsSourceTypeEnum
const (
FunctionSourceDetailsSourceTypePreBuiltFunctions FunctionSourceDetailsSourceTypeEnum = "PRE_BUILT_FUNCTIONS"
FunctionSourceDetailsSourceTypeArchive FunctionSourceDetailsSourceTypeEnum = "ARCHIVE"
FunctionSourceDetailsSourceTypeContainerImage FunctionSourceDetailsSourceTypeEnum = "CONTAINER_IMAGE"
)
func GetFunctionSourceDetailsSourceTypeEnumValues() []FunctionSourceDetailsSourceTypeEnum
GetFunctionSourceDetailsSourceTypeEnumValues Enumerates the set of values for FunctionSourceDetailsSourceTypeEnum
func GetMappingFunctionSourceDetailsSourceTypeEnum(val string) (FunctionSourceDetailsSourceTypeEnum, bool)
GetMappingFunctionSourceDetailsSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
FunctionSummary Summary of a function.
type FunctionSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the function.
Id *string `mandatory:"true" json:"id"`
// The display name of the function. The display name is unique within the application containing the function.
DisplayName *string `mandatory:"false" json:"displayName"`
// The OCID of the application the function belongs to.
ApplicationId *string `mandatory:"false" json:"applicationId"`
// The OCID of the compartment that contains the function.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The current state of the function.
LifecycleState FunctionLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
SourceDetails FunctionSourceDetails `mandatory:"false" json:"sourceDetails"`
// The processor shape (`GENERIC_X86`/`GENERIC_ARM`) on which to run functions in the application, extracted from the image manifest.
Shape FunctionSummaryShapeEnum `mandatory:"false" json:"shape,omitempty"`
// Maximum usable memory for the function (MiB).
MemoryInMBs *int64 `mandatory:"false" json:"memoryInMBs"`
// Timeout for executions of the function. Value in seconds.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
ProvisionedConcurrencyConfig FunctionProvisionedConcurrencyConfig `mandatory:"false" json:"provisionedConcurrencyConfig"`
// Timeout for detached function invocations. Value in seconds.
DetachedModeTimeoutInSeconds *int `mandatory:"false" json:"detachedModeTimeoutInSeconds"`
FailureDestination FailureDestinationDetails `mandatory:"false" json:"failureDestination"`
SuccessDestination SuccessDestinationDetails `mandatory:"false" json:"successDestination"`
TraceConfig *FunctionTraceConfig `mandatory:"false" json:"traceConfig"`
// 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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The base https invoke URL to set on a client in order to invoke a function. This URL will never change over the lifetime of the function and can be cached.
InvokeEndpoint *string `mandatory:"false" json:"invokeEndpoint"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The time the function was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2018-09-12T22:47:12.613Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the function was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339)
// timestamp format.
// Example: `2018-09-12T22:47:12.613Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m FunctionSummary) String() string
func (m *FunctionSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m FunctionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FunctionSummaryShapeEnum Enum with underlying type: string
type FunctionSummaryShapeEnum string
Set of constants representing the allowable values for FunctionSummaryShapeEnum
const (
FunctionSummaryShapeX86 FunctionSummaryShapeEnum = "GENERIC_X86"
FunctionSummaryShapeArm FunctionSummaryShapeEnum = "GENERIC_ARM"
FunctionSummaryShapeX86Arm FunctionSummaryShapeEnum = "GENERIC_X86_ARM"
)
func GetFunctionSummaryShapeEnumValues() []FunctionSummaryShapeEnum
GetFunctionSummaryShapeEnumValues Enumerates the set of values for FunctionSummaryShapeEnum
func GetMappingFunctionSummaryShapeEnum(val string) (FunctionSummaryShapeEnum, bool)
GetMappingFunctionSummaryShapeEnum performs case Insensitive comparison on enum value and return the desired enum
FunctionTraceConfig Define the tracing configuration for a function.
type FunctionTraceConfig struct {
// Define if tracing is enabled for the resource.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
}
func (m FunctionTraceConfig) String() string
func (m FunctionTraceConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FunctionUpdateRuntimeConfig FunctionsRuntime configuration for a function with 'FUNCTION_UPDATE' Runtime Update strategy.
type FunctionUpdateRuntimeConfig struct {
// The name of the FunctionsRuntime this function is to be associated with.
FunctionsRuntimeName *string `mandatory:"true" json:"functionsRuntimeName"`
// The OCID of the FunctionsRuntimeVersion that is currently in use for the function.
FunctionsRuntimeVersionId *string `mandatory:"false" json:"functionsRuntimeVersionId"`
}
func (m FunctionUpdateRuntimeConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FunctionUpdateRuntimeConfig) String() string
func (m FunctionUpdateRuntimeConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FunctionsInvokeClient a client for FunctionsInvoke
type FunctionsInvokeClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewFunctionsInvokeClientWithConfigurationProvider(configProvider common.ConfigurationProvider, endpoint string) (client FunctionsInvokeClient, err error)
NewFunctionsInvokeClientWithConfigurationProvider Creates a new default FunctionsInvoke client with the given configuration provider. the configuration provider will be used for the default signer
func NewFunctionsInvokeClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string, endpoint string) (client FunctionsInvokeClient, err error)
NewFunctionsInvokeClientWithOboToken Creates a new default FunctionsInvoke 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
func (client *FunctionsInvokeClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client FunctionsInvokeClient) InvokeFunction(ctx context.Context, request InvokeFunctionRequest) (response InvokeFunctionResponse, err error)
InvokeFunction Invokes a function
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/InvokeFunction.go.html to see an example of how to use InvokeFunction API.
FunctionsManagementClient a client for FunctionsManagement
type FunctionsManagementClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewFunctionsManagementClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client FunctionsManagementClient, err error)
NewFunctionsManagementClientWithConfigurationProvider Creates a new default FunctionsManagement client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewFunctionsManagementClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client FunctionsManagementClient, err error)
NewFunctionsManagementClientWithOboToken Creates a new default FunctionsManagement 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 (client FunctionsManagementClient) ChangeApplicationCompartment(ctx context.Context, request ChangeApplicationCompartmentRequest) (response ChangeApplicationCompartmentResponse, err error)
ChangeApplicationCompartment Moves an application into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources Between Compartments (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ChangeApplicationCompartment.go.html to see an example of how to use ChangeApplicationCompartment API. A default retry strategy applies to this operation ChangeApplicationCompartment()
func (client *FunctionsManagementClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client FunctionsManagementClient) CreateApplication(ctx context.Context, request CreateApplicationRequest) (response CreateApplicationResponse, err error)
CreateApplication Creates a new application.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/CreateApplication.go.html to see an example of how to use CreateApplication API. A default retry strategy applies to this operation CreateApplication()
func (client FunctionsManagementClient) CreateFunction(ctx context.Context, request CreateFunctionRequest) (response CreateFunctionResponse, err error)
CreateFunction Creates a new function.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/CreateFunction.go.html to see an example of how to use CreateFunction API. A default retry strategy applies to this operation CreateFunction()
func (client FunctionsManagementClient) DeleteApplication(ctx context.Context, request DeleteApplicationRequest) (response DeleteApplicationResponse, err error)
DeleteApplication Deletes an application.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/DeleteApplication.go.html to see an example of how to use DeleteApplication API. A default retry strategy applies to this operation DeleteApplication()
func (client FunctionsManagementClient) DeleteFunction(ctx context.Context, request DeleteFunctionRequest) (response DeleteFunctionResponse, err error)
DeleteFunction Deletes a function.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/DeleteFunction.go.html to see an example of how to use DeleteFunction API. A default retry strategy applies to this operation DeleteFunction()
func (client FunctionsManagementClient) GetApplication(ctx context.Context, request GetApplicationRequest) (response GetApplicationResponse, err error)
GetApplication Retrieves an application.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/GetApplication.go.html to see an example of how to use GetApplication API. A default retry strategy applies to this operation GetApplication()
func (client FunctionsManagementClient) GetFunction(ctx context.Context, request GetFunctionRequest) (response GetFunctionResponse, err error)
GetFunction Retrieves a function.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/GetFunction.go.html to see an example of how to use GetFunction API. A default retry strategy applies to this operation GetFunction()
func (client FunctionsManagementClient) GetFunctionsRuntime(ctx context.Context, request GetFunctionsRuntimeRequest) (response GetFunctionsRuntimeResponse, err error)
GetFunctionsRuntime Fetches a FunctionsRuntime by ID. Returns a FunctionsRuntime response model.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/GetFunctionsRuntime.go.html to see an example of how to use GetFunctionsRuntime API. A default retry strategy applies to this operation GetFunctionsRuntime()
func (client FunctionsManagementClient) GetFunctionsRuntimeVersion(ctx context.Context, request GetFunctionsRuntimeVersionRequest) (response GetFunctionsRuntimeVersionResponse, err error)
GetFunctionsRuntimeVersion Fetches a FunctionsRuntimeVersion by ID. Returns a FunctionsRuntimeVersion response model.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/GetFunctionsRuntimeVersion.go.html to see an example of how to use GetFunctionsRuntimeVersion API. A default retry strategy applies to this operation GetFunctionsRuntimeVersion()
func (client FunctionsManagementClient) GetPbfListing(ctx context.Context, request GetPbfListingRequest) (response GetPbfListingResponse, err error)
GetPbfListing Fetches a Pre-built Function(PBF) Listing. Returns a PbfListing response model.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/GetPbfListing.go.html to see an example of how to use GetPbfListing API. A default retry strategy applies to this operation GetPbfListing()
func (client FunctionsManagementClient) GetPbfListingVersion(ctx context.Context, request GetPbfListingVersionRequest) (response GetPbfListingVersionResponse, err error)
GetPbfListingVersion Gets a PbfListingVersion by identifier for a PbfListing.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/GetPbfListingVersion.go.html to see an example of how to use GetPbfListingVersion API. A default retry strategy applies to this operation GetPbfListingVersion()
func (client FunctionsManagementClient) ListApplications(ctx context.Context, request ListApplicationsRequest) (response ListApplicationsResponse, err error)
ListApplications Lists applications for a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListApplications.go.html to see an example of how to use ListApplications API. A default retry strategy applies to this operation ListApplications()
func (client FunctionsManagementClient) ListFunctions(ctx context.Context, request ListFunctionsRequest) (response ListFunctionsResponse, err error)
ListFunctions Lists functions for an application.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListFunctions.go.html to see an example of how to use ListFunctions API. A default retry strategy applies to this operation ListFunctions()
func (client FunctionsManagementClient) ListFunctionsRuntimeVersions(ctx context.Context, request ListFunctionsRuntimeVersionsRequest) (response ListFunctionsRuntimeVersionsResponse, err error)
ListFunctionsRuntimeVersions Fetches a wrapped list of all FunctionsRuntimeVersions. Returns a FunctionsRuntimeVersionCollection containing an array of FunctionsRuntimeVersionSummary response models.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListFunctionsRuntimeVersions.go.html to see an example of how to use ListFunctionsRuntimeVersions API. A default retry strategy applies to this operation ListFunctionsRuntimeVersions()
func (client FunctionsManagementClient) ListFunctionsRuntimes(ctx context.Context, request ListFunctionsRuntimesRequest) (response ListFunctionsRuntimesResponse, err error)
ListFunctionsRuntimes Fetches a wrapped list of all FunctionsRuntimes. Returns a FunctionsRuntimeCollection containing an array of FunctionsRuntimeSummary response models.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListFunctionsRuntimes.go.html to see an example of how to use ListFunctionsRuntimes API. A default retry strategy applies to this operation ListFunctionsRuntimes()
func (client FunctionsManagementClient) ListPbfListingVersions(ctx context.Context, request ListPbfListingVersionsRequest) (response ListPbfListingVersionsResponse, err error)
ListPbfListingVersions Fetches a wrapped list of all Pre-built Function(PBF) Listing versions. Returns a PbfListingVersionCollection containing an array of PbfListingVersionSummary response models. Note that the PbfListingIdentifier must be provided as a query parameter, otherwise an exception shall be thrown.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListPbfListingVersions.go.html to see an example of how to use ListPbfListingVersions API. A default retry strategy applies to this operation ListPbfListingVersions()
func (client FunctionsManagementClient) ListPbfListings(ctx context.Context, request ListPbfListingsRequest) (response ListPbfListingsResponse, err error)
ListPbfListings Fetches a wrapped list of all Pre-built Function(PBF) Listings. Returns a PbfListingCollection containing an array of PbfListingSummary response models.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListPbfListings.go.html to see an example of how to use ListPbfListings API. A default retry strategy applies to this operation ListPbfListings()
func (client FunctionsManagementClient) ListTriggers(ctx context.Context, request ListTriggersRequest) (response ListTriggersResponse, err error)
ListTriggers Returns a list of Triggers.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListTriggers.go.html to see an example of how to use ListTriggers API. A default retry strategy applies to this operation ListTriggers()
func (client *FunctionsManagementClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client FunctionsManagementClient) UpdateApplication(ctx context.Context, request UpdateApplicationRequest) (response UpdateApplicationResponse, err error)
UpdateApplication Modifies an application
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/UpdateApplication.go.html to see an example of how to use UpdateApplication API. A default retry strategy applies to this operation UpdateApplication()
func (client FunctionsManagementClient) UpdateFunction(ctx context.Context, request UpdateFunctionRequest) (response UpdateFunctionResponse, err error)
UpdateFunction Modifies a function
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/UpdateFunction.go.html to see an example of how to use UpdateFunction API. A default retry strategy applies to this operation UpdateFunction()
FunctionsRuntime FunctionsRuntime resources provide details about the available runtimes for consumption by the user. This resource contains details about the runtimes supported language and os etc.
type FunctionsRuntime struct {
// The OCID of the FunctionsRuntime that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// A brief descriptive name for the FunctionsRuntime. The FunctionsRuntime name must be unique, and not match any existing
// FunctionsRuntime.
Name *string `mandatory:"true" json:"name"`
// The operating system of the FunctionsRuntime. This is the OS that the FunctionsRuntime provides for execution of customer payloads.
Os *string `mandatory:"true" json:"os"`
// The programming language of the FunctionsRuntime. This is the language that the FunctionsRuntime provides for execution of customer payloads.
Language *string `mandatory:"true" json:"language"`
// The time when the FunctionsRuntime will be deprecated. An RFC3339 formatted datetime string.
TimeDeprecated *common.SDKTime `mandatory:"true" json:"timeDeprecated"`
// The time when the FunctionsRuntime will be decommissioned. An RFC3339 formatted datetime string.
TimeDecommissioned *common.SDKTime `mandatory:"true" json:"timeDecommissioned"`
// The current state of the FunctionsRuntime resource.
// - `ACTIVE`: The resource is currently active and operational.
// - `INACTIVE`: The resource is currently inactive and not operational.
LifecycleState FunctionsRuntimeLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID of the current FunctionsRuntimeVersion for this FunctionsRuntime.
CurrentFunctionsRuntimeVersionId *string `mandatory:"true" json:"currentFunctionsRuntimeVersionId"`
// The time when the FunctionsRuntime was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time when the FunctionsRuntime was updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Metadata for the FunctionsRuntime Resource.
Metadata *string `mandatory:"false" json:"metadata"`
// 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"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m FunctionsRuntime) String() string
func (m FunctionsRuntime) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FunctionsRuntimeCollection Results of a FunctionsRuntime search. Contains FunctionsRuntimeSummary items.
type FunctionsRuntimeCollection struct {
// List of FunctionsRuntimeSummary.
Items []FunctionsRuntimeSummary `mandatory:"true" json:"items"`
}
func (m FunctionsRuntimeCollection) String() string
func (m FunctionsRuntimeCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FunctionsRuntimeLifecycleStateEnum Enum with underlying type: string
type FunctionsRuntimeLifecycleStateEnum string
Set of constants representing the allowable values for FunctionsRuntimeLifecycleStateEnum
const (
FunctionsRuntimeLifecycleStateActive FunctionsRuntimeLifecycleStateEnum = "ACTIVE"
FunctionsRuntimeLifecycleStateInactive FunctionsRuntimeLifecycleStateEnum = "INACTIVE"
)
func GetFunctionsRuntimeLifecycleStateEnumValues() []FunctionsRuntimeLifecycleStateEnum
GetFunctionsRuntimeLifecycleStateEnumValues Enumerates the set of values for FunctionsRuntimeLifecycleStateEnum
func GetMappingFunctionsRuntimeLifecycleStateEnum(val string) (FunctionsRuntimeLifecycleStateEnum, bool)
GetMappingFunctionsRuntimeLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
FunctionsRuntimeSummary Summary of the FunctionsRuntime.
type FunctionsRuntimeSummary struct {
// The OCID of the FunctionsRuntime that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// A brief descriptive name for the FunctionsRuntime. The FunctionsRuntime name must be unique, and not match any existing
// FunctionsRuntime.
Name *string `mandatory:"true" json:"name"`
// The operating system of the FunctionsRuntime. This is the OS that the FunctionsRuntime provides for execution of customer payloads.
Os *string `mandatory:"true" json:"os"`
// The programming language of the FunctionsRuntime. This is the language that the FunctionsRuntime provides for execution of customer payloads.
Language *string `mandatory:"true" json:"language"`
// The time when the FunctionsRuntime will be deprecated. An RFC3339 formatted datetime string.
TimeDeprecated *common.SDKTime `mandatory:"true" json:"timeDeprecated"`
// The time when the FunctionsRuntime will be decommissioned. An RFC3339 formatted datetime string.
TimeDecommissioned *common.SDKTime `mandatory:"true" json:"timeDecommissioned"`
// The current state of the FunctionsRuntime resource.
LifecycleState FunctionsRuntimeLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID of the current FunctionsRuntimeVersion for this FunctionsRuntime.
CurrentFunctionsRuntimeVersionId *string `mandatory:"true" json:"currentFunctionsRuntimeVersionId"`
// The time when the FunctionsRuntime was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time when the FunctionsRuntime was updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// Metadata for the FunctionsRuntime Resource.
Metadata *string `mandatory:"false" json:"metadata"`
// 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"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m FunctionsRuntimeSummary) String() string
func (m FunctionsRuntimeSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FunctionsRuntimeVersion This represents a version of a FunctionsRuntime. Each new functional update to a FunctionsRuntime from the Functions team will change the image that will result in the creation of new FunctionsRuntimeVersion resource creation. This is a sub-resource of a FunctionsRuntime.
type FunctionsRuntimeVersion struct {
// The OCID of the FunctionsRuntimeVersion that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// The OCID of the FunctionsRuntime this resource version belongs to.
FunctionsRuntimeId *string `mandatory:"true" json:"functionsRuntimeId"`
// The display name of the FunctionsRuntimeVersion.
DisplayName *string `mandatory:"true" json:"displayName"`
// The version of the operating system of the FunctionsRuntime. This is the OS version that the FunctionsRuntime provides for execution of customer payloads.
OsVersion *string `mandatory:"true" json:"osVersion"`
// The version of the programming language of the FunctionsRuntime. This is the language version that the FunctionsRuntime provides for execution of customer payloads.
LanguageVersion *string `mandatory:"true" json:"languageVersion"`
// The list of supported architectures for the FunctionsRuntimeVersion.
SupportedArchitectures []FunctionsRuntimeVersionSupportedArchitecturesEnum `mandatory:"true" json:"supportedArchitectures"`
// Details of the change in the FunctionsRuntimeVersion of the FunctionsRuntime.
Metadata *string `mandatory:"true" json:"metadata"`
// The current state of the FunctionsRuntimeVersion resource.
// - `ACTIVE`: The resource is currently active and operational.
// - `INACTIVE`: The resource is currently inactive and not operational.
LifecycleState FunctionsRuntimeVersionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The time when the FunctionsRuntimeVersion was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time when the FunctionsRuntimeVersion was updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// 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"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m FunctionsRuntimeVersion) String() string
func (m FunctionsRuntimeVersion) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FunctionsRuntimeVersionCollection Results of a FunctionsRuntimeVersion search. Contains FunctionsRuntimeVersionSummary items.
type FunctionsRuntimeVersionCollection struct {
// List of FunctionsRuntimeVersionSummary.
Items []FunctionsRuntimeVersionSummary `mandatory:"true" json:"items"`
}
func (m FunctionsRuntimeVersionCollection) String() string
func (m FunctionsRuntimeVersionCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FunctionsRuntimeVersionLifecycleStateEnum Enum with underlying type: string
type FunctionsRuntimeVersionLifecycleStateEnum string
Set of constants representing the allowable values for FunctionsRuntimeVersionLifecycleStateEnum
const (
FunctionsRuntimeVersionLifecycleStateActive FunctionsRuntimeVersionLifecycleStateEnum = "ACTIVE"
FunctionsRuntimeVersionLifecycleStateInactive FunctionsRuntimeVersionLifecycleStateEnum = "INACTIVE"
)
func GetFunctionsRuntimeVersionLifecycleStateEnumValues() []FunctionsRuntimeVersionLifecycleStateEnum
GetFunctionsRuntimeVersionLifecycleStateEnumValues Enumerates the set of values for FunctionsRuntimeVersionLifecycleStateEnum
func GetMappingFunctionsRuntimeVersionLifecycleStateEnum(val string) (FunctionsRuntimeVersionLifecycleStateEnum, bool)
GetMappingFunctionsRuntimeVersionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
FunctionsRuntimeVersionSummary Summary of the FunctionsRuntimeVersion.
type FunctionsRuntimeVersionSummary struct {
// The OCID of the FunctionsRuntimeVersion that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// The OCID of the FunctionsRuntime this resource version belongs to.
FunctionsRuntimeId *string `mandatory:"true" json:"functionsRuntimeId"`
// The display name of the FunctionsRuntimeVersion.
DisplayName *string `mandatory:"true" json:"displayName"`
// The version of the operating system of the FunctionsRuntime. This is the OS version that the FunctionsRuntime provides for execution of customer payloads.
OsVersion *string `mandatory:"true" json:"osVersion"`
// The version of the programming language of the FunctionsRuntime. This is the language version that the FunctionsRuntime provides for execution of customer payloads.
LanguageVersion *string `mandatory:"true" json:"languageVersion"`
// The list of supported architectures for the FunctionsRuntimeVersion.
SupportedArchitectures []FunctionsRuntimeVersionSummarySupportedArchitecturesEnum `mandatory:"true" json:"supportedArchitectures"`
// The current state of the FunctionsRuntimeVersion resource.
LifecycleState FunctionsRuntimeVersionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Details of the change in the FunctionsRuntimeVersion of the FunctionsRuntime.
Metadata *string `mandatory:"true" json:"metadata"`
// The time when the FunctionsRuntimeVersion was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The time when the FunctionsRuntimeVersion was updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// 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"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m FunctionsRuntimeVersionSummary) String() string
func (m FunctionsRuntimeVersionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
FunctionsRuntimeVersionSummarySupportedArchitecturesEnum Enum with underlying type: string
type FunctionsRuntimeVersionSummarySupportedArchitecturesEnum string
Set of constants representing the allowable values for FunctionsRuntimeVersionSummarySupportedArchitecturesEnum
const (
FunctionsRuntimeVersionSummarySupportedArchitecturesArm FunctionsRuntimeVersionSummarySupportedArchitecturesEnum = "ARM"
FunctionsRuntimeVersionSummarySupportedArchitecturesX86 FunctionsRuntimeVersionSummarySupportedArchitecturesEnum = "X86"
)
func GetFunctionsRuntimeVersionSummarySupportedArchitecturesEnumValues() []FunctionsRuntimeVersionSummarySupportedArchitecturesEnum
GetFunctionsRuntimeVersionSummarySupportedArchitecturesEnumValues Enumerates the set of values for FunctionsRuntimeVersionSummarySupportedArchitecturesEnum
func GetMappingFunctionsRuntimeVersionSummarySupportedArchitecturesEnum(val string) (FunctionsRuntimeVersionSummarySupportedArchitecturesEnum, bool)
GetMappingFunctionsRuntimeVersionSummarySupportedArchitecturesEnum performs case Insensitive comparison on enum value and return the desired enum
FunctionsRuntimeVersionSupportedArchitecturesEnum Enum with underlying type: string
type FunctionsRuntimeVersionSupportedArchitecturesEnum string
Set of constants representing the allowable values for FunctionsRuntimeVersionSupportedArchitecturesEnum
const (
FunctionsRuntimeVersionSupportedArchitecturesArm FunctionsRuntimeVersionSupportedArchitecturesEnum = "ARM"
FunctionsRuntimeVersionSupportedArchitecturesX86 FunctionsRuntimeVersionSupportedArchitecturesEnum = "X86"
)
func GetFunctionsRuntimeVersionSupportedArchitecturesEnumValues() []FunctionsRuntimeVersionSupportedArchitecturesEnum
GetFunctionsRuntimeVersionSupportedArchitecturesEnumValues Enumerates the set of values for FunctionsRuntimeVersionSupportedArchitecturesEnum
func GetMappingFunctionsRuntimeVersionSupportedArchitecturesEnum(val string) (FunctionsRuntimeVersionSupportedArchitecturesEnum, bool)
GetMappingFunctionsRuntimeVersionSupportedArchitecturesEnum performs case Insensitive comparison on enum value and return the desired enum
GetApplicationRequest wrapper for the GetApplication operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/GetApplication.go.html to see an example of how to use GetApplicationRequest.
type GetApplicationRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this application.
ApplicationId *string `mandatory:"true" contributesTo:"path" name:"applicationId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetApplicationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetApplicationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetApplicationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetApplicationRequest) String() string
func (request GetApplicationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetApplicationResponse wrapper for the GetApplication operation
type GetApplicationResponse struct {
// The underlying http response
RawResponse *http.Response
// The Application instance
Application `presentIn:"body"`
// For optimistic concurrency control. Add this value to the `if-match` parameter
// in a PUT or DELETE operation. The resource will be updated only if the value you
// provide matches the `etag` on the resource.
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"`
}
func (response GetApplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetApplicationResponse) String() string
GetFunctionRequest wrapper for the GetFunction operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/GetFunction.go.html to see an example of how to use GetFunctionRequest.
type GetFunctionRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this function.
FunctionId *string `mandatory:"true" contributesTo:"path" name:"functionId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetFunctionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetFunctionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetFunctionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetFunctionRequest) String() string
func (request GetFunctionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetFunctionResponse wrapper for the GetFunction operation
type GetFunctionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Function instance
Function `presentIn:"body"`
// For optimistic concurrency control. Add this value to the `if-match` parameter
// in a PUT or DELETE operation. The resource will be updated only if the value you
// provide matches the `etag` on the resource.
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"`
}
func (response GetFunctionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetFunctionResponse) String() string
GetFunctionsRuntimeRequest wrapper for the GetFunctionsRuntime operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/GetFunctionsRuntime.go.html to see an example of how to use GetFunctionsRuntimeRequest.
type GetFunctionsRuntimeRequest struct {
// unique FunctionsRuntime identifier
FunctionsRuntimeId *string `mandatory:"true" contributesTo:"path" name:"functionsRuntimeId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetFunctionsRuntimeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetFunctionsRuntimeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetFunctionsRuntimeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetFunctionsRuntimeRequest) String() string
func (request GetFunctionsRuntimeRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetFunctionsRuntimeResponse wrapper for the GetFunctionsRuntime operation
type GetFunctionsRuntimeResponse struct {
// The underlying http response
RawResponse *http.Response
// The FunctionsRuntime instance
FunctionsRuntime `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"`
}
func (response GetFunctionsRuntimeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetFunctionsRuntimeResponse) String() string
GetFunctionsRuntimeVersionRequest wrapper for the GetFunctionsRuntimeVersion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/GetFunctionsRuntimeVersion.go.html to see an example of how to use GetFunctionsRuntimeVersionRequest.
type GetFunctionsRuntimeVersionRequest struct {
// unique FunctionsRuntimeVersion identifier
FunctionsRuntimeVersionId *string `mandatory:"true" contributesTo:"path" name:"functionsRuntimeVersionId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetFunctionsRuntimeVersionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetFunctionsRuntimeVersionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetFunctionsRuntimeVersionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetFunctionsRuntimeVersionRequest) String() string
func (request GetFunctionsRuntimeVersionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetFunctionsRuntimeVersionResponse wrapper for the GetFunctionsRuntimeVersion operation
type GetFunctionsRuntimeVersionResponse struct {
// The underlying http response
RawResponse *http.Response
// The FunctionsRuntimeVersion instance
FunctionsRuntimeVersion `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"`
}
func (response GetFunctionsRuntimeVersionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetFunctionsRuntimeVersionResponse) String() string
GetPbfListingRequest wrapper for the GetPbfListing operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/GetPbfListing.go.html to see an example of how to use GetPbfListingRequest.
type GetPbfListingRequest struct {
// unique PbfListing identifier
PbfListingId *string `mandatory:"true" contributesTo:"path" name:"pbfListingId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetPbfListingRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPbfListingRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPbfListingRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPbfListingRequest) String() string
func (request GetPbfListingRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetPbfListingResponse wrapper for the GetPbfListing operation
type GetPbfListingResponse struct {
// The underlying http response
RawResponse *http.Response
// The PbfListing instance
PbfListing `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"`
}
func (response GetPbfListingResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPbfListingResponse) String() string
GetPbfListingVersionRequest wrapper for the GetPbfListingVersion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/GetPbfListingVersion.go.html to see an example of how to use GetPbfListingVersionRequest.
type GetPbfListingVersionRequest struct {
// unique PbfListingVersion identifier
PbfListingVersionId *string `mandatory:"true" contributesTo:"path" name:"pbfListingVersionId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetPbfListingVersionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPbfListingVersionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPbfListingVersionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPbfListingVersionRequest) String() string
func (request GetPbfListingVersionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetPbfListingVersionResponse wrapper for the GetPbfListingVersion operation
type GetPbfListingVersionResponse struct {
// The underlying http response
RawResponse *http.Response
// The PbfListingVersion instance
PbfListingVersion `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"`
}
func (response GetPbfListingVersionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPbfListingVersionResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
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"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
ImagePolicyConfig Define the image signature verification policy for an application.
type ImagePolicyConfig struct {
// Define if image signature verification policy is enabled for the application.
IsPolicyEnabled *bool `mandatory:"true" json:"isPolicyEnabled"`
// A list of KMS key details.
KeyDetails []KeyDetails `mandatory:"false" json:"keyDetails"`
}
func (m ImagePolicyConfig) String() string
func (m ImagePolicyConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InvokeFunctionFnIntentEnum Enum with underlying type: string
type InvokeFunctionFnIntentEnum string
Set of constants representing the allowable values for InvokeFunctionFnIntentEnum
const (
InvokeFunctionFnIntentHttprequest InvokeFunctionFnIntentEnum = "httprequest"
InvokeFunctionFnIntentCloudevent InvokeFunctionFnIntentEnum = "cloudevent"
)
func GetInvokeFunctionFnIntentEnumValues() []InvokeFunctionFnIntentEnum
GetInvokeFunctionFnIntentEnumValues Enumerates the set of values for InvokeFunctionFnIntentEnum
func GetMappingInvokeFunctionFnIntentEnum(val string) (InvokeFunctionFnIntentEnum, bool)
GetMappingInvokeFunctionFnIntentEnum performs case Insensitive comparison on enum value and return the desired enum
InvokeFunctionFnInvokeTypeEnum Enum with underlying type: string
type InvokeFunctionFnInvokeTypeEnum string
Set of constants representing the allowable values for InvokeFunctionFnInvokeTypeEnum
const (
InvokeFunctionFnInvokeTypeDetached InvokeFunctionFnInvokeTypeEnum = "detached"
InvokeFunctionFnInvokeTypeSync InvokeFunctionFnInvokeTypeEnum = "sync"
)
func GetInvokeFunctionFnInvokeTypeEnumValues() []InvokeFunctionFnInvokeTypeEnum
GetInvokeFunctionFnInvokeTypeEnumValues Enumerates the set of values for InvokeFunctionFnInvokeTypeEnum
func GetMappingInvokeFunctionFnInvokeTypeEnum(val string) (InvokeFunctionFnInvokeTypeEnum, bool)
GetMappingInvokeFunctionFnInvokeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
InvokeFunctionRequest wrapper for the InvokeFunction operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/InvokeFunction.go.html to see an example of how to use InvokeFunctionRequest.
type InvokeFunctionRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this function.
FunctionId *string `mandatory:"true" contributesTo:"path" name:"functionId"`
// The body of the function invocation.
// Note: The maximum size of the request is limited. This limit is currently 6MB and the endpoint will not accept requests that are bigger than this limit.
InvokeFunctionBody io.ReadCloser `mandatory:"false" contributesTo:"body" encoding:"binary"`
// An optional intent header that indicates to the FDK the way the event should be interpreted. E.g. 'httprequest', 'cloudevent'.
FnIntent InvokeFunctionFnIntentEnum `mandatory:"false" contributesTo:"header" name:"fn-intent"`
// Indicates whether Oracle Functions should execute the request and return the result ('sync') of the execution,
// or whether Oracle Functions should return as soon as processing has begun ('detached') and leave result handling to the function.
FnInvokeType InvokeFunctionFnInvokeTypeEnum `mandatory:"false" contributesTo:"header" name:"fn-invoke-type"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Indicates that the request is a dry run, if set to "true". A dry run request does not execute the function.
IsDryRun *bool `mandatory:"false" contributesTo:"header" name:"is-dry-run"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request InvokeFunctionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request InvokeFunctionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request InvokeFunctionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request InvokeFunctionRequest) String() string
func (request InvokeFunctionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InvokeFunctionResponse wrapper for the InvokeFunction operation
type InvokeFunctionResponse struct {
// The underlying http response
RawResponse *http.Response
// The io.ReadCloser instance
Content io.ReadCloser `presentIn:"body" encoding:"binary"`
// 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"`
}
func (response InvokeFunctionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response InvokeFunctionResponse) String() string
KeyDetails The properties that define the kms keys used by Functions for Image Signature verification.
type KeyDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the KMS key that will be used to verify the image signature.
KmsKeyId *string `mandatory:"true" json:"kmsKeyId"`
}
func (m KeyDetails) String() string
func (m KeyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListApplicationsRequest wrapper for the ListApplications operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListApplications.go.html to see an example of how to use ListApplicationsRequest.
type ListApplicationsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this resource belongs.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The maximum number of items to return. 1 is the minimum, 50 is the maximum.
// Default: 10
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The pagination token for a list query returned by a previous operation
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A filter to return only applications that match the lifecycle state in this parameter.
// Example: `Creating`
LifecycleState ApplicationLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only applications with display names that match the display name string. Matching is exact.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only applications with the specified OCID.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// Specifies sort order.
// * **ASC:** Ascending sort order.
// * **DESC:** Descending sort order.
SortOrder ListApplicationsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Specifies the attribute with which to sort the rules.
// Default: `displayName`
// * **timeCreated:** Sorts by timeCreated.
// * **displayName:** Sorts by displayName.
// * **id:** Sorts by id.
SortBy ListApplicationsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListApplicationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListApplicationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListApplicationsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListApplicationsRequest) String() string
func (request ListApplicationsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListApplicationsResponse wrapper for the ListApplications operation
type ListApplicationsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ApplicationSummary instances
Items []ApplicationSummary `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of
// results remain. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListApplicationsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListApplicationsResponse) String() string
ListApplicationsSortByEnum Enum with underlying type: string
type ListApplicationsSortByEnum string
Set of constants representing the allowable values for ListApplicationsSortByEnum
const (
ListApplicationsSortByTimecreated ListApplicationsSortByEnum = "timeCreated"
ListApplicationsSortById ListApplicationsSortByEnum = "id"
ListApplicationsSortByDisplayname ListApplicationsSortByEnum = "displayName"
)
func GetListApplicationsSortByEnumValues() []ListApplicationsSortByEnum
GetListApplicationsSortByEnumValues Enumerates the set of values for ListApplicationsSortByEnum
func GetMappingListApplicationsSortByEnum(val string) (ListApplicationsSortByEnum, bool)
GetMappingListApplicationsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListApplicationsSortOrderEnum Enum with underlying type: string
type ListApplicationsSortOrderEnum string
Set of constants representing the allowable values for ListApplicationsSortOrderEnum
const (
ListApplicationsSortOrderAsc ListApplicationsSortOrderEnum = "ASC"
ListApplicationsSortOrderDesc ListApplicationsSortOrderEnum = "DESC"
)
func GetListApplicationsSortOrderEnumValues() []ListApplicationsSortOrderEnum
GetListApplicationsSortOrderEnumValues Enumerates the set of values for ListApplicationsSortOrderEnum
func GetMappingListApplicationsSortOrderEnum(val string) (ListApplicationsSortOrderEnum, bool)
GetMappingListApplicationsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListFunctionsRequest wrapper for the ListFunctions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListFunctions.go.html to see an example of how to use ListFunctionsRequest.
type ListFunctionsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application to which this function belongs.
ApplicationId *string `mandatory:"true" contributesTo:"query" name:"applicationId"`
// The maximum number of items to return. 1 is the minimum, 50 is the maximum.
// Default: 10
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The pagination token for a list query returned by a previous operation
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A filter to return only functions that match the lifecycle state in this parameter.
// Example: `Creating`
LifecycleState FunctionLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only functions with display names that match the display name string. Matching is exact.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only functions with the specified OCID.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// Specifies sort order.
// * **ASC:** Ascending sort order.
// * **DESC:** Descending sort order.
SortOrder ListFunctionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Specifies the attribute with which to sort the rules.
// Default: `displayName`
// * **timeCreated:** Sorts by timeCreated.
// * **displayName:** Sorts by displayName.
// * **id:** Sorts by id.
SortBy ListFunctionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListFunctionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListFunctionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListFunctionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListFunctionsRequest) String() string
func (request ListFunctionsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListFunctionsResponse wrapper for the ListFunctions operation
type ListFunctionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []FunctionSummary instances
Items []FunctionSummary `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of
// results remain. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListFunctionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListFunctionsResponse) String() string
ListFunctionsRuntimeVersionsRequest wrapper for the ListFunctionsRuntimeVersions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListFunctionsRuntimeVersions.go.html to see an example of how to use ListFunctionsRuntimeVersionsRequest.
type ListFunctionsRuntimeVersionsRequest struct {
// unique FunctionsRuntime identifier
FunctionsRuntimeId *string `mandatory:"false" contributesTo:"query" name:"functionsRuntimeId"`
// A filter to return only resources that match the entire FunctionsRuntime name given.
FunctionsRuntimeName *string `mandatory:"false" contributesTo:"query" name:"functionsRuntimeName"`
// unique FunctionsRuntimeVersion identifier
FunctionsRuntimeVersionId *string `mandatory:"false" contributesTo:"query" name:"functionsRuntimeVersionId"`
// A filter to return only resources that match the entire FunctionsRuntimeVersion name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources that match the entire osVersion name given.
OsVersion *string `mandatory:"false" contributesTo:"query" name:"osVersion"`
// A filter to return only resources that match the entire languageVersion name given.
LanguageVersion *string `mandatory:"false" contributesTo:"query" name:"languageVersion"`
// Matches the current version associated with a FunctionsRuntime.
IsCurrentVersion *bool `mandatory:"false" contributesTo:"query" name:"isCurrentVersion"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState FunctionsRuntimeVersionLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending.
SortBy ListFunctionsRuntimeVersionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The maximum number of items to return. 1 is the minimum, 50 is the maximum.
// Default: 10
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The pagination token for a list query returned by a previous operation
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Specifies sort order.
// * **ASC:** Ascending sort order.
// * **DESC:** Descending sort order.
SortOrder ListFunctionsRuntimeVersionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListFunctionsRuntimeVersionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListFunctionsRuntimeVersionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListFunctionsRuntimeVersionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListFunctionsRuntimeVersionsRequest) String() string
func (request ListFunctionsRuntimeVersionsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListFunctionsRuntimeVersionsResponse wrapper for the ListFunctionsRuntimeVersions operation
type ListFunctionsRuntimeVersionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of FunctionsRuntimeVersionCollection instances
FunctionsRuntimeVersionCollection `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"`
}
func (response ListFunctionsRuntimeVersionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListFunctionsRuntimeVersionsResponse) String() string
ListFunctionsRuntimeVersionsSortByEnum Enum with underlying type: string
type ListFunctionsRuntimeVersionsSortByEnum string
Set of constants representing the allowable values for ListFunctionsRuntimeVersionsSortByEnum
const (
ListFunctionsRuntimeVersionsSortByTimecreated ListFunctionsRuntimeVersionsSortByEnum = "timeCreated"
ListFunctionsRuntimeVersionsSortByName ListFunctionsRuntimeVersionsSortByEnum = "name"
)
func GetListFunctionsRuntimeVersionsSortByEnumValues() []ListFunctionsRuntimeVersionsSortByEnum
GetListFunctionsRuntimeVersionsSortByEnumValues Enumerates the set of values for ListFunctionsRuntimeVersionsSortByEnum
func GetMappingListFunctionsRuntimeVersionsSortByEnum(val string) (ListFunctionsRuntimeVersionsSortByEnum, bool)
GetMappingListFunctionsRuntimeVersionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListFunctionsRuntimeVersionsSortOrderEnum Enum with underlying type: string
type ListFunctionsRuntimeVersionsSortOrderEnum string
Set of constants representing the allowable values for ListFunctionsRuntimeVersionsSortOrderEnum
const (
ListFunctionsRuntimeVersionsSortOrderAsc ListFunctionsRuntimeVersionsSortOrderEnum = "ASC"
ListFunctionsRuntimeVersionsSortOrderDesc ListFunctionsRuntimeVersionsSortOrderEnum = "DESC"
)
func GetListFunctionsRuntimeVersionsSortOrderEnumValues() []ListFunctionsRuntimeVersionsSortOrderEnum
GetListFunctionsRuntimeVersionsSortOrderEnumValues Enumerates the set of values for ListFunctionsRuntimeVersionsSortOrderEnum
func GetMappingListFunctionsRuntimeVersionsSortOrderEnum(val string) (ListFunctionsRuntimeVersionsSortOrderEnum, bool)
GetMappingListFunctionsRuntimeVersionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListFunctionsRuntimesRequest wrapper for the ListFunctionsRuntimes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListFunctionsRuntimes.go.html to see an example of how to use ListFunctionsRuntimesRequest.
type ListFunctionsRuntimesRequest struct {
// unique FunctionsRuntime identifier
FunctionsRuntimeId *string `mandatory:"false" contributesTo:"query" name:"functionsRuntimeId"`
// A filter to return only resources that match the entire FunctionsRuntime name given.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// A filter to return only resources that contain the supplied filter text in the FunctionsRuntime name given.
NameContains *string `mandatory:"false" contributesTo:"query" name:"nameContains"`
// A filter to return only resources that start with the supplied filter text in the FunctionsRuntime name given.
NameStartsWith *string `mandatory:"false" contributesTo:"query" name:"nameStartsWith"`
// A filter to return only resources that match the entire os name given.
Os *string `mandatory:"false" contributesTo:"query" name:"os"`
// A filter to return only resources that match the entire language name given.
Language *string `mandatory:"false" contributesTo:"query" name:"language"`
// A filter to return only resources where their lifecycleState matches the given lifecycleState.
LifecycleState FunctionsRuntimeLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return. 1 is the minimum, 50 is the maximum.
// Default: 10
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The pagination token for a list query returned by a previous operation
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Specifies sort order.
// * **ASC:** Ascending sort order.
// * **DESC:** Descending sort order.
SortOrder ListFunctionsRuntimesSortOrderEnum `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 name is ascending.
SortBy ListFunctionsRuntimesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListFunctionsRuntimesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListFunctionsRuntimesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListFunctionsRuntimesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListFunctionsRuntimesRequest) String() string
func (request ListFunctionsRuntimesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListFunctionsRuntimesResponse wrapper for the ListFunctionsRuntimes operation
type ListFunctionsRuntimesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of FunctionsRuntimeCollection instances
FunctionsRuntimeCollection `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"`
}
func (response ListFunctionsRuntimesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListFunctionsRuntimesResponse) String() string
ListFunctionsRuntimesSortByEnum Enum with underlying type: string
type ListFunctionsRuntimesSortByEnum string
Set of constants representing the allowable values for ListFunctionsRuntimesSortByEnum
const (
ListFunctionsRuntimesSortByTimecreated ListFunctionsRuntimesSortByEnum = "timeCreated"
ListFunctionsRuntimesSortByName ListFunctionsRuntimesSortByEnum = "name"
ListFunctionsRuntimesSortByTimedeprecated ListFunctionsRuntimesSortByEnum = "timeDeprecated"
ListFunctionsRuntimesSortByTimedecommissioned ListFunctionsRuntimesSortByEnum = "timeDecommissioned"
)
func GetListFunctionsRuntimesSortByEnumValues() []ListFunctionsRuntimesSortByEnum
GetListFunctionsRuntimesSortByEnumValues Enumerates the set of values for ListFunctionsRuntimesSortByEnum
func GetMappingListFunctionsRuntimesSortByEnum(val string) (ListFunctionsRuntimesSortByEnum, bool)
GetMappingListFunctionsRuntimesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListFunctionsRuntimesSortOrderEnum Enum with underlying type: string
type ListFunctionsRuntimesSortOrderEnum string
Set of constants representing the allowable values for ListFunctionsRuntimesSortOrderEnum
const (
ListFunctionsRuntimesSortOrderAsc ListFunctionsRuntimesSortOrderEnum = "ASC"
ListFunctionsRuntimesSortOrderDesc ListFunctionsRuntimesSortOrderEnum = "DESC"
)
func GetListFunctionsRuntimesSortOrderEnumValues() []ListFunctionsRuntimesSortOrderEnum
GetListFunctionsRuntimesSortOrderEnumValues Enumerates the set of values for ListFunctionsRuntimesSortOrderEnum
func GetMappingListFunctionsRuntimesSortOrderEnum(val string) (ListFunctionsRuntimesSortOrderEnum, bool)
GetMappingListFunctionsRuntimesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListFunctionsSortByEnum Enum with underlying type: string
type ListFunctionsSortByEnum string
Set of constants representing the allowable values for ListFunctionsSortByEnum
const (
ListFunctionsSortByTimecreated ListFunctionsSortByEnum = "timeCreated"
ListFunctionsSortById ListFunctionsSortByEnum = "id"
ListFunctionsSortByDisplayname ListFunctionsSortByEnum = "displayName"
)
func GetListFunctionsSortByEnumValues() []ListFunctionsSortByEnum
GetListFunctionsSortByEnumValues Enumerates the set of values for ListFunctionsSortByEnum
func GetMappingListFunctionsSortByEnum(val string) (ListFunctionsSortByEnum, bool)
GetMappingListFunctionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListFunctionsSortOrderEnum Enum with underlying type: string
type ListFunctionsSortOrderEnum string
Set of constants representing the allowable values for ListFunctionsSortOrderEnum
const (
ListFunctionsSortOrderAsc ListFunctionsSortOrderEnum = "ASC"
ListFunctionsSortOrderDesc ListFunctionsSortOrderEnum = "DESC"
)
func GetListFunctionsSortOrderEnumValues() []ListFunctionsSortOrderEnum
GetListFunctionsSortOrderEnumValues Enumerates the set of values for ListFunctionsSortOrderEnum
func GetMappingListFunctionsSortOrderEnum(val string) (ListFunctionsSortOrderEnum, bool)
GetMappingListFunctionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListPbfListingVersionsRequest wrapper for the ListPbfListingVersions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListPbfListingVersions.go.html to see an example of how to use ListPbfListingVersionsRequest.
type ListPbfListingVersionsRequest struct {
// unique PbfListing identifier
PbfListingId *string `mandatory:"true" contributesTo:"query" name:"pbfListingId"`
// unique PbfListingVersion identifier
PbfListingVersionId *string `mandatory:"false" contributesTo:"query" name:"pbfListingVersionId"`
// Matches a PbfListingVersion based on a provided semantic version name for a PbfListingVersion.
// Each PbfListingVersion name is unique with respect to its associated PbfListing.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// Matches the current version (the most recently added version with an Active
// lifecycleState) associated with a PbfListing.
IsCurrentVersion *bool `mandatory:"false" contributesTo:"query" name:"isCurrentVersion"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState PbfListingVersionLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return. 1 is the minimum, 50 is the maximum.
// Default: 10
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The pagination token for a list query returned by a previous operation
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Specifies sort order.
// * **ASC:** Ascending sort order.
// * **DESC:** Descending sort order.
SortOrder ListPbfListingVersionsSortOrderEnum `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 name is ascending.
SortBy ListPbfListingVersionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListPbfListingVersionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPbfListingVersionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPbfListingVersionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPbfListingVersionsRequest) String() string
func (request ListPbfListingVersionsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListPbfListingVersionsResponse wrapper for the ListPbfListingVersions operation
type ListPbfListingVersionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of PbfListingVersionsCollection instances
PbfListingVersionsCollection `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"`
}
func (response ListPbfListingVersionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPbfListingVersionsResponse) String() string
ListPbfListingVersionsSortByEnum Enum with underlying type: string
type ListPbfListingVersionsSortByEnum string
Set of constants representing the allowable values for ListPbfListingVersionsSortByEnum
const (
ListPbfListingVersionsSortByTimecreated ListPbfListingVersionsSortByEnum = "timeCreated"
ListPbfListingVersionsSortByName ListPbfListingVersionsSortByEnum = "name"
)
func GetListPbfListingVersionsSortByEnumValues() []ListPbfListingVersionsSortByEnum
GetListPbfListingVersionsSortByEnumValues Enumerates the set of values for ListPbfListingVersionsSortByEnum
func GetMappingListPbfListingVersionsSortByEnum(val string) (ListPbfListingVersionsSortByEnum, bool)
GetMappingListPbfListingVersionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListPbfListingVersionsSortOrderEnum Enum with underlying type: string
type ListPbfListingVersionsSortOrderEnum string
Set of constants representing the allowable values for ListPbfListingVersionsSortOrderEnum
const (
ListPbfListingVersionsSortOrderAsc ListPbfListingVersionsSortOrderEnum = "ASC"
ListPbfListingVersionsSortOrderDesc ListPbfListingVersionsSortOrderEnum = "DESC"
)
func GetListPbfListingVersionsSortOrderEnumValues() []ListPbfListingVersionsSortOrderEnum
GetListPbfListingVersionsSortOrderEnumValues Enumerates the set of values for ListPbfListingVersionsSortOrderEnum
func GetMappingListPbfListingVersionsSortOrderEnum(val string) (ListPbfListingVersionsSortOrderEnum, bool)
GetMappingListPbfListingVersionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListPbfListingsRequest wrapper for the ListPbfListings operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListPbfListings.go.html to see an example of how to use ListPbfListingsRequest.
type ListPbfListingsRequest struct {
// unique PbfListing identifier
PbfListingId *string `mandatory:"false" contributesTo:"query" name:"pbfListingId"`
// A filter to return only resources that match the entire PBF name given.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// A filter to return only resources that contain the supplied filter text in the PBF name given.
NameContains *string `mandatory:"false" contributesTo:"query" name:"nameContains"`
// A filter to return only resources that start with the supplied filter text in the PBF name given.
NameStartsWith *string `mandatory:"false" contributesTo:"query" name:"nameStartsWith"`
// A filter to return only resources that match the service trigger sources of a PBF.
Trigger []string `contributesTo:"query" name:"trigger" collectionFormat:"multi"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState PbfListingLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return. 1 is the minimum, 50 is the maximum.
// Default: 10
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The pagination token for a list query returned by a previous operation
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Specifies sort order.
// * **ASC:** Ascending sort order.
// * **DESC:** Descending sort order.
SortOrder ListPbfListingsSortOrderEnum `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 name is ascending.
SortBy ListPbfListingsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListPbfListingsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPbfListingsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPbfListingsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPbfListingsRequest) String() string
func (request ListPbfListingsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListPbfListingsResponse wrapper for the ListPbfListings operation
type ListPbfListingsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of PbfListingsCollection instances
PbfListingsCollection `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"`
}
func (response ListPbfListingsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPbfListingsResponse) String() string
ListPbfListingsSortByEnum Enum with underlying type: string
type ListPbfListingsSortByEnum string
Set of constants representing the allowable values for ListPbfListingsSortByEnum
const (
ListPbfListingsSortByTimecreated ListPbfListingsSortByEnum = "timeCreated"
ListPbfListingsSortByName ListPbfListingsSortByEnum = "name"
)
func GetListPbfListingsSortByEnumValues() []ListPbfListingsSortByEnum
GetListPbfListingsSortByEnumValues Enumerates the set of values for ListPbfListingsSortByEnum
func GetMappingListPbfListingsSortByEnum(val string) (ListPbfListingsSortByEnum, bool)
GetMappingListPbfListingsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListPbfListingsSortOrderEnum Enum with underlying type: string
type ListPbfListingsSortOrderEnum string
Set of constants representing the allowable values for ListPbfListingsSortOrderEnum
const (
ListPbfListingsSortOrderAsc ListPbfListingsSortOrderEnum = "ASC"
ListPbfListingsSortOrderDesc ListPbfListingsSortOrderEnum = "DESC"
)
func GetListPbfListingsSortOrderEnumValues() []ListPbfListingsSortOrderEnum
GetListPbfListingsSortOrderEnumValues Enumerates the set of values for ListPbfListingsSortOrderEnum
func GetMappingListPbfListingsSortOrderEnum(val string) (ListPbfListingsSortOrderEnum, bool)
GetMappingListPbfListingsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListTriggersRequest wrapper for the ListTriggers operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListTriggers.go.html to see an example of how to use ListTriggersRequest.
type ListTriggersRequest struct {
// A filter to return only resources that match the service trigger source of a PBF.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// The maximum number of items to return. 1 is the minimum, 50 is the maximum.
// Default: 10
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The pagination token for a list query returned by a previous operation
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Specifies sort order.
// * **ASC:** Ascending sort order.
// * **DESC:** Descending sort order.
SortOrder ListTriggersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListTriggersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListTriggersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTriggersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTriggersRequest) String() string
func (request ListTriggersRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListTriggersResponse wrapper for the ListTriggers operation
type ListTriggersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of TriggersCollection instances
TriggersCollection `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"`
}
func (response ListTriggersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTriggersResponse) String() string
ListTriggersSortOrderEnum Enum with underlying type: string
type ListTriggersSortOrderEnum string
Set of constants representing the allowable values for ListTriggersSortOrderEnum
const (
ListTriggersSortOrderAsc ListTriggersSortOrderEnum = "ASC"
ListTriggersSortOrderDesc ListTriggersSortOrderEnum = "DESC"
)
func GetListTriggersSortOrderEnumValues() []ListTriggersSortOrderEnum
GetListTriggersSortOrderEnumValues Enumerates the set of values for ListTriggersSortOrderEnum
func GetMappingListTriggersSortOrderEnum(val string) (ListTriggersSortOrderEnum, bool)
GetMappingListTriggersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The pagination token for a list query returned by a previous operation
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return. 1 is the minimum, 50 is the maximum.
// Default: 10
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Specifies sort order.
// * **ASC:** Ascending sort order.
// * **DESC:** Descending sort order.
SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `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"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The pagination token for a list query returned by a previous operation
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return. 1 is the minimum, 50 is the maximum.
// Default: 10
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Specifies sort order.
// * **ASC:** Ascending sort order.
// * **DESC:** Descending sort order.
SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `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"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this resource belongs.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// A filter to return only the resources that match the given lifecycle state.
Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The pagination token for a list query returned by a previous operation
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return. 1 is the minimum, 50 is the maximum.
// Default: 10
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Specifies sort order.
// * **ASC:** Ascending sort order.
// * **DESC:** Descending sort order.
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestSummaryCollection instances
WorkRequestSummaryCollection `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"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const (
ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusWaiting ListWorkRequestsStatusEnum = "WAITING"
ListWorkRequestsStatusNeedsAttention ListWorkRequestsStatusEnum = "NEEDS_ATTENTION"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING"
ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ManualRuntimeConfig FunctionsRuntime configuration for a function with 'MANUAL' Runtime Update strategy.
type ManualRuntimeConfig struct {
// The name of the FunctionsRuntime this function is to be associated with.
FunctionsRuntimeName *string `mandatory:"true" json:"functionsRuntimeName"`
// The OCID of the FunctionsRuntimeVersion that is currently in use for the function.
FunctionsRuntimeVersionId *string `mandatory:"false" json:"functionsRuntimeVersionId"`
}
func (m ManualRuntimeConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ManualRuntimeConfig) String() string
func (m ManualRuntimeConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
NoneFailureDestinationDetails Specifies no failure destination Example: `{"kind": "NONE"}`
type NoneFailureDestinationDetails struct {
}
func (m NoneFailureDestinationDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NoneFailureDestinationDetails) String() string
func (m NoneFailureDestinationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
NoneProvisionedConcurrencyConfig Configuration specifying no provisioned concurrency
type NoneProvisionedConcurrencyConfig struct {
}
func (m NoneProvisionedConcurrencyConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NoneProvisionedConcurrencyConfig) String() string
func (m NoneProvisionedConcurrencyConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
NoneSuccessDestinationDetails Specifies no success destination Example: `{"kind": "NONE"}`
type NoneSuccessDestinationDetails struct {
}
func (m NoneSuccessDestinationDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NoneSuccessDestinationDetails) String() string
func (m NoneSuccessDestinationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
NotificationFailureDestinationDetails The destination topic in the Notifications service to which to send the response of the failed detached function invocation. Example: `{"kind": "NOTIFICATION", "topicId": "topic_OCID"}`
type NotificationFailureDestinationDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic.
TopicId *string `mandatory:"true" json:"topicId"`
}
func (m NotificationFailureDestinationDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NotificationFailureDestinationDetails) String() string
func (m NotificationFailureDestinationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
NotificationSuccessDestinationDetails The destination topic in the Notifications service to which to send the response of the successful detached function invocation. Example: `{"kind": "NOTIFICATION", "topicId": "topic_OCID"}`
type NotificationSuccessDestinationDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic.
TopicId *string `mandatory:"true" json:"topicId"`
}
func (m NotificationSuccessDestinationDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NotificationSuccessDestinationDetails) String() string
func (m NotificationSuccessDestinationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ObjectStorageArchiveSourceDetails The details for the Archive source of the Function from Object Storage. This is used when the function code is stored in Object Storage. It is suitable for scenarios where the function code is uploaded as an archive file to a specific bucket and namespace
type ObjectStorageArchiveSourceDetails struct {
// The name of the Object Storage bucket.
BucketName *string `mandatory:"true" json:"bucketName"`
// The Object Storage namespace.
Namespace *string `mandatory:"true" json:"namespace"`
// The name of the Object Storage object.
ObjectName *string `mandatory:"true" json:"objectName"`
// VersionId used to identify a particular version of the object. If not specified, the latest version of the object is used.
ObjectVersionId *string `mandatory:"false" json:"objectVersionId"`
}
func (m ObjectStorageArchiveSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStorageArchiveSourceDetails) String() string
func (m ObjectStorageArchiveSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusWaiting OperationStatusEnum = "WAITING"
OperationStatusNeedsAttention OperationStatusEnum = "NEEDS_ATTENTION"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreateFunction OperationTypeEnum = "CREATE_FUNCTION"
OperationTypeUpdateFunction OperationTypeEnum = "UPDATE_FUNCTION"
OperationTypeDeleteFunction OperationTypeEnum = "DELETE_FUNCTION"
OperationTypeCreateApplication OperationTypeEnum = "CREATE_APPLICATION"
OperationTypeUpdateApplication OperationTypeEnum = "UPDATE_APPLICATION"
OperationTypeDeleteApplication OperationTypeEnum = "DELETE_APPLICATION"
OperationTypeCreateFunctionsRuntime OperationTypeEnum = "CREATE_FUNCTIONS_RUNTIME"
OperationTypeUpdateFunctionsRuntime OperationTypeEnum = "UPDATE_FUNCTIONS_RUNTIME"
OperationTypeDeleteFunctionsRuntime OperationTypeEnum = "DELETE_FUNCTIONS_RUNTIME"
OperationTypeRollbackFunctionsRuntimeVersion OperationTypeEnum = "ROLLBACK_FUNCTIONS_RUNTIME_VERSION"
OperationTypeCreateFunctionsRuntimeVersion OperationTypeEnum = "CREATE_FUNCTIONS_RUNTIME_VERSION"
OperationTypeUpdateFunctionsRuntimeVersion OperationTypeEnum = "UPDATE_FUNCTIONS_RUNTIME_VERSION"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
PbfListing PbfListing resources provide details about the available PBFs for consumption by the user. This resource contains details about PBF's functionality, policies required, configuration parameters expected etc.
type PbfListing struct {
// Unique identifier that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// A brief descriptive name for the PBF listing. The PBF listing name must be unique, and not match and existing
// PBF.
Name *string `mandatory:"true" json:"name"`
// A short overview of the PBF Listing: the purpose of the PBF and and associated information.
Description *string `mandatory:"true" json:"description"`
PublisherDetails *PublisherDetails `mandatory:"true" json:"publisherDetails"`
// The time the PbfListing was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The last time the PbfListing was updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the PBF resource.
LifecycleState PbfListingLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// An array of Trigger. A list of triggers that may activate the PBF.
Triggers []Trigger `mandatory:"false" json:"triggers"`
// 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"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m PbfListing) String() string
func (m PbfListing) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PbfListingLifecycleStateEnum Enum with underlying type: string
type PbfListingLifecycleStateEnum string
Set of constants representing the allowable values for PbfListingLifecycleStateEnum
const (
PbfListingLifecycleStateActive PbfListingLifecycleStateEnum = "ACTIVE"
PbfListingLifecycleStateInactive PbfListingLifecycleStateEnum = "INACTIVE"
PbfListingLifecycleStateDeleted PbfListingLifecycleStateEnum = "DELETED"
)
func GetMappingPbfListingLifecycleStateEnum(val string) (PbfListingLifecycleStateEnum, bool)
GetMappingPbfListingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPbfListingLifecycleStateEnumValues() []PbfListingLifecycleStateEnum
GetPbfListingLifecycleStateEnumValues Enumerates the set of values for PbfListingLifecycleStateEnum
PbfListingSummary Summary of the PbfListing.
type PbfListingSummary struct {
// Unique identifier that is immutable on creation.
Id *string `mandatory:"true" json:"id"`
// A brief descriptive name for the PBF listing. The PBF listing name must be unique, and not match and existing
// PBF.
Name *string `mandatory:"true" json:"name"`
// A short overview of the PBF Listing: the purpose of the PBF and and associated information.
Description *string `mandatory:"true" json:"description"`
PublisherDetails *PublisherDetails `mandatory:"true" json:"publisherDetails"`
// The time the PbfListing was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The last time the PbfListing was updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the PBF resource.
LifecycleState PbfListingLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// An array of Trigger. A list of triggers that may activate the PBF.
Triggers []Trigger `mandatory:"false" json:"triggers"`
// 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"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m PbfListingSummary) String() string
func (m PbfListingSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PbfListingVersion This represents a version of a PbfListing. Each new update from the publisher or the change in the image will result in the creation of new PbfListingVersion resource creation. This is a sub-resource of a PbfListing.
type PbfListingVersion struct {
// Unique identifier that is immutable on creation
Id *string `mandatory:"true" json:"id"`
// The OCID of the PbfListing this resource version belongs to.
PbfListingId *string `mandatory:"true" json:"pbfListingId"`
// Semantic version
Name *string `mandatory:"true" json:"name"`
Requirements *RequirementDetails `mandatory:"true" json:"requirements"`
// Details changes are included in this version.
ChangeSummary *string `mandatory:"true" json:"changeSummary"`
// An array of Trigger. A list of triggers that may activate the PBF.
Triggers []Trigger `mandatory:"true" json:"triggers"`
// The time the PbfListingVersion was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The last time the PbfListingVersion was updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the PBF resource.
LifecycleState PbfListingVersionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Details about the required and optional Function configurations needed for proper performance of the PBF.
Config []ConfigDetails `mandatory:"false" json:"config"`
// 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"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m PbfListingVersion) String() string
func (m PbfListingVersion) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PbfListingVersionLifecycleStateEnum Enum with underlying type: string
type PbfListingVersionLifecycleStateEnum string
Set of constants representing the allowable values for PbfListingVersionLifecycleStateEnum
const (
PbfListingVersionLifecycleStateActive PbfListingVersionLifecycleStateEnum = "ACTIVE"
PbfListingVersionLifecycleStateInactive PbfListingVersionLifecycleStateEnum = "INACTIVE"
PbfListingVersionLifecycleStateDeleted PbfListingVersionLifecycleStateEnum = "DELETED"
)
func GetMappingPbfListingVersionLifecycleStateEnum(val string) (PbfListingVersionLifecycleStateEnum, bool)
GetMappingPbfListingVersionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPbfListingVersionLifecycleStateEnumValues() []PbfListingVersionLifecycleStateEnum
GetPbfListingVersionLifecycleStateEnumValues Enumerates the set of values for PbfListingVersionLifecycleStateEnum
PbfListingVersionSummary Summary of the PbfListingVersion.
type PbfListingVersionSummary struct {
// Unique identifier that is immutable on creation
Id *string `mandatory:"true" json:"id"`
// The OCID of the PbfListing this resource version belongs to.
PbfListingId *string `mandatory:"true" json:"pbfListingId"`
// Semantic version
Name *string `mandatory:"true" json:"name"`
Requirements *RequirementDetails `mandatory:"true" json:"requirements"`
// Details changes are included in this version.
ChangeSummary *string `mandatory:"true" json:"changeSummary"`
// An array of Trigger. A list of triggers that may activate the PBF.
Triggers []Trigger `mandatory:"true" json:"triggers"`
// The time the PbfListingVersion was created. An RFC3339 formatted datetime string.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The last time the PbfListingVersion was updated. An RFC3339 formatted datetime string.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the PBF resource.
LifecycleState PbfListingVersionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Details about the required and optional Function configurations needed for proper performance of the PBF.
Config []ConfigDetails `mandatory:"false" json:"config"`
// 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"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m PbfListingVersionSummary) String() string
func (m PbfListingVersionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PbfListingVersionsCollection Results of a PbfListingVersion search. Contains both PbfListingVersionSummary items and other information, such as metadata.
type PbfListingVersionsCollection struct {
// List of PbfListingVersion.
Items []PbfListingVersionSummary `mandatory:"true" json:"items"`
}
func (m PbfListingVersionsCollection) String() string
func (m PbfListingVersionsCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PbfListingsCollection Results of a PbfListing search. Contains boh PbfListingSummary items and other information, such as metadata.
type PbfListingsCollection struct {
// List of PbfListingSummary.
Items []PbfListingSummary `mandatory:"true" json:"items"`
}
func (m PbfListingsCollection) String() string
func (m PbfListingsCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PolicyDetails A policy required for this PBF execution.
type PolicyDetails struct {
// Policy required for PBF execution
Policy *string `mandatory:"true" json:"policy"`
// Details about why this policy is required and what it will be used for.
Description *string `mandatory:"true" json:"description"`
}
func (m PolicyDetails) String() string
func (m PolicyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PreBuiltFunctionSourceDetails The source of the Function which is based on a Pre-Built Function Listing (PbfListing).
type PreBuiltFunctionSourceDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the PbfListing this
// function is sourced from.
PbfListingId *string `mandatory:"true" json:"pbfListingId"`
}
func (m PreBuiltFunctionSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PreBuiltFunctionSourceDetails) String() string
func (m PreBuiltFunctionSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PublisherDetails Contains details about the publisher of this PBF Listing.
type PublisherDetails struct {
// Name of the Publisher
Name *string `mandatory:"true" json:"name"`
}
func (m PublisherDetails) String() string
func (m PublisherDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
QueueFailureDestinationDetails The destination queue or channel in the Queue service to which to send the response of the failed detached function invocation. Example: `{"kind": "QUEUE", "queueId": "queue_OCID", "channelId": "channel_Id"}`
type QueueFailureDestinationDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the queue.
QueueId *string `mandatory:"true" json:"queueId"`
// The ID of the channel in the queue.
ChannelId *string `mandatory:"false" json:"channelId"`
}
func (m QueueFailureDestinationDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m QueueFailureDestinationDetails) String() string
func (m QueueFailureDestinationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
QueueSuccessDestinationDetails The destination queue or channel in the Queue service to which to send the response of the successful detached function invocation. Example: `{"kind": "QUEUE", "queueId": "queue_OCID", "channelId": "channel_Id"}`
type QueueSuccessDestinationDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the queue.
QueueId *string `mandatory:"true" json:"queueId"`
// The ID of the channel in the queue.
ChannelId *string `mandatory:"false" json:"channelId"`
}
func (m QueueSuccessDestinationDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m QueueSuccessDestinationDetails) String() string
func (m QueueSuccessDestinationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RequirementDetails Minimum memory required by this PBF. The user should use memory greater than or equal to this value while configuring the Function.
type RequirementDetails struct {
// Minimum memory required by this PBF. The user should use memory greater than or equal to
// this value while configuring the Function.
MinMemoryRequiredInMBs *int64 `mandatory:"true" json:"minMemoryRequiredInMBs"`
// List of policies required for this PBF execution.
Policies []PolicyDetails `mandatory:"false" json:"policies"`
}
func (m RequirementDetails) String() string
func (m RequirementDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RuntimeConfig FunctionsRuntime configuration for a function.
type RuntimeConfig interface {
}
RuntimeConfigRuntimeConfigTypeEnum Enum with underlying type: string
type RuntimeConfigRuntimeConfigTypeEnum string
Set of constants representing the allowable values for RuntimeConfigRuntimeConfigTypeEnum
const (
RuntimeConfigRuntimeConfigTypeFunctionUpdate RuntimeConfigRuntimeConfigTypeEnum = "FUNCTION_UPDATE"
RuntimeConfigRuntimeConfigTypeManual RuntimeConfigRuntimeConfigTypeEnum = "MANUAL"
)
func GetMappingRuntimeConfigRuntimeConfigTypeEnum(val string) (RuntimeConfigRuntimeConfigTypeEnum, bool)
GetMappingRuntimeConfigRuntimeConfigTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRuntimeConfigRuntimeConfigTypeEnumValues() []RuntimeConfigRuntimeConfigTypeEnum
GetRuntimeConfigRuntimeConfigTypeEnumValues Enumerates the set of values for RuntimeConfigRuntimeConfigTypeEnum
StreamFailureDestinationDetails The destination stream in the Streaming service to which to send the response of the failed detached function invocation. Example: `{"kind": "STREAM", "streamId": "stream_OCID"}`
type StreamFailureDestinationDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream.
StreamId *string `mandatory:"true" json:"streamId"`
}
func (m StreamFailureDestinationDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StreamFailureDestinationDetails) String() string
func (m StreamFailureDestinationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StreamSuccessDestinationDetails The destination stream in the Streaming service to which to send the response of the successful detached function invocation. Example: `{"kind": "STREAM", "streamId": "stream_OCID"}`
type StreamSuccessDestinationDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream.
StreamId *string `mandatory:"true" json:"streamId"`
}
func (m StreamSuccessDestinationDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StreamSuccessDestinationDetails) String() string
func (m StreamSuccessDestinationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SuccessDestinationDetails An object that represents the destination to which Oracle Functions will send an invocation record with the details of the successful detached function invocation. A stream is an example of a success destination. Example: `{"kind": "STREAM", "streamId": "stream_OCID"}`
type SuccessDestinationDetails interface {
}
SuccessDestinationDetailsKindEnum Enum with underlying type: string
type SuccessDestinationDetailsKindEnum string
Set of constants representing the allowable values for SuccessDestinationDetailsKindEnum
const (
SuccessDestinationDetailsKindNotification SuccessDestinationDetailsKindEnum = "NOTIFICATION"
SuccessDestinationDetailsKindQueue SuccessDestinationDetailsKindEnum = "QUEUE"
SuccessDestinationDetailsKindStream SuccessDestinationDetailsKindEnum = "STREAM"
SuccessDestinationDetailsKindNone SuccessDestinationDetailsKindEnum = "NONE"
)
func GetMappingSuccessDestinationDetailsKindEnum(val string) (SuccessDestinationDetailsKindEnum, bool)
GetMappingSuccessDestinationDetailsKindEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSuccessDestinationDetailsKindEnumValues() []SuccessDestinationDetailsKindEnum
GetSuccessDestinationDetailsKindEnumValues Enumerates the set of values for SuccessDestinationDetailsKindEnum
Trigger PBF specific triggers for activating a PBF.
type Trigger struct {
// A brief descriptive name for the PBF trigger.
Name *string `mandatory:"true" json:"name"`
}
func (m Trigger) String() string
func (m Trigger) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TriggerSummary Summary of the Trigger.
type TriggerSummary struct {
// A brief descriptive name for the PBF trigger.
Name *string `mandatory:"true" json:"name"`
}
func (m TriggerSummary) String() string
func (m TriggerSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
TriggersCollection Results of a Trigger search. Contains boh TriggerSummary items and other information, such as metadata.
type TriggersCollection struct {
// List of TriggerSummary.
Items []TriggerSummary `mandatory:"true" json:"items"`
}
func (m TriggersCollection) String() string
func (m TriggersCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateApplicationDetails Properties to update an application.
type UpdateApplicationDetails struct {
// Application configuration. These values are passed on to the function as environment variables, functions may override application configuration.
// Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters.
// Example: `{"MY_FUNCTION_CONFIG": "ConfVal"}`
// The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8.
Config map[string]string `mandatory:"false" json:"config"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of the Network Security Groups to add the application to.
NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`
// A syslog URL to which to send all function logs. Supports tcp, udp, and tcp+tls.
// The syslog URL must be reachable from all of the subnets configured for the application.
// Note: If you enable the OCI Logging service for this application, the syslogUrl value is ignored. Function logs are sent to the OCI Logging service, and not to the syslog URL.
// Example: `tcp://logserver.myserver:1234`
SyslogUrl *string `mandatory:"false" json:"syslogUrl"`
TraceConfig *ApplicationTraceConfig `mandatory:"false" json:"traceConfig"`
Logging *ApplicationLoggingConfig `mandatory:"false" json:"logging"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
ImagePolicyConfig *ImagePolicyConfig `mandatory:"false" json:"imagePolicyConfig"`
// Security attributes for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
SecurityAttributes map[string]map[string]interface{} `mandatory:"false" json:"securityAttributes"`
}
func (m UpdateApplicationDetails) String() string
func (m UpdateApplicationDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateApplicationRequest wrapper for the UpdateApplication operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/UpdateApplication.go.html to see an example of how to use UpdateApplicationRequest.
type UpdateApplicationRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this application.
ApplicationId *string `mandatory:"true" contributesTo:"path" name:"applicationId"`
// The new application spec to apply
UpdateApplicationDetails `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 unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateApplicationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateApplicationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateApplicationRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateApplicationRequest) String() string
func (request UpdateApplicationRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateApplicationResponse wrapper for the UpdateApplication operation
type UpdateApplicationResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateApplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateApplicationResponse) String() string
UpdateArchiveFunctionSourceDetails Source details for updating an archive‑based function.
type UpdateArchiveFunctionSourceDetails struct {
ArchiveSourceDetails UpdateArchiveSourceDetails `mandatory:"false" json:"archiveSourceDetails"`
// The function handler that is executed when the function is invoked. The value of this field depends on the runtime used
Handler *string `mandatory:"false" json:"handler"`
RuntimeConfig UpdateRuntimeConfig `mandatory:"false" json:"runtimeConfig"`
}
func (m UpdateArchiveFunctionSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateArchiveFunctionSourceDetails) String() string
func (m *UpdateArchiveFunctionSourceDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateArchiveFunctionSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateArchiveSourceDetails Source details for updating an archive‑based function.
type UpdateArchiveSourceDetails interface {
}
UpdateArchiveSourceDetailsArchiveSourceTypeEnum Enum with underlying type: string
type UpdateArchiveSourceDetailsArchiveSourceTypeEnum string
Set of constants representing the allowable values for UpdateArchiveSourceDetailsArchiveSourceTypeEnum
const (
UpdateArchiveSourceDetailsArchiveSourceTypeObjectStorageArchive UpdateArchiveSourceDetailsArchiveSourceTypeEnum = "OBJECT_STORAGE_ARCHIVE"
UpdateArchiveSourceDetailsArchiveSourceTypeDirectArchive UpdateArchiveSourceDetailsArchiveSourceTypeEnum = "DIRECT_ARCHIVE"
)
func GetMappingUpdateArchiveSourceDetailsArchiveSourceTypeEnum(val string) (UpdateArchiveSourceDetailsArchiveSourceTypeEnum, bool)
GetMappingUpdateArchiveSourceDetailsArchiveSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateArchiveSourceDetailsArchiveSourceTypeEnumValues() []UpdateArchiveSourceDetailsArchiveSourceTypeEnum
GetUpdateArchiveSourceDetailsArchiveSourceTypeEnumValues Enumerates the set of values for UpdateArchiveSourceDetailsArchiveSourceTypeEnum
UpdateContainerImageFunctionSourceDetails Source details for updating a container image based function.
type UpdateContainerImageFunctionSourceDetails struct {
// The qualified name of the Docker image to use in the function, including the image tag.
// The image should be in the OCI Registry that is in the same region as the function itself.
// Example: `phx.ocir.io/ten/functions/function:0.0.1`
Image *string `mandatory:"false" json:"image"`
// The image digest for the version of the image that will be pulled when invoking this function.
// If no value is specified, the digest currently associated with the image in the OCI Registry will be used.
// Example: `sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7`
ImageDigest *string `mandatory:"false" json:"imageDigest"`
}
func (m UpdateContainerImageFunctionSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateContainerImageFunctionSourceDetails) String() string
func (m UpdateContainerImageFunctionSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateDirectArchiveSourceDetails Source details required for updating an archive based function from Direct Archive.
type UpdateDirectArchiveSourceDetails struct {
// The base64-encoded archive file of the function code. The archive file must contain all the files for the function. Please refer to functions documentation for maximum allowed size and supported archive formats.
ArchiveFile []byte `mandatory:"true" json:"archiveFile"`
}
func (m UpdateDirectArchiveSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateDirectArchiveSourceDetails) String() string
func (m UpdateDirectArchiveSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateFunctionDetails Updates attributes of a function.
type UpdateFunctionDetails struct {
// Maximum usable memory for the function (MiB).
MemoryInMBs *int64 `mandatory:"false" json:"memoryInMBs"`
// Function configuration. These values are passed on to the function as environment variables, this overrides application configuration values.
// Keys must be ASCII strings consisting solely of letters, digits, and the '_' (underscore) character, and must not begin with a digit. Values should be limited to printable unicode characters.
// Example: `{"MY_FUNCTION_CONFIG": "ConfVal"}`
// The maximum size for all configuration keys and values is limited to 4KB. This is measured as the sum of octets necessary to represent each key and value in UTF-8.
Config map[string]string `mandatory:"false" json:"config"`
// Timeout for executions of the function. Value in seconds.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
ProvisionedConcurrencyConfig FunctionProvisionedConcurrencyConfig `mandatory:"false" json:"provisionedConcurrencyConfig"`
// Timeout for detached function invocations. Value in seconds.
DetachedModeTimeoutInSeconds *int `mandatory:"false" json:"detachedModeTimeoutInSeconds"`
FailureDestination FailureDestinationDetails `mandatory:"false" json:"failureDestination"`
SuccessDestination SuccessDestinationDetails `mandatory:"false" json:"successDestination"`
TraceConfig *FunctionTraceConfig `mandatory:"false" json:"traceConfig"`
SourceDetails UpdateFunctionSourceDetails `mandatory:"false" json:"sourceDetails"`
// 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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateFunctionDetails) String() string
func (m *UpdateFunctionDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateFunctionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateFunctionRequest wrapper for the UpdateFunction operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/UpdateFunction.go.html to see an example of how to use UpdateFunctionRequest.
type UpdateFunctionRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this function.
FunctionId *string `mandatory:"true" contributesTo:"path" name:"functionId"`
// The new function spec to apply
UpdateFunctionDetails `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 unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateFunctionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateFunctionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateFunctionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateFunctionRequest) String() string
func (request UpdateFunctionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateFunctionResponse wrapper for the UpdateFunction operation
type UpdateFunctionResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
// a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response UpdateFunctionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateFunctionResponse) String() string
UpdateFunctionSourceDetails The source details for updating the Function.
type UpdateFunctionSourceDetails interface {
}
UpdateFunctionSourceDetailsSourceTypeEnum Enum with underlying type: string
type UpdateFunctionSourceDetailsSourceTypeEnum string
Set of constants representing the allowable values for UpdateFunctionSourceDetailsSourceTypeEnum
const (
UpdateFunctionSourceDetailsSourceTypeArchive UpdateFunctionSourceDetailsSourceTypeEnum = "ARCHIVE"
UpdateFunctionSourceDetailsSourceTypeContainerImage UpdateFunctionSourceDetailsSourceTypeEnum = "CONTAINER_IMAGE"
)
func GetMappingUpdateFunctionSourceDetailsSourceTypeEnum(val string) (UpdateFunctionSourceDetailsSourceTypeEnum, bool)
GetMappingUpdateFunctionSourceDetailsSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateFunctionSourceDetailsSourceTypeEnumValues() []UpdateFunctionSourceDetailsSourceTypeEnum
GetUpdateFunctionSourceDetailsSourceTypeEnumValues Enumerates the set of values for UpdateFunctionSourceDetailsSourceTypeEnum
UpdateFunctionUpdateRuntimeConfig FunctionsRuntime configuration for updating a function with 'FUNCTION_UPDATE' Runtime Update strategy.
type UpdateFunctionUpdateRuntimeConfig struct {
// The name of the FunctionsRuntime this function is to be associated with.
FunctionsRuntimeName *string `mandatory:"true" json:"functionsRuntimeName"`
}
func (m UpdateFunctionUpdateRuntimeConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateFunctionUpdateRuntimeConfig) String() string
func (m UpdateFunctionUpdateRuntimeConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateManualRuntimeConfig FunctionsRuntime configuration for updating a function with 'MANUAL' Runtime Update strategy.
type UpdateManualRuntimeConfig struct {
// The OCID of the FunctionsRuntimeVersion to use for the Function in manual mode.
FunctionsRuntimeVersionId *string `mandatory:"true" json:"functionsRuntimeVersionId"`
// The name of the FunctionsRuntime this function is to be associated with.
FunctionsRuntimeName *string `mandatory:"false" json:"functionsRuntimeName"`
}
func (m UpdateManualRuntimeConfig) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateManualRuntimeConfig) String() string
func (m UpdateManualRuntimeConfig) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateObjectStorageArchiveSourceDetails Source details required for updating an archive based function from Object Storage.
type UpdateObjectStorageArchiveSourceDetails struct {
// The name of the Object Storage bucket.
BucketName *string `mandatory:"false" json:"bucketName"`
// The Object Storage namespace.
Namespace *string `mandatory:"false" json:"namespace"`
// The name of the Object Storage object.
ObjectName *string `mandatory:"false" json:"objectName"`
// VersionId used to identify a particular version of the object. If not specified, the latest version of the object is used.
ObjectVersionId *string `mandatory:"false" json:"objectVersionId"`
}
func (m UpdateObjectStorageArchiveSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateObjectStorageArchiveSourceDetails) String() string
func (m UpdateObjectStorageArchiveSourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateRuntimeConfig FunctionsRuntime configuration used to update a function.
type UpdateRuntimeConfig interface {
}
UpdateRuntimeConfigRuntimeConfigTypeEnum Enum with underlying type: string
type UpdateRuntimeConfigRuntimeConfigTypeEnum string
Set of constants representing the allowable values for UpdateRuntimeConfigRuntimeConfigTypeEnum
const (
UpdateRuntimeConfigRuntimeConfigTypeFunctionUpdate UpdateRuntimeConfigRuntimeConfigTypeEnum = "FUNCTION_UPDATE"
UpdateRuntimeConfigRuntimeConfigTypeManual UpdateRuntimeConfigRuntimeConfigTypeEnum = "MANUAL"
)
func GetMappingUpdateRuntimeConfigRuntimeConfigTypeEnum(val string) (UpdateRuntimeConfigRuntimeConfigTypeEnum, bool)
GetMappingUpdateRuntimeConfigRuntimeConfigTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateRuntimeConfigRuntimeConfigTypeEnumValues() []UpdateRuntimeConfigRuntimeConfigTypeEnum
GetUpdateRuntimeConfigRuntimeConfigTypeEnumValues Enumerates the set of values for UpdateRuntimeConfigRuntimeConfigTypeEnum
WorkRequest An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that lets you track each step in the operation's progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation.
type WorkRequest struct {
// The asynchronous operation tracked by this work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources that are affected by the work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Shows the progress of the operation tracked by the work request, as a percentage of the total work
// that must be performed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the work request was created, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request was started, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request was finished, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// The date and time the work request was updated, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An error encountered while performing an operation that is tracked by a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occurred. For a list of error codes, see
// API Errors (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm).
Code *string `mandatory:"true" json:"code"`
// A human-readable error message.
Message *string `mandatory:"true" json:"message"`
// The date and time the error occurred, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestErrorCollection A list of work request errors. Can contain both errors and other information, such as metadata.
type WorkRequestErrorCollection struct {
// A list of work request errors.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntry A log message from performing an operation that is tracked by a work request.
type WorkRequestLogEntry struct {
// A human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The date and time the log message was written, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntryCollection A list of work request logs. Can contain both logs and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// A list of work request log entries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestManagementClient a client for WorkRequestManagement
type WorkRequestManagementClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewWorkRequestManagementClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client WorkRequestManagementClient, err error)
NewWorkRequestManagementClientWithConfigurationProvider Creates a new default WorkRequestManagement client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewWorkRequestManagementClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client WorkRequestManagementClient, err error)
NewWorkRequestManagementClientWithOboToken Creates a new default WorkRequestManagement 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 (client WorkRequestManagementClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
CancelWorkRequest Cancels a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API.
func (client *WorkRequestManagementClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client WorkRequestManagementClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the details of a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client WorkRequestManagementClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Lists the errors for a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client WorkRequestManagementClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Lists the logs for a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client WorkRequestManagementClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/functions/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *WorkRequestManagementClient) SetRegion(region string)
SetRegion overrides the region of this client.
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type that the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the operation tracked in the work request.
// A resource being created, updated, or deleted remains in the IN_PROGRESS state until
// work is complete for that resource, at which point it transitions to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// An OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that you can use for a GET request to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
// Additional information that helps to explain the resource.
Metadata map[string]string `mandatory:"false" json:"metadata"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResourceMetadataKeyEnum Enum with underlying type: string
type WorkRequestResourceMetadataKeyEnum string
Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum
const (
WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)
func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)
GetMappingWorkRequestResourceMetadataKeyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum
GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum
WorkRequestSummary Summary information about an asynchronous work request.
type WorkRequestSummary struct {
// The asynchronous operation tracked by this work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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"`
// Shows the progress of the operation tracked by the work request, as a percentage of the total work
// that must be performed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the work request was created, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request was started, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request was finished, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// The date and time the work request was updated, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestSummaryCollection A list of work requests. Can contain both work requests and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// A list of work requests.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
func (m WorkRequestSummaryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly