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

package functions

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

Index

Package Files

application.go application_summary.go change_application_compartment_details.go change_application_compartment_request_response.go create_application_details.go create_application_request_response.go create_function_details.go create_function_request_response.go delete_application_request_response.go delete_function_request_response.go function.go function_summary.go functions_functionsinvoke_client.go functions_functionsmanagement_client.go get_application_request_response.go get_function_request_response.go invoke_function_request_response.go list_applications_request_response.go list_functions_request_response.go update_application_details.go update_application_request_response.go update_function_details.go update_function_request_response.go

type Application Uses

type Application struct {

    // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application.
    Id  *string `mandatory:"false" 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"`

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

Application An application contains functions and defined attributes shared between those functions, such as network configuration and configuration. Avoid entering confidential information.

func (Application) String Uses

func (m Application) String() string

type ApplicationLifecycleStateEnum Uses

type ApplicationLifecycleStateEnum string

ApplicationLifecycleStateEnum Enum with underlying type: string

const (
    ApplicationLifecycleStateCreating ApplicationLifecycleStateEnum = "CREATING"
    ApplicationLifecycleStateActive   ApplicationLifecycleStateEnum = "ACTIVE"
    ApplicationLifecycleStateInactive ApplicationLifecycleStateEnum = "INACTIVE"
    ApplicationLifecycleStateUpdating ApplicationLifecycleStateEnum = "UPDATING"
    ApplicationLifecycleStateDeleting ApplicationLifecycleStateEnum = "DELETING"
    ApplicationLifecycleStateDeleted  ApplicationLifecycleStateEnum = "DELETED"
    ApplicationLifecycleStateFailed   ApplicationLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ApplicationLifecycleStateEnum

func GetApplicationLifecycleStateEnumValues Uses

func GetApplicationLifecycleStateEnumValues() []ApplicationLifecycleStateEnum

GetApplicationLifecycleStateEnumValues Enumerates the set of values for ApplicationLifecycleStateEnum

type ApplicationSummary Uses

type ApplicationSummary struct {

    // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application.
    Id  *string `mandatory:"false" 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"`
}

ApplicationSummary Summary of an application.

func (ApplicationSummary) String Uses

func (m ApplicationSummary) String() string

type ChangeApplicationCompartmentDetails Uses

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

ChangeApplicationCompartmentDetails Properties to change the compartment of an application.

func (ChangeApplicationCompartmentDetails) String Uses

func (m ChangeApplicationCompartmentDetails) String() string

type ChangeApplicationCompartmentRequest Uses

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
}

ChangeApplicationCompartmentRequest wrapper for the ChangeApplicationCompartment operation

func (ChangeApplicationCompartmentRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ChangeApplicationCompartmentRequest) RetryPolicy Uses

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

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

func (ChangeApplicationCompartmentRequest) String Uses

func (request ChangeApplicationCompartmentRequest) String() string

type ChangeApplicationCompartmentResponse Uses

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

ChangeApplicationCompartmentResponse wrapper for the ChangeApplicationCompartment operation

func (ChangeApplicationCompartmentResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ChangeApplicationCompartmentResponse) String Uses

func (response ChangeApplicationCompartmentResponse) String() string

type CreateApplicationDetails Uses

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

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

CreateApplicationDetails Properties for a new application.

func (CreateApplicationDetails) String Uses

func (m CreateApplicationDetails) String() string

type CreateApplicationRequest Uses

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
}

CreateApplicationRequest wrapper for the CreateApplication operation

func (CreateApplicationRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CreateApplicationRequest) RetryPolicy Uses

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

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

func (CreateApplicationRequest) String Uses

func (request CreateApplicationRequest) String() string

type CreateApplicationResponse Uses

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

CreateApplicationResponse wrapper for the CreateApplication operation

func (CreateApplicationResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateApplicationResponse) String Uses

func (response CreateApplicationResponse) String() string

type CreateFunctionDetails Uses

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

CreateFunctionDetails Properties to create a new function.

func (CreateFunctionDetails) String Uses

func (m CreateFunctionDetails) String() string

type CreateFunctionRequest Uses

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
}

CreateFunctionRequest wrapper for the CreateFunction operation

func (CreateFunctionRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CreateFunctionRequest) RetryPolicy Uses

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

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

func (CreateFunctionRequest) String Uses

func (request CreateFunctionRequest) String() string

type CreateFunctionResponse Uses

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

CreateFunctionResponse wrapper for the CreateFunction operation

func (CreateFunctionResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateFunctionResponse) String Uses

func (response CreateFunctionResponse) String() string

type DeleteApplicationRequest Uses

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
}

DeleteApplicationRequest wrapper for the DeleteApplication operation

func (DeleteApplicationRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (DeleteApplicationRequest) RetryPolicy Uses

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

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

func (DeleteApplicationRequest) String Uses

func (request DeleteApplicationRequest) String() string

type DeleteApplicationResponse Uses

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

DeleteApplicationResponse wrapper for the DeleteApplication operation

func (DeleteApplicationResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteApplicationResponse) String Uses

func (response DeleteApplicationResponse) String() string

type DeleteFunctionRequest Uses

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
}

DeleteFunctionRequest wrapper for the DeleteFunction operation

func (DeleteFunctionRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (DeleteFunctionRequest) RetryPolicy Uses

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

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

func (DeleteFunctionRequest) String Uses

func (request DeleteFunctionRequest) String() string

type DeleteFunctionResponse Uses

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

DeleteFunctionResponse wrapper for the DeleteFunction operation

func (DeleteFunctionResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteFunctionResponse) String Uses

func (response DeleteFunctionResponse) String() string

type Function Uses

type Function struct {

    // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the function.
    Id  *string `mandatory:"false" 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"`
}

Function A function resource defines the code (Docker image) and configuration for a specific function. Functions are defined in applications. Avoid entering confidential information.

func (Function) String Uses

func (m Function) String() string

type FunctionLifecycleStateEnum Uses

type FunctionLifecycleStateEnum string

FunctionLifecycleStateEnum Enum with underlying type: string

const (
    FunctionLifecycleStateCreating FunctionLifecycleStateEnum = "CREATING"
    FunctionLifecycleStateActive   FunctionLifecycleStateEnum = "ACTIVE"
    FunctionLifecycleStateInactive FunctionLifecycleStateEnum = "INACTIVE"
    FunctionLifecycleStateUpdating FunctionLifecycleStateEnum = "UPDATING"
    FunctionLifecycleStateDeleting FunctionLifecycleStateEnum = "DELETING"
    FunctionLifecycleStateDeleted  FunctionLifecycleStateEnum = "DELETED"
    FunctionLifecycleStateFailed   FunctionLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for FunctionLifecycleStateEnum

func GetFunctionLifecycleStateEnumValues Uses

func GetFunctionLifecycleStateEnumValues() []FunctionLifecycleStateEnum

GetFunctionLifecycleStateEnumValues Enumerates the set of values for FunctionLifecycleStateEnum

type FunctionSummary Uses

type FunctionSummary struct {

    // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the function.
    Id  *string `mandatory:"false" 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"`
}

FunctionSummary Summary of a function.

func (FunctionSummary) String Uses

func (m FunctionSummary) String() string

type FunctionsInvokeClient Uses

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

FunctionsInvokeClient a client for FunctionsInvoke

func NewFunctionsInvokeClientWithConfigurationProvider Uses

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 Uses

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 (*FunctionsInvokeClient) ConfigurationProvider Uses

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

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

func (FunctionsInvokeClient) InvokeFunction Uses

func (client FunctionsInvokeClient) InvokeFunction(ctx context.Context, request InvokeFunctionRequest) (response InvokeFunctionResponse, err error)

InvokeFunction Invokes a function

type FunctionsManagementClient Uses

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

FunctionsManagementClient a client for FunctionsManagement

func NewFunctionsManagementClientWithConfigurationProvider Uses

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 Uses

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 (FunctionsManagementClient) ChangeApplicationCompartment Uses

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).

func (*FunctionsManagementClient) ConfigurationProvider Uses

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

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

func (FunctionsManagementClient) CreateApplication Uses

func (client FunctionsManagementClient) CreateApplication(ctx context.Context, request CreateApplicationRequest) (response CreateApplicationResponse, err error)

CreateApplication Creates a new application.

func (FunctionsManagementClient) CreateFunction Uses

func (client FunctionsManagementClient) CreateFunction(ctx context.Context, request CreateFunctionRequest) (response CreateFunctionResponse, err error)

CreateFunction Creates a new function.

func (FunctionsManagementClient) DeleteApplication Uses

func (client FunctionsManagementClient) DeleteApplication(ctx context.Context, request DeleteApplicationRequest) (response DeleteApplicationResponse, err error)

DeleteApplication Deletes an application.

func (FunctionsManagementClient) DeleteFunction Uses

func (client FunctionsManagementClient) DeleteFunction(ctx context.Context, request DeleteFunctionRequest) (response DeleteFunctionResponse, err error)

DeleteFunction Deletes a function.

func (FunctionsManagementClient) GetApplication Uses

func (client FunctionsManagementClient) GetApplication(ctx context.Context, request GetApplicationRequest) (response GetApplicationResponse, err error)

GetApplication Retrieves an application.

func (FunctionsManagementClient) GetFunction Uses

func (client FunctionsManagementClient) GetFunction(ctx context.Context, request GetFunctionRequest) (response GetFunctionResponse, err error)

GetFunction Retrieves a function.

func (FunctionsManagementClient) ListApplications Uses

func (client FunctionsManagementClient) ListApplications(ctx context.Context, request ListApplicationsRequest) (response ListApplicationsResponse, err error)

ListApplications Lists applications for a compartment.

func (FunctionsManagementClient) ListFunctions Uses

func (client FunctionsManagementClient) ListFunctions(ctx context.Context, request ListFunctionsRequest) (response ListFunctionsResponse, err error)

ListFunctions Lists functions for an application.

func (*FunctionsManagementClient) SetRegion Uses

func (client *FunctionsManagementClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (FunctionsManagementClient) UpdateApplication Uses

func (client FunctionsManagementClient) UpdateApplication(ctx context.Context, request UpdateApplicationRequest) (response UpdateApplicationResponse, err error)

UpdateApplication Modifies an application

func (FunctionsManagementClient) UpdateFunction Uses

func (client FunctionsManagementClient) UpdateFunction(ctx context.Context, request UpdateFunctionRequest) (response UpdateFunctionResponse, err error)

UpdateFunction Modifies a function

type GetApplicationRequest Uses

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
}

GetApplicationRequest wrapper for the GetApplication operation

func (GetApplicationRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetApplicationRequest) RetryPolicy Uses

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

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

func (GetApplicationRequest) String Uses

func (request GetApplicationRequest) String() string

type GetApplicationResponse Uses

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

GetApplicationResponse wrapper for the GetApplication operation

func (GetApplicationResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetApplicationResponse) String Uses

func (response GetApplicationResponse) String() string

type GetFunctionRequest Uses

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
}

GetFunctionRequest wrapper for the GetFunction operation

func (GetFunctionRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetFunctionRequest) RetryPolicy Uses

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

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

func (GetFunctionRequest) String Uses

func (request GetFunctionRequest) String() string

type GetFunctionResponse Uses

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

GetFunctionResponse wrapper for the GetFunction operation

func (GetFunctionResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetFunctionResponse) String Uses

func (response GetFunctionResponse) String() string

type InvokeFunctionFnIntentEnum Uses

type InvokeFunctionFnIntentEnum string

InvokeFunctionFnIntentEnum Enum with underlying type: string

const (
    InvokeFunctionFnIntentHttprequest InvokeFunctionFnIntentEnum = "httprequest"
    InvokeFunctionFnIntentCloudevent  InvokeFunctionFnIntentEnum = "cloudevent"
)

Set of constants representing the allowable values for InvokeFunctionFnIntentEnum

func GetInvokeFunctionFnIntentEnumValues Uses

func GetInvokeFunctionFnIntentEnumValues() []InvokeFunctionFnIntentEnum

GetInvokeFunctionFnIntentEnumValues Enumerates the set of values for InvokeFunctionFnIntentEnum

type InvokeFunctionFnInvokeTypeEnum Uses

type InvokeFunctionFnInvokeTypeEnum string

InvokeFunctionFnInvokeTypeEnum Enum with underlying type: string

const (
    InvokeFunctionFnInvokeTypeDetached InvokeFunctionFnInvokeTypeEnum = "detached"
    InvokeFunctionFnInvokeTypeSync     InvokeFunctionFnInvokeTypeEnum = "sync"
)

Set of constants representing the allowable values for InvokeFunctionFnInvokeTypeEnum

func GetInvokeFunctionFnInvokeTypeEnumValues Uses

func GetInvokeFunctionFnInvokeTypeEnumValues() []InvokeFunctionFnInvokeTypeEnum

GetInvokeFunctionFnInvokeTypeEnumValues Enumerates the set of values for InvokeFunctionFnInvokeTypeEnum

type InvokeFunctionRequest Uses

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
}

InvokeFunctionRequest wrapper for the InvokeFunction operation

func (InvokeFunctionRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (InvokeFunctionRequest) RetryPolicy Uses

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

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

func (InvokeFunctionRequest) String Uses

func (request InvokeFunctionRequest) String() string

type InvokeFunctionResponse Uses

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

InvokeFunctionResponse wrapper for the InvokeFunction operation

func (InvokeFunctionResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (InvokeFunctionResponse) String Uses

func (response InvokeFunctionResponse) String() string

type ListApplicationsRequest Uses

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

ListApplicationsRequest wrapper for the ListApplications operation

func (ListApplicationsRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListApplicationsRequest) RetryPolicy Uses

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

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

func (ListApplicationsRequest) String Uses

func (request ListApplicationsRequest) String() string

type ListApplicationsResponse Uses

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

ListApplicationsResponse wrapper for the ListApplications operation

func (ListApplicationsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListApplicationsResponse) String Uses

func (response ListApplicationsResponse) String() string

type ListApplicationsSortByEnum Uses

type ListApplicationsSortByEnum string

ListApplicationsSortByEnum Enum with underlying type: string

const (
    ListApplicationsSortByTimecreated ListApplicationsSortByEnum = "timeCreated"
    ListApplicationsSortById          ListApplicationsSortByEnum = "id"
    ListApplicationsSortByDisplayname ListApplicationsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListApplicationsSortByEnum

func GetListApplicationsSortByEnumValues Uses

func GetListApplicationsSortByEnumValues() []ListApplicationsSortByEnum

GetListApplicationsSortByEnumValues Enumerates the set of values for ListApplicationsSortByEnum

type ListApplicationsSortOrderEnum Uses

type ListApplicationsSortOrderEnum string

ListApplicationsSortOrderEnum Enum with underlying type: string

const (
    ListApplicationsSortOrderAsc  ListApplicationsSortOrderEnum = "ASC"
    ListApplicationsSortOrderDesc ListApplicationsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListApplicationsSortOrderEnum

func GetListApplicationsSortOrderEnumValues Uses

func GetListApplicationsSortOrderEnumValues() []ListApplicationsSortOrderEnum

GetListApplicationsSortOrderEnumValues Enumerates the set of values for ListApplicationsSortOrderEnum

type ListFunctionsRequest Uses

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
}

ListFunctionsRequest wrapper for the ListFunctions operation

func (ListFunctionsRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListFunctionsRequest) RetryPolicy Uses

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

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

func (ListFunctionsRequest) String Uses

func (request ListFunctionsRequest) String() string

type ListFunctionsResponse Uses

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

ListFunctionsResponse wrapper for the ListFunctions operation

func (ListFunctionsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListFunctionsResponse) String Uses

func (response ListFunctionsResponse) String() string

type ListFunctionsSortByEnum Uses

type ListFunctionsSortByEnum string

ListFunctionsSortByEnum Enum with underlying type: string

const (
    ListFunctionsSortByTimecreated ListFunctionsSortByEnum = "timeCreated"
    ListFunctionsSortById          ListFunctionsSortByEnum = "id"
    ListFunctionsSortByDisplayname ListFunctionsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListFunctionsSortByEnum

func GetListFunctionsSortByEnumValues Uses

func GetListFunctionsSortByEnumValues() []ListFunctionsSortByEnum

GetListFunctionsSortByEnumValues Enumerates the set of values for ListFunctionsSortByEnum

type ListFunctionsSortOrderEnum Uses

type ListFunctionsSortOrderEnum string

ListFunctionsSortOrderEnum Enum with underlying type: string

const (
    ListFunctionsSortOrderAsc  ListFunctionsSortOrderEnum = "ASC"
    ListFunctionsSortOrderDesc ListFunctionsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListFunctionsSortOrderEnum

func GetListFunctionsSortOrderEnumValues Uses

func GetListFunctionsSortOrderEnumValues() []ListFunctionsSortOrderEnum

GetListFunctionsSortOrderEnumValues Enumerates the set of values for ListFunctionsSortOrderEnum

type UpdateApplicationDetails Uses

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

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

UpdateApplicationDetails Properties to update an application.

func (UpdateApplicationDetails) String Uses

func (m UpdateApplicationDetails) String() string

type UpdateApplicationRequest Uses

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
}

UpdateApplicationRequest wrapper for the UpdateApplication operation

func (UpdateApplicationRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (UpdateApplicationRequest) RetryPolicy Uses

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

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

func (UpdateApplicationRequest) String Uses

func (request UpdateApplicationRequest) String() string

type UpdateApplicationResponse Uses

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

UpdateApplicationResponse wrapper for the UpdateApplication operation

func (UpdateApplicationResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (UpdateApplicationResponse) String Uses

func (response UpdateApplicationResponse) String() string

type UpdateFunctionDetails Uses

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

UpdateFunctionDetails Updates attributes of a function.

func (UpdateFunctionDetails) String Uses

func (m UpdateFunctionDetails) String() string

type UpdateFunctionRequest Uses

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
}

UpdateFunctionRequest wrapper for the UpdateFunction operation

func (UpdateFunctionRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (UpdateFunctionRequest) RetryPolicy Uses

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

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

func (UpdateFunctionRequest) String Uses

func (request UpdateFunctionRequest) String() string

type UpdateFunctionResponse Uses

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

UpdateFunctionResponse wrapper for the UpdateFunction operation

func (UpdateFunctionResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (UpdateFunctionResponse) String Uses

func (response UpdateFunctionResponse) String() string

Package functions imports 5 packages (graph) and is imported by 2 packages. Updated 2020-04-02. Refresh now. Tools for package owners.