...

Package apigateway

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

Overview ▾

Index ▾

type AccessLogPolicy
    func (m AccessLogPolicy) String() string
type AnonymousRouteAuthorizationPolicy
    func (m AnonymousRouteAuthorizationPolicy) MarshalJSON() (buff []byte, e error)
    func (m AnonymousRouteAuthorizationPolicy) String() string
type AnyOfRouteAuthorizationPolicy
    func (m AnyOfRouteAuthorizationPolicy) MarshalJSON() (buff []byte, e error)
    func (m AnyOfRouteAuthorizationPolicy) String() string
type Api
    func (m Api) String() string
type ApiCollection
    func (m ApiCollection) String() string
type ApiGatewayClient
    func NewApiGatewayClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ApiGatewayClient, err error)
    func NewApiGatewayClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ApiGatewayClient, err error)
    func (client ApiGatewayClient) ChangeApiCompartment(ctx context.Context, request ChangeApiCompartmentRequest) (response ChangeApiCompartmentResponse, err error)
    func (client ApiGatewayClient) ChangeCertificateCompartment(ctx context.Context, request ChangeCertificateCompartmentRequest) (response ChangeCertificateCompartmentResponse, err error)
    func (client *ApiGatewayClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client ApiGatewayClient) CreateApi(ctx context.Context, request CreateApiRequest) (response CreateApiResponse, err error)
    func (client ApiGatewayClient) CreateCertificate(ctx context.Context, request CreateCertificateRequest) (response CreateCertificateResponse, err error)
    func (client ApiGatewayClient) DeleteApi(ctx context.Context, request DeleteApiRequest) (response DeleteApiResponse, err error)
    func (client ApiGatewayClient) DeleteCertificate(ctx context.Context, request DeleteCertificateRequest) (response DeleteCertificateResponse, err error)
    func (client ApiGatewayClient) GetApi(ctx context.Context, request GetApiRequest) (response GetApiResponse, err error)
    func (client ApiGatewayClient) GetApiContent(ctx context.Context, request GetApiContentRequest) (response GetApiContentResponse, err error)
    func (client ApiGatewayClient) GetApiDeploymentSpecification(ctx context.Context, request GetApiDeploymentSpecificationRequest) (response GetApiDeploymentSpecificationResponse, err error)
    func (client ApiGatewayClient) GetApiValidations(ctx context.Context, request GetApiValidationsRequest) (response GetApiValidationsResponse, err error)
    func (client ApiGatewayClient) GetCertificate(ctx context.Context, request GetCertificateRequest) (response GetCertificateResponse, err error)
    func (client ApiGatewayClient) ListApis(ctx context.Context, request ListApisRequest) (response ListApisResponse, err error)
    func (client ApiGatewayClient) ListCertificates(ctx context.Context, request ListCertificatesRequest) (response ListCertificatesResponse, err error)
    func (client *ApiGatewayClient) SetRegion(region string)
    func (client ApiGatewayClient) UpdateApi(ctx context.Context, request UpdateApiRequest) (response UpdateApiResponse, err error)
    func (client ApiGatewayClient) UpdateCertificate(ctx context.Context, request UpdateCertificateRequest) (response UpdateCertificateResponse, err error)
type ApiLifecycleStateEnum
    func GetApiLifecycleStateEnumValues() []ApiLifecycleStateEnum
type ApiSpecification
    func (m ApiSpecification) String() string
type ApiSpecificationLoggingPolicies
    func (m ApiSpecificationLoggingPolicies) String() string
type ApiSpecificationRequestPolicies
    func (m ApiSpecificationRequestPolicies) String() string
    func (m *ApiSpecificationRequestPolicies) UnmarshalJSON(data []byte) (e error)
type ApiSpecificationRoute
    func (m ApiSpecificationRoute) String() string
    func (m *ApiSpecificationRoute) UnmarshalJSON(data []byte) (e error)
type ApiSpecificationRouteBackend
type ApiSpecificationRouteBackendTypeEnum
    func GetApiSpecificationRouteBackendTypeEnumValues() []ApiSpecificationRouteBackendTypeEnum
type ApiSpecificationRouteMethodsEnum
    func GetApiSpecificationRouteMethodsEnumValues() []ApiSpecificationRouteMethodsEnum
type ApiSpecificationRouteRequestPolicies
    func (m ApiSpecificationRouteRequestPolicies) String() string
    func (m *ApiSpecificationRouteRequestPolicies) UnmarshalJSON(data []byte) (e error)
type ApiSpecificationRouteResponsePolicies
    func (m ApiSpecificationRouteResponsePolicies) String() string
type ApiSummary
    func (m ApiSummary) String() string
type ApiSummaryLifecycleStateEnum
    func GetApiSummaryLifecycleStateEnumValues() []ApiSummaryLifecycleStateEnum
type ApiValidationDetail
    func (m ApiValidationDetail) String() string
type ApiValidationDetailSeverityEnum
    func GetApiValidationDetailSeverityEnumValues() []ApiValidationDetailSeverityEnum
type ApiValidationDetails
    func (m ApiValidationDetails) String() string
type ApiValidationDetailsResultEnum
    func GetApiValidationDetailsResultEnumValues() []ApiValidationDetailsResultEnum
type ApiValidationResult
    func (m ApiValidationResult) String() string
type ApiValidationResultResultEnum
    func GetApiValidationResultResultEnumValues() []ApiValidationResultResultEnum
type ApiValidations
    func (m ApiValidations) String() string
type AuthenticationOnlyRouteAuthorizationPolicy
    func (m AuthenticationOnlyRouteAuthorizationPolicy) MarshalJSON() (buff []byte, e error)
    func (m AuthenticationOnlyRouteAuthorizationPolicy) String() string
type AuthenticationPolicy
type AuthenticationPolicyTypeEnum
    func GetAuthenticationPolicyTypeEnumValues() []AuthenticationPolicyTypeEnum
type CancelWorkRequestRequest
    func (request CancelWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
    func (request CancelWorkRequestRequest) String() string
type CancelWorkRequestResponse
    func (response CancelWorkRequestResponse) HTTPResponse() *http.Response
    func (response CancelWorkRequestResponse) String() string
type Certificate
    func (m Certificate) String() string
type CertificateCollection
    func (m CertificateCollection) String() string
type CertificateLifecycleStateEnum
    func GetCertificateLifecycleStateEnumValues() []CertificateLifecycleStateEnum
type CertificateSummary
    func (m CertificateSummary) String() string
type ChangeApiCompartmentDetails
    func (m ChangeApiCompartmentDetails) String() string
type ChangeApiCompartmentRequest
    func (request ChangeApiCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ChangeApiCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeApiCompartmentRequest) String() string
type ChangeApiCompartmentResponse
    func (response ChangeApiCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeApiCompartmentResponse) String() string
type ChangeCertificateCompartmentDetails
    func (m ChangeCertificateCompartmentDetails) String() string
type ChangeCertificateCompartmentRequest
    func (request ChangeCertificateCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ChangeCertificateCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeCertificateCompartmentRequest) String() string
type ChangeCertificateCompartmentResponse
    func (response ChangeCertificateCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeCertificateCompartmentResponse) String() string
type ChangeDeploymentCompartmentDetails
    func (m ChangeDeploymentCompartmentDetails) String() string
type ChangeDeploymentCompartmentRequest
    func (request ChangeDeploymentCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ChangeDeploymentCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeDeploymentCompartmentRequest) String() string
type ChangeDeploymentCompartmentResponse
    func (response ChangeDeploymentCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeDeploymentCompartmentResponse) String() string
type ChangeGatewayCompartmentDetails
    func (m ChangeGatewayCompartmentDetails) String() string
type ChangeGatewayCompartmentRequest
    func (request ChangeGatewayCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ChangeGatewayCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeGatewayCompartmentRequest) String() string
type ChangeGatewayCompartmentResponse
    func (response ChangeGatewayCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeGatewayCompartmentResponse) String() string
type CorsPolicy
    func (m CorsPolicy) String() string
type CreateApiDetails
    func (m CreateApiDetails) String() string
type CreateApiRequest
    func (request CreateApiRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateApiRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateApiRequest) String() string
type CreateApiResponse
    func (response CreateApiResponse) HTTPResponse() *http.Response
    func (response CreateApiResponse) String() string
type CreateCertificateDetails
    func (m CreateCertificateDetails) String() string
type CreateCertificateRequest
    func (request CreateCertificateRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateCertificateRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateCertificateRequest) String() string
type CreateCertificateResponse
    func (response CreateCertificateResponse) HTTPResponse() *http.Response
    func (response CreateCertificateResponse) String() string
type CreateDeploymentDetails
    func (m CreateDeploymentDetails) String() string
type CreateDeploymentRequest
    func (request CreateDeploymentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateDeploymentRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateDeploymentRequest) String() string
type CreateDeploymentResponse
    func (response CreateDeploymentResponse) HTTPResponse() *http.Response
    func (response CreateDeploymentResponse) String() string
type CreateGatewayDetails
    func (m CreateGatewayDetails) String() string
type CreateGatewayRequest
    func (request CreateGatewayRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateGatewayRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateGatewayRequest) String() string
type CreateGatewayResponse
    func (response CreateGatewayResponse) HTTPResponse() *http.Response
    func (response CreateGatewayResponse) String() string
type CustomAuthenticationPolicy
    func (m CustomAuthenticationPolicy) GetIsAnonymousAccessAllowed() *bool
    func (m CustomAuthenticationPolicy) MarshalJSON() (buff []byte, e error)
    func (m CustomAuthenticationPolicy) String() string
type DeleteApiRequest
    func (request DeleteApiRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteApiRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteApiRequest) String() string
type DeleteApiResponse
    func (response DeleteApiResponse) HTTPResponse() *http.Response
    func (response DeleteApiResponse) String() string
type DeleteCertificateRequest
    func (request DeleteCertificateRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteCertificateRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteCertificateRequest) String() string
type DeleteCertificateResponse
    func (response DeleteCertificateResponse) HTTPResponse() *http.Response
    func (response DeleteCertificateResponse) String() string
type DeleteDeploymentRequest
    func (request DeleteDeploymentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteDeploymentRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteDeploymentRequest) String() string
type DeleteDeploymentResponse
    func (response DeleteDeploymentResponse) HTTPResponse() *http.Response
    func (response DeleteDeploymentResponse) String() string
type DeleteGatewayRequest
    func (request DeleteGatewayRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteGatewayRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteGatewayRequest) String() string
type DeleteGatewayResponse
    func (response DeleteGatewayResponse) HTTPResponse() *http.Response
    func (response DeleteGatewayResponse) String() string
type Deployment
    func (m Deployment) String() string
type DeploymentClient
    func NewDeploymentClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DeploymentClient, err error)
    func NewDeploymentClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DeploymentClient, err error)
    func (client DeploymentClient) ChangeDeploymentCompartment(ctx context.Context, request ChangeDeploymentCompartmentRequest) (response ChangeDeploymentCompartmentResponse, err error)
    func (client *DeploymentClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client DeploymentClient) CreateDeployment(ctx context.Context, request CreateDeploymentRequest) (response CreateDeploymentResponse, err error)
    func (client DeploymentClient) DeleteDeployment(ctx context.Context, request DeleteDeploymentRequest) (response DeleteDeploymentResponse, err error)
    func (client DeploymentClient) GetDeployment(ctx context.Context, request GetDeploymentRequest) (response GetDeploymentResponse, err error)
    func (client DeploymentClient) ListDeployments(ctx context.Context, request ListDeploymentsRequest) (response ListDeploymentsResponse, err error)
    func (client *DeploymentClient) SetRegion(region string)
    func (client DeploymentClient) UpdateDeployment(ctx context.Context, request UpdateDeploymentRequest) (response UpdateDeploymentResponse, err error)
type DeploymentCollection
    func (m DeploymentCollection) String() string
type DeploymentLifecycleStateEnum
    func GetDeploymentLifecycleStateEnumValues() []DeploymentLifecycleStateEnum
type DeploymentSummary
    func (m DeploymentSummary) String() string
type ExecutionLogPolicy
    func (m ExecutionLogPolicy) String() string
type ExecutionLogPolicyLogLevelEnum
    func GetExecutionLogPolicyLogLevelEnumValues() []ExecutionLogPolicyLogLevelEnum
type FilterHeaderPolicy
    func (m FilterHeaderPolicy) String() string
type FilterHeaderPolicyItem
    func (m FilterHeaderPolicyItem) String() string
type FilterHeaderPolicyTypeEnum
    func GetFilterHeaderPolicyTypeEnumValues() []FilterHeaderPolicyTypeEnum
type FilterQueryParameterPolicy
    func (m FilterQueryParameterPolicy) String() string
type FilterQueryParameterPolicyItem
    func (m FilterQueryParameterPolicyItem) String() string
type FilterQueryParameterPolicyTypeEnum
    func GetFilterQueryParameterPolicyTypeEnumValues() []FilterQueryParameterPolicyTypeEnum
type Gateway
    func (m Gateway) String() string
type GatewayClient
    func NewGatewayClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client GatewayClient, err error)
    func NewGatewayClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client GatewayClient, err error)
    func (client GatewayClient) ChangeGatewayCompartment(ctx context.Context, request ChangeGatewayCompartmentRequest) (response ChangeGatewayCompartmentResponse, err error)
    func (client *GatewayClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client GatewayClient) CreateGateway(ctx context.Context, request CreateGatewayRequest) (response CreateGatewayResponse, err error)
    func (client GatewayClient) DeleteGateway(ctx context.Context, request DeleteGatewayRequest) (response DeleteGatewayResponse, err error)
    func (client GatewayClient) GetGateway(ctx context.Context, request GetGatewayRequest) (response GetGatewayResponse, err error)
    func (client GatewayClient) ListGateways(ctx context.Context, request ListGatewaysRequest) (response ListGatewaysResponse, err error)
    func (client *GatewayClient) SetRegion(region string)
    func (client GatewayClient) UpdateGateway(ctx context.Context, request UpdateGatewayRequest) (response UpdateGatewayResponse, err error)
type GatewayCollection
    func (m GatewayCollection) String() string
type GatewayEndpointTypeEnum
    func GetGatewayEndpointTypeEnumValues() []GatewayEndpointTypeEnum
type GatewayLifecycleStateEnum
    func GetGatewayLifecycleStateEnumValues() []GatewayLifecycleStateEnum
type GatewaySummary
    func (m GatewaySummary) String() string
type GetApiContentRequest
    func (request GetApiContentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetApiContentRequest) RetryPolicy() *common.RetryPolicy
    func (request GetApiContentRequest) String() string
type GetApiContentResponse
    func (response GetApiContentResponse) HTTPResponse() *http.Response
    func (response GetApiContentResponse) String() string
type GetApiDeploymentSpecificationRequest
    func (request GetApiDeploymentSpecificationRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetApiDeploymentSpecificationRequest) RetryPolicy() *common.RetryPolicy
    func (request GetApiDeploymentSpecificationRequest) String() string
type GetApiDeploymentSpecificationResponse
    func (response GetApiDeploymentSpecificationResponse) HTTPResponse() *http.Response
    func (response GetApiDeploymentSpecificationResponse) String() string
type GetApiRequest
    func (request GetApiRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetApiRequest) RetryPolicy() *common.RetryPolicy
    func (request GetApiRequest) String() string
type GetApiResponse
    func (response GetApiResponse) HTTPResponse() *http.Response
    func (response GetApiResponse) String() string
type GetApiValidationsRequest
    func (request GetApiValidationsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetApiValidationsRequest) RetryPolicy() *common.RetryPolicy
    func (request GetApiValidationsRequest) String() string
type GetApiValidationsResponse
    func (response GetApiValidationsResponse) HTTPResponse() *http.Response
    func (response GetApiValidationsResponse) String() string
type GetCertificateRequest
    func (request GetCertificateRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetCertificateRequest) RetryPolicy() *common.RetryPolicy
    func (request GetCertificateRequest) String() string
type GetCertificateResponse
    func (response GetCertificateResponse) HTTPResponse() *http.Response
    func (response GetCertificateResponse) String() string
type GetDeploymentRequest
    func (request GetDeploymentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetDeploymentRequest) RetryPolicy() *common.RetryPolicy
    func (request GetDeploymentRequest) String() string
type GetDeploymentResponse
    func (response GetDeploymentResponse) HTTPResponse() *http.Response
    func (response GetDeploymentResponse) String() string
type GetGatewayRequest
    func (request GetGatewayRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetGatewayRequest) RetryPolicy() *common.RetryPolicy
    func (request GetGatewayRequest) String() string
type GetGatewayResponse
    func (response GetGatewayResponse) HTTPResponse() *http.Response
    func (response GetGatewayResponse) String() string
type GetWorkRequestRequest
    func (request GetWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
    func (request GetWorkRequestRequest) String() string
type GetWorkRequestResponse
    func (response GetWorkRequestResponse) HTTPResponse() *http.Response
    func (response GetWorkRequestResponse) String() string
type HeaderFieldSpecification
    func (m HeaderFieldSpecification) String() string
type HeaderTransformationPolicy
    func (m HeaderTransformationPolicy) String() string
type HttpBackend
    func (m HttpBackend) MarshalJSON() (buff []byte, e error)
    func (m HttpBackend) String() string
type IpAddress
    func (m IpAddress) String() string
type JsonWebKey
    func (m JsonWebKey) GetKid() *string
    func (m JsonWebKey) MarshalJSON() (buff []byte, e error)
    func (m JsonWebKey) String() string
type JsonWebKeyKeyOpsEnum
    func GetJsonWebKeyKeyOpsEnumValues() []JsonWebKeyKeyOpsEnum
type JsonWebKeyKtyEnum
    func GetJsonWebKeyKtyEnumValues() []JsonWebKeyKtyEnum
type JsonWebKeyUseEnum
    func GetJsonWebKeyUseEnumValues() []JsonWebKeyUseEnum
type JsonWebTokenClaim
    func (m JsonWebTokenClaim) String() string
type JwtAuthenticationPolicy
    func (m JwtAuthenticationPolicy) GetIsAnonymousAccessAllowed() *bool
    func (m JwtAuthenticationPolicy) MarshalJSON() (buff []byte, e error)
    func (m JwtAuthenticationPolicy) String() string
    func (m *JwtAuthenticationPolicy) UnmarshalJSON(data []byte) (e error)
type ListApisRequest
    func (request ListApisRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListApisRequest) RetryPolicy() *common.RetryPolicy
    func (request ListApisRequest) String() string
type ListApisResponse
    func (response ListApisResponse) HTTPResponse() *http.Response
    func (response ListApisResponse) String() string
type ListApisSortByEnum
    func GetListApisSortByEnumValues() []ListApisSortByEnum
type ListApisSortOrderEnum
    func GetListApisSortOrderEnumValues() []ListApisSortOrderEnum
type ListCertificatesRequest
    func (request ListCertificatesRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListCertificatesRequest) RetryPolicy() *common.RetryPolicy
    func (request ListCertificatesRequest) String() string
type ListCertificatesResponse
    func (response ListCertificatesResponse) HTTPResponse() *http.Response
    func (response ListCertificatesResponse) String() string
type ListCertificatesSortByEnum
    func GetListCertificatesSortByEnumValues() []ListCertificatesSortByEnum
type ListCertificatesSortOrderEnum
    func GetListCertificatesSortOrderEnumValues() []ListCertificatesSortOrderEnum
type ListDeploymentsRequest
    func (request ListDeploymentsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListDeploymentsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListDeploymentsRequest) String() string
type ListDeploymentsResponse
    func (response ListDeploymentsResponse) HTTPResponse() *http.Response
    func (response ListDeploymentsResponse) String() string
type ListDeploymentsSortByEnum
    func GetListDeploymentsSortByEnumValues() []ListDeploymentsSortByEnum
type ListDeploymentsSortOrderEnum
    func GetListDeploymentsSortOrderEnumValues() []ListDeploymentsSortOrderEnum
type ListGatewaysRequest
    func (request ListGatewaysRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListGatewaysRequest) RetryPolicy() *common.RetryPolicy
    func (request ListGatewaysRequest) String() string
type ListGatewaysResponse
    func (response ListGatewaysResponse) HTTPResponse() *http.Response
    func (response ListGatewaysResponse) String() string
type ListGatewaysSortByEnum
    func GetListGatewaysSortByEnumValues() []ListGatewaysSortByEnum
type ListGatewaysSortOrderEnum
    func GetListGatewaysSortOrderEnumValues() []ListGatewaysSortOrderEnum
type ListWorkRequestErrorsRequest
    func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestErrorsRequest) String() string
type ListWorkRequestErrorsResponse
    func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestErrorsResponse) String() string
type ListWorkRequestErrorsSortByEnum
    func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
type ListWorkRequestErrorsSortOrderEnum
    func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
type ListWorkRequestLogsRequest
    func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestLogsRequest) String() string
type ListWorkRequestLogsResponse
    func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestLogsResponse) String() string
type ListWorkRequestLogsSortByEnum
    func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
type ListWorkRequestLogsSortOrderEnum
    func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
type ListWorkRequestsRequest
    func (request ListWorkRequestsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestsRequest) String() string
type ListWorkRequestsResponse
    func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestsResponse) String() string
type ListWorkRequestsSortByEnum
    func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
type ListWorkRequestsSortOrderEnum
    func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
type OracleFunctionBackend
    func (m OracleFunctionBackend) MarshalJSON() (buff []byte, e error)
    func (m OracleFunctionBackend) String() string
type PemEncodedPublicKey
    func (m PemEncodedPublicKey) GetKid() *string
    func (m PemEncodedPublicKey) MarshalJSON() (buff []byte, e error)
    func (m PemEncodedPublicKey) String() string
type PublicKeySet
type PublicKeySetTypeEnum
    func GetPublicKeySetTypeEnumValues() []PublicKeySetTypeEnum
type QueryParameterTransformationPolicy
    func (m QueryParameterTransformationPolicy) String() string
type RateLimitingPolicy
    func (m RateLimitingPolicy) String() string
type RateLimitingPolicyRateKeyEnum
    func GetRateLimitingPolicyRateKeyEnumValues() []RateLimitingPolicyRateKeyEnum
type RemoteJsonWebKeySet
    func (m RemoteJsonWebKeySet) MarshalJSON() (buff []byte, e error)
    func (m RemoteJsonWebKeySet) String() string
type RenameHeaderPolicy
    func (m RenameHeaderPolicy) String() string
type RenameHeaderPolicyItem
    func (m RenameHeaderPolicyItem) String() string
type RenameQueryParameterPolicy
    func (m RenameQueryParameterPolicy) String() string
type RenameQueryParameterPolicyItem
    func (m RenameQueryParameterPolicyItem) String() string
type RouteAuthorizationPolicy
type RouteAuthorizationPolicyTypeEnum
    func GetRouteAuthorizationPolicyTypeEnumValues() []RouteAuthorizationPolicyTypeEnum
type SetHeaderPolicy
    func (m SetHeaderPolicy) String() string
type SetHeaderPolicyItem
    func (m SetHeaderPolicyItem) String() string
type SetHeaderPolicyItemIfExistsEnum
    func GetSetHeaderPolicyItemIfExistsEnumValues() []SetHeaderPolicyItemIfExistsEnum
type SetQueryParameterPolicy
    func (m SetQueryParameterPolicy) String() string
type SetQueryParameterPolicyItem
    func (m SetQueryParameterPolicyItem) String() string
type SetQueryParameterPolicyItemIfExistsEnum
    func GetSetQueryParameterPolicyItemIfExistsEnumValues() []SetQueryParameterPolicyItemIfExistsEnum
type StaticPublicKey
type StaticPublicKeyFormatEnum
    func GetStaticPublicKeyFormatEnumValues() []StaticPublicKeyFormatEnum
type StaticPublicKeySet
    func (m StaticPublicKeySet) MarshalJSON() (buff []byte, e error)
    func (m StaticPublicKeySet) String() string
    func (m *StaticPublicKeySet) UnmarshalJSON(data []byte) (e error)
type StockResponseBackend
    func (m StockResponseBackend) MarshalJSON() (buff []byte, e error)
    func (m StockResponseBackend) String() string
type UpdateApiDetails
    func (m UpdateApiDetails) String() string
type UpdateApiRequest
    func (request UpdateApiRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateApiRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateApiRequest) String() string
type UpdateApiResponse
    func (response UpdateApiResponse) HTTPResponse() *http.Response
    func (response UpdateApiResponse) String() string
type UpdateCertificateDetails
    func (m UpdateCertificateDetails) String() string
type UpdateCertificateRequest
    func (request UpdateCertificateRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateCertificateRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateCertificateRequest) String() string
type UpdateCertificateResponse
    func (response UpdateCertificateResponse) HTTPResponse() *http.Response
    func (response UpdateCertificateResponse) String() string
type UpdateDeploymentDetails
    func (m UpdateDeploymentDetails) String() string
type UpdateDeploymentRequest
    func (request UpdateDeploymentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateDeploymentRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateDeploymentRequest) String() string
type UpdateDeploymentResponse
    func (response UpdateDeploymentResponse) HTTPResponse() *http.Response
    func (response UpdateDeploymentResponse) String() string
type UpdateGatewayDetails
    func (m UpdateGatewayDetails) String() string
type UpdateGatewayRequest
    func (request UpdateGatewayRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateGatewayRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateGatewayRequest) String() string
type UpdateGatewayResponse
    func (response UpdateGatewayResponse) HTTPResponse() *http.Response
    func (response UpdateGatewayResponse) String() string
type WorkRequest
    func (m WorkRequest) String() string
type WorkRequestCollection
    func (m WorkRequestCollection) String() string
type WorkRequestError
    func (m WorkRequestError) String() string
type WorkRequestErrorCollection
    func (m WorkRequestErrorCollection) String() string
type WorkRequestLog
    func (m WorkRequestLog) String() string
type WorkRequestLogCollection
    func (m WorkRequestLogCollection) String() string
type WorkRequestOperationTypeEnum
    func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum
type WorkRequestResource
    func (m WorkRequestResource) String() string
type WorkRequestResourceActionTypeEnum
    func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum
type WorkRequestStatusEnum
    func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum
type WorkRequestSummary
    func (m WorkRequestSummary) String() string
type WorkRequestsClient
    func NewWorkRequestsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client WorkRequestsClient, err error)
    func NewWorkRequestsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client WorkRequestsClient, err error)
    func (client WorkRequestsClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
    func (client *WorkRequestsClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client WorkRequestsClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
    func (client WorkRequestsClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
    func (client WorkRequestsClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
    func (client WorkRequestsClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
    func (client *WorkRequestsClient) SetRegion(region string)

Package files

access_log_policy.go anonymous_route_authorization_policy.go any_of_route_authorization_policy.go api.go api_collection.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 api_specification_route_response_policies.go api_summary.go api_validation_detail.go api_validation_details.go api_validation_result.go api_validations.go apigateway_client.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 certificate.go certificate_collection.go certificate_summary.go change_api_compartment_details.go change_api_compartment_request_response.go change_certificate_compartment_details.go change_certificate_compartment_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_api_details.go create_api_request_response.go create_certificate_details.go create_certificate_request_response.go create_deployment_details.go create_deployment_request_response.go create_gateway_details.go create_gateway_request_response.go custom_authentication_policy.go delete_api_request_response.go delete_certificate_request_response.go delete_deployment_request_response.go delete_gateway_request_response.go deployment.go deployment_collection.go deployment_summary.go execution_log_policy.go filter_header_policy.go filter_header_policy_item.go filter_query_parameter_policy.go filter_query_parameter_policy_item.go gateway.go gateway_collection.go gateway_summary.go get_api_content_request_response.go get_api_deployment_specification_request_response.go get_api_request_response.go get_api_validations_request_response.go get_certificate_request_response.go get_deployment_request_response.go get_gateway_request_response.go get_work_request_request_response.go header_field_specification.go header_transformation_policy.go http_backend.go ip_address.go json_web_key.go json_web_token_claim.go jwt_authentication_policy.go list_apis_request_response.go list_certificates_request_response.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 pem_encoded_public_key.go public_key_set.go query_parameter_transformation_policy.go rate_limiting_policy.go remote_json_web_key_set.go rename_header_policy.go rename_header_policy_item.go rename_query_parameter_policy.go rename_query_parameter_policy_item.go route_authorization_policy.go set_header_policy.go set_header_policy_item.go set_query_parameter_policy.go set_query_parameter_policy_item.go static_public_key.go static_public_key_set.go stock_response_backend.go update_api_details.go update_api_request_response.go update_certificate_details.go update_certificate_request_response.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

AccessLogPolicy Configures the logging policies for the access logs of an API Deployment.

type AccessLogPolicy struct {

    // Enables pushing of access logs to the legacy OCI Object Storage log archival bucket.
    // Oracle recommends using the OCI Logging service to enable, retrieve, and query access logs
    // for an API Deployment. If there is an active log object for the API Deployment and its
    // category is set to 'access' in OCI Logging service, the logs will not be uploaded to the
    // legacy OCI Object Storage log archival bucket.
    // Please note that the functionality to push to the legacy OCI Object Storage log
    // archival bucket has been deprecated and will be removed in the future.
    IsEnabled *bool `mandatory:"false" json:"isEnabled"`
}

func (AccessLogPolicy) String

func (m AccessLogPolicy) String() string

type AnonymousRouteAuthorizationPolicy

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

type AnonymousRouteAuthorizationPolicy struct {
}

func (AnonymousRouteAuthorizationPolicy) MarshalJSON

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

MarshalJSON marshals to json representation

func (AnonymousRouteAuthorizationPolicy) String

func (m AnonymousRouteAuthorizationPolicy) String() string

type AnyOfRouteAuthorizationPolicy

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

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

func (AnyOfRouteAuthorizationPolicy) MarshalJSON

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

MarshalJSON marshals to json representation

func (AnyOfRouteAuthorizationPolicy) String

func (m AnyOfRouteAuthorizationPolicy) String() string

type Api

Api An API is simple container for an API Specification. For more information, see API Gateway Concepts (https://docs.cloud.oracle.com/iaas/Content/APIGateway/Concepts/apigatewayconcepts.htm).

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

    // 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 API.
    LifecycleState ApiLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // A message describing the current lifecycleState in more detail. For ACTIVE
    // state it describes if the document has been validated and the possible values are:
    // - 'New' for just updated API Specifications
    // - 'Validating' for a document which is being validated.
    // - 'Valid' the document has been validated without any errors or warnings
    // - 'Warning' the document has been validated and contains warnings
    // - 'Error' the document has been validated and contains errors
    // - 'Failed' the document validation failed
    // - 'Canceled' the document validation was canceled
    // For other states it may provide more details like actionable information.
    LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

    // Type of API Specification file.
    SpecificationType *string `mandatory:"false" json:"specificationType"`

    // Status of each feature available from the API.
    ValidationResults []ApiValidationResult `mandatory:"false" json:"validationResults"`

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

func (Api) String

func (m Api) String() string

type ApiCollection

ApiCollection Collection of API summaries.

type ApiCollection struct {

    // API summaries.
    Items []ApiSummary `mandatory:"true" json:"items"`
}

func (ApiCollection) String

func (m ApiCollection) String() string

type ApiGatewayClient

ApiGatewayClient a client for ApiGateway

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

func NewApiGatewayClientWithConfigurationProvider

func NewApiGatewayClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ApiGatewayClient, err error)

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

func NewApiGatewayClientWithOboToken

func NewApiGatewayClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ApiGatewayClient, err error)

NewApiGatewayClientWithOboToken Creates a new default ApiGateway 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 (ApiGatewayClient) ChangeApiCompartment

func (client ApiGatewayClient) ChangeApiCompartment(ctx context.Context, request ChangeApiCompartmentRequest) (response ChangeApiCompartmentResponse, err error)

ChangeApiCompartment Changes the API compartment.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ChangeApiCompartment.go.html to see an example of how to use ChangeApiCompartment API.

func (ApiGatewayClient) ChangeCertificateCompartment

func (client ApiGatewayClient) ChangeCertificateCompartment(ctx context.Context, request ChangeCertificateCompartmentRequest) (response ChangeCertificateCompartmentResponse, err error)

ChangeCertificateCompartment Changes the certificate compartment.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ChangeCertificateCompartment.go.html to see an example of how to use ChangeCertificateCompartment API.

func (*ApiGatewayClient) ConfigurationProvider

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

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

func (ApiGatewayClient) CreateApi

func (client ApiGatewayClient) CreateApi(ctx context.Context, request CreateApiRequest) (response CreateApiResponse, err error)

CreateApi Creates a new API.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/CreateApi.go.html to see an example of how to use CreateApi API.

func (ApiGatewayClient) CreateCertificate

func (client ApiGatewayClient) CreateCertificate(ctx context.Context, request CreateCertificateRequest) (response CreateCertificateResponse, err error)

CreateCertificate Creates a new Certificate.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/CreateCertificate.go.html to see an example of how to use CreateCertificate API.

func (ApiGatewayClient) DeleteApi

func (client ApiGatewayClient) DeleteApi(ctx context.Context, request DeleteApiRequest) (response DeleteApiResponse, err error)

DeleteApi Deletes the API with the given identifier.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/DeleteApi.go.html to see an example of how to use DeleteApi API.

func (ApiGatewayClient) DeleteCertificate

func (client ApiGatewayClient) DeleteCertificate(ctx context.Context, request DeleteCertificateRequest) (response DeleteCertificateResponse, err error)

DeleteCertificate Deletes the certificate with the given identifier.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/DeleteCertificate.go.html to see an example of how to use DeleteCertificate API.

func (ApiGatewayClient) GetApi

func (client ApiGatewayClient) GetApi(ctx context.Context, request GetApiRequest) (response GetApiResponse, err error)

GetApi Gets an API by identifier.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/GetApi.go.html to see an example of how to use GetApi API.

func (ApiGatewayClient) GetApiContent

func (client ApiGatewayClient) GetApiContent(ctx context.Context, request GetApiContentRequest) (response GetApiContentResponse, err error)

GetApiContent Get the raw API content.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/GetApiContent.go.html to see an example of how to use GetApiContent API.

func (ApiGatewayClient) GetApiDeploymentSpecification

func (client ApiGatewayClient) GetApiDeploymentSpecification(ctx context.Context, request GetApiDeploymentSpecificationRequest) (response GetApiDeploymentSpecificationResponse, err error)

GetApiDeploymentSpecification Gets an API Deployment specification by identifier.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/GetApiDeploymentSpecification.go.html to see an example of how to use GetApiDeploymentSpecification API.

func (ApiGatewayClient) GetApiValidations

func (client ApiGatewayClient) GetApiValidations(ctx context.Context, request GetApiValidationsRequest) (response GetApiValidationsResponse, err error)

GetApiValidations Gets the API validation results.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/GetApiValidations.go.html to see an example of how to use GetApiValidations API.

func (ApiGatewayClient) GetCertificate

func (client ApiGatewayClient) GetCertificate(ctx context.Context, request GetCertificateRequest) (response GetCertificateResponse, err error)

GetCertificate Gets a certificate by identifier.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/GetCertificate.go.html to see an example of how to use GetCertificate API.

func (ApiGatewayClient) ListApis

func (client ApiGatewayClient) ListApis(ctx context.Context, request ListApisRequest) (response ListApisResponse, err error)

ListApis Returns a list of APIs.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ListApis.go.html to see an example of how to use ListApis API.

func (ApiGatewayClient) ListCertificates

func (client ApiGatewayClient) ListCertificates(ctx context.Context, request ListCertificatesRequest) (response ListCertificatesResponse, err error)

ListCertificates Returns a list of certificates.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ListCertificates.go.html to see an example of how to use ListCertificates API.

func (*ApiGatewayClient) SetRegion

func (client *ApiGatewayClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (ApiGatewayClient) UpdateApi

func (client ApiGatewayClient) UpdateApi(ctx context.Context, request UpdateApiRequest) (response UpdateApiResponse, err error)

UpdateApi Updates the API with the given identifier.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/UpdateApi.go.html to see an example of how to use UpdateApi API.

func (ApiGatewayClient) UpdateCertificate

func (client ApiGatewayClient) UpdateCertificate(ctx context.Context, request UpdateCertificateRequest) (response UpdateCertificateResponse, err error)

UpdateCertificate Updates a certificate with the given identifier

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/UpdateCertificate.go.html to see an example of how to use UpdateCertificate API.

type ApiLifecycleStateEnum

ApiLifecycleStateEnum Enum with underlying type: string

type ApiLifecycleStateEnum string

Set of constants representing the allowable values for ApiLifecycleStateEnum

const (
    ApiLifecycleStateCreating ApiLifecycleStateEnum = "CREATING"
    ApiLifecycleStateActive   ApiLifecycleStateEnum = "ACTIVE"
    ApiLifecycleStateUpdating ApiLifecycleStateEnum = "UPDATING"
    ApiLifecycleStateDeleting ApiLifecycleStateEnum = "DELETING"
    ApiLifecycleStateDeleted  ApiLifecycleStateEnum = "DELETED"
    ApiLifecycleStateFailed   ApiLifecycleStateEnum = "FAILED"
)

func GetApiLifecycleStateEnumValues

func GetApiLifecycleStateEnumValues() []ApiLifecycleStateEnum

GetApiLifecycleStateEnumValues Enumerates the set of values for ApiLifecycleStateEnum

type ApiSpecification

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

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

func (ApiSpecification) String

func (m ApiSpecification) String() string

type ApiSpecificationLoggingPolicies

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

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

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

func (ApiSpecificationLoggingPolicies) String

func (m ApiSpecificationLoggingPolicies) String() string

type ApiSpecificationRequestPolicies

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

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

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

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

func (ApiSpecificationRequestPolicies) String

func (m ApiSpecificationRequestPolicies) String() string

func (*ApiSpecificationRequestPolicies) UnmarshalJSON

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

UnmarshalJSON unmarshals from json

type ApiSpecificationRoute

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

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

    ResponsePolicies *ApiSpecificationRouteResponsePolicies `mandatory:"false" json:"responsePolicies"`

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

func (ApiSpecificationRoute) String

func (m ApiSpecificationRoute) String() string

func (*ApiSpecificationRoute) UnmarshalJSON

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

UnmarshalJSON unmarshals from json

type ApiSpecificationRouteBackend

ApiSpecificationRouteBackend The backend to forward requests to.

type ApiSpecificationRouteBackend interface {
}

type ApiSpecificationRouteBackendTypeEnum

ApiSpecificationRouteBackendTypeEnum Enum with underlying type: string

type ApiSpecificationRouteBackendTypeEnum string

Set of constants representing the allowable values for ApiSpecificationRouteBackendTypeEnum

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

func GetApiSpecificationRouteBackendTypeEnumValues

func GetApiSpecificationRouteBackendTypeEnumValues() []ApiSpecificationRouteBackendTypeEnum

GetApiSpecificationRouteBackendTypeEnumValues Enumerates the set of values for ApiSpecificationRouteBackendTypeEnum

type ApiSpecificationRouteMethodsEnum

ApiSpecificationRouteMethodsEnum Enum with underlying type: string

type ApiSpecificationRouteMethodsEnum string

Set of constants representing the allowable values for ApiSpecificationRouteMethodsEnum

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

func GetApiSpecificationRouteMethodsEnumValues

func GetApiSpecificationRouteMethodsEnumValues() []ApiSpecificationRouteMethodsEnum

GetApiSpecificationRouteMethodsEnumValues Enumerates the set of values for ApiSpecificationRouteMethodsEnum

type ApiSpecificationRouteRequestPolicies

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

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

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

    HeaderTransformations *HeaderTransformationPolicy `mandatory:"false" json:"headerTransformations"`

    QueryParameterTransformations *QueryParameterTransformationPolicy `mandatory:"false" json:"queryParameterTransformations"`
}

func (ApiSpecificationRouteRequestPolicies) String

func (m ApiSpecificationRouteRequestPolicies) String() string

func (*ApiSpecificationRouteRequestPolicies) UnmarshalJSON

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

UnmarshalJSON unmarshals from json

type ApiSpecificationRouteResponsePolicies

ApiSpecificationRouteResponsePolicies Behavior applied to any responses sent by the API for requests on this route.

type ApiSpecificationRouteResponsePolicies struct {
    HeaderTransformations *HeaderTransformationPolicy `mandatory:"false" json:"headerTransformations"`
}

func (ApiSpecificationRouteResponsePolicies) String

func (m ApiSpecificationRouteResponsePolicies) String() string

type ApiSummary

ApiSummary A summary of the API.

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

    // 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 API.
    LifecycleState ApiSummaryLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`

    // A message describing the current lifecycleState in more detail. For ACTIVE
    // state it describes if the document has been validated and the possible values are:
    // - 'New' for just updated API Specifications
    // - 'Validating' for a document which is being validated.
    // - 'Valid' the document has been validated without any errors or warnings
    // - 'Warning' the document has been validated and contains warnings
    // - 'Error' the document has been validated and contains errors
    // - 'Failed' the document validation failed
    // - 'Canceled' the document validation was canceled
    // For other states it may provide more details like actionable information.
    LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

    // Type of API Specification file.
    SpecificationType *string `mandatory:"false" json:"specificationType"`

    // Status of each feature available from the API.
    ValidationResults []ApiValidationResult `mandatory:"false" json:"validationResults"`

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

func (ApiSummary) String

func (m ApiSummary) String() string

type ApiSummaryLifecycleStateEnum

ApiSummaryLifecycleStateEnum Enum with underlying type: string

type ApiSummaryLifecycleStateEnum string

Set of constants representing the allowable values for ApiSummaryLifecycleStateEnum

const (
    ApiSummaryLifecycleStateCreating ApiSummaryLifecycleStateEnum = "CREATING"
    ApiSummaryLifecycleStateActive   ApiSummaryLifecycleStateEnum = "ACTIVE"
    ApiSummaryLifecycleStateUpdating ApiSummaryLifecycleStateEnum = "UPDATING"
    ApiSummaryLifecycleStateDeleting ApiSummaryLifecycleStateEnum = "DELETING"
    ApiSummaryLifecycleStateDeleted  ApiSummaryLifecycleStateEnum = "DELETED"
    ApiSummaryLifecycleStateFailed   ApiSummaryLifecycleStateEnum = "FAILED"
)

func GetApiSummaryLifecycleStateEnumValues

func GetApiSummaryLifecycleStateEnumValues() []ApiSummaryLifecycleStateEnum

GetApiSummaryLifecycleStateEnumValues Enumerates the set of values for ApiSummaryLifecycleStateEnum

type ApiValidationDetail

ApiValidationDetail Detail of a single error or warning.

type ApiValidationDetail struct {

    // Description of the warning/error.
    Msg *string `mandatory:"false" json:"msg"`

    // Severity of the issue.
    Severity ApiValidationDetailSeverityEnum `mandatory:"false" json:"severity,omitempty"`

    // Position of the issue in the specification file (line, column).
    Src [][]float32 `mandatory:"false" json:"src"`
}

func (ApiValidationDetail) String

func (m ApiValidationDetail) String() string

type ApiValidationDetailSeverityEnum

ApiValidationDetailSeverityEnum Enum with underlying type: string

type ApiValidationDetailSeverityEnum string

Set of constants representing the allowable values for ApiValidationDetailSeverityEnum

const (
    ApiValidationDetailSeverityInfo    ApiValidationDetailSeverityEnum = "INFO"
    ApiValidationDetailSeverityWarning ApiValidationDetailSeverityEnum = "WARNING"
    ApiValidationDetailSeverityError   ApiValidationDetailSeverityEnum = "ERROR"
)

func GetApiValidationDetailSeverityEnumValues

func GetApiValidationDetailSeverityEnumValues() []ApiValidationDetailSeverityEnum

GetApiValidationDetailSeverityEnumValues Enumerates the set of values for ApiValidationDetailSeverityEnum

type ApiValidationDetails

ApiValidationDetails Detail of an error or warning.

type ApiValidationDetails struct {

    // Name of the validation.
    Name *string `mandatory:"true" json:"name"`

    // Result of the validation.
    Result ApiValidationDetailsResultEnum `mandatory:"true" json:"result"`

    // Details of validation.
    Details []ApiValidationDetail `mandatory:"false" json:"details"`
}

func (ApiValidationDetails) String

func (m ApiValidationDetails) String() string

type ApiValidationDetailsResultEnum

ApiValidationDetailsResultEnum Enum with underlying type: string

type ApiValidationDetailsResultEnum string

Set of constants representing the allowable values for ApiValidationDetailsResultEnum

const (
    ApiValidationDetailsResultError   ApiValidationDetailsResultEnum = "ERROR"
    ApiValidationDetailsResultWarning ApiValidationDetailsResultEnum = "WARNING"
    ApiValidationDetailsResultOk      ApiValidationDetailsResultEnum = "OK"
    ApiValidationDetailsResultFailed  ApiValidationDetailsResultEnum = "FAILED"
)

func GetApiValidationDetailsResultEnumValues

func GetApiValidationDetailsResultEnumValues() []ApiValidationDetailsResultEnum

GetApiValidationDetailsResultEnumValues Enumerates the set of values for ApiValidationDetailsResultEnum

type ApiValidationResult

ApiValidationResult The result of single validation.

type ApiValidationResult struct {

    // Name of the validation.
    Name *string `mandatory:"true" json:"name"`

    // Result of the validation.
    Result ApiValidationResultResultEnum `mandatory:"true" json:"result"`
}

func (ApiValidationResult) String

func (m ApiValidationResult) String() string

type ApiValidationResultResultEnum

ApiValidationResultResultEnum Enum with underlying type: string

type ApiValidationResultResultEnum string

Set of constants representing the allowable values for ApiValidationResultResultEnum

const (
    ApiValidationResultResultError   ApiValidationResultResultEnum = "ERROR"
    ApiValidationResultResultWarning ApiValidationResultResultEnum = "WARNING"
    ApiValidationResultResultOk      ApiValidationResultResultEnum = "OK"
    ApiValidationResultResultFailed  ApiValidationResultResultEnum = "FAILED"
)

func GetApiValidationResultResultEnumValues

func GetApiValidationResultResultEnumValues() []ApiValidationResultResultEnum

GetApiValidationResultResultEnumValues Enumerates the set of values for ApiValidationResultResultEnum

type ApiValidations

ApiValidations The result of validations conducted on the API.

type ApiValidations struct {

    // API validation results.
    Validations []ApiValidationDetails `mandatory:"true" json:"validations"`
}

func (ApiValidations) String

func (m ApiValidations) String() string

type AuthenticationOnlyRouteAuthorizationPolicy

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

type AuthenticationOnlyRouteAuthorizationPolicy struct {
}

func (AuthenticationOnlyRouteAuthorizationPolicy) MarshalJSON

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

MarshalJSON marshals to json representation

func (AuthenticationOnlyRouteAuthorizationPolicy) String

func (m AuthenticationOnlyRouteAuthorizationPolicy) String() string

type AuthenticationPolicy

AuthenticationPolicy Information on how to authenticate incoming requests.

type AuthenticationPolicy interface {

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

type AuthenticationPolicyTypeEnum

AuthenticationPolicyTypeEnum Enum with underlying type: string

type AuthenticationPolicyTypeEnum string

Set of constants representing the allowable values for AuthenticationPolicyTypeEnum

const (
    AuthenticationPolicyTypeCustomAuthentication AuthenticationPolicyTypeEnum = "CUSTOM_AUTHENTICATION"
    AuthenticationPolicyTypeJwtAuthentication    AuthenticationPolicyTypeEnum = "JWT_AUTHENTICATION"
)

func GetAuthenticationPolicyTypeEnumValues

func GetAuthenticationPolicyTypeEnumValues() []AuthenticationPolicyTypeEnum

GetAuthenticationPolicyTypeEnumValues Enumerates the set of values for AuthenticationPolicyTypeEnum

type CancelWorkRequestRequest

CancelWorkRequestRequest wrapper for the CancelWorkRequest operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.

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
}

func (CancelWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CancelWorkRequestRequest) RetryPolicy

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

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

func (CancelWorkRequestRequest) String

func (request CancelWorkRequestRequest) String() string

type CancelWorkRequestResponse

CancelWorkRequestResponse wrapper for the CancelWorkRequest operation

type CancelWorkRequestResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

func (CancelWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CancelWorkRequestResponse) String

func (response CancelWorkRequestResponse) String() string

type Certificate

Certificate A certificate contains information to be installed on a gateway to secure the traffic going through it. For more information, see API Gateway Concepts (https://docs.cloud.oracle.com/iaas/Content/APIGateway/Concepts/apigatewayconcepts.htm).

type Certificate struct {

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

    // 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:"true" json:"displayName"`

    // 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 entity to be secured by the certificate and additional host names.
    SubjectNames []string `mandatory:"true" json:"subjectNames"`

    // The date and time the certificate will expire.
    TimeNotValidAfter *common.SDKTime `mandatory:"true" json:"timeNotValidAfter"`

    // The data of the leaf certificate in pem format.
    Certificate *string `mandatory:"true" json:"certificate"`

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

    // The intermediate certificate data associated with the certificate in pem format.
    IntermediateCertificates *string `mandatory:"false" json:"intermediateCertificates"`

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

    // The current state of the certificate.
    LifecycleState CertificateLifecycleStateEnum `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"`
}

func (Certificate) String

func (m Certificate) String() string

type CertificateCollection

CertificateCollection Collection of certificate summaries.

type CertificateCollection struct {

    // Certificate summaries.
    Items []CertificateSummary `mandatory:"true" json:"items"`
}

func (CertificateCollection) String

func (m CertificateCollection) String() string

type CertificateLifecycleStateEnum

CertificateLifecycleStateEnum Enum with underlying type: string

type CertificateLifecycleStateEnum string

Set of constants representing the allowable values for CertificateLifecycleStateEnum

const (
    CertificateLifecycleStateCreating CertificateLifecycleStateEnum = "CREATING"
    CertificateLifecycleStateActive   CertificateLifecycleStateEnum = "ACTIVE"
    CertificateLifecycleStateUpdating CertificateLifecycleStateEnum = "UPDATING"
    CertificateLifecycleStateDeleting CertificateLifecycleStateEnum = "DELETING"
    CertificateLifecycleStateDeleted  CertificateLifecycleStateEnum = "DELETED"
    CertificateLifecycleStateFailed   CertificateLifecycleStateEnum = "FAILED"
)

func GetCertificateLifecycleStateEnumValues

func GetCertificateLifecycleStateEnumValues() []CertificateLifecycleStateEnum

GetCertificateLifecycleStateEnumValues Enumerates the set of values for CertificateLifecycleStateEnum

type CertificateSummary

CertificateSummary A summary of the certificate.

type CertificateSummary struct {

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

    // 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:"true" json:"displayName"`

    // 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 entity to be secured by the certificate and additional host names.
    SubjectNames []string `mandatory:"true" json:"subjectNames"`

    // The date and time the certificate will expire.
    TimeNotValidAfter *common.SDKTime `mandatory:"true" json:"timeNotValidAfter"`

    // The time this resource was created. An RFC3339 formatted datetime string.
    TimeCreated *common.SDKTime `mandatory:"true" 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 certificate.
    LifecycleState CertificateLifecycleStateEnum `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"`
}

func (CertificateSummary) String

func (m CertificateSummary) String() string

type ChangeApiCompartmentDetails

ChangeApiCompartmentDetails The new compartment details for the API.

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

func (ChangeApiCompartmentDetails) String

func (m ChangeApiCompartmentDetails) String() string

type ChangeApiCompartmentRequest

ChangeApiCompartmentRequest wrapper for the ChangeApiCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ChangeApiCompartment.go.html to see an example of how to use ChangeApiCompartmentRequest.

type ChangeApiCompartmentRequest struct {

    // The ocid of the API.
    ApiId *string `mandatory:"true" contributesTo:"path" name:"apiId"`

    // Details of the target compartment.
    ChangeApiCompartmentDetails `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
}

func (ChangeApiCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeApiCompartmentRequest) RetryPolicy

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

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

func (ChangeApiCompartmentRequest) String

func (request ChangeApiCompartmentRequest) String() string

type ChangeApiCompartmentResponse

ChangeApiCompartmentResponse wrapper for the ChangeApiCompartment operation

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

func (ChangeApiCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeApiCompartmentResponse) String

func (response ChangeApiCompartmentResponse) String() string

type ChangeCertificateCompartmentDetails

ChangeCertificateCompartmentDetails The new compartment details for the certificate.

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

func (ChangeCertificateCompartmentDetails) String

func (m ChangeCertificateCompartmentDetails) String() string

type ChangeCertificateCompartmentRequest

ChangeCertificateCompartmentRequest wrapper for the ChangeCertificateCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ChangeCertificateCompartment.go.html to see an example of how to use ChangeCertificateCompartmentRequest.

type ChangeCertificateCompartmentRequest struct {

    // The ocid of the certificate.
    CertificateId *string `mandatory:"true" contributesTo:"path" name:"certificateId"`

    // Details of the target compartment.
    ChangeCertificateCompartmentDetails `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
}

func (ChangeCertificateCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeCertificateCompartmentRequest) RetryPolicy

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

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

func (ChangeCertificateCompartmentRequest) String

func (request ChangeCertificateCompartmentRequest) String() string

type ChangeCertificateCompartmentResponse

ChangeCertificateCompartmentResponse wrapper for the ChangeCertificateCompartment operation

type ChangeCertificateCompartmentResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

func (ChangeCertificateCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeCertificateCompartmentResponse) String

func (response ChangeCertificateCompartmentResponse) String() string

type ChangeDeploymentCompartmentDetails

ChangeDeploymentCompartmentDetails The new compartment details for the deployment.

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

func (ChangeDeploymentCompartmentDetails) String

func (m ChangeDeploymentCompartmentDetails) String() string

type ChangeDeploymentCompartmentRequest

ChangeDeploymentCompartmentRequest wrapper for the ChangeDeploymentCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ChangeDeploymentCompartment.go.html to see an example of how to use ChangeDeploymentCompartmentRequest.

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
}

func (ChangeDeploymentCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeDeploymentCompartmentRequest) RetryPolicy

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

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

func (ChangeDeploymentCompartmentRequest) String

func (request ChangeDeploymentCompartmentRequest) String() string

type ChangeDeploymentCompartmentResponse

ChangeDeploymentCompartmentResponse wrapper for the ChangeDeploymentCompartment operation

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

func (ChangeDeploymentCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeDeploymentCompartmentResponse) String

func (response ChangeDeploymentCompartmentResponse) String() string

type ChangeGatewayCompartmentDetails

ChangeGatewayCompartmentDetails The new compartment details for the gateway.

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

func (ChangeGatewayCompartmentDetails) String

func (m ChangeGatewayCompartmentDetails) String() string

type ChangeGatewayCompartmentRequest

ChangeGatewayCompartmentRequest wrapper for the ChangeGatewayCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ChangeGatewayCompartment.go.html to see an example of how to use ChangeGatewayCompartmentRequest.

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
}

func (ChangeGatewayCompartmentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ChangeGatewayCompartmentRequest) RetryPolicy

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

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

func (ChangeGatewayCompartmentRequest) String

func (request ChangeGatewayCompartmentRequest) String() string

type ChangeGatewayCompartmentResponse

ChangeGatewayCompartmentResponse wrapper for the ChangeGatewayCompartment operation

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

func (ChangeGatewayCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeGatewayCompartmentResponse) String

func (response ChangeGatewayCompartmentResponse) String() string

type CorsPolicy

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

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

func (CorsPolicy) String

func (m CorsPolicy) String() string

type CreateApiDetails

CreateApiDetails Information about the new API.

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

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

    // API Specification content in json or yaml format
    Content *string `mandatory:"false" json:"content"`
}

func (CreateApiDetails) String

func (m CreateApiDetails) String() string

type CreateApiRequest

CreateApiRequest wrapper for the CreateApi operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/CreateApi.go.html to see an example of how to use CreateApiRequest.

type CreateApiRequest struct {

    // Details for the new API.
    CreateApiDetails `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
}

func (CreateApiRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateApiRequest) RetryPolicy

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

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

func (CreateApiRequest) String

func (request CreateApiRequest) String() string

type CreateApiResponse

CreateApiResponse wrapper for the CreateApi operation

type CreateApiResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

func (CreateApiResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateApiResponse) String

func (response CreateApiResponse) String() string

type CreateCertificateDetails

CreateCertificateDetails Information about a new certificate.

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

    // The private key associated with the certificate in pem format.
    PrivateKey *string `mandatory:"true" json:"privateKey"`

    // The data of the leaf certificate in pem format.
    Certificate *string `mandatory:"true" json:"certificate"`

    // 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 intermediate certificate data associated with the certificate in pem format.
    IntermediateCertificates *string `mandatory:"false" json:"intermediateCertificates"`

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

func (CreateCertificateDetails) String

func (m CreateCertificateDetails) String() string

type CreateCertificateRequest

CreateCertificateRequest wrapper for the CreateCertificate operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/CreateCertificate.go.html to see an example of how to use CreateCertificateRequest.

type CreateCertificateRequest struct {

    // Details for the new certificate
    CreateCertificateDetails `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
}

func (CreateCertificateRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateCertificateRequest) RetryPolicy

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

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

func (CreateCertificateRequest) String

func (request CreateCertificateRequest) String() string

type CreateCertificateResponse

CreateCertificateResponse wrapper for the CreateCertificate operation

type CreateCertificateResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (CreateCertificateResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateCertificateResponse) String

func (response CreateCertificateResponse) String() string

type CreateDeploymentDetails

CreateDeploymentDetails Information about a new deployment.

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

func (CreateDeploymentDetails) String

func (m CreateDeploymentDetails) String() string

type CreateDeploymentRequest

CreateDeploymentRequest wrapper for the CreateDeployment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/CreateDeployment.go.html to see an example of how to use CreateDeploymentRequest.

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
}

func (CreateDeploymentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateDeploymentRequest) RetryPolicy

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

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

func (CreateDeploymentRequest) String

func (request CreateDeploymentRequest) String() string

type CreateDeploymentResponse

CreateDeploymentResponse wrapper for the CreateDeployment operation

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

func (CreateDeploymentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateDeploymentResponse) String

func (response CreateDeploymentResponse) String() string

type CreateGatewayDetails

CreateGatewayDetails Information about the new gateway.

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. `PUBLIC` will have a public ip address assigned to it, while `PRIVATE` will only be
    // accessible on a private IP address on the subnet.
    // Example: `PUBLIC` or `PRIVATE`
    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"`

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

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

func (CreateGatewayDetails) String

func (m CreateGatewayDetails) String() string

type CreateGatewayRequest

CreateGatewayRequest wrapper for the CreateGateway operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/CreateGateway.go.html to see an example of how to use CreateGatewayRequest.

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
}

func (CreateGatewayRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (CreateGatewayRequest) RetryPolicy

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

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

func (CreateGatewayRequest) String

func (request CreateGatewayRequest) String() string

type CreateGatewayResponse

CreateGatewayResponse wrapper for the CreateGateway operation

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

func (CreateGatewayResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateGatewayResponse) String

func (response CreateGatewayResponse) String() string

type CustomAuthenticationPolicy

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.

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

func (CustomAuthenticationPolicy) GetIsAnonymousAccessAllowed

func (m CustomAuthenticationPolicy) GetIsAnonymousAccessAllowed() *bool

GetIsAnonymousAccessAllowed returns IsAnonymousAccessAllowed

func (CustomAuthenticationPolicy) MarshalJSON

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

MarshalJSON marshals to json representation

func (CustomAuthenticationPolicy) String

func (m CustomAuthenticationPolicy) String() string

type DeleteApiRequest

DeleteApiRequest wrapper for the DeleteApi operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/DeleteApi.go.html to see an example of how to use DeleteApiRequest.

type DeleteApiRequest struct {

    // The ocid of the API.
    ApiId *string `mandatory:"true" contributesTo:"path" name:"apiId"`

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

func (DeleteApiRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteApiRequest) RetryPolicy

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

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

func (DeleteApiRequest) String

func (request DeleteApiRequest) String() string

type DeleteApiResponse

DeleteApiResponse wrapper for the DeleteApi operation

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

func (DeleteApiResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteApiResponse) String

func (response DeleteApiResponse) String() string

type DeleteCertificateRequest

DeleteCertificateRequest wrapper for the DeleteCertificate operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/DeleteCertificate.go.html to see an example of how to use DeleteCertificateRequest.

type DeleteCertificateRequest struct {

    // The ocid of the certificate.
    CertificateId *string `mandatory:"true" contributesTo:"path" name:"certificateId"`

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

func (DeleteCertificateRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteCertificateRequest) RetryPolicy

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

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

func (DeleteCertificateRequest) String

func (request DeleteCertificateRequest) String() string

type DeleteCertificateResponse

DeleteCertificateResponse wrapper for the DeleteCertificate operation

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

func (DeleteCertificateResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteCertificateResponse) String

func (response DeleteCertificateResponse) String() string

type DeleteDeploymentRequest

DeleteDeploymentRequest wrapper for the DeleteDeployment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/DeleteDeployment.go.html to see an example of how to use DeleteDeploymentRequest.

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
}

func (DeleteDeploymentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteDeploymentRequest) RetryPolicy

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

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

func (DeleteDeploymentRequest) String

func (request DeleteDeploymentRequest) String() string

type DeleteDeploymentResponse

DeleteDeploymentResponse wrapper for the DeleteDeployment operation

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

func (DeleteDeploymentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteDeploymentResponse) String

func (response DeleteDeploymentResponse) String() string

type DeleteGatewayRequest

DeleteGatewayRequest wrapper for the DeleteGateway operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/DeleteGateway.go.html to see an example of how to use DeleteGatewayRequest.

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
}

func (DeleteGatewayRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (DeleteGatewayRequest) RetryPolicy

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

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

func (DeleteGatewayRequest) String

func (request DeleteGatewayRequest) String() string

type DeleteGatewayResponse

DeleteGatewayResponse wrapper for the DeleteGateway operation

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

func (DeleteGatewayResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteGatewayResponse) String

func (response DeleteGatewayResponse) String() string

type Deployment

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

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

func (Deployment) String

func (m Deployment) String() string

type DeploymentClient

DeploymentClient a client for Deployment

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

func NewDeploymentClientWithConfigurationProvider

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

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

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

ChangeDeploymentCompartment Changes the deployment compartment.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ChangeDeploymentCompartment.go.html to see an example of how to use ChangeDeploymentCompartment API.

func (*DeploymentClient) ConfigurationProvider

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

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

func (DeploymentClient) CreateDeployment

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

CreateDeployment Creates a new deployment.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/CreateDeployment.go.html to see an example of how to use CreateDeployment API.

func (DeploymentClient) DeleteDeployment

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

DeleteDeployment Deletes the deployment with the given identifier.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/DeleteDeployment.go.html to see an example of how to use DeleteDeployment API.

func (DeploymentClient) GetDeployment

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

GetDeployment Gets a deployment by identifier.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/GetDeployment.go.html to see an example of how to use GetDeployment API.

func (DeploymentClient) ListDeployments

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

ListDeployments Returns a list of deployments.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ListDeployments.go.html to see an example of how to use ListDeployments API.

func (*DeploymentClient) SetRegion

func (client *DeploymentClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (DeploymentClient) UpdateDeployment

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

UpdateDeployment Updates the deployment with the given identifier.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/UpdateDeployment.go.html to see an example of how to use UpdateDeployment API.

type DeploymentCollection

DeploymentCollection Collection of deployment summaries.

type DeploymentCollection struct {

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

func (DeploymentCollection) String

func (m DeploymentCollection) String() string

type DeploymentLifecycleStateEnum

DeploymentLifecycleStateEnum Enum with underlying type: string

type DeploymentLifecycleStateEnum string

Set of constants representing the allowable values for DeploymentLifecycleStateEnum

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

func GetDeploymentLifecycleStateEnumValues

func GetDeploymentLifecycleStateEnumValues() []DeploymentLifecycleStateEnum

GetDeploymentLifecycleStateEnumValues Enumerates the set of values for DeploymentLifecycleStateEnum

type DeploymentSummary

DeploymentSummary A summary of the deployment.

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

func (DeploymentSummary) String

func (m DeploymentSummary) String() string

type ExecutionLogPolicy

ExecutionLogPolicy Configures the logging policies for the execution logs of an API Deployment.

type ExecutionLogPolicy struct {

    // Enables pushing of execution logs to the legacy OCI Object Storage log archival bucket.
    // Oracle recommends using the OCI Logging service to enable, retrieve, and query execution logs
    // for an API Deployment. If there is an active log object for the API Deployment and its
    // category is set to 'execution' in OCI Logging service, the logs will not be uploaded to the legacy
    // OCI Object Storage log archival bucket.
    // Please note that the functionality to push to the legacy OCI Object Storage log
    // archival bucket has been deprecated and will be removed in the future.
    IsEnabled *bool `mandatory:"false" json:"isEnabled"`

    // Specifies the log level used to control logging output of execution logs.
    // Enabling logging at a given level also enables logging at all higher levels.
    LogLevel ExecutionLogPolicyLogLevelEnum `mandatory:"false" json:"logLevel,omitempty"`
}

func (ExecutionLogPolicy) String

func (m ExecutionLogPolicy) String() string

type ExecutionLogPolicyLogLevelEnum

ExecutionLogPolicyLogLevelEnum Enum with underlying type: string

type ExecutionLogPolicyLogLevelEnum string

Set of constants representing the allowable values for ExecutionLogPolicyLogLevelEnum

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

func GetExecutionLogPolicyLogLevelEnumValues

func GetExecutionLogPolicyLogLevelEnumValues() []ExecutionLogPolicyLogLevelEnum

GetExecutionLogPolicyLogLevelEnumValues Enumerates the set of values for ExecutionLogPolicyLogLevelEnum

type FilterHeaderPolicy

FilterHeaderPolicy Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.

type FilterHeaderPolicy struct {

    // BLOCK drops any headers that are in the list of items, so it acts as an exclusion list.  ALLOW
    // permits only the headers in the list and removes all others, so it acts as an inclusion list.
    Type FilterHeaderPolicyTypeEnum `mandatory:"true" json:"type"`

    // The list of headers.
    Items []FilterHeaderPolicyItem `mandatory:"true" json:"items"`
}

func (FilterHeaderPolicy) String

func (m FilterHeaderPolicy) String() string

type FilterHeaderPolicyItem

FilterHeaderPolicyItem A header to drop (with BLOCK) or pass through (with ALLOW).

type FilterHeaderPolicyItem struct {

    // The case-insensitive name of the header.  This name must be unique across transformation policies.
    Name *string `mandatory:"true" json:"name"`
}

func (FilterHeaderPolicyItem) String

func (m FilterHeaderPolicyItem) String() string

type FilterHeaderPolicyTypeEnum

FilterHeaderPolicyTypeEnum Enum with underlying type: string

type FilterHeaderPolicyTypeEnum string

Set of constants representing the allowable values for FilterHeaderPolicyTypeEnum

const (
    FilterHeaderPolicyTypeAllow FilterHeaderPolicyTypeEnum = "ALLOW"
    FilterHeaderPolicyTypeBlock FilterHeaderPolicyTypeEnum = "BLOCK"
)

func GetFilterHeaderPolicyTypeEnumValues

func GetFilterHeaderPolicyTypeEnumValues() []FilterHeaderPolicyTypeEnum

GetFilterHeaderPolicyTypeEnumValues Enumerates the set of values for FilterHeaderPolicyTypeEnum

type FilterQueryParameterPolicy

FilterQueryParameterPolicy Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.

type FilterQueryParameterPolicy struct {

    // BLOCK drops any query parameters that are in the list of items, so it acts as an exclusion list.  ALLOW
    // permits only the parameters in the list and removes all others, so it acts as an inclusion list.
    Type FilterQueryParameterPolicyTypeEnum `mandatory:"true" json:"type"`

    // The list of query parameters.
    Items []FilterQueryParameterPolicyItem `mandatory:"true" json:"items"`
}

func (FilterQueryParameterPolicy) String

func (m FilterQueryParameterPolicy) String() string

type FilterQueryParameterPolicyItem

FilterQueryParameterPolicyItem A query parameter to drop (with BLOCK) or pass through (with ALLOW).

type FilterQueryParameterPolicyItem struct {

    // The case-sensitive name of the query parameter.
    Name *string `mandatory:"true" json:"name"`
}

func (FilterQueryParameterPolicyItem) String

func (m FilterQueryParameterPolicyItem) String() string

type FilterQueryParameterPolicyTypeEnum

FilterQueryParameterPolicyTypeEnum Enum with underlying type: string

type FilterQueryParameterPolicyTypeEnum string

Set of constants representing the allowable values for FilterQueryParameterPolicyTypeEnum

const (
    FilterQueryParameterPolicyTypeAllow FilterQueryParameterPolicyTypeEnum = "ALLOW"
    FilterQueryParameterPolicyTypeBlock FilterQueryParameterPolicyTypeEnum = "BLOCK"
)

func GetFilterQueryParameterPolicyTypeEnumValues

func GetFilterQueryParameterPolicyTypeEnumValues() []FilterQueryParameterPolicyTypeEnum

GetFilterQueryParameterPolicyTypeEnumValues Enumerates the set of values for FilterQueryParameterPolicyTypeEnum

type Gateway

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

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. `PUBLIC` will have a public ip address assigned to it, while `PRIVATE` will only be
    // accessible on a private IP address on the subnet.
    // Example: `PUBLIC` or `PRIVATE`
    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"`

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

    // An array of IP addresses associated with the gateway.
    IpAddresses []IpAddress `mandatory:"false" json:"ipAddresses"`

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

func (Gateway) String

func (m Gateway) String() string

type GatewayClient

GatewayClient a client for Gateway

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

func NewGatewayClientWithConfigurationProvider

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

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

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

ChangeGatewayCompartment Changes the gateway compartment.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ChangeGatewayCompartment.go.html to see an example of how to use ChangeGatewayCompartment API.

func (*GatewayClient) ConfigurationProvider

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

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

func (GatewayClient) CreateGateway

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

CreateGateway Creates a new gateway.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/CreateGateway.go.html to see an example of how to use CreateGateway API.

func (GatewayClient) DeleteGateway

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

DeleteGateway Deletes the gateway with the given identifier.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/DeleteGateway.go.html to see an example of how to use DeleteGateway API.

func (GatewayClient) GetGateway

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

GetGateway Gets a gateway by identifier.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/GetGateway.go.html to see an example of how to use GetGateway API.

func (GatewayClient) ListGateways

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

ListGateways Returns a list of gateways.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ListGateways.go.html to see an example of how to use ListGateways API.

func (*GatewayClient) SetRegion

func (client *GatewayClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (GatewayClient) UpdateGateway

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

UpdateGateway Updates the gateway with the given identifier.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/UpdateGateway.go.html to see an example of how to use UpdateGateway API.

type GatewayCollection

GatewayCollection Collection of gateway summaries.

type GatewayCollection struct {

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

func (GatewayCollection) String

func (m GatewayCollection) String() string

type GatewayEndpointTypeEnum

GatewayEndpointTypeEnum Enum with underlying type: string

type GatewayEndpointTypeEnum string

Set of constants representing the allowable values for GatewayEndpointTypeEnum

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

func GetGatewayEndpointTypeEnumValues

func GetGatewayEndpointTypeEnumValues() []GatewayEndpointTypeEnum

GetGatewayEndpointTypeEnumValues Enumerates the set of values for GatewayEndpointTypeEnum

type GatewayLifecycleStateEnum

GatewayLifecycleStateEnum Enum with underlying type: string

type GatewayLifecycleStateEnum string

Set of constants representing the allowable values for GatewayLifecycleStateEnum

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

func GetGatewayLifecycleStateEnumValues

func GetGatewayLifecycleStateEnumValues() []GatewayLifecycleStateEnum

GetGatewayLifecycleStateEnumValues Enumerates the set of values for GatewayLifecycleStateEnum

type GatewaySummary

GatewaySummary A summary of the gateway.

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. `PUBLIC` will have a public ip address assigned to it, while `PRIVATE` will only be
    // accessible on a private IP address on the subnet.
    // Example: `PUBLIC` or `PRIVATE`
    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"`

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

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

func (GatewaySummary) String

func (m GatewaySummary) String() string

type GetApiContentRequest

GetApiContentRequest wrapper for the GetApiContent operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/GetApiContent.go.html to see an example of how to use GetApiContentRequest.

type GetApiContentRequest struct {

    // The ocid of the API.
    ApiId *string `mandatory:"true" contributesTo:"path" name:"apiId"`

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

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

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

func (GetApiContentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetApiContentRequest) RetryPolicy

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

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

func (GetApiContentRequest) String

func (request GetApiContentRequest) String() string

type GetApiContentResponse

GetApiContentResponse wrapper for the GetApiContent operation

type GetApiContentResponse struct {

    // The underlying http response
    RawResponse *http.Response

    // The io.ReadCloser instance
    Content io.ReadCloser `presentIn:"body" encoding:"binary"`

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

    // Base64 encoded Sha256 of the body.
    XContentSha256 *string `presentIn:"header" name:"x-content-sha256"`
}

func (GetApiContentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetApiContentResponse) String

func (response GetApiContentResponse) String() string

type GetApiDeploymentSpecificationRequest

GetApiDeploymentSpecificationRequest wrapper for the GetApiDeploymentSpecification operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/GetApiDeploymentSpecification.go.html to see an example of how to use GetApiDeploymentSpecificationRequest.

type GetApiDeploymentSpecificationRequest struct {

    // The ocid of the API.
    ApiId *string `mandatory:"true" contributesTo:"path" name:"apiId"`

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

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

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

func (GetApiDeploymentSpecificationRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetApiDeploymentSpecificationRequest) RetryPolicy

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

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

func (GetApiDeploymentSpecificationRequest) String

func (request GetApiDeploymentSpecificationRequest) String() string

type GetApiDeploymentSpecificationResponse

GetApiDeploymentSpecificationResponse wrapper for the GetApiDeploymentSpecification operation

type GetApiDeploymentSpecificationResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (GetApiDeploymentSpecificationResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetApiDeploymentSpecificationResponse) String

func (response GetApiDeploymentSpecificationResponse) String() string

type GetApiRequest

GetApiRequest wrapper for the GetApi operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/GetApi.go.html to see an example of how to use GetApiRequest.

type GetApiRequest struct {

    // The ocid of the API.
    ApiId *string `mandatory:"true" contributesTo:"path" name:"apiId"`

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

func (GetApiRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetApiRequest) RetryPolicy

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

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

func (GetApiRequest) String

func (request GetApiRequest) String() string

type GetApiResponse

GetApiResponse wrapper for the GetApi operation

type GetApiResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (GetApiResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetApiResponse) String

func (response GetApiResponse) String() string

type GetApiValidationsRequest

GetApiValidationsRequest wrapper for the GetApiValidations operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/GetApiValidations.go.html to see an example of how to use GetApiValidationsRequest.

type GetApiValidationsRequest struct {

    // The ocid of the API.
    ApiId *string `mandatory:"true" contributesTo:"path" name:"apiId"`

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

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

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

func (GetApiValidationsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetApiValidationsRequest) RetryPolicy

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

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

func (GetApiValidationsRequest) String

func (request GetApiValidationsRequest) String() string

type GetApiValidationsResponse

GetApiValidationsResponse wrapper for the GetApiValidations operation

type GetApiValidationsResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (GetApiValidationsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetApiValidationsResponse) String

func (response GetApiValidationsResponse) String() string

type GetCertificateRequest

GetCertificateRequest wrapper for the GetCertificate operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/GetCertificate.go.html to see an example of how to use GetCertificateRequest.

type GetCertificateRequest struct {

    // The ocid of the certificate.
    CertificateId *string `mandatory:"true" contributesTo:"path" name:"certificateId"`

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

func (GetCertificateRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetCertificateRequest) RetryPolicy

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

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

func (GetCertificateRequest) String

func (request GetCertificateRequest) String() string

type GetCertificateResponse

GetCertificateResponse wrapper for the GetCertificate operation

type GetCertificateResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

func (GetCertificateResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetCertificateResponse) String

func (response GetCertificateResponse) String() string

type GetDeploymentRequest

GetDeploymentRequest wrapper for the GetDeployment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/GetDeployment.go.html to see an example of how to use GetDeploymentRequest.

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
}

func (GetDeploymentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetDeploymentRequest) RetryPolicy

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

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

func (GetDeploymentRequest) String

func (request GetDeploymentRequest) String() string

type GetDeploymentResponse

GetDeploymentResponse wrapper for the GetDeployment operation

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

func (GetDeploymentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetDeploymentResponse) String

func (response GetDeploymentResponse) String() string

type GetGatewayRequest

GetGatewayRequest wrapper for the GetGateway operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/GetGateway.go.html to see an example of how to use GetGatewayRequest.

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
}

func (GetGatewayRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetGatewayRequest) RetryPolicy

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

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

func (GetGatewayRequest) String

func (request GetGatewayRequest) String() string

type GetGatewayResponse

GetGatewayResponse wrapper for the GetGateway operation

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

func (GetGatewayResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetGatewayResponse) String

func (response GetGatewayResponse) String() string

type GetWorkRequestRequest

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.

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
}

func (GetWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy

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

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

func (GetWorkRequestRequest) String

func (request GetWorkRequestRequest) String() string

type GetWorkRequestResponse

GetWorkRequestResponse wrapper for the GetWorkRequest operation

type GetWorkRequestResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

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

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

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

func (GetWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type HeaderFieldSpecification

HeaderFieldSpecification Header in key/value pair.

type HeaderFieldSpecification struct {

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

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

func (HeaderFieldSpecification) String

func (m HeaderFieldSpecification) String() string

type HeaderTransformationPolicy

HeaderTransformationPolicy A set of transformations to apply to HTTP headers that pass through the gateway.

type HeaderTransformationPolicy struct {
    SetHeaders *SetHeaderPolicy `mandatory:"false" json:"setHeaders"`

    RenameHeaders *RenameHeaderPolicy `mandatory:"false" json:"renameHeaders"`

    FilterHeaders *FilterHeaderPolicy `mandatory:"false" json:"filterHeaders"`
}

func (HeaderTransformationPolicy) String

func (m HeaderTransformationPolicy) String() string

type HttpBackend

HttpBackend Send the request to an HTTP backend.

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

func (HttpBackend) MarshalJSON

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

MarshalJSON marshals to json representation

func (HttpBackend) String

func (m HttpBackend) String() string

type IpAddress

IpAddress IP address associated with the gateway.

type IpAddress struct {

    // An IP address.
    IpAddress *string `mandatory:"true" json:"ipAddress"`
}

func (IpAddress) String

func (m IpAddress) String() string

type JsonWebKey

JsonWebKey A JSON Web Key that represents the public key used for verifying the JWT signature.

type JsonWebKey struct {

    // A unique key ID. This key will be used to verify the signature of a
    // JWT with matching "kid".
    Kid *string `mandatory:"true" json:"kid"`

    // The algorithm intended for use with this key.
    Alg *string `mandatory:"true" json:"alg"`

    // The base64 url encoded modulus of the RSA public key represented
    // by this key.
    N *string `mandatory:"true" json:"n"`

    // The base64 url encoded exponent of the RSA public key represented
    // by this key.
    E *string `mandatory:"true" json:"e"`

    // The key type.
    Kty JsonWebKeyKtyEnum `mandatory:"true" json:"kty"`

    // The intended use of the public key.
    Use JsonWebKeyUseEnum `mandatory:"false" json:"use,omitempty"`

    // The operations for which this key is to be used.
    KeyOps []JsonWebKeyKeyOpsEnum `mandatory:"false" json:"key_ops,omitempty"`
}

func (JsonWebKey) GetKid

func (m JsonWebKey) GetKid() *string

GetKid returns Kid

func (JsonWebKey) MarshalJSON

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

MarshalJSON marshals to json representation

func (JsonWebKey) String

func (m JsonWebKey) String() string

type JsonWebKeyKeyOpsEnum

JsonWebKeyKeyOpsEnum Enum with underlying type: string

type JsonWebKeyKeyOpsEnum string

Set of constants representing the allowable values for JsonWebKeyKeyOpsEnum

const (
    JsonWebKeyKeyOpsVerify JsonWebKeyKeyOpsEnum = "verify"
)

func GetJsonWebKeyKeyOpsEnumValues

func GetJsonWebKeyKeyOpsEnumValues() []JsonWebKeyKeyOpsEnum

GetJsonWebKeyKeyOpsEnumValues Enumerates the set of values for JsonWebKeyKeyOpsEnum

type JsonWebKeyKtyEnum

JsonWebKeyKtyEnum Enum with underlying type: string

type JsonWebKeyKtyEnum string

Set of constants representing the allowable values for JsonWebKeyKtyEnum

const (
    JsonWebKeyKtyRsa JsonWebKeyKtyEnum = "RSA"
)

func GetJsonWebKeyKtyEnumValues

func GetJsonWebKeyKtyEnumValues() []JsonWebKeyKtyEnum

GetJsonWebKeyKtyEnumValues Enumerates the set of values for JsonWebKeyKtyEnum

type JsonWebKeyUseEnum

JsonWebKeyUseEnum Enum with underlying type: string

type JsonWebKeyUseEnum string

Set of constants representing the allowable values for JsonWebKeyUseEnum

const (
    JsonWebKeyUseSig JsonWebKeyUseEnum = "sig"
)

func GetJsonWebKeyUseEnumValues

func GetJsonWebKeyUseEnumValues() []JsonWebKeyUseEnum

GetJsonWebKeyUseEnumValues Enumerates the set of values for JsonWebKeyUseEnum

type JsonWebTokenClaim

JsonWebTokenClaim An individual JWT claim.

type JsonWebTokenClaim struct {

    // Name of the claim.
    Key *string `mandatory:"true" json:"key"`

    // The list of acceptable values for a given claim.
    // If this value is "null" or empty and "isRequired" set to "true", then
    // the presence of this claim in the JWT is validated.
    Values []string `mandatory:"false" json:"values"`

    // Whether the claim is required to be present in the JWT or not. If set
    // to "false", the claim values will be matched only if the claim is
    // present in the JWT.
    IsRequired *bool `mandatory:"false" json:"isRequired"`
}

func (JsonWebTokenClaim) String

func (m JsonWebTokenClaim) String() string

type JwtAuthenticationPolicy

JwtAuthenticationPolicy Validate a JWT token present in the header or query parameter. A valid policy must specify either tokenHeader or tokenQueryParam.

type JwtAuthenticationPolicy struct {

    // A list of parties that could have issued the token.
    Issuers []string `mandatory:"true" json:"issuers"`

    // The list of intended recipients for the token.
    Audiences []string `mandatory:"true" json:"audiences"`

    PublicKeys PublicKeySet `mandatory:"true" json:"publicKeys"`

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

    // The authentication scheme that is to be used when authenticating
    // the token. This must to be provided if "tokenHeader" is specified.
    TokenAuthScheme *string `mandatory:"false" json:"tokenAuthScheme"`

    // A list of claims which should be validated to consider the token valid.
    VerifyClaims []JsonWebTokenClaim `mandatory:"false" json:"verifyClaims"`

    // The maximum expected time difference between the system clocks
    // of the token issuer and the API Gateway.
    MaxClockSkewInSeconds *float32 `mandatory:"false" json:"maxClockSkewInSeconds"`
}

func (JwtAuthenticationPolicy) GetIsAnonymousAccessAllowed

func (m JwtAuthenticationPolicy) GetIsAnonymousAccessAllowed() *bool

GetIsAnonymousAccessAllowed returns IsAnonymousAccessAllowed

func (JwtAuthenticationPolicy) MarshalJSON

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

MarshalJSON marshals to json representation

func (JwtAuthenticationPolicy) String

func (m JwtAuthenticationPolicy) String() string

func (*JwtAuthenticationPolicy) UnmarshalJSON

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

UnmarshalJSON unmarshals from json

type ListApisRequest

ListApisRequest wrapper for the ListApis operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ListApis.go.html to see an example of how to use ListApisRequest.

type ListApisRequest 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: `ACTIVE`
    LifecycleState ApiSummaryLifecycleStateEnum `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 ListApisSortOrderEnum `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 ListApisSortByEnum `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
}

func (ListApisRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListApisRequest) RetryPolicy

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

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

func (ListApisRequest) String

func (request ListApisRequest) String() string

type ListApisResponse

ListApisResponse wrapper for the ListApis operation

type ListApisResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

func (ListApisResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListApisResponse) String

func (response ListApisResponse) String() string

type ListApisSortByEnum

ListApisSortByEnum Enum with underlying type: string

type ListApisSortByEnum string

Set of constants representing the allowable values for ListApisSortByEnum

const (
    ListApisSortByTimecreated ListApisSortByEnum = "timeCreated"
    ListApisSortByDisplayname ListApisSortByEnum = "displayName"
)

func GetListApisSortByEnumValues

func GetListApisSortByEnumValues() []ListApisSortByEnum

GetListApisSortByEnumValues Enumerates the set of values for ListApisSortByEnum

type ListApisSortOrderEnum

ListApisSortOrderEnum Enum with underlying type: string

type ListApisSortOrderEnum string

Set of constants representing the allowable values for ListApisSortOrderEnum

const (
    ListApisSortOrderAsc  ListApisSortOrderEnum = "ASC"
    ListApisSortOrderDesc ListApisSortOrderEnum = "DESC"
)

func GetListApisSortOrderEnumValues

func GetListApisSortOrderEnumValues() []ListApisSortOrderEnum

GetListApisSortOrderEnumValues Enumerates the set of values for ListApisSortOrderEnum

type ListCertificatesRequest

ListCertificatesRequest wrapper for the ListCertificates operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ListCertificates.go.html to see an example of how to use ListCertificatesRequest.

type ListCertificatesRequest 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: `ACTIVE` or `DELETED`
    LifecycleState CertificateLifecycleStateEnum `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 ListCertificatesSortOrderEnum `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 ListCertificatesSortByEnum `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
}

func (ListCertificatesRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListCertificatesRequest) RetryPolicy

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

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

func (ListCertificatesRequest) String

func (request ListCertificatesRequest) String() string

type ListCertificatesResponse

ListCertificatesResponse wrapper for the ListCertificates operation

type ListCertificatesResponse struct {

    // The underlying http response
    RawResponse *http.Response

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

func (ListCertificatesResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListCertificatesResponse) String

func (response ListCertificatesResponse) String() string

type ListCertificatesSortByEnum

ListCertificatesSortByEnum Enum with underlying type: string

type ListCertificatesSortByEnum string

Set of constants representing the allowable values for ListCertificatesSortByEnum

const (
    ListCertificatesSortByTimecreated ListCertificatesSortByEnum = "timeCreated"
    ListCertificatesSortByDisplayname ListCertificatesSortByEnum = "displayName"
)

func GetListCertificatesSortByEnumValues

func GetListCertificatesSortByEnumValues() []ListCertificatesSortByEnum

GetListCertificatesSortByEnumValues Enumerates the set of values for ListCertificatesSortByEnum

type ListCertificatesSortOrderEnum

ListCertificatesSortOrderEnum Enum with underlying type: string

type ListCertificatesSortOrderEnum string

Set of constants representing the allowable values for ListCertificatesSortOrderEnum

const (
    ListCertificatesSortOrderAsc  ListCertificatesSortOrderEnum = "ASC"
    ListCertificatesSortOrderDesc ListCertificatesSortOrderEnum = "DESC"
)

func GetListCertificatesSortOrderEnumValues

func GetListCertificatesSortOrderEnumValues() []ListCertificatesSortOrderEnum

GetListCertificatesSortOrderEnumValues Enumerates the set of values for ListCertificatesSortOrderEnum

type ListDeploymentsRequest

ListDeploymentsRequest wrapper for the ListDeployments operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ListDeployments.go.html to see an example of how to use ListDeploymentsRequest.

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
}

func (ListDeploymentsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListDeploymentsRequest) RetryPolicy

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

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

func (ListDeploymentsRequest) String

func (request ListDeploymentsRequest) String() string

type ListDeploymentsResponse

ListDeploymentsResponse wrapper for the ListDeployments operation

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

func (ListDeploymentsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListDeploymentsResponse) String

func (response ListDeploymentsResponse) String() string

type ListDeploymentsSortByEnum

ListDeploymentsSortByEnum Enum with underlying type: string

type ListDeploymentsSortByEnum string

Set of constants representing the allowable values for ListDeploymentsSortByEnum

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

func GetListDeploymentsSortByEnumValues

func GetListDeploymentsSortByEnumValues() []ListDeploymentsSortByEnum

GetListDeploymentsSortByEnumValues Enumerates the set of values for ListDeploymentsSortByEnum

type ListDeploymentsSortOrderEnum

ListDeploymentsSortOrderEnum Enum with underlying type: string

type ListDeploymentsSortOrderEnum string

Set of constants representing the allowable values for ListDeploymentsSortOrderEnum

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

func GetListDeploymentsSortOrderEnumValues

func GetListDeploymentsSortOrderEnumValues() []ListDeploymentsSortOrderEnum

GetListDeploymentsSortOrderEnumValues Enumerates the set of values for ListDeploymentsSortOrderEnum

type ListGatewaysRequest

ListGatewaysRequest wrapper for the ListGateways operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ListGateways.go.html to see an example of how to use ListGatewaysRequest.

type ListGatewaysRequest struct {

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

    // Filter gateways by the certificate ocid.
    CertificateId *string `mandatory:"false" contributesTo:"query" name:"certificateId"`

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

func (ListGatewaysRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListGatewaysRequest) RetryPolicy

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

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

func (ListGatewaysRequest) String

func (request ListGatewaysRequest) String() string

type ListGatewaysResponse

ListGatewaysResponse wrapper for the ListGateways operation

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

func (ListGatewaysResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListGatewaysResponse) String

func (response ListGatewaysResponse) String() string

type ListGatewaysSortByEnum

ListGatewaysSortByEnum Enum with underlying type: string

type ListGatewaysSortByEnum string

Set of constants representing the allowable values for ListGatewaysSortByEnum

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

func GetListGatewaysSortByEnumValues

func GetListGatewaysSortByEnumValues() []ListGatewaysSortByEnum

GetListGatewaysSortByEnumValues Enumerates the set of values for ListGatewaysSortByEnum

type ListGatewaysSortOrderEnum

ListGatewaysSortOrderEnum Enum with underlying type: string

type ListGatewaysSortOrderEnum string

Set of constants representing the allowable values for ListGatewaysSortOrderEnum

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

func GetListGatewaysSortOrderEnumValues

func GetListGatewaysSortOrderEnumValues() []ListGatewaysSortOrderEnum

GetListGatewaysSortOrderEnumValues Enumerates the set of values for ListGatewaysSortOrderEnum

type ListWorkRequestErrorsRequest

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.

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
}

func (ListWorkRequestErrorsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy

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

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

func (ListWorkRequestErrorsRequest) String

func (request ListWorkRequestErrorsRequest) String() string

type ListWorkRequestErrorsResponse

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

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

func (ListWorkRequestErrorsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum

ListWorkRequestErrorsSortByEnum Enum with underlying type: string

type ListWorkRequestErrorsSortByEnum string

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

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

func GetListWorkRequestErrorsSortByEnumValues

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

type ListWorkRequestErrorsSortOrderEnum

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string

type ListWorkRequestErrorsSortOrderEnum string

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

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

func GetListWorkRequestErrorsSortOrderEnumValues

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

type ListWorkRequestLogsRequest

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.

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
}

func (ListWorkRequestLogsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy

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

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

func (ListWorkRequestLogsRequest) String

func (request ListWorkRequestLogsRequest) String() string

type ListWorkRequestLogsResponse

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

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

func (ListWorkRequestLogsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum

ListWorkRequestLogsSortByEnum Enum with underlying type: string

type ListWorkRequestLogsSortByEnum string

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

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

func GetListWorkRequestLogsSortByEnumValues

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

type ListWorkRequestLogsSortOrderEnum

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string

type ListWorkRequestLogsSortOrderEnum string

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

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

func GetListWorkRequestLogsSortOrderEnumValues

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

type ListWorkRequestsRequest

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.

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
}

func (ListWorkRequestsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy

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

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

func (ListWorkRequestsRequest) String

func (request ListWorkRequestsRequest) String() string

type ListWorkRequestsResponse

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

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

func (ListWorkRequestsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum

ListWorkRequestsSortByEnum Enum with underlying type: string

type ListWorkRequestsSortByEnum string

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

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

func GetListWorkRequestsSortByEnumValues

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

type ListWorkRequestsSortOrderEnum

ListWorkRequestsSortOrderEnum Enum with underlying type: string

type ListWorkRequestsSortOrderEnum string

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

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

func GetListWorkRequestsSortOrderEnumValues

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

type OracleFunctionBackend

OracleFunctionBackend Send the request to an Oracle Functions function.

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

func (OracleFunctionBackend) MarshalJSON

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

MarshalJSON marshals to json representation

func (OracleFunctionBackend) String

func (m OracleFunctionBackend) String() string

type PemEncodedPublicKey

PemEncodedPublicKey A PEM-encoded public key used for verifying the JWT signature.

type PemEncodedPublicKey struct {

    // A unique key ID. This key will be used to verify the signature of a
    // JWT with matching "kid".
    Kid *string `mandatory:"true" json:"kid"`

    // The content of the PEM-encoded public key.
    Key *string `mandatory:"true" json:"key"`
}

func (PemEncodedPublicKey) GetKid

func (m PemEncodedPublicKey) GetKid() *string

GetKid returns Kid

func (PemEncodedPublicKey) MarshalJSON

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

MarshalJSON marshals to json representation

func (PemEncodedPublicKey) String

func (m PemEncodedPublicKey) String() string

type PublicKeySet

PublicKeySet A set of Public Keys that will be used to verify the JWT signature.

type PublicKeySet interface {
}

type PublicKeySetTypeEnum

PublicKeySetTypeEnum Enum with underlying type: string

type PublicKeySetTypeEnum string

Set of constants representing the allowable values for PublicKeySetTypeEnum

const (
    PublicKeySetTypeStaticKeys PublicKeySetTypeEnum = "STATIC_KEYS"
    PublicKeySetTypeRemoteJwks PublicKeySetTypeEnum = "REMOTE_JWKS"
)

func GetPublicKeySetTypeEnumValues

func GetPublicKeySetTypeEnumValues() []PublicKeySetTypeEnum

GetPublicKeySetTypeEnumValues Enumerates the set of values for PublicKeySetTypeEnum

type QueryParameterTransformationPolicy

QueryParameterTransformationPolicy A set of transformations to apply to query parameters that pass through the gateway.

type QueryParameterTransformationPolicy struct {
    SetQueryParameters *SetQueryParameterPolicy `mandatory:"false" json:"setQueryParameters"`

    RenameQueryParameters *RenameQueryParameterPolicy `mandatory:"false" json:"renameQueryParameters"`

    FilterQueryParameters *FilterQueryParameterPolicy `mandatory:"false" json:"filterQueryParameters"`
}

func (QueryParameterTransformationPolicy) String

func (m QueryParameterTransformationPolicy) String() string

type RateLimitingPolicy

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

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

func (RateLimitingPolicy) String

func (m RateLimitingPolicy) String() string

type RateLimitingPolicyRateKeyEnum

RateLimitingPolicyRateKeyEnum Enum with underlying type: string

type RateLimitingPolicyRateKeyEnum string

Set of constants representing the allowable values for RateLimitingPolicyRateKeyEnum

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

func GetRateLimitingPolicyRateKeyEnumValues

func GetRateLimitingPolicyRateKeyEnumValues() []RateLimitingPolicyRateKeyEnum

GetRateLimitingPolicyRateKeyEnumValues Enumerates the set of values for RateLimitingPolicyRateKeyEnum

type RemoteJsonWebKeySet

RemoteJsonWebKeySet A set of public keys that is retrieved at run-time from a remote location to verify the JWT signature. The set should only contain JWK-formatted keys.

type RemoteJsonWebKeySet struct {

    // The uri from which to retrieve the key. It must be accessible
    // without authentication.
    Uri *string `mandatory:"true" json:"uri"`

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

    // The duration for which the JWKS should be cached before it is
    // fetched again.
    MaxCacheDurationInHours *int `mandatory:"false" json:"maxCacheDurationInHours"`
}

func (RemoteJsonWebKeySet) MarshalJSON

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

MarshalJSON marshals to json representation

func (RemoteJsonWebKeySet) String

func (m RemoteJsonWebKeySet) String() string

type RenameHeaderPolicy

RenameHeaderPolicy Rename HTTP headers as they pass through the gateway.

type RenameHeaderPolicy struct {

    // The list of headers.
    Items []RenameHeaderPolicyItem `mandatory:"true" json:"items"`
}

func (RenameHeaderPolicy) String

func (m RenameHeaderPolicy) String() string

type RenameHeaderPolicyItem

RenameHeaderPolicyItem The value will be a copy of the original value of the source header and will not be affected by any other transformation policies applied to that header.

type RenameHeaderPolicyItem struct {

    // The original case-insensitive name of the header.  This name must be unique across transformation policies.
    From *string `mandatory:"true" json:"from"`

    // The new name of the header.  This name must be unique across transformation policies.
    To *string `mandatory:"true" json:"to"`
}

func (RenameHeaderPolicyItem) String

func (m RenameHeaderPolicyItem) String() string

type RenameQueryParameterPolicy

RenameQueryParameterPolicy Rename parameters on the query string as they pass through the gateway.

type RenameQueryParameterPolicy struct {

    // The list of query parameters.
    Items []RenameQueryParameterPolicyItem `mandatory:"true" json:"items"`
}

func (RenameQueryParameterPolicy) String

func (m RenameQueryParameterPolicy) String() string

type RenameQueryParameterPolicyItem

RenameQueryParameterPolicyItem The value will be a copy of the original value of the source parameter and will not be affected by any other transformation policies applied to that parameter.

type RenameQueryParameterPolicyItem struct {

    // The original case-sensitive name of the query parameter.  This name must be unique across transformation
    // policies.
    From *string `mandatory:"true" json:"from"`

    // The new name of the query parameter.  This name must be unique across transformation policies.
    To *string `mandatory:"true" json:"to"`
}

func (RenameQueryParameterPolicyItem) String

func (m RenameQueryParameterPolicyItem) String() string

type RouteAuthorizationPolicy

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 RouteAuthorizationPolicy interface {
}

type RouteAuthorizationPolicyTypeEnum

RouteAuthorizationPolicyTypeEnum Enum with underlying type: string

type RouteAuthorizationPolicyTypeEnum string

Set of constants representing the allowable values for RouteAuthorizationPolicyTypeEnum

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

func GetRouteAuthorizationPolicyTypeEnumValues

func GetRouteAuthorizationPolicyTypeEnumValues() []RouteAuthorizationPolicyTypeEnum

GetRouteAuthorizationPolicyTypeEnumValues Enumerates the set of values for RouteAuthorizationPolicyTypeEnum

type SetHeaderPolicy

SetHeaderPolicy Set HTTP headers as they pass through the gateway.

type SetHeaderPolicy struct {

    // The list of headers.
    Items []SetHeaderPolicyItem `mandatory:"true" json:"items"`
}

func (SetHeaderPolicy) String

func (m SetHeaderPolicy) String() string

type SetHeaderPolicyItem

SetHeaderPolicyItem Set will add a new header if it was not in the original request. If the header already exists on the request, you can choose to override, append, or skip it.

type SetHeaderPolicyItem struct {

    // The case-insensitive name of the header.  This name must be unique across transformation policies.
    Name *string `mandatory:"true" json:"name"`

    // A list of new values.  Each value can be a constant or may include one or more expressions enclosed within
    // ${} delimiters.
    Values []string `mandatory:"true" json:"values"`

    // If a header with the same name already exists in the request, OVERWRITE will overwrite the value,
    // APPEND will append to the existing value, or SKIP will keep the existing value.
    IfExists SetHeaderPolicyItemIfExistsEnum `mandatory:"false" json:"ifExists,omitempty"`
}

func (SetHeaderPolicyItem) String

func (m SetHeaderPolicyItem) String() string

type SetHeaderPolicyItemIfExistsEnum

SetHeaderPolicyItemIfExistsEnum Enum with underlying type: string

type SetHeaderPolicyItemIfExistsEnum string

Set of constants representing the allowable values for SetHeaderPolicyItemIfExistsEnum

const (
    SetHeaderPolicyItemIfExistsOverwrite SetHeaderPolicyItemIfExistsEnum = "OVERWRITE"
    SetHeaderPolicyItemIfExistsAppend    SetHeaderPolicyItemIfExistsEnum = "APPEND"
    SetHeaderPolicyItemIfExistsSkip      SetHeaderPolicyItemIfExistsEnum = "SKIP"
)

func GetSetHeaderPolicyItemIfExistsEnumValues

func GetSetHeaderPolicyItemIfExistsEnumValues() []SetHeaderPolicyItemIfExistsEnum

GetSetHeaderPolicyItemIfExistsEnumValues Enumerates the set of values for SetHeaderPolicyItemIfExistsEnum

type SetQueryParameterPolicy

SetQueryParameterPolicy Set parameters on the query string as they pass through the gateway.

type SetQueryParameterPolicy struct {

    // The list of query parameters.
    Items []SetQueryParameterPolicyItem `mandatory:"true" json:"items"`
}

func (SetQueryParameterPolicy) String

func (m SetQueryParameterPolicy) String() string

type SetQueryParameterPolicyItem

SetQueryParameterPolicyItem Set will add a new query parameter if it was not in the original request. If the parameter already exists on the request, you can choose to override, append, or skip it.

type SetQueryParameterPolicyItem struct {

    // The case-sensitive name of the query parameter.  This name must be unique across transformation policies.
    Name *string `mandatory:"true" json:"name"`

    // A list of new values.  Each value can be a constant or may include one or more expressions enclosed within
    // ${} delimiters.
    Values []string `mandatory:"true" json:"values"`

    // If a query parameter with the same name already exists in the request, OVERWRITE will overwrite the value,
    // APPEND will append to the existing value, or SKIP will keep the existing value.
    IfExists SetQueryParameterPolicyItemIfExistsEnum `mandatory:"false" json:"ifExists,omitempty"`
}

func (SetQueryParameterPolicyItem) String

func (m SetQueryParameterPolicyItem) String() string

type SetQueryParameterPolicyItemIfExistsEnum

SetQueryParameterPolicyItemIfExistsEnum Enum with underlying type: string

type SetQueryParameterPolicyItemIfExistsEnum string

Set of constants representing the allowable values for SetQueryParameterPolicyItemIfExistsEnum

const (
    SetQueryParameterPolicyItemIfExistsOverwrite SetQueryParameterPolicyItemIfExistsEnum = "OVERWRITE"
    SetQueryParameterPolicyItemIfExistsAppend    SetQueryParameterPolicyItemIfExistsEnum = "APPEND"
    SetQueryParameterPolicyItemIfExistsSkip      SetQueryParameterPolicyItemIfExistsEnum = "SKIP"
)

func GetSetQueryParameterPolicyItemIfExistsEnumValues

func GetSetQueryParameterPolicyItemIfExistsEnumValues() []SetQueryParameterPolicyItemIfExistsEnum

GetSetQueryParameterPolicyItemIfExistsEnumValues Enumerates the set of values for SetQueryParameterPolicyItemIfExistsEnum

type StaticPublicKey

StaticPublicKey A static public key which is used to verify the JWT signature.

type StaticPublicKey interface {

    // A unique key ID. This key will be used to verify the signature of a
    // JWT with matching "kid".
    GetKid() *string
}

type StaticPublicKeyFormatEnum

StaticPublicKeyFormatEnum Enum with underlying type: string

type StaticPublicKeyFormatEnum string

Set of constants representing the allowable values for StaticPublicKeyFormatEnum

const (
    StaticPublicKeyFormatJsonWebKey StaticPublicKeyFormatEnum = "JSON_WEB_KEY"
    StaticPublicKeyFormatPem        StaticPublicKeyFormatEnum = "PEM"
)

func GetStaticPublicKeyFormatEnumValues

func GetStaticPublicKeyFormatEnumValues() []StaticPublicKeyFormatEnum

GetStaticPublicKeyFormatEnumValues Enumerates the set of values for StaticPublicKeyFormatEnum

type StaticPublicKeySet

StaticPublicKeySet A set of static public keys that will be used to verify the JWT signature.

type StaticPublicKeySet struct {

    // The set of static public keys.
    Keys []StaticPublicKey `mandatory:"false" json:"keys"`
}

func (StaticPublicKeySet) MarshalJSON

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

MarshalJSON marshals to json representation

func (StaticPublicKeySet) String

func (m StaticPublicKeySet) String() string

func (*StaticPublicKeySet) UnmarshalJSON

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

UnmarshalJSON unmarshals from json

type StockResponseBackend

StockResponseBackend Send the request to a mock backend.

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

func (StockResponseBackend) MarshalJSON

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

MarshalJSON marshals to json representation

func (StockResponseBackend) String

func (m StockResponseBackend) String() string

type UpdateApiDetails

UpdateApiDetails The information to be updated.

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

    // API Specification content in json or yaml format
    Content *string `mandatory:"false" json:"content"`
}

func (UpdateApiDetails) String

func (m UpdateApiDetails) String() string

type UpdateApiRequest

UpdateApiRequest wrapper for the UpdateApi operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/UpdateApi.go.html to see an example of how to use UpdateApiRequest.

type UpdateApiRequest struct {

    // The ocid of the API.
    ApiId *string `mandatory:"true" contributesTo:"path" name:"apiId"`

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

func (UpdateApiRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateApiRequest) RetryPolicy

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

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

func (UpdateApiRequest) String

func (request UpdateApiRequest) String() string

type UpdateApiResponse

UpdateApiResponse wrapper for the UpdateApi operation

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

func (UpdateApiResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateApiResponse) String

func (response UpdateApiResponse) String() string

type UpdateCertificateDetails

UpdateCertificateDetails The information to be updated.

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

func (UpdateCertificateDetails) String

func (m UpdateCertificateDetails) String() string

type UpdateCertificateRequest

UpdateCertificateRequest wrapper for the UpdateCertificate operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/UpdateCertificate.go.html to see an example of how to use UpdateCertificateRequest.

type UpdateCertificateRequest struct {

    // The ocid of the certificate.
    CertificateId *string `mandatory:"true" contributesTo:"path" name:"certificateId"`

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

func (UpdateCertificateRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateCertificateRequest) RetryPolicy

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

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

func (UpdateCertificateRequest) String

func (request UpdateCertificateRequest) String() string

type UpdateCertificateResponse

UpdateCertificateResponse wrapper for the UpdateCertificate operation

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

func (UpdateCertificateResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateCertificateResponse) String

func (response UpdateCertificateResponse) String() string

type UpdateDeploymentDetails

UpdateDeploymentDetails The information to be updated.

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

func (UpdateDeploymentDetails) String

func (m UpdateDeploymentDetails) String() string

type UpdateDeploymentRequest

UpdateDeploymentRequest wrapper for the UpdateDeployment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/UpdateDeployment.go.html to see an example of how to use UpdateDeploymentRequest.

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
}

func (UpdateDeploymentRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateDeploymentRequest) RetryPolicy

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

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

func (UpdateDeploymentRequest) String

func (request UpdateDeploymentRequest) String() string

type UpdateDeploymentResponse

UpdateDeploymentResponse wrapper for the UpdateDeployment operation

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

func (UpdateDeploymentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateDeploymentResponse) String

func (response UpdateDeploymentResponse) String() string

type UpdateGatewayDetails

UpdateGatewayDetails The information to be updated.

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

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

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

func (UpdateGatewayDetails) String

func (m UpdateGatewayDetails) String() string

type UpdateGatewayRequest

UpdateGatewayRequest wrapper for the UpdateGateway operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/UpdateGateway.go.html to see an example of how to use UpdateGatewayRequest.

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
}

func (UpdateGatewayRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (UpdateGatewayRequest) RetryPolicy

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

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

func (UpdateGatewayRequest) String

func (request UpdateGatewayRequest) String() string

type UpdateGatewayResponse

UpdateGatewayResponse wrapper for the UpdateGateway operation

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

func (UpdateGatewayResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateGatewayResponse) String

func (response UpdateGatewayResponse) String() string

type WorkRequest

WorkRequest A description of the work request status.

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

func (WorkRequest) String

func (m WorkRequest) String() string

type WorkRequestCollection

WorkRequestCollection Collection of work request summaries.

type WorkRequestCollection struct {

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

func (WorkRequestCollection) String

func (m WorkRequestCollection) String() string

type WorkRequestError

WorkRequestError An error encountered while executing a work request.

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

func (WorkRequestError) String

func (m WorkRequestError) String() string

type WorkRequestErrorCollection

WorkRequestErrorCollection Collection of work request errors.

type WorkRequestErrorCollection struct {

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

func (WorkRequestErrorCollection) String

func (m WorkRequestErrorCollection) String() string

type WorkRequestLog

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

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

func (WorkRequestLog) String

func (m WorkRequestLog) String() string

type WorkRequestLogCollection

WorkRequestLogCollection Collection of work request logs.

type WorkRequestLogCollection struct {

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

func (WorkRequestLogCollection) String

func (m WorkRequestLogCollection) String() string

type WorkRequestOperationTypeEnum

WorkRequestOperationTypeEnum Enum with underlying type: string

type WorkRequestOperationTypeEnum string

Set of constants representing the allowable values for WorkRequestOperationTypeEnum

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"
    WorkRequestOperationTypeCreateCertificate WorkRequestOperationTypeEnum = "CREATE_CERTIFICATE"
    WorkRequestOperationTypeUpdateCertificate WorkRequestOperationTypeEnum = "UPDATE_CERTIFICATE"
    WorkRequestOperationTypeDeleteCertificate WorkRequestOperationTypeEnum = "DELETE_CERTIFICATE"
    WorkRequestOperationTypeCreateApi         WorkRequestOperationTypeEnum = "CREATE_API"
    WorkRequestOperationTypeUpdateApi         WorkRequestOperationTypeEnum = "UPDATE_API"
    WorkRequestOperationTypeDeleteApi         WorkRequestOperationTypeEnum = "DELETE_API"
    WorkRequestOperationTypeValidateApi       WorkRequestOperationTypeEnum = "VALIDATE_API"
)

func GetWorkRequestOperationTypeEnumValues

func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum

GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum

type WorkRequestResource

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

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

func (WorkRequestResource) String

func (m WorkRequestResource) String() string

type WorkRequestResourceActionTypeEnum

WorkRequestResourceActionTypeEnum Enum with underlying type: string

type WorkRequestResourceActionTypeEnum string

Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum

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

func GetWorkRequestResourceActionTypeEnumValues

func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum

GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum

type WorkRequestStatusEnum

WorkRequestStatusEnum Enum with underlying type: string

type WorkRequestStatusEnum string

Set of constants representing the allowable values for WorkRequestStatusEnum

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

func GetWorkRequestStatusEnumValues

func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum

GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum

type WorkRequestSummary

WorkRequestSummary A summary of the work request.

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

func (WorkRequestSummary) String

func (m WorkRequestSummary) String() string

type WorkRequestsClient

WorkRequestsClient a client for WorkRequests

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

func NewWorkRequestsClientWithConfigurationProvider

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

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

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

CancelWorkRequest Cancels the work request.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API.

func (*WorkRequestsClient) ConfigurationProvider

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

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

func (WorkRequestsClient) GetWorkRequest

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API.

func (WorkRequestsClient) ListWorkRequestErrors

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API.

func (WorkRequestsClient) ListWorkRequestLogs

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API.

func (WorkRequestsClient) ListWorkRequests

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

ListWorkRequests Lists the work requests in a compartment.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/apigateway/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.

func (*WorkRequestsClient) SetRegion

func (client *WorkRequestsClient) SetRegion(region string)

SetRegion overrides the region of this client.