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

package apigateway

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

Index

Package Files

access_log_policy.go anonymous_route_authorization_policy.go any_of_route_authorization_policy.go api_specification.go api_specification_logging_policies.go api_specification_request_policies.go api_specification_route.go api_specification_route_backend.go api_specification_route_request_policies.go apigateway_deployment_client.go apigateway_gateway_client.go apigateway_workrequests_client.go authentication_only_route_authorization_policy.go authentication_policy.go cancel_work_request_request_response.go change_deployment_compartment_details.go change_deployment_compartment_request_response.go change_gateway_compartment_details.go change_gateway_compartment_request_response.go cors_policy.go create_deployment_details.go create_deployment_request_response.go create_gateway_details.go create_gateway_request_response.go custom_authentication_policy.go delete_deployment_request_response.go delete_gateway_request_response.go deployment.go deployment_collection.go deployment_summary.go execution_log_policy.go gateway.go gateway_collection.go gateway_summary.go get_deployment_request_response.go get_gateway_request_response.go get_work_request_request_response.go header_field_specification.go http_backend.go list_deployments_request_response.go list_gateways_request_response.go list_work_request_errors_request_response.go list_work_request_logs_request_response.go list_work_requests_request_response.go oracle_function_backend.go rate_limiting_policy.go route_authorization_policy.go stock_response_backend.go update_deployment_details.go update_deployment_request_response.go update_gateway_details.go update_gateway_request_response.go work_request.go work_request_collection.go work_request_error.go work_request_error_collection.go work_request_log.go work_request_log_collection.go work_request_resource.go work_request_summary.go

type AccessLogPolicy Uses

type AccessLogPolicy struct {

    // Enables pushing of access logs to OCI Public Logging.
    IsEnabled *bool `mandatory:"false" json:"isEnabled"`
}

AccessLogPolicy Configures the pushing of access logs to OCI Public Logging.

func (AccessLogPolicy) String Uses

func (m AccessLogPolicy) String() string

type AnonymousRouteAuthorizationPolicy Uses

type AnonymousRouteAuthorizationPolicy struct {
}

AnonymousRouteAuthorizationPolicy For a type of ANONYMOUS, an authenticated API must have the "isAnonymousAccessAllowed" property set to "true" in the authentication policy.

func (AnonymousRouteAuthorizationPolicy) MarshalJSON Uses

func (m AnonymousRouteAuthorizationPolicy) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (AnonymousRouteAuthorizationPolicy) String Uses

func (m AnonymousRouteAuthorizationPolicy) String() string

type AnyOfRouteAuthorizationPolicy Uses

type AnyOfRouteAuthorizationPolicy struct {

    // A user whose scope includes any of these access ranges is allowed on
    // this route. Access ranges are case-sensitive.
    AllowedScope []string `mandatory:"true" json:"allowedScope"`
}

AnyOfRouteAuthorizationPolicy If authentication has been performed, validate whether the request scope (if any) applies to this route.

func (AnyOfRouteAuthorizationPolicy) MarshalJSON Uses

func (m AnyOfRouteAuthorizationPolicy) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (AnyOfRouteAuthorizationPolicy) String Uses

func (m AnyOfRouteAuthorizationPolicy) String() string

type ApiSpecification Uses

type ApiSpecification struct {
    RequestPolicies *ApiSpecificationRequestPolicies `mandatory:"false" json:"requestPolicies"`

    LoggingPolicies *ApiSpecificationLoggingPolicies `mandatory:"false" json:"loggingPolicies"`

    // A list of routes that this API exposes.
    Routes []ApiSpecificationRoute `mandatory:"false" json:"routes"`
}

ApiSpecification The logical configuration of the API exposed by a deployment.

func (ApiSpecification) String Uses

func (m ApiSpecification) String() string

type ApiSpecificationLoggingPolicies Uses

type ApiSpecificationLoggingPolicies struct {
    AccessLog *AccessLogPolicy `mandatory:"false" json:"accessLog"`

    ExecutionLog *ExecutionLogPolicy `mandatory:"false" json:"executionLog"`
}

ApiSpecificationLoggingPolicies Policies controlling the pushing of logs to OCI Public Logging.

func (ApiSpecificationLoggingPolicies) String Uses

func (m ApiSpecificationLoggingPolicies) String() string

type ApiSpecificationRequestPolicies Uses

type ApiSpecificationRequestPolicies struct {
    Authentication AuthenticationPolicy `mandatory:"false" json:"authentication"`

    RateLimiting *RateLimitingPolicy `mandatory:"false" json:"rateLimiting"`

    Cors *CorsPolicy `mandatory:"false" json:"cors"`
}

ApiSpecificationRequestPolicies Global behavior applied to all requests received by the API.

func (ApiSpecificationRequestPolicies) String Uses

func (m ApiSpecificationRequestPolicies) String() string

func (*ApiSpecificationRequestPolicies) UnmarshalJSON Uses

func (m *ApiSpecificationRequestPolicies) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type ApiSpecificationRoute Uses

type ApiSpecificationRoute struct {

    // A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers
    // to allow wildcard and parameterized matching.
    Path *string `mandatory:"true" json:"path"`

    Backend ApiSpecificationRouteBackend `mandatory:"true" json:"backend"`

    // A list of allowed methods on this route.
    Methods []ApiSpecificationRouteMethodsEnum `mandatory:"false" json:"methods,omitempty"`

    RequestPolicies *ApiSpecificationRouteRequestPolicies `mandatory:"false" json:"requestPolicies"`

    LoggingPolicies *ApiSpecificationLoggingPolicies `mandatory:"false" json:"loggingPolicies"`
}

ApiSpecificationRoute A single route that forwards requests to a particular backend and may contain some additional policies.

func (ApiSpecificationRoute) String Uses

func (m ApiSpecificationRoute) String() string

func (*ApiSpecificationRoute) UnmarshalJSON Uses

func (m *ApiSpecificationRoute) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type ApiSpecificationRouteBackend Uses

type ApiSpecificationRouteBackend interface {
}

ApiSpecificationRouteBackend The backend to forward requests to.

type ApiSpecificationRouteBackendTypeEnum Uses

type ApiSpecificationRouteBackendTypeEnum string

ApiSpecificationRouteBackendTypeEnum Enum with underlying type: string

const (
    ApiSpecificationRouteBackendTypeOracleFunctionsBackend ApiSpecificationRouteBackendTypeEnum = "ORACLE_FUNCTIONS_BACKEND"
    ApiSpecificationRouteBackendTypeHttpBackend            ApiSpecificationRouteBackendTypeEnum = "HTTP_BACKEND"
    ApiSpecificationRouteBackendTypeStockResponseBackend   ApiSpecificationRouteBackendTypeEnum = "STOCK_RESPONSE_BACKEND"
)

Set of constants representing the allowable values for ApiSpecificationRouteBackendTypeEnum

func GetApiSpecificationRouteBackendTypeEnumValues Uses

func GetApiSpecificationRouteBackendTypeEnumValues() []ApiSpecificationRouteBackendTypeEnum

GetApiSpecificationRouteBackendTypeEnumValues Enumerates the set of values for ApiSpecificationRouteBackendTypeEnum

type ApiSpecificationRouteMethodsEnum Uses

type ApiSpecificationRouteMethodsEnum string

ApiSpecificationRouteMethodsEnum Enum with underlying type: string

const (
    ApiSpecificationRouteMethodsAny     ApiSpecificationRouteMethodsEnum = "ANY"
    ApiSpecificationRouteMethodsHead    ApiSpecificationRouteMethodsEnum = "HEAD"
    ApiSpecificationRouteMethodsGet     ApiSpecificationRouteMethodsEnum = "GET"
    ApiSpecificationRouteMethodsPost    ApiSpecificationRouteMethodsEnum = "POST"
    ApiSpecificationRouteMethodsPut     ApiSpecificationRouteMethodsEnum = "PUT"
    ApiSpecificationRouteMethodsPatch   ApiSpecificationRouteMethodsEnum = "PATCH"
    ApiSpecificationRouteMethodsDelete  ApiSpecificationRouteMethodsEnum = "DELETE"
    ApiSpecificationRouteMethodsOptions ApiSpecificationRouteMethodsEnum = "OPTIONS"
)

Set of constants representing the allowable values for ApiSpecificationRouteMethodsEnum

func GetApiSpecificationRouteMethodsEnumValues Uses

func GetApiSpecificationRouteMethodsEnumValues() []ApiSpecificationRouteMethodsEnum

GetApiSpecificationRouteMethodsEnumValues Enumerates the set of values for ApiSpecificationRouteMethodsEnum

type ApiSpecificationRouteRequestPolicies Uses

type ApiSpecificationRouteRequestPolicies struct {
    Authorization RouteAuthorizationPolicy `mandatory:"false" json:"authorization"`

    Cors *CorsPolicy `mandatory:"false" json:"cors"`
}

ApiSpecificationRouteRequestPolicies Behavior applied to any requests received by the API on this route.

func (ApiSpecificationRouteRequestPolicies) String Uses

func (m ApiSpecificationRouteRequestPolicies) String() string

func (*ApiSpecificationRouteRequestPolicies) UnmarshalJSON Uses

func (m *ApiSpecificationRouteRequestPolicies) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type AuthenticationOnlyRouteAuthorizationPolicy Uses

type AuthenticationOnlyRouteAuthorizationPolicy struct {
}

AuthenticationOnlyRouteAuthorizationPolicy Only authentication is performed for the request and authorization is skipped.

func (AuthenticationOnlyRouteAuthorizationPolicy) MarshalJSON Uses

func (m AuthenticationOnlyRouteAuthorizationPolicy) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (AuthenticationOnlyRouteAuthorizationPolicy) String Uses

func (m AuthenticationOnlyRouteAuthorizationPolicy) String() string

type AuthenticationPolicy Uses

type AuthenticationPolicy interface {

    // Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS
    // route authorization.
    GetIsAnonymousAccessAllowed() *bool
}

AuthenticationPolicy Information on how to authenticate incoming requests.

type AuthenticationPolicyTypeEnum Uses

type AuthenticationPolicyTypeEnum string

AuthenticationPolicyTypeEnum Enum with underlying type: string

const (
    AuthenticationPolicyTypeCustomAuthentication AuthenticationPolicyTypeEnum = "CUSTOM_AUTHENTICATION"
)

Set of constants representing the allowable values for AuthenticationPolicyTypeEnum

func GetAuthenticationPolicyTypeEnumValues Uses

func GetAuthenticationPolicyTypeEnumValues() []AuthenticationPolicyTypeEnum

GetAuthenticationPolicyTypeEnumValues Enumerates the set of values for AuthenticationPolicyTypeEnum

type CancelWorkRequestRequest Uses

type CancelWorkRequestRequest struct {

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

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

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

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

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

CancelWorkRequestRequest wrapper for the CancelWorkRequest operation

func (CancelWorkRequestRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CancelWorkRequestRequest) RetryPolicy Uses

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

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

func (CancelWorkRequestRequest) String Uses

func (request CancelWorkRequestRequest) String() string

type CancelWorkRequestResponse Uses

type CancelWorkRequestResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

CancelWorkRequestResponse wrapper for the CancelWorkRequest operation

func (CancelWorkRequestResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CancelWorkRequestResponse) String Uses

func (response CancelWorkRequestResponse) String() string

type ChangeDeploymentCompartmentDetails Uses

type ChangeDeploymentCompartmentDetails struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
    // resource is created.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeDeploymentCompartmentDetails The new compartment details for the deployment.

func (ChangeDeploymentCompartmentDetails) String Uses

func (m ChangeDeploymentCompartmentDetails) String() string

type ChangeDeploymentCompartmentRequest Uses

type ChangeDeploymentCompartmentRequest struct {

    // The ocid of the deployment.
    DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`

    // Details of the target compartment.
    ChangeDeploymentCompartmentDetails `contributesTo:"body"`

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

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

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

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

ChangeDeploymentCompartmentRequest wrapper for the ChangeDeploymentCompartment operation

func (ChangeDeploymentCompartmentRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ChangeDeploymentCompartmentRequest) RetryPolicy Uses

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

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

func (ChangeDeploymentCompartmentRequest) String Uses

func (request ChangeDeploymentCompartmentRequest) String() string

type ChangeDeploymentCompartmentResponse Uses

type ChangeDeploymentCompartmentResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

ChangeDeploymentCompartmentResponse wrapper for the ChangeDeploymentCompartment operation

func (ChangeDeploymentCompartmentResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ChangeDeploymentCompartmentResponse) String Uses

func (response ChangeDeploymentCompartmentResponse) String() string

type ChangeGatewayCompartmentDetails Uses

type ChangeGatewayCompartmentDetails struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
    // resource is created.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeGatewayCompartmentDetails The new compartment details for the gateway.

func (ChangeGatewayCompartmentDetails) String Uses

func (m ChangeGatewayCompartmentDetails) String() string

type ChangeGatewayCompartmentRequest Uses

type ChangeGatewayCompartmentRequest struct {

    // The ocid of the gateway.
    GatewayId *string `mandatory:"true" contributesTo:"path" name:"gatewayId"`

    // Details of the target compartment.
    ChangeGatewayCompartmentDetails `contributesTo:"body"`

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

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

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

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

ChangeGatewayCompartmentRequest wrapper for the ChangeGatewayCompartment operation

func (ChangeGatewayCompartmentRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ChangeGatewayCompartmentRequest) RetryPolicy Uses

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

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

func (ChangeGatewayCompartmentRequest) String Uses

func (request ChangeGatewayCompartmentRequest) String() string

type ChangeGatewayCompartmentResponse Uses

type ChangeGatewayCompartmentResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

ChangeGatewayCompartmentResponse wrapper for the ChangeGatewayCompartment operation

func (ChangeGatewayCompartmentResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ChangeGatewayCompartmentResponse) String Uses

func (response ChangeGatewayCompartmentResponse) String() string

type CorsPolicy Uses

type CorsPolicy struct {

    // The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will
    // send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match
    // any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the
    // scheme, full hostname, and port if necessary.
    AllowedOrigins []string `mandatory:"true" json:"allowedOrigins"`

    // The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the
    // Access-Control-Allow-Methods header. '*' will allow all methods.
    AllowedMethods []string `mandatory:"false" json:"allowedMethods"`

    // The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header.
    // '*' will allow all headers.
    AllowedHeaders []string `mandatory:"false" json:"allowedHeaders"`

    // The list of headers that the client will be allowed to see from the response as indicated by the
    // Access-Control-Expose-Headers header. '*' will expose all headers.
    ExposedHeaders []string `mandatory:"false" json:"exposedHeaders"`

    // Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.
    IsAllowCredentialsEnabled *bool `mandatory:"false" json:"isAllowCredentialsEnabled"`

    // The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age
    // if greater than 0.
    MaxAgeInSeconds *int `mandatory:"false" json:"maxAgeInSeconds"`
}

CorsPolicy Enable CORS (Cross-Origin-Resource-Sharing) request handling.

func (CorsPolicy) String Uses

func (m CorsPolicy) String() string

type CreateDeploymentDetails Uses

type CreateDeploymentDetails struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
    GatewayId *string `mandatory:"true" json:"gatewayId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
    // resource is created.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // A path on which to deploy all routes contained in the API
    // deployment specification. For more information, see
    // Deploying an API on an API Gateway by Creating an API
    // Deployment (https://docs.cloud.oracle.com/iaas/Content/APIGateway/Tasks/apigatewaycreatingdeployment.htm).
    PathPrefix *string `mandatory:"true" json:"pathPrefix"`

    Specification *ApiSpecification `mandatory:"true" json:"specification"`

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

    // 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/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/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateDeploymentDetails Information about a new deployment.

func (CreateDeploymentDetails) String Uses

func (m CreateDeploymentDetails) String() string

type CreateDeploymentRequest Uses

type CreateDeploymentRequest struct {

    // Details for the new deployment
    CreateDeploymentDetails `contributesTo:"body"`

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

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

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

CreateDeploymentRequest wrapper for the CreateDeployment operation

func (CreateDeploymentRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CreateDeploymentRequest) RetryPolicy Uses

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

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

func (CreateDeploymentRequest) String Uses

func (request CreateDeploymentRequest) String() string

type CreateDeploymentResponse Uses

type CreateDeploymentResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

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

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

    // Location of the resource.
    Location *string `presentIn:"header" name:"location"`
}

CreateDeploymentResponse wrapper for the CreateDeployment operation

func (CreateDeploymentResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateDeploymentResponse) String Uses

func (response CreateDeploymentResponse) String() string

type CreateGatewayDetails Uses

type CreateGatewayDetails struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
    // resource is created.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // Gateway endpoint type.
    EndpointType GatewayEndpointTypeEnum `mandatory:"true" json:"endpointType"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the subnet in which
    // related resources are created.
    SubnetId *string `mandatory:"true" json:"subnetId"`

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

    // 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/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/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateGatewayDetails Information about the new gateway.

func (CreateGatewayDetails) String Uses

func (m CreateGatewayDetails) String() string

type CreateGatewayRequest Uses

type CreateGatewayRequest struct {

    // Details for the new gateway.
    CreateGatewayDetails `contributesTo:"body"`

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

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

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

CreateGatewayRequest wrapper for the CreateGateway operation

func (CreateGatewayRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CreateGatewayRequest) RetryPolicy Uses

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

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

func (CreateGatewayRequest) String Uses

func (request CreateGatewayRequest) String() string

type CreateGatewayResponse Uses

type CreateGatewayResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

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

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

    // Location of the resource.
    Location *string `presentIn:"header" name:"location"`
}

CreateGatewayResponse wrapper for the CreateGateway operation

func (CreateGatewayResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateGatewayResponse) String Uses

func (response CreateGatewayResponse) String() string

type CustomAuthenticationPolicy Uses

type CustomAuthenticationPolicy struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.
    FunctionId *string `mandatory:"true" json:"functionId"`

    // Whether an unauthenticated user may access the API. Must be "true" to enable ANONYMOUS
    // route authorization.
    IsAnonymousAccessAllowed *bool `mandatory:"false" json:"isAnonymousAccessAllowed"`

    // The name of the header containing the authentication token.
    TokenHeader *string `mandatory:"false" json:"tokenHeader"`

    // The name of the query parameter containing the authentication token.
    TokenQueryParam *string `mandatory:"false" json:"tokenQueryParam"`
}

CustomAuthenticationPolicy Use a function to validate a custom header or query parameter sent with the request authentication. A valid policy must specify either tokenHeader or tokenQueryParam.

func (CustomAuthenticationPolicy) GetIsAnonymousAccessAllowed Uses

func (m CustomAuthenticationPolicy) GetIsAnonymousAccessAllowed() *bool

GetIsAnonymousAccessAllowed returns IsAnonymousAccessAllowed

func (CustomAuthenticationPolicy) MarshalJSON Uses

func (m CustomAuthenticationPolicy) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CustomAuthenticationPolicy) String Uses

func (m CustomAuthenticationPolicy) String() string

type DeleteDeploymentRequest Uses

type DeleteDeploymentRequest struct {

    // The ocid of the deployment.
    DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`

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

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

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

DeleteDeploymentRequest wrapper for the DeleteDeployment operation

func (DeleteDeploymentRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (DeleteDeploymentRequest) RetryPolicy Uses

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

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

func (DeleteDeploymentRequest) String Uses

func (request DeleteDeploymentRequest) String() string

type DeleteDeploymentResponse Uses

type DeleteDeploymentResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

DeleteDeploymentResponse wrapper for the DeleteDeployment operation

func (DeleteDeploymentResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteDeploymentResponse) String Uses

func (response DeleteDeploymentResponse) String() string

type DeleteGatewayRequest Uses

type DeleteGatewayRequest struct {

    // The ocid of the gateway.
    GatewayId *string `mandatory:"true" contributesTo:"path" name:"gatewayId"`

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

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

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

DeleteGatewayRequest wrapper for the DeleteGateway operation

func (DeleteGatewayRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (DeleteGatewayRequest) RetryPolicy Uses

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

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

func (DeleteGatewayRequest) String Uses

func (request DeleteGatewayRequest) String() string

type DeleteGatewayResponse Uses

type DeleteGatewayResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

DeleteGatewayResponse wrapper for the DeleteGateway operation

func (DeleteGatewayResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteGatewayResponse) String Uses

func (response DeleteGatewayResponse) String() string

type Deployment Uses

type Deployment struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
    Id  *string `mandatory:"true" json:"id"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
    GatewayId *string `mandatory:"true" json:"gatewayId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
    // resource is created.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // A path on which to deploy all routes contained in the API
    // deployment specification. For more information, see
    // Deploying an API on an API Gateway by Creating an API
    // Deployment (https://docs.cloud.oracle.com/iaas/Content/APIGateway/Tasks/apigatewaycreatingdeployment.htm).
    PathPrefix *string `mandatory:"true" json:"pathPrefix"`

    // The endpoint to access this deployment on the gateway.
    Endpoint *string `mandatory:"true" json:"endpoint"`

    Specification *ApiSpecification `mandatory:"true" json:"specification"`

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

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

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

    // The current state of the deployment.
    LifecycleState DeploymentLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

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

    // 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/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/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

Deployment A deployment deploys an API on a gateway. Avoid entering confidential information. For more information, see API Gateway Concepts (https://docs.cloud.oracle.com/iaas/Content/APIGateway/Concepts/apigatewayconcepts.htm).

func (Deployment) String Uses

func (m Deployment) String() string

type DeploymentClient Uses

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

DeploymentClient a client for Deployment

func NewDeploymentClientWithConfigurationProvider Uses

func NewDeploymentClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DeploymentClient, err error)

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

func NewDeploymentClientWithOboToken Uses

func NewDeploymentClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DeploymentClient, err error)

NewDeploymentClientWithOboToken Creates a new default Deployment 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 (DeploymentClient) ChangeDeploymentCompartment Uses

func (client DeploymentClient) ChangeDeploymentCompartment(ctx context.Context, request ChangeDeploymentCompartmentRequest) (response ChangeDeploymentCompartmentResponse, err error)

ChangeDeploymentCompartment Changes the deployment compartment.

func (*DeploymentClient) ConfigurationProvider Uses

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

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

func (DeploymentClient) CreateDeployment Uses

func (client DeploymentClient) CreateDeployment(ctx context.Context, request CreateDeploymentRequest) (response CreateDeploymentResponse, err error)

CreateDeployment Creates a new deployment.

func (DeploymentClient) DeleteDeployment Uses

func (client DeploymentClient) DeleteDeployment(ctx context.Context, request DeleteDeploymentRequest) (response DeleteDeploymentResponse, err error)

DeleteDeployment Deletes the deployment with the given identifier.

func (DeploymentClient) GetDeployment Uses

func (client DeploymentClient) GetDeployment(ctx context.Context, request GetDeploymentRequest) (response GetDeploymentResponse, err error)

GetDeployment Gets a deployment by identifier.

func (DeploymentClient) ListDeployments Uses

func (client DeploymentClient) ListDeployments(ctx context.Context, request ListDeploymentsRequest) (response ListDeploymentsResponse, err error)

ListDeployments Returns a list of deployments.

func (*DeploymentClient) SetRegion Uses

func (client *DeploymentClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (DeploymentClient) UpdateDeployment Uses

func (client DeploymentClient) UpdateDeployment(ctx context.Context, request UpdateDeploymentRequest) (response UpdateDeploymentResponse, err error)

UpdateDeployment Updates the deployment with the given identifier.

type DeploymentCollection Uses

type DeploymentCollection struct {

    // Deployment summaries.
    Items []DeploymentSummary `mandatory:"true" json:"items"`
}

DeploymentCollection Collection of deployment summaries.

func (DeploymentCollection) String Uses

func (m DeploymentCollection) String() string

type DeploymentLifecycleStateEnum Uses

type DeploymentLifecycleStateEnum string

DeploymentLifecycleStateEnum Enum with underlying type: string

const (
    DeploymentLifecycleStateCreating DeploymentLifecycleStateEnum = "CREATING"
    DeploymentLifecycleStateActive   DeploymentLifecycleStateEnum = "ACTIVE"
    DeploymentLifecycleStateUpdating DeploymentLifecycleStateEnum = "UPDATING"
    DeploymentLifecycleStateDeleting DeploymentLifecycleStateEnum = "DELETING"
    DeploymentLifecycleStateDeleted  DeploymentLifecycleStateEnum = "DELETED"
    DeploymentLifecycleStateFailed   DeploymentLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for DeploymentLifecycleStateEnum

func GetDeploymentLifecycleStateEnumValues Uses

func GetDeploymentLifecycleStateEnumValues() []DeploymentLifecycleStateEnum

GetDeploymentLifecycleStateEnumValues Enumerates the set of values for DeploymentLifecycleStateEnum

type DeploymentSummary Uses

type DeploymentSummary struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
    Id  *string `mandatory:"true" json:"id"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
    GatewayId *string `mandatory:"true" json:"gatewayId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
    // resource is created.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The path on which all routes contained in the API
    // deployment specification are deployed. For more information, see
    // Deploying an API on an API Gateway by Creating an API
    // Deployment (https://docs.cloud.oracle.com/iaas/Content/APIGateway/Tasks/apigatewaycreatingdeployment.htm).
    PathPrefix *string `mandatory:"true" json:"pathPrefix"`

    // The endpoint to access this deployment on the gateway.
    Endpoint *string `mandatory:"true" json:"endpoint"`

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

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

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

    // The current state of the deployment.
    LifecycleState DeploymentLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

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

    // 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/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/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

DeploymentSummary A summary of the deployment.

func (DeploymentSummary) String Uses

func (m DeploymentSummary) String() string

type ExecutionLogPolicy Uses

type ExecutionLogPolicy struct {

    // Enables pushing of execution logs to OCI Public Logging.
    IsEnabled *bool `mandatory:"false" json:"isEnabled"`

    // Specifies the logging level, which affects the log entries pushed to
    // OCI Public Logging if `isEnabled` is set to True.
    LogLevel ExecutionLogPolicyLogLevelEnum `mandatory:"false" json:"logLevel,omitempty"`
}

ExecutionLogPolicy Configures the pushing of execution logs to OCI Public Logging.

func (ExecutionLogPolicy) String Uses

func (m ExecutionLogPolicy) String() string

type ExecutionLogPolicyLogLevelEnum Uses

type ExecutionLogPolicyLogLevelEnum string

ExecutionLogPolicyLogLevelEnum Enum with underlying type: string

const (
    ExecutionLogPolicyLogLevelInfo  ExecutionLogPolicyLogLevelEnum = "INFO"
    ExecutionLogPolicyLogLevelWarn  ExecutionLogPolicyLogLevelEnum = "WARN"
    ExecutionLogPolicyLogLevelError ExecutionLogPolicyLogLevelEnum = "ERROR"
)

Set of constants representing the allowable values for ExecutionLogPolicyLogLevelEnum

func GetExecutionLogPolicyLogLevelEnumValues Uses

func GetExecutionLogPolicyLogLevelEnumValues() []ExecutionLogPolicyLogLevelEnum

GetExecutionLogPolicyLogLevelEnumValues Enumerates the set of values for ExecutionLogPolicyLogLevelEnum

type Gateway Uses

type Gateway struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
    Id  *string `mandatory:"true" json:"id"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
    // resource is created.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // Gateway endpoint type.
    EndpointType GatewayEndpointTypeEnum `mandatory:"true" json:"endpointType"`

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

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the subnet in which
    // related resources are created.
    SubnetId *string `mandatory:"false" json:"subnetId"`

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

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

    // The current state of the gateway.
    LifecycleState GatewayLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

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

    // The hostname for APIs deployed on the gateway.
    Hostname *string `mandatory:"false" json:"hostname"`

    // 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/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/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

Gateway A gateway is a virtual network appliance in a regional subnet. A gateway routes inbound traffic to back-end services including public, private, and partner HTTP APIs, as well as Oracle Functions. Avoid entering confidential information. For more information, see API Gateway Concepts (https://docs.cloud.oracle.com/iaas/Content/APIGateway/Concepts/apigatewayconcepts.htm).

func (Gateway) String Uses

func (m Gateway) String() string

type GatewayClient Uses

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

GatewayClient a client for Gateway

func NewGatewayClientWithConfigurationProvider Uses

func NewGatewayClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client GatewayClient, err error)

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

func NewGatewayClientWithOboToken Uses

func NewGatewayClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client GatewayClient, err error)

NewGatewayClientWithOboToken Creates a new default Gateway 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 (GatewayClient) ChangeGatewayCompartment Uses

func (client GatewayClient) ChangeGatewayCompartment(ctx context.Context, request ChangeGatewayCompartmentRequest) (response ChangeGatewayCompartmentResponse, err error)

ChangeGatewayCompartment Changes the gateway compartment.

func (*GatewayClient) ConfigurationProvider Uses

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

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

func (GatewayClient) CreateGateway Uses

func (client GatewayClient) CreateGateway(ctx context.Context, request CreateGatewayRequest) (response CreateGatewayResponse, err error)

CreateGateway Creates a new gateway.

func (GatewayClient) DeleteGateway Uses

func (client GatewayClient) DeleteGateway(ctx context.Context, request DeleteGatewayRequest) (response DeleteGatewayResponse, err error)

DeleteGateway Deletes the gateway with the given identifier.

func (GatewayClient) GetGateway Uses

func (client GatewayClient) GetGateway(ctx context.Context, request GetGatewayRequest) (response GetGatewayResponse, err error)

GetGateway Gets a gateway by identifier.

func (GatewayClient) ListGateways Uses

func (client GatewayClient) ListGateways(ctx context.Context, request ListGatewaysRequest) (response ListGatewaysResponse, err error)

ListGateways Returns a list of gateways.

func (*GatewayClient) SetRegion Uses

func (client *GatewayClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (GatewayClient) UpdateGateway Uses

func (client GatewayClient) UpdateGateway(ctx context.Context, request UpdateGatewayRequest) (response UpdateGatewayResponse, err error)

UpdateGateway Updates the gateway with the given identifier.

type GatewayCollection Uses

type GatewayCollection struct {

    // Gateway summaries.
    Items []GatewaySummary `mandatory:"true" json:"items"`
}

GatewayCollection Collection of gateway summaries.

func (GatewayCollection) String Uses

func (m GatewayCollection) String() string

type GatewayEndpointTypeEnum Uses

type GatewayEndpointTypeEnum string

GatewayEndpointTypeEnum Enum with underlying type: string

const (
    GatewayEndpointTypePublic  GatewayEndpointTypeEnum = "PUBLIC"
    GatewayEndpointTypePrivate GatewayEndpointTypeEnum = "PRIVATE"
)

Set of constants representing the allowable values for GatewayEndpointTypeEnum

func GetGatewayEndpointTypeEnumValues Uses

func GetGatewayEndpointTypeEnumValues() []GatewayEndpointTypeEnum

GetGatewayEndpointTypeEnumValues Enumerates the set of values for GatewayEndpointTypeEnum

type GatewayLifecycleStateEnum Uses

type GatewayLifecycleStateEnum string

GatewayLifecycleStateEnum Enum with underlying type: string

const (
    GatewayLifecycleStateCreating GatewayLifecycleStateEnum = "CREATING"
    GatewayLifecycleStateActive   GatewayLifecycleStateEnum = "ACTIVE"
    GatewayLifecycleStateUpdating GatewayLifecycleStateEnum = "UPDATING"
    GatewayLifecycleStateDeleting GatewayLifecycleStateEnum = "DELETING"
    GatewayLifecycleStateDeleted  GatewayLifecycleStateEnum = "DELETED"
    GatewayLifecycleStateFailed   GatewayLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for GatewayLifecycleStateEnum

func GetGatewayLifecycleStateEnumValues Uses

func GetGatewayLifecycleStateEnumValues() []GatewayLifecycleStateEnum

GetGatewayLifecycleStateEnumValues Enumerates the set of values for GatewayLifecycleStateEnum

type GatewaySummary Uses

type GatewaySummary struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
    Id  *string `mandatory:"true" json:"id"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
    // resource is created.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // Gateway endpoint type.
    EndpointType GatewayEndpointTypeEnum `mandatory:"true" json:"endpointType"`

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

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the subnet in which
    // related resources are created.
    SubnetId *string `mandatory:"false" json:"subnetId"`

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

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

    // The current state of the gateway.
    LifecycleState GatewayLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

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

    // The hostname for the APIs deployed on the gateway.
    Hostname *string `mandatory:"false" json:"hostname"`

    // 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/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/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

GatewaySummary A summary of the gateway.

func (GatewaySummary) String Uses

func (m GatewaySummary) String() string

type GetDeploymentRequest Uses

type GetDeploymentRequest struct {

    // The ocid of the deployment.
    DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`

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

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

GetDeploymentRequest wrapper for the GetDeployment operation

func (GetDeploymentRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetDeploymentRequest) RetryPolicy Uses

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

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

func (GetDeploymentRequest) String Uses

func (request GetDeploymentRequest) String() string

type GetDeploymentResponse Uses

type GetDeploymentResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

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

GetDeploymentResponse wrapper for the GetDeployment operation

func (GetDeploymentResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetDeploymentResponse) String Uses

func (response GetDeploymentResponse) String() string

type GetGatewayRequest Uses

type GetGatewayRequest struct {

    // The ocid of the gateway.
    GatewayId *string `mandatory:"true" contributesTo:"path" name:"gatewayId"`

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

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

GetGatewayRequest wrapper for the GetGateway operation

func (GetGatewayRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetGatewayRequest) RetryPolicy Uses

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

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

func (GetGatewayRequest) String Uses

func (request GetGatewayRequest) String() string

type GetGatewayResponse Uses

type GetGatewayResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

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

GetGatewayResponse wrapper for the GetGateway operation

func (GetGatewayResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetGatewayResponse) String Uses

func (response GetGatewayResponse) String() string

type GetWorkRequestRequest Uses

type GetWorkRequestRequest struct {

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

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

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

GetWorkRequestRequest wrapper for the GetWorkRequest operation

func (GetWorkRequestRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy Uses

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

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

func (GetWorkRequestRequest) String Uses

func (request GetWorkRequestRequest) String() string

type GetWorkRequestResponse Uses

type GetWorkRequestResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

    // For optimistic concurrency control. See `if-match`.
    Etag *string `presentIn:"header" name:"etag"`

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

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

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String Uses

func (response GetWorkRequestResponse) String() string

type HeaderFieldSpecification Uses

type HeaderFieldSpecification struct {

    // Name of the header.
    Name *string `mandatory:"false" json:"name"`

    // Value of the header.
    Value *string `mandatory:"false" json:"value"`
}

HeaderFieldSpecification Header in key/value pair.

func (HeaderFieldSpecification) String Uses

func (m HeaderFieldSpecification) String() string

type HttpBackend Uses

type HttpBackend struct {
    Url *string `mandatory:"true" json:"url"`

    // Defines a timeout for establishing a connection with a proxied server.
    ConnectTimeoutInSeconds *float32 `mandatory:"false" json:"connectTimeoutInSeconds"`

    // Defines a timeout for reading a response from the proxied server.
    ReadTimeoutInSeconds *float32 `mandatory:"false" json:"readTimeoutInSeconds"`

    // Defines a timeout for transmitting a request to the proxied server.
    SendTimeoutInSeconds *float32 `mandatory:"false" json:"sendTimeoutInSeconds"`

    // Defines whether or not to uphold SSL verification.
    IsSslVerifyDisabled *bool `mandatory:"false" json:"isSslVerifyDisabled"`
}

HttpBackend Send the request to an HTTP backend.

func (HttpBackend) MarshalJSON Uses

func (m HttpBackend) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (HttpBackend) String Uses

func (m HttpBackend) String() string

type ListDeploymentsRequest Uses

type ListDeploymentsRequest struct {

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

    // Filter deployments by the gateway ocid.
    GatewayId *string `mandatory:"false" contributesTo:"query" name:"gatewayId"`

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

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

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

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

    // The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.
    SortOrder ListDeploymentsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // The field to sort by. You can provide one sort order (`sortOrder`).
    // Default order for `timeCreated` is descending. Default order for
    // `displayName` is ascending. The `displayName` sort order is case
    // sensitive.
    SortBy ListDeploymentsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

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

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

ListDeploymentsRequest wrapper for the ListDeployments operation

func (ListDeploymentsRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListDeploymentsRequest) RetryPolicy Uses

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

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

func (ListDeploymentsRequest) String Uses

func (request ListDeploymentsRequest) String() string

type ListDeploymentsResponse Uses

type ListDeploymentsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of DeploymentCollection instances
    DeploymentCollection `presentIn:"body"`

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

    // For list pagination. When this header appears in the response,
    // additional pages of results remain. 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"`

    // For list pagination. When this header appears in the response,
    // additional pages of results were seen previously. For important details
    // about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}

ListDeploymentsResponse wrapper for the ListDeployments operation

func (ListDeploymentsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListDeploymentsResponse) String Uses

func (response ListDeploymentsResponse) String() string

type ListDeploymentsSortByEnum Uses

type ListDeploymentsSortByEnum string

ListDeploymentsSortByEnum Enum with underlying type: string

const (
    ListDeploymentsSortByTimecreated ListDeploymentsSortByEnum = "timeCreated"
    ListDeploymentsSortByDisplayname ListDeploymentsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListDeploymentsSortByEnum

func GetListDeploymentsSortByEnumValues Uses

func GetListDeploymentsSortByEnumValues() []ListDeploymentsSortByEnum

GetListDeploymentsSortByEnumValues Enumerates the set of values for ListDeploymentsSortByEnum

type ListDeploymentsSortOrderEnum Uses

type ListDeploymentsSortOrderEnum string

ListDeploymentsSortOrderEnum Enum with underlying type: string

const (
    ListDeploymentsSortOrderAsc  ListDeploymentsSortOrderEnum = "ASC"
    ListDeploymentsSortOrderDesc ListDeploymentsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDeploymentsSortOrderEnum

func GetListDeploymentsSortOrderEnumValues Uses

func GetListDeploymentsSortOrderEnumValues() []ListDeploymentsSortOrderEnum

GetListDeploymentsSortOrderEnumValues Enumerates the set of values for ListDeploymentsSortOrderEnum

type ListGatewaysRequest Uses

type ListGatewaysRequest struct {

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

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

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

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

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

    // The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.
    SortOrder ListGatewaysSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // The field to sort by. You can provide one sort order (`sortOrder`).
    // Default order for `timeCreated` is descending. Default order for
    // `displayName` is ascending. The `displayName` sort order is case
    // sensitive.
    SortBy ListGatewaysSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

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

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

ListGatewaysRequest wrapper for the ListGateways operation

func (ListGatewaysRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListGatewaysRequest) RetryPolicy Uses

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

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

func (ListGatewaysRequest) String Uses

func (request ListGatewaysRequest) String() string

type ListGatewaysResponse Uses

type ListGatewaysResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of GatewayCollection instances
    GatewayCollection `presentIn:"body"`

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

    // For list pagination. When this header appears in the response,
    // additional pages of results remain. 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"`

    // For list pagination. When this header appears in the response,
    // additional pages of results were seen previously. For important details
    // about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}

ListGatewaysResponse wrapper for the ListGateways operation

func (ListGatewaysResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListGatewaysResponse) String Uses

func (response ListGatewaysResponse) String() string

type ListGatewaysSortByEnum Uses

type ListGatewaysSortByEnum string

ListGatewaysSortByEnum Enum with underlying type: string

const (
    ListGatewaysSortByTimecreated ListGatewaysSortByEnum = "timeCreated"
    ListGatewaysSortByDisplayname ListGatewaysSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListGatewaysSortByEnum

func GetListGatewaysSortByEnumValues Uses

func GetListGatewaysSortByEnumValues() []ListGatewaysSortByEnum

GetListGatewaysSortByEnumValues Enumerates the set of values for ListGatewaysSortByEnum

type ListGatewaysSortOrderEnum Uses

type ListGatewaysSortOrderEnum string

ListGatewaysSortOrderEnum Enum with underlying type: string

const (
    ListGatewaysSortOrderAsc  ListGatewaysSortOrderEnum = "ASC"
    ListGatewaysSortOrderDesc ListGatewaysSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListGatewaysSortOrderEnum

func GetListGatewaysSortOrderEnumValues Uses

func GetListGatewaysSortOrderEnumValues() []ListGatewaysSortOrderEnum

GetListGatewaysSortOrderEnumValues Enumerates the set of values for ListGatewaysSortOrderEnum

type ListWorkRequestErrorsRequest Uses

type ListWorkRequestErrorsRequest struct {

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

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

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

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

    // The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.
    SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // The field to sort by. You can provide one sort order (`sortOrder`).
    // Default order for `timeCreated` is descending. Default order for
    // `displayName` is ascending. The `displayName` sort order is case
    // sensitive.
    SortBy ListWorkRequestErrorsSortByEnum `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
}

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy Uses

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

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

func (ListWorkRequestErrorsRequest) String Uses

func (request ListWorkRequestErrorsRequest) String() string

type ListWorkRequestErrorsResponse Uses

type ListWorkRequestErrorsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of WorkRequestErrorCollection instances
    WorkRequestErrorCollection `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"`

    // For list pagination. When this header appears in the response,
    // additional pages of results were seen previously. For important details
    // about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`

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

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String Uses

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum Uses

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string

const (
    ListWorkRequestErrorsSortByTimecreated ListWorkRequestErrorsSortByEnum = "timeCreated"
    ListWorkRequestErrorsSortByDisplayname ListWorkRequestErrorsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues Uses

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

type ListWorkRequestErrorsSortOrderEnum Uses

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string

const (
    ListWorkRequestErrorsSortOrderAsc  ListWorkRequestErrorsSortOrderEnum = "ASC"
    ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues Uses

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

type ListWorkRequestLogsRequest Uses

type ListWorkRequestLogsRequest struct {

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

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

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

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

    // The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.
    SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // The field to sort by. You can provide one sort order (`sortOrder`).
    // Default order for `timeCreated` is descending. Default order for
    // `displayName` is ascending. The `displayName` sort order is case
    // sensitive.
    SortBy ListWorkRequestLogsSortByEnum `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
}

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy Uses

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

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

func (ListWorkRequestLogsRequest) String Uses

func (request ListWorkRequestLogsRequest) String() string

type ListWorkRequestLogsResponse Uses

type ListWorkRequestLogsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of WorkRequestLogCollection instances
    WorkRequestLogCollection `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"`

    // For list pagination. When this header appears in the response,
    // additional pages of results were seen previously. For important details
    // about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`

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

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String Uses

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum Uses

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string

const (
    ListWorkRequestLogsSortByTimecreated ListWorkRequestLogsSortByEnum = "timeCreated"
    ListWorkRequestLogsSortByDisplayname ListWorkRequestLogsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues Uses

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

type ListWorkRequestLogsSortOrderEnum Uses

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string

const (
    ListWorkRequestLogsSortOrderAsc  ListWorkRequestLogsSortOrderEnum = "ASC"
    ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues Uses

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

type ListWorkRequestsRequest Uses

type ListWorkRequestsRequest struct {

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

    // Filter work requests by the resource ocid.
    ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`

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

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

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

    // The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.
    SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // The field to sort by. You can provide one sort order (`sortOrder`).
    // Default order for `timeCreated` is descending. Default order for
    // `displayName` is ascending. The `displayName` sort order is case
    // sensitive.
    SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

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

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

func (ListWorkRequestsRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy Uses

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

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

func (ListWorkRequestsRequest) String Uses

func (request ListWorkRequestsRequest) String() string

type ListWorkRequestsResponse Uses

type ListWorkRequestsResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // A list of WorkRequestCollection instances
    WorkRequestCollection `presentIn:"body"`

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

    // For list pagination. When this header appears in the response,
    // additional pages of results remain. 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"`

    // For list pagination. When this header appears in the response,
    // additional pages of results were seen previously. For important details
    // about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
}

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String Uses

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum Uses

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string

const (
    ListWorkRequestsSortByTimecreated ListWorkRequestsSortByEnum = "timeCreated"
    ListWorkRequestsSortByDisplayname ListWorkRequestsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues Uses

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

type ListWorkRequestsSortOrderEnum Uses

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string

const (
    ListWorkRequestsSortOrderAsc  ListWorkRequestsSortOrderEnum = "ASC"
    ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues Uses

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

type OracleFunctionBackend Uses

type OracleFunctionBackend struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.
    FunctionId *string `mandatory:"true" json:"functionId"`
}

OracleFunctionBackend Send the request to an Oracle Functions function.

func (OracleFunctionBackend) MarshalJSON Uses

func (m OracleFunctionBackend) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (OracleFunctionBackend) String Uses

func (m OracleFunctionBackend) String() string

type RateLimitingPolicy Uses

type RateLimitingPolicy struct {

    // The maximum number of requests per second to allow.
    RateInRequestsPerSecond *int `mandatory:"true" json:"rateInRequestsPerSecond"`

    // The key used to group requests together.
    RateKey RateLimitingPolicyRateKeyEnum `mandatory:"true" json:"rateKey"`
}

RateLimitingPolicy Limit the number of requests that should be handled for the specified window using a specfic key.

func (RateLimitingPolicy) String Uses

func (m RateLimitingPolicy) String() string

type RateLimitingPolicyRateKeyEnum Uses

type RateLimitingPolicyRateKeyEnum string

RateLimitingPolicyRateKeyEnum Enum with underlying type: string

const (
    RateLimitingPolicyRateKeyClientIp RateLimitingPolicyRateKeyEnum = "CLIENT_IP"
    RateLimitingPolicyRateKeyTotal    RateLimitingPolicyRateKeyEnum = "TOTAL"
)

Set of constants representing the allowable values for RateLimitingPolicyRateKeyEnum

func GetRateLimitingPolicyRateKeyEnumValues Uses

func GetRateLimitingPolicyRateKeyEnumValues() []RateLimitingPolicyRateKeyEnum

GetRateLimitingPolicyRateKeyEnumValues Enumerates the set of values for RateLimitingPolicyRateKeyEnum

type RouteAuthorizationPolicy Uses

type RouteAuthorizationPolicy interface {
}

RouteAuthorizationPolicy If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.

type RouteAuthorizationPolicyTypeEnum Uses

type RouteAuthorizationPolicyTypeEnum string

RouteAuthorizationPolicyTypeEnum Enum with underlying type: string

const (
    RouteAuthorizationPolicyTypeAnonymous          RouteAuthorizationPolicyTypeEnum = "ANONYMOUS"
    RouteAuthorizationPolicyTypeAnyOf              RouteAuthorizationPolicyTypeEnum = "ANY_OF"
    RouteAuthorizationPolicyTypeAuthenticationOnly RouteAuthorizationPolicyTypeEnum = "AUTHENTICATION_ONLY"
)

Set of constants representing the allowable values for RouteAuthorizationPolicyTypeEnum

func GetRouteAuthorizationPolicyTypeEnumValues Uses

func GetRouteAuthorizationPolicyTypeEnumValues() []RouteAuthorizationPolicyTypeEnum

GetRouteAuthorizationPolicyTypeEnumValues Enumerates the set of values for RouteAuthorizationPolicyTypeEnum

type StockResponseBackend Uses

type StockResponseBackend struct {

    // The status code of the stock response from the mock backend.
    Status *int `mandatory:"true" json:"status"`

    // The body of the stock response from the mock backend.
    Body *string `mandatory:"false" json:"body"`

    // The headers of the stock response from the mock backend.
    Headers []HeaderFieldSpecification `mandatory:"false" json:"headers"`
}

StockResponseBackend Send the request to a mock backend.

func (StockResponseBackend) MarshalJSON Uses

func (m StockResponseBackend) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (StockResponseBackend) String Uses

func (m StockResponseBackend) String() string

type UpdateDeploymentDetails Uses

type UpdateDeploymentDetails struct {

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

    Specification *ApiSpecification `mandatory:"false" json:"specification"`

    // 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/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/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateDeploymentDetails The information to be updated.

func (UpdateDeploymentDetails) String Uses

func (m UpdateDeploymentDetails) String() string

type UpdateDeploymentRequest Uses

type UpdateDeploymentRequest struct {

    // The ocid of the deployment.
    DeploymentId *string `mandatory:"true" contributesTo:"path" name:"deploymentId"`

    // The information to be updated.
    UpdateDeploymentDetails `contributesTo:"body"`

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

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

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

UpdateDeploymentRequest wrapper for the UpdateDeployment operation

func (UpdateDeploymentRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (UpdateDeploymentRequest) RetryPolicy Uses

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

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

func (UpdateDeploymentRequest) String Uses

func (request UpdateDeploymentRequest) String() string

type UpdateDeploymentResponse Uses

type UpdateDeploymentResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

UpdateDeploymentResponse wrapper for the UpdateDeployment operation

func (UpdateDeploymentResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (UpdateDeploymentResponse) String Uses

func (response UpdateDeploymentResponse) String() string

type UpdateGatewayDetails Uses

type UpdateGatewayDetails struct {

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

    // 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/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/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateGatewayDetails The information to be updated.

func (UpdateGatewayDetails) String Uses

func (m UpdateGatewayDetails) String() string

type UpdateGatewayRequest Uses

type UpdateGatewayRequest struct {

    // The ocid of the gateway.
    GatewayId *string `mandatory:"true" contributesTo:"path" name:"gatewayId"`

    // The information to be updated.
    UpdateGatewayDetails `contributesTo:"body"`

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

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

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

UpdateGatewayRequest wrapper for the UpdateGateway operation

func (UpdateGatewayRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (UpdateGatewayRequest) RetryPolicy Uses

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

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

func (UpdateGatewayRequest) String Uses

func (request UpdateGatewayRequest) String() string

type UpdateGatewayResponse Uses

type UpdateGatewayResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

UpdateGatewayResponse wrapper for the UpdateGateway operation

func (UpdateGatewayResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (UpdateGatewayResponse) String Uses

func (response UpdateGatewayResponse) String() string

type WorkRequest Uses

type WorkRequest struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
    Id  *string `mandatory:"true" json:"id"`

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

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

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
    // resource is created.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

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

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

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

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

WorkRequest A description of the work request status.

func (WorkRequest) String Uses

func (m WorkRequest) String() string

type WorkRequestCollection Uses

type WorkRequestCollection struct {

    // Work request summaries.
    Items []WorkRequestSummary `mandatory:"true" json:"items"`
}

WorkRequestCollection Collection of work request summaries.

func (WorkRequestCollection) String Uses

func (m WorkRequestCollection) String() string

type WorkRequestError Uses

type WorkRequestError struct {

    // A machine-usable code for the error that occured. See
    // <a href="/Content/API/References/apierrors.htm">API Errors</a>.
    Code *string `mandatory:"true" json:"code"`

    // A human-readable description of the issue encountered.
    Message *string `mandatory:"true" json:"message"`

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

WorkRequestError An error encountered while executing a work request.

func (WorkRequestError) String Uses

func (m WorkRequestError) String() string

type WorkRequestErrorCollection Uses

type WorkRequestErrorCollection struct {

    // Work request errors.
    Items []WorkRequestError `mandatory:"true" json:"items"`
}

WorkRequestErrorCollection Collection of work request errors.

func (WorkRequestErrorCollection) String Uses

func (m WorkRequestErrorCollection) String() string

type WorkRequestLog Uses

type WorkRequestLog struct {

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

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

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

func (WorkRequestLog) String Uses

func (m WorkRequestLog) String() string

type WorkRequestLogCollection Uses

type WorkRequestLogCollection struct {

    // Work request logs.
    Items []WorkRequestLog `mandatory:"true" json:"items"`
}

WorkRequestLogCollection Collection of work request logs.

func (WorkRequestLogCollection) String Uses

func (m WorkRequestLogCollection) String() string

type WorkRequestOperationTypeEnum Uses

type WorkRequestOperationTypeEnum string

WorkRequestOperationTypeEnum Enum with underlying type: string

const (
    WorkRequestOperationTypeCreateGateway    WorkRequestOperationTypeEnum = "CREATE_GATEWAY"
    WorkRequestOperationTypeUpdateGateway    WorkRequestOperationTypeEnum = "UPDATE_GATEWAY"
    WorkRequestOperationTypeDeleteGateway    WorkRequestOperationTypeEnum = "DELETE_GATEWAY"
    WorkRequestOperationTypeCreateDeployment WorkRequestOperationTypeEnum = "CREATE_DEPLOYMENT"
    WorkRequestOperationTypeUpdateDeployment WorkRequestOperationTypeEnum = "UPDATE_DEPLOYMENT"
    WorkRequestOperationTypeDeleteDeployment WorkRequestOperationTypeEnum = "DELETE_DEPLOYMENT"
)

Set of constants representing the allowable values for WorkRequestOperationTypeEnum

func GetWorkRequestOperationTypeEnumValues Uses

func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum

GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum

type WorkRequestResource Uses

type WorkRequestResource struct {

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

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

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

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

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

func (WorkRequestResource) String Uses

func (m WorkRequestResource) String() string

type WorkRequestResourceActionTypeEnum Uses

type WorkRequestResourceActionTypeEnum string

WorkRequestResourceActionTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum

func GetWorkRequestResourceActionTypeEnumValues Uses

func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum

GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum

type WorkRequestStatusEnum Uses

type WorkRequestStatusEnum string

WorkRequestStatusEnum Enum with underlying type: string

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

Set of constants representing the allowable values for WorkRequestStatusEnum

func GetWorkRequestStatusEnumValues Uses

func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum

GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum

type WorkRequestSummary Uses

type WorkRequestSummary struct {

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

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

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the resource.
    WorkRequestId *string `mandatory:"true" json:"workRequestId"`

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment in which the
    // resource is created.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

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

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

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

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

WorkRequestSummary A summary of the work request.

func (WorkRequestSummary) String Uses

func (m WorkRequestSummary) String() string

type WorkRequestsClient Uses

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

WorkRequestsClient a client for WorkRequests

func NewWorkRequestsClientWithConfigurationProvider Uses

func NewWorkRequestsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client WorkRequestsClient, err error)

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

func NewWorkRequestsClientWithOboToken Uses

func NewWorkRequestsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client WorkRequestsClient, err error)

NewWorkRequestsClientWithOboToken Creates a new default WorkRequests 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 (WorkRequestsClient) CancelWorkRequest Uses

func (client WorkRequestsClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)

CancelWorkRequest Cancels the work request.

func (*WorkRequestsClient) ConfigurationProvider Uses

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

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

func (WorkRequestsClient) GetWorkRequest Uses

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

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

func (WorkRequestsClient) ListWorkRequestErrors Uses

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

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

func (WorkRequestsClient) ListWorkRequestLogs Uses

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

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

func (WorkRequestsClient) ListWorkRequests Uses

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

ListWorkRequests Lists the work requests in a compartment.

func (*WorkRequestsClient) SetRegion Uses

func (client *WorkRequestsClient) SetRegion(region string)

SetRegion overrides the region of this client.

Package apigateway imports 5 packages (graph). Updated 2020-04-07. Refresh now. Tools for package owners.