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.cloud.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.cloud.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"` // 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"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). // Example: `{"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"` }
func (m Application) String() string
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
ApplicationSummary Summary of an application.
type ApplicationSummary struct { // The OCID (https://docs.cloud.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.cloud.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"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). // Example: `{"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"` }
func (m ApplicationSummary) String() string
ChangeApplicationCompartmentDetails Properties to change the compartment of an application.
type ChangeApplicationCompartmentDetails struct { // The OCID (https://docs.cloud.oracle.com/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
ChangeApplicationCompartmentRequest wrapper for the ChangeApplicationCompartment operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/ChangeApplicationCompartment.go.html to see an example of how to use ChangeApplicationCompartmentRequest.
type ChangeApplicationCompartmentRequest struct { // The OCID (https://docs.cloud.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) HTTPRequest(method, path 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
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"` }
func (response ChangeApplicationCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeApplicationCompartmentResponse) String() string
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.cloud.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"` // 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"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` }
func (m CreateApplicationDetails) String() string
CreateApplicationRequest wrapper for the CreateApplication operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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) HTTPRequest(method, path 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
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"` }
func (response CreateApplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateApplicationResponse) String() string
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"` // 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"` // Maximum usable memory for the function (MiB). MemoryInMBs *int64 `mandatory:"true" json:"memoryInMBs"` // 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"` // 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"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` }
func (m CreateFunctionDetails) String() string
CreateFunctionRequest wrapper for the CreateFunction operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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) HTTPRequest(method, path 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
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"` }
func (response CreateFunctionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateFunctionResponse) String() string
DeleteApplicationRequest wrapper for the DeleteApplication operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/DeleteApplication.go.html to see an example of how to use DeleteApplicationRequest.
type DeleteApplicationRequest struct { // The OCID (https://docs.cloud.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) HTTPRequest(method, path 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
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"` }
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.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/DeleteFunction.go.html to see an example of how to use DeleteFunctionRequest.
type DeleteFunctionRequest struct { // The OCID (https://docs.cloud.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) HTTPRequest(method, path 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
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"` }
func (response DeleteFunctionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteFunctionResponse) String() string
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.cloud.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 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 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"` // 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"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // 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.cloud.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
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
FunctionSummary Summary of a function.
type FunctionSummary struct { // The OCID (https://docs.cloud.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"` // 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"` // 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"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // 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.cloud.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
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.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/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.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/ChangeApplicationCompartment.go.html to see an example of how to use ChangeApplicationCompartment API.
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.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/CreateApplication.go.html to see an example of how to use CreateApplication API.
func (client FunctionsManagementClient) CreateFunction(ctx context.Context, request CreateFunctionRequest) (response CreateFunctionResponse, err error)
CreateFunction Creates a new function.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/CreateFunction.go.html to see an example of how to use CreateFunction API.
func (client FunctionsManagementClient) DeleteApplication(ctx context.Context, request DeleteApplicationRequest) (response DeleteApplicationResponse, err error)
DeleteApplication Deletes an application.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/DeleteApplication.go.html to see an example of how to use DeleteApplication API.
func (client FunctionsManagementClient) DeleteFunction(ctx context.Context, request DeleteFunctionRequest) (response DeleteFunctionResponse, err error)
DeleteFunction Deletes a function.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/DeleteFunction.go.html to see an example of how to use DeleteFunction API.
func (client FunctionsManagementClient) GetApplication(ctx context.Context, request GetApplicationRequest) (response GetApplicationResponse, err error)
GetApplication Retrieves an application.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/GetApplication.go.html to see an example of how to use GetApplication API.
func (client FunctionsManagementClient) GetFunction(ctx context.Context, request GetFunctionRequest) (response GetFunctionResponse, err error)
GetFunction Retrieves a function.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/GetFunction.go.html to see an example of how to use GetFunction API.
func (client FunctionsManagementClient) ListApplications(ctx context.Context, request ListApplicationsRequest) (response ListApplicationsResponse, err error)
ListApplications Lists applications for a compartment.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/ListApplications.go.html to see an example of how to use ListApplications API.
func (client FunctionsManagementClient) ListFunctions(ctx context.Context, request ListFunctionsRequest) (response ListFunctionsResponse, err error)
ListFunctions Lists functions for an application.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/ListFunctions.go.html to see an example of how to use ListFunctions API.
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.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/UpdateApplication.go.html to see an example of how to use UpdateApplication API.
func (client FunctionsManagementClient) UpdateFunction(ctx context.Context, request UpdateFunctionRequest) (response UpdateFunctionResponse, err error)
UpdateFunction Modifies a function
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/UpdateFunction.go.html to see an example of how to use UpdateFunction API.
GetApplicationRequest wrapper for the GetApplication operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/GetApplication.go.html to see an example of how to use GetApplicationRequest.
type GetApplicationRequest struct { // The OCID (https://docs.cloud.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) HTTPRequest(method, path 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
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.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/GetFunction.go.html to see an example of how to use GetFunctionRequest.
type GetFunctionRequest struct { // The OCID (https://docs.cloud.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) HTTPRequest(method, path 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
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
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
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
InvokeFunctionRequest wrapper for the InvokeFunction operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/InvokeFunction.go.html to see an example of how to use InvokeFunctionRequest.
type InvokeFunctionRequest struct { // The OCID (https://docs.cloud.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 the functions platform should execute the request directly and return the result ('sync') or // whether the platform should enqueue the request for later processing and acknowledge that it has been processed ('detached'). 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"` // Metadata about the request. 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) HTTPRequest(method, path 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
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
ListApplicationsRequest wrapper for the ListApplications operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/ListApplications.go.html to see an example of how to use ListApplicationsRequest.
type ListApplicationsRequest struct { // The OCID (https://docs.cloud.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) HTTPRequest(method, path 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
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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
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
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
ListFunctionsRequest wrapper for the ListFunctions operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/ListFunctions.go.html to see an example of how to use ListFunctionsRequest.
type ListFunctionsRequest struct { // The OCID (https://docs.cloud.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) HTTPRequest(method, path 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
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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ListFunctionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListFunctionsResponse) String() string
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
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
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"` // 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"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` }
func (m UpdateApplicationDetails) String() string
UpdateApplicationRequest wrapper for the UpdateApplication operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/UpdateApplication.go.html to see an example of how to use UpdateApplicationRequest.
type UpdateApplicationRequest struct { // The OCID (https://docs.cloud.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) HTTPRequest(method, path 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
UpdateApplicationResponse wrapper for the UpdateApplication operation
type UpdateApplicationResponse 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 UpdateApplicationResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateApplicationResponse) String() string
UpdateFunctionDetails Updates attributes of a function.
type UpdateFunctionDetails 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. // If an image is specified but no value for imageDigest is provided, the digest currently associated with the image tag in the OCI Registry will be used. // 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. // Example: `sha256:ca0eeb6fb05351dfc8759c20733c91def84cb8007aa89a5bf606bc8b315b9fc7` ImageDigest *string `mandatory:"false" json:"imageDigest"` // 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"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. // For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). // Example: `{"Department": "Finance"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). // Example: `{"Operations": {"CostCenter": "42"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` }
func (m UpdateFunctionDetails) String() string
UpdateFunctionRequest wrapper for the UpdateFunction operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/functions/UpdateFunction.go.html to see an example of how to use UpdateFunctionRequest.
type UpdateFunctionRequest struct { // The OCID (https://docs.cloud.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) HTTPRequest(method, path 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
UpdateFunctionResponse wrapper for the UpdateFunction operation
type UpdateFunctionResponse 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 UpdateFunctionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateFunctionResponse) String() string