apigateway

package
v65.75.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 24, 2024 License: Apache-2.0, UPL-1.0 Imports: 8 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetApiLifecycleStateEnumStringValues 

func GetApiLifecycleStateEnumStringValues() []string

GetApiLifecycleStateEnumStringValues Enumerates the set of values in String for ApiLifecycleStateEnum

func GetApiSpecificationRouteBackendTypeEnumStringValues 

func GetApiSpecificationRouteBackendTypeEnumStringValues() []string

GetApiSpecificationRouteBackendTypeEnumStringValues Enumerates the set of values in String for ApiSpecificationRouteBackendTypeEnum

func GetApiSpecificationRouteMethodsEnumStringValues 

func GetApiSpecificationRouteMethodsEnumStringValues() []string

GetApiSpecificationRouteMethodsEnumStringValues Enumerates the set of values in String for ApiSpecificationRouteMethodsEnum

func GetApiSummaryLifecycleStateEnumStringValues 

func GetApiSummaryLifecycleStateEnumStringValues() []string

GetApiSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for ApiSummaryLifecycleStateEnum

func GetApiValidationDetailSeverityEnumStringValues 

func GetApiValidationDetailSeverityEnumStringValues() []string

GetApiValidationDetailSeverityEnumStringValues Enumerates the set of values in String for ApiValidationDetailSeverityEnum

func GetApiValidationDetailsResultEnumStringValues 

func GetApiValidationDetailsResultEnumStringValues() []string

GetApiValidationDetailsResultEnumStringValues Enumerates the set of values in String for ApiValidationDetailsResultEnum

func GetApiValidationResultResultEnumStringValues 

func GetApiValidationResultResultEnumStringValues() []string

GetApiValidationResultResultEnumStringValues Enumerates the set of values in String for ApiValidationResultResultEnum

func GetAuthenticationPolicyTypeEnumStringValues 

func GetAuthenticationPolicyTypeEnumStringValues() []string

GetAuthenticationPolicyTypeEnumStringValues Enumerates the set of values in String for AuthenticationPolicyTypeEnum

func GetBodyValidationRequestPolicyValidationModeEnumStringValues 

func GetBodyValidationRequestPolicyValidationModeEnumStringValues() []string

GetBodyValidationRequestPolicyValidationModeEnumStringValues Enumerates the set of values in String for BodyValidationRequestPolicyValidationModeEnum

func GetCaBundleTypeEnumStringValues 

func GetCaBundleTypeEnumStringValues() []string

GetCaBundleTypeEnumStringValues Enumerates the set of values in String for CaBundleTypeEnum

func GetCertificateLifecycleStateEnumStringValues 

func GetCertificateLifecycleStateEnumStringValues() []string

GetCertificateLifecycleStateEnumStringValues Enumerates the set of values in String for CertificateLifecycleStateEnum

func GetClientAppDetailsTypeEnumStringValues added in v65.27.0 

func GetClientAppDetailsTypeEnumStringValues() []string

GetClientAppDetailsTypeEnumStringValues Enumerates the set of values in String for ClientAppDetailsTypeEnum

func GetContentValidationValidationTypeEnumStringValues 

func GetContentValidationValidationTypeEnumStringValues() []string

GetContentValidationValidationTypeEnumStringValues Enumerates the set of values in String for ContentValidationValidationTypeEnum

func GetDeploymentLifecycleStateEnumStringValues 

func GetDeploymentLifecycleStateEnumStringValues() []string

GetDeploymentLifecycleStateEnumStringValues Enumerates the set of values in String for DeploymentLifecycleStateEnum

func GetDynamicSelectionKeyTypeEnumStringValues added in v65.20.0 

func GetDynamicSelectionKeyTypeEnumStringValues() []string

GetDynamicSelectionKeyTypeEnumStringValues Enumerates the set of values in String for DynamicSelectionKeyTypeEnum

func GetExecutionLogPolicyLogLevelEnumStringValues 

func GetExecutionLogPolicyLogLevelEnumStringValues() []string

GetExecutionLogPolicyLogLevelEnumStringValues Enumerates the set of values in String for ExecutionLogPolicyLogLevelEnum

func GetFilterHeaderPolicyTypeEnumStringValues 

func GetFilterHeaderPolicyTypeEnumStringValues() []string

GetFilterHeaderPolicyTypeEnumStringValues Enumerates the set of values in String for FilterHeaderPolicyTypeEnum

func GetFilterQueryParameterPolicyTypeEnumStringValues 

func GetFilterQueryParameterPolicyTypeEnumStringValues() []string

GetFilterQueryParameterPolicyTypeEnumStringValues Enumerates the set of values in String for FilterQueryParameterPolicyTypeEnum

func GetGatewayEndpointTypeEnumStringValues 

func GetGatewayEndpointTypeEnumStringValues() []string

GetGatewayEndpointTypeEnumStringValues Enumerates the set of values in String for GatewayEndpointTypeEnum

func GetGatewayLifecycleStateEnumStringValues 

func GetGatewayLifecycleStateEnumStringValues() []string

GetGatewayLifecycleStateEnumStringValues Enumerates the set of values in String for GatewayLifecycleStateEnum

func GetHeaderValidationRequestPolicyValidationModeEnumStringValues 

func GetHeaderValidationRequestPolicyValidationModeEnumStringValues() []string

GetHeaderValidationRequestPolicyValidationModeEnumStringValues Enumerates the set of values in String for HeaderValidationRequestPolicyValidationModeEnum

func GetJsonWebKeyKeyOpsEnumStringValues 

func GetJsonWebKeyKeyOpsEnumStringValues() []string

GetJsonWebKeyKeyOpsEnumStringValues Enumerates the set of values in String for JsonWebKeyKeyOpsEnum

func GetJsonWebKeyKtyEnumStringValues 

func GetJsonWebKeyKtyEnumStringValues() []string

GetJsonWebKeyKtyEnumStringValues Enumerates the set of values in String for JsonWebKeyKtyEnum

func GetJsonWebKeyUseEnumStringValues 

func GetJsonWebKeyUseEnumStringValues() []string

GetJsonWebKeyUseEnumStringValues Enumerates the set of values in String for JsonWebKeyUseEnum

func GetListApisSortByEnumStringValues 

func GetListApisSortByEnumStringValues() []string

GetListApisSortByEnumStringValues Enumerates the set of values in String for ListApisSortByEnum

func GetListApisSortOrderEnumStringValues 

func GetListApisSortOrderEnumStringValues() []string

GetListApisSortOrderEnumStringValues Enumerates the set of values in String for ListApisSortOrderEnum

func GetListCertificatesSortByEnumStringValues 

func GetListCertificatesSortByEnumStringValues() []string

GetListCertificatesSortByEnumStringValues Enumerates the set of values in String for ListCertificatesSortByEnum

func GetListCertificatesSortOrderEnumStringValues 

func GetListCertificatesSortOrderEnumStringValues() []string

GetListCertificatesSortOrderEnumStringValues Enumerates the set of values in String for ListCertificatesSortOrderEnum

func GetListDeploymentsSortByEnumStringValues 

func GetListDeploymentsSortByEnumStringValues() []string

GetListDeploymentsSortByEnumStringValues Enumerates the set of values in String for ListDeploymentsSortByEnum

func GetListDeploymentsSortOrderEnumStringValues 

func GetListDeploymentsSortOrderEnumStringValues() []string

GetListDeploymentsSortOrderEnumStringValues Enumerates the set of values in String for ListDeploymentsSortOrderEnum

func GetListGatewaysSortByEnumStringValues 

func GetListGatewaysSortByEnumStringValues() []string

GetListGatewaysSortByEnumStringValues Enumerates the set of values in String for ListGatewaysSortByEnum

func GetListGatewaysSortOrderEnumStringValues 

func GetListGatewaysSortOrderEnumStringValues() []string

GetListGatewaysSortOrderEnumStringValues Enumerates the set of values in String for ListGatewaysSortOrderEnum

func GetListSdkLanguageTypesSortByEnumStringValues 

func GetListSdkLanguageTypesSortByEnumStringValues() []string

GetListSdkLanguageTypesSortByEnumStringValues Enumerates the set of values in String for ListSdkLanguageTypesSortByEnum

func GetListSdkLanguageTypesSortOrderEnumStringValues 

func GetListSdkLanguageTypesSortOrderEnumStringValues() []string

GetListSdkLanguageTypesSortOrderEnumStringValues Enumerates the set of values in String for ListSdkLanguageTypesSortOrderEnum

func GetListSdksSortByEnumStringValues 

func GetListSdksSortByEnumStringValues() []string

GetListSdksSortByEnumStringValues Enumerates the set of values in String for ListSdksSortByEnum

func GetListSdksSortOrderEnumStringValues 

func GetListSdksSortOrderEnumStringValues() []string

GetListSdksSortOrderEnumStringValues Enumerates the set of values in String for ListSdksSortOrderEnum

func GetListSubscribersSortByEnumStringValues added in v65.7.0 

func GetListSubscribersSortByEnumStringValues() []string

GetListSubscribersSortByEnumStringValues Enumerates the set of values in String for ListSubscribersSortByEnum

func GetListSubscribersSortOrderEnumStringValues added in v65.7.0 

func GetListSubscribersSortOrderEnumStringValues() []string

GetListSubscribersSortOrderEnumStringValues Enumerates the set of values in String for ListSubscribersSortOrderEnum

func GetListUsagePlansSortByEnumStringValues added in v65.7.0 

func GetListUsagePlansSortByEnumStringValues() []string

GetListUsagePlansSortByEnumStringValues Enumerates the set of values in String for ListUsagePlansSortByEnum

func GetListUsagePlansSortOrderEnumStringValues added in v65.7.0 

func GetListUsagePlansSortOrderEnumStringValues() []string

GetListUsagePlansSortOrderEnumStringValues Enumerates the set of values in String for ListUsagePlansSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues 

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues 

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues 

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues 

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues 

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues 

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetOAuth2ResponseValidationFailurePolicyResponseTypeEnumStringValues added in v65.27.0 

func GetOAuth2ResponseValidationFailurePolicyResponseTypeEnumStringValues() []string

GetOAuth2ResponseValidationFailurePolicyResponseTypeEnumStringValues Enumerates the set of values in String for OAuth2ResponseValidationFailurePolicyResponseTypeEnum

func GetPublicKeySetTypeEnumStringValues 

func GetPublicKeySetTypeEnumStringValues() []string

GetPublicKeySetTypeEnumStringValues Enumerates the set of values in String for PublicKeySetTypeEnum

func GetQueryParameterValidationRequestPolicyValidationModeEnumStringValues 

func GetQueryParameterValidationRequestPolicyValidationModeEnumStringValues() []string

GetQueryParameterValidationRequestPolicyValidationModeEnumStringValues Enumerates the set of values in String for QueryParameterValidationRequestPolicyValidationModeEnum

func GetQuotaOperationOnBreachEnumStringValues added in v65.7.0 

func GetQuotaOperationOnBreachEnumStringValues() []string

GetQuotaOperationOnBreachEnumStringValues Enumerates the set of values in String for QuotaOperationOnBreachEnum

func GetQuotaResetPolicyEnumStringValues added in v65.7.0 

func GetQuotaResetPolicyEnumStringValues() []string

GetQuotaResetPolicyEnumStringValues Enumerates the set of values in String for QuotaResetPolicyEnum

func GetQuotaUnitEnumStringValues added in v65.7.0 

func GetQuotaUnitEnumStringValues() []string

GetQuotaUnitEnumStringValues Enumerates the set of values in String for QuotaUnitEnum

func GetRateLimitUnitEnumStringValues added in v65.7.0 

func GetRateLimitUnitEnumStringValues() []string

GetRateLimitUnitEnumStringValues Enumerates the set of values in String for RateLimitUnitEnum

func GetRateLimitingPolicyRateKeyEnumStringValues 

func GetRateLimitingPolicyRateKeyEnumStringValues() []string

GetRateLimitingPolicyRateKeyEnumStringValues Enumerates the set of values in String for RateLimitingPolicyRateKeyEnum

func GetResponseCacheDetailsTypeEnumStringValues 

func GetResponseCacheDetailsTypeEnumStringValues() []string

GetResponseCacheDetailsTypeEnumStringValues Enumerates the set of values in String for ResponseCacheDetailsTypeEnum

func GetResponseCacheLookupPolicyTypeEnumStringValues 

func GetResponseCacheLookupPolicyTypeEnumStringValues() []string

GetResponseCacheLookupPolicyTypeEnumStringValues Enumerates the set of values in String for ResponseCacheLookupPolicyTypeEnum

func GetResponseCacheStorePolicyTypeEnumStringValues 

func GetResponseCacheStorePolicyTypeEnumStringValues() []string

GetResponseCacheStorePolicyTypeEnumStringValues Enumerates the set of values in String for ResponseCacheStorePolicyTypeEnum

func GetRouteAuthorizationPolicyTypeEnumStringValues 

func GetRouteAuthorizationPolicyTypeEnumStringValues() []string

GetRouteAuthorizationPolicyTypeEnumStringValues Enumerates the set of values in String for RouteAuthorizationPolicyTypeEnum

func GetSdkLanguageOptionalParametersInputTypeEnumStringValues 

func GetSdkLanguageOptionalParametersInputTypeEnumStringValues() []string

GetSdkLanguageOptionalParametersInputTypeEnumStringValues Enumerates the set of values in String for SdkLanguageOptionalParametersInputTypeEnum

func GetSdkLifecycleStateEnumStringValues 

func GetSdkLifecycleStateEnumStringValues() []string

GetSdkLifecycleStateEnumStringValues Enumerates the set of values in String for SdkLifecycleStateEnum

func GetSelectionSourcePolicyTypeEnumStringValues added in v65.20.0 

func GetSelectionSourcePolicyTypeEnumStringValues() []string

GetSelectionSourcePolicyTypeEnumStringValues Enumerates the set of values in String for SelectionSourcePolicyTypeEnum

func GetSetHeaderPolicyItemIfExistsEnumStringValues 

func GetSetHeaderPolicyItemIfExistsEnumStringValues() []string

GetSetHeaderPolicyItemIfExistsEnumStringValues Enumerates the set of values in String for SetHeaderPolicyItemIfExistsEnum

func GetSetQueryParameterPolicyItemIfExistsEnumStringValues 

func GetSetQueryParameterPolicyItemIfExistsEnumStringValues() []string

GetSetQueryParameterPolicyItemIfExistsEnumStringValues Enumerates the set of values in String for SetQueryParameterPolicyItemIfExistsEnum

func GetSourceUriDetailsTypeEnumStringValues added in v65.27.0 

func GetSourceUriDetailsTypeEnumStringValues() []string

GetSourceUriDetailsTypeEnumStringValues Enumerates the set of values in String for SourceUriDetailsTypeEnum

func GetStaticPublicKeyFormatEnumStringValues 

func GetStaticPublicKeyFormatEnumStringValues() []string

GetStaticPublicKeyFormatEnumStringValues Enumerates the set of values in String for StaticPublicKeyFormatEnum

func GetSubscriberLifecycleStateEnumStringValues added in v65.7.0 

func GetSubscriberLifecycleStateEnumStringValues() []string

GetSubscriberLifecycleStateEnumStringValues Enumerates the set of values in String for SubscriberLifecycleStateEnum

func GetTokenAuthenticationValidationPolicyTypeEnumStringValues added in v65.27.0 

func GetTokenAuthenticationValidationPolicyTypeEnumStringValues() []string

GetTokenAuthenticationValidationPolicyTypeEnumStringValues Enumerates the set of values in String for TokenAuthenticationValidationPolicyTypeEnum

func GetUsagePlanLifecycleStateEnumStringValues added in v65.7.0 

func GetUsagePlanLifecycleStateEnumStringValues() []string

GetUsagePlanLifecycleStateEnumStringValues Enumerates the set of values in String for UsagePlanLifecycleStateEnum

func GetValidationFailurePolicyTypeEnumStringValues added in v65.20.0 

func GetValidationFailurePolicyTypeEnumStringValues() []string

GetValidationFailurePolicyTypeEnumStringValues Enumerates the set of values in String for ValidationFailurePolicyTypeEnum

func GetValidationRequestPolicyValidationModeEnumStringValues 

func GetValidationRequestPolicyValidationModeEnumStringValues() []string

GetValidationRequestPolicyValidationModeEnumStringValues Enumerates the set of values in String for ValidationRequestPolicyValidationModeEnum

func GetWorkRequestOperationTypeEnumStringValues 

func GetWorkRequestOperationTypeEnumStringValues() []string

GetWorkRequestOperationTypeEnumStringValues Enumerates the set of values in String for WorkRequestOperationTypeEnum

func GetWorkRequestResourceActionTypeEnumStringValues 

func GetWorkRequestResourceActionTypeEnumStringValues() []string

GetWorkRequestResourceActionTypeEnumStringValues Enumerates the set of values in String for WorkRequestResourceActionTypeEnum

func GetWorkRequestStatusEnumStringValues 

func GetWorkRequestStatusEnumStringValues() []string

GetWorkRequestStatusEnumStringValues Enumerates the set of values in String for WorkRequestStatusEnum

Types

type AccessLogPolicy 

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

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

func (AccessLogPolicy) String 

func (m AccessLogPolicy) String() string

func (AccessLogPolicy) ValidateEnumValue 

func (m AccessLogPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type AdditionalValidationPolicy added in v65.27.0 

type AdditionalValidationPolicy struct {

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

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

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

AdditionalValidationPolicy Additional JWT validation checks.

func (AdditionalValidationPolicy) String added in v65.27.0 

func (m AdditionalValidationPolicy) String() string

func (AdditionalValidationPolicy) ValidateEnumValue added in v65.27.0 

func (m AdditionalValidationPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type AnonymousRouteAuthorizationPolicy 

type AnonymousRouteAuthorizationPolicy struct {
}

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

func (AnonymousRouteAuthorizationPolicy) MarshalJSON 

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

MarshalJSON marshals to json representation

func (AnonymousRouteAuthorizationPolicy) String 

func (m AnonymousRouteAuthorizationPolicy) String() string

func (AnonymousRouteAuthorizationPolicy) ValidateEnumValue 

func (m AnonymousRouteAuthorizationPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type AnyOfRouteAuthorizationPolicy 

type AnyOfRouteAuthorizationPolicy struct {

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

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

func (AnyOfRouteAuthorizationPolicy) MarshalJSON 

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

MarshalJSON marshals to json representation

func (AnyOfRouteAuthorizationPolicy) String 

func (m AnyOfRouteAuthorizationPolicy) String() string

func (AnyOfRouteAuthorizationPolicy) ValidateEnumValue 

func (m AnyOfRouteAuthorizationPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type AnyOfSelectionKey added in v65.20.0 

type AnyOfSelectionKey struct {

	// Name assigned to the branch.
	Name *string `mandatory:"true" json:"name"`

	// Specifies whether to use the route or authentication server associated with this selection key as the default. The default is used if the value of a context variable in an incoming request does not match any of the other selection key values when dynamically routing and dynamically authenticating requests.
	IsDefault *bool `mandatory:"false" json:"isDefault"`

	// The set of selection keys to match with the context variable in an incoming request. If the context variable exactly matches one of the keys in the set, the request is sent to the route or authentication server associated with the set.
	Values []string `mandatory:"false" json:"values"`
}

AnyOfSelectionKey When dynamically routing and dynamically authenticating requests, the route or authentication server associated with a set of selection keys is used if the context variable in an incoming request exactly matches one of the keys in the set.

func (AnyOfSelectionKey) GetIsDefault added in v65.20.0 

func (m AnyOfSelectionKey) GetIsDefault() *bool

GetIsDefault returns IsDefault

func (AnyOfSelectionKey) GetName added in v65.20.0 

func (m AnyOfSelectionKey) GetName() *string

GetName returns Name

func (AnyOfSelectionKey) MarshalJSON added in v65.20.0 

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

MarshalJSON marshals to json representation

func (AnyOfSelectionKey) String added in v65.20.0 

func (m AnyOfSelectionKey) String() string

func (AnyOfSelectionKey) ValidateEnumValue added in v65.20.0 

func (m AnyOfSelectionKey) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type Api 

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

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

func (Api) String 

func (m Api) String() string

func (Api) ValidateEnumValue 

func (m Api) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ApiCollection 

type ApiCollection struct {

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

ApiCollection Collection of API summaries.

func (ApiCollection) String 

func (m ApiCollection) String() string

func (ApiCollection) ValidateEnumValue 

func (m ApiCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ApiGatewayClient 

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

ApiGatewayClient a client for ApiGateway

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/latest/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/latest/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/latest/apigateway/CreateApi.go.html to see an example of how to use CreateApi API. A default retry strategy applies to this operation CreateApi()

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/latest/apigateway/CreateCertificate.go.html to see an example of how to use CreateCertificate API. A default retry strategy applies to this operation CreateCertificate()

func (ApiGatewayClient) CreateSdk 

func (client ApiGatewayClient) CreateSdk(ctx context.Context, request CreateSdkRequest) (response CreateSdkResponse, err error)

CreateSdk Creates a new SDK.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apigateway/CreateSdk.go.html to see an example of how to use CreateSdk API. A default retry strategy applies to this operation CreateSdk()

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/latest/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/latest/apigateway/DeleteCertificate.go.html to see an example of how to use DeleteCertificate API.

func (ApiGatewayClient) DeleteSdk 

func (client ApiGatewayClient) DeleteSdk(ctx context.Context, request DeleteSdkRequest) (response DeleteSdkResponse, err error)

DeleteSdk Deletes provided SDK.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apigateway/DeleteSdk.go.html to see an example of how to use DeleteSdk 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/latest/apigateway/GetApi.go.html to see an example of how to use GetApi API. A default retry strategy applies to this operation GetApi()

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/latest/apigateway/GetApiContent.go.html to see an example of how to use GetApiContent API. A default retry strategy applies to this operation GetApiContent()

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/latest/apigateway/GetApiDeploymentSpecification.go.html to see an example of how to use GetApiDeploymentSpecification API. A default retry strategy applies to this operation GetApiDeploymentSpecification()

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/latest/apigateway/GetApiValidations.go.html to see an example of how to use GetApiValidations API. A default retry strategy applies to this operation GetApiValidations()

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/latest/apigateway/GetCertificate.go.html to see an example of how to use GetCertificate API. A default retry strategy applies to this operation GetCertificate()

func (ApiGatewayClient) GetSdk 

func (client ApiGatewayClient) GetSdk(ctx context.Context, request GetSdkRequest) (response GetSdkResponse, err error)

GetSdk Return object store downloadable URL and metadata.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apigateway/GetSdk.go.html to see an example of how to use GetSdk API. A default retry strategy applies to this operation GetSdk()

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/latest/apigateway/ListApis.go.html to see an example of how to use ListApis API. A default retry strategy applies to this operation ListApis()

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/latest/apigateway/ListCertificates.go.html to see an example of how to use ListCertificates API. A default retry strategy applies to this operation ListCertificates()

func (ApiGatewayClient) ListSdkLanguageTypes 

func (client ApiGatewayClient) ListSdkLanguageTypes(ctx context.Context, request ListSdkLanguageTypesRequest) (response ListSdkLanguageTypesResponse, err error)

ListSdkLanguageTypes Lists programming languages in which SDK can be generated.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apigateway/ListSdkLanguageTypes.go.html to see an example of how to use ListSdkLanguageTypes API. A default retry strategy applies to this operation ListSdkLanguageTypes()

func (ApiGatewayClient) ListSdks 

func (client ApiGatewayClient) ListSdks(ctx context.Context, request ListSdksRequest) (response ListSdksResponse, err error)

ListSdks Returns list of generated SDKs.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apigateway/ListSdks.go.html to see an example of how to use ListSdks API. A default retry strategy applies to this operation ListSdks()

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/latest/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/latest/apigateway/UpdateCertificate.go.html to see an example of how to use UpdateCertificate API.

func (ApiGatewayClient) UpdateSdk 

func (client ApiGatewayClient) UpdateSdk(ctx context.Context, request UpdateSdkRequest) (response UpdateSdkResponse, err error)

UpdateSdk Updates the SDK with the given identifier.

See also

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

type ApiLifecycleStateEnum 

type ApiLifecycleStateEnum string

ApiLifecycleStateEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ApiLifecycleStateEnum

func GetApiLifecycleStateEnumValues 

func GetApiLifecycleStateEnumValues() []ApiLifecycleStateEnum

GetApiLifecycleStateEnumValues Enumerates the set of values for ApiLifecycleStateEnum

func GetMappingApiLifecycleStateEnum 

func GetMappingApiLifecycleStateEnum(val string) (ApiLifecycleStateEnum, bool)

GetMappingApiLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ApiSpecification 

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

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

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

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

func (ApiSpecification) String 

func (m ApiSpecification) String() string

func (ApiSpecification) ValidateEnumValue 

func (m ApiSpecification) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ApiSpecificationLoggingPolicies 

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

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

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

func (ApiSpecificationLoggingPolicies) String 

func (m ApiSpecificationLoggingPolicies) String() string

func (ApiSpecificationLoggingPolicies) ValidateEnumValue 

func (m ApiSpecificationLoggingPolicies) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ApiSpecificationRequestPolicies 

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

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

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

	MutualTls *MutualTlsDetails `mandatory:"false" json:"mutualTls"`

	UsagePlans *UsagePlansPolicy `mandatory:"false" json:"usagePlans"`

	DynamicAuthentication *DynamicAuthenticationPolicy `mandatory:"false" json:"dynamicAuthentication"`
}

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

func (ApiSpecificationRequestPolicies) String 

func (m ApiSpecificationRequestPolicies) String() string

func (*ApiSpecificationRequestPolicies) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (ApiSpecificationRequestPolicies) ValidateEnumValue 

func (m ApiSpecificationRequestPolicies) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ApiSpecificationRoute 

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

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

func (ApiSpecificationRoute) String 

func (m ApiSpecificationRoute) String() string

func (*ApiSpecificationRoute) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (ApiSpecificationRoute) ValidateEnumValue 

func (m ApiSpecificationRoute) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ApiSpecificationRouteBackend 

type ApiSpecificationRouteBackend interface {
}

ApiSpecificationRouteBackend The backend to forward requests to.

type ApiSpecificationRouteBackendTypeEnum 

type ApiSpecificationRouteBackendTypeEnum string

ApiSpecificationRouteBackendTypeEnum Enum with underlying type: string 

const (
	ApiSpecificationRouteBackendTypeOracleFunctionsBackend ApiSpecificationRouteBackendTypeEnum = "ORACLE_FUNCTIONS_BACKEND"
	ApiSpecificationRouteBackendTypeHttpBackend            ApiSpecificationRouteBackendTypeEnum = "HTTP_BACKEND"
	ApiSpecificationRouteBackendTypeStockResponseBackend   ApiSpecificationRouteBackendTypeEnum = "STOCK_RESPONSE_BACKEND"
	ApiSpecificationRouteBackendTypeDynamicRoutingBackend  ApiSpecificationRouteBackendTypeEnum = "DYNAMIC_ROUTING_BACKEND"
	ApiSpecificationRouteBackendTypeOauth2LogoutBackend    ApiSpecificationRouteBackendTypeEnum = "OAUTH2_LOGOUT_BACKEND"
)

Set of constants representing the allowable values for ApiSpecificationRouteBackendTypeEnum

func GetApiSpecificationRouteBackendTypeEnumValues 

func GetApiSpecificationRouteBackendTypeEnumValues() []ApiSpecificationRouteBackendTypeEnum

GetApiSpecificationRouteBackendTypeEnumValues Enumerates the set of values for ApiSpecificationRouteBackendTypeEnum

func GetMappingApiSpecificationRouteBackendTypeEnum 

func GetMappingApiSpecificationRouteBackendTypeEnum(val string) (ApiSpecificationRouteBackendTypeEnum, bool)

GetMappingApiSpecificationRouteBackendTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ApiSpecificationRouteMethodsEnum 

type ApiSpecificationRouteMethodsEnum string

ApiSpecificationRouteMethodsEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ApiSpecificationRouteMethodsEnum

func GetApiSpecificationRouteMethodsEnumValues 

func GetApiSpecificationRouteMethodsEnumValues() []ApiSpecificationRouteMethodsEnum

GetApiSpecificationRouteMethodsEnumValues Enumerates the set of values for ApiSpecificationRouteMethodsEnum

func GetMappingApiSpecificationRouteMethodsEnum 

func GetMappingApiSpecificationRouteMethodsEnum(val string) (ApiSpecificationRouteMethodsEnum, bool)

GetMappingApiSpecificationRouteMethodsEnum performs case Insensitive comparison on enum value and return the desired enum

type ApiSpecificationRouteRequestPolicies 

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

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

	QueryParameterValidations *QueryParameterValidationRequestPolicy `mandatory:"false" json:"queryParameterValidations"`

	HeaderValidations *HeaderValidationRequestPolicy `mandatory:"false" json:"headerValidations"`

	BodyValidation *BodyValidationRequestPolicy `mandatory:"false" json:"bodyValidation"`

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

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

	ResponseCacheLookup ResponseCacheLookupPolicy `mandatory:"false" json:"responseCacheLookup"`
}

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

func (ApiSpecificationRouteRequestPolicies) String 

func (m ApiSpecificationRouteRequestPolicies) String() string

func (*ApiSpecificationRouteRequestPolicies) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (ApiSpecificationRouteRequestPolicies) ValidateEnumValue 

func (m ApiSpecificationRouteRequestPolicies) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ApiSpecificationRouteResponsePolicies 

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

	ResponseCacheStore ResponseCacheStorePolicy `mandatory:"false" json:"responseCacheStore"`
}

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

func (ApiSpecificationRouteResponsePolicies) String 

func (m ApiSpecificationRouteResponsePolicies) String() string

func (*ApiSpecificationRouteResponsePolicies) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (ApiSpecificationRouteResponsePolicies) ValidateEnumValue 

func (m ApiSpecificationRouteResponsePolicies) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ApiSummary 

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

ApiSummary A summary of the API.

func (ApiSummary) String 

func (m ApiSummary) String() string

func (ApiSummary) ValidateEnumValue 

func (m ApiSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ApiSummaryLifecycleStateEnum 

type ApiSummaryLifecycleStateEnum string

ApiSummaryLifecycleStateEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ApiSummaryLifecycleStateEnum

func GetApiSummaryLifecycleStateEnumValues 

func GetApiSummaryLifecycleStateEnumValues() []ApiSummaryLifecycleStateEnum

GetApiSummaryLifecycleStateEnumValues Enumerates the set of values for ApiSummaryLifecycleStateEnum

func GetMappingApiSummaryLifecycleStateEnum 

func GetMappingApiSummaryLifecycleStateEnum(val string) (ApiSummaryLifecycleStateEnum, bool)

GetMappingApiSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ApiValidationDetail 

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

ApiValidationDetail Detail of a single error or warning.

func (ApiValidationDetail) String 

func (m ApiValidationDetail) String() string

func (ApiValidationDetail) ValidateEnumValue 

func (m ApiValidationDetail) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ApiValidationDetailSeverityEnum 

type ApiValidationDetailSeverityEnum string

ApiValidationDetailSeverityEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ApiValidationDetailSeverityEnum

func GetApiValidationDetailSeverityEnumValues 

func GetApiValidationDetailSeverityEnumValues() []ApiValidationDetailSeverityEnum

GetApiValidationDetailSeverityEnumValues Enumerates the set of values for ApiValidationDetailSeverityEnum

func GetMappingApiValidationDetailSeverityEnum 

func GetMappingApiValidationDetailSeverityEnum(val string) (ApiValidationDetailSeverityEnum, bool)

GetMappingApiValidationDetailSeverityEnum performs case Insensitive comparison on enum value and return the desired enum

type ApiValidationDetails 

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

ApiValidationDetails Detail of an error or warning.

func (ApiValidationDetails) String 

func (m ApiValidationDetails) String() string

func (ApiValidationDetails) ValidateEnumValue 

func (m ApiValidationDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ApiValidationDetailsResultEnum 

type ApiValidationDetailsResultEnum string

ApiValidationDetailsResultEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ApiValidationDetailsResultEnum

func GetApiValidationDetailsResultEnumValues 

func GetApiValidationDetailsResultEnumValues() []ApiValidationDetailsResultEnum

GetApiValidationDetailsResultEnumValues Enumerates the set of values for ApiValidationDetailsResultEnum

func GetMappingApiValidationDetailsResultEnum 

func GetMappingApiValidationDetailsResultEnum(val string) (ApiValidationDetailsResultEnum, bool)

GetMappingApiValidationDetailsResultEnum performs case Insensitive comparison on enum value and return the desired enum

type ApiValidationResult 

type ApiValidationResult struct {

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

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

ApiValidationResult The result of single validation.

func (ApiValidationResult) String 

func (m ApiValidationResult) String() string

func (ApiValidationResult) ValidateEnumValue 

func (m ApiValidationResult) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ApiValidationResultResultEnum 

type ApiValidationResultResultEnum string

ApiValidationResultResultEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ApiValidationResultResultEnum

func GetApiValidationResultResultEnumValues 

func GetApiValidationResultResultEnumValues() []ApiValidationResultResultEnum

GetApiValidationResultResultEnumValues Enumerates the set of values for ApiValidationResultResultEnum

func GetMappingApiValidationResultResultEnum 

func GetMappingApiValidationResultResultEnum(val string) (ApiValidationResultResultEnum, bool)

GetMappingApiValidationResultResultEnum performs case Insensitive comparison on enum value and return the desired enum

type ApiValidations 

type ApiValidations struct {

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

ApiValidations The result of validations conducted on the API.

func (ApiValidations) String 

func (m ApiValidations) String() string

func (ApiValidations) ValidateEnumValue 

func (m ApiValidations) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type AuthenticationOnlyRouteAuthorizationPolicy 

type AuthenticationOnlyRouteAuthorizationPolicy struct {
}

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

func (AuthenticationOnlyRouteAuthorizationPolicy) MarshalJSON 

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

MarshalJSON marshals to json representation

func (AuthenticationOnlyRouteAuthorizationPolicy) String 

func (m AuthenticationOnlyRouteAuthorizationPolicy) String() string

func (AuthenticationOnlyRouteAuthorizationPolicy) ValidateEnumValue 

func (m AuthenticationOnlyRouteAuthorizationPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type AuthenticationPolicy 

type AuthenticationPolicy interface {

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

AuthenticationPolicy Information on how to authenticate incoming requests.

type AuthenticationPolicyTypeEnum 

type AuthenticationPolicyTypeEnum string

AuthenticationPolicyTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for AuthenticationPolicyTypeEnum

func GetAuthenticationPolicyTypeEnumValues 

func GetAuthenticationPolicyTypeEnumValues() []AuthenticationPolicyTypeEnum

GetAuthenticationPolicyTypeEnumValues Enumerates the set of values for AuthenticationPolicyTypeEnum

func GetMappingAuthenticationPolicyTypeEnum 

func GetMappingAuthenticationPolicyTypeEnum(val string) (AuthenticationPolicyTypeEnum, bool)

GetMappingAuthenticationPolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type AuthenticationServerPolicy added in v65.20.0 

type AuthenticationServerPolicy struct {
	Key DynamicSelectionKey `mandatory:"true" json:"key"`

	AuthenticationServerDetail AuthenticationPolicy `mandatory:"true" json:"authenticationServerDetail"`
}

AuthenticationServerPolicy Policy for the details regarding each authentication server under dynamic authentication. We specify the value of selectors for which this authentication server must be selected for a request under keys. We specify the configuration details of authentication server under authenticationServerDetail.

func (AuthenticationServerPolicy) String added in v65.20.0 

func (m AuthenticationServerPolicy) String() string

func (*AuthenticationServerPolicy) UnmarshalJSON added in v65.20.0 

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

UnmarshalJSON unmarshals from json

func (AuthenticationServerPolicy) ValidateEnumValue added in v65.20.0 

func (m AuthenticationServerPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BodyValidationRequestPolicy 

type BodyValidationRequestPolicy struct {

	// The content of the request body. The key is a media type range (https://tools.ietf.org/html/rfc7231#appendix-D)
	// subset restricted to the following schema
	//     key ::= (
	//           / (  "*" "/" "*" )
	//           / ( type "/" "*" )
	//           / ( type "/" subtype )
	//           )
	// For requests that match multiple keys, only the most specific key is applicable.
	// e.g. `text/plain` overrides `text/*`
	Content map[string]ContentValidation `mandatory:"true" json:"content"`

	// Validation behavior mode.
	// In `ENFORCING` mode, upon a validation failure, the request will be rejected with a 4xx response
	// and not sent to the backend.
	// In `PERMISSIVE` mode, the result of the validation will be exposed as metrics while the request
	// will follow the normal path.
	// `DISABLED` type turns the validation off.
	ValidationMode BodyValidationRequestPolicyValidationModeEnum `mandatory:"false" json:"validationMode,omitempty"`

	// Determines if the request body is required in the request.
	Required *bool `mandatory:"false" json:"required"`
}

BodyValidationRequestPolicy Validate the payload body of the incoming API requests on a specific route.

func (BodyValidationRequestPolicy) String 

func (m BodyValidationRequestPolicy) String() string

func (*BodyValidationRequestPolicy) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (BodyValidationRequestPolicy) ValidateEnumValue 

func (m BodyValidationRequestPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BodyValidationRequestPolicyValidationModeEnum 

type BodyValidationRequestPolicyValidationModeEnum string

BodyValidationRequestPolicyValidationModeEnum Enum with underlying type: string 

const (
	BodyValidationRequestPolicyValidationModeEnforcing  BodyValidationRequestPolicyValidationModeEnum = "ENFORCING"
	BodyValidationRequestPolicyValidationModePermissive BodyValidationRequestPolicyValidationModeEnum = "PERMISSIVE"
	BodyValidationRequestPolicyValidationModeDisabled   BodyValidationRequestPolicyValidationModeEnum = "DISABLED"
)

Set of constants representing the allowable values for BodyValidationRequestPolicyValidationModeEnum

func GetBodyValidationRequestPolicyValidationModeEnumValues 

func GetBodyValidationRequestPolicyValidationModeEnumValues() []BodyValidationRequestPolicyValidationModeEnum

GetBodyValidationRequestPolicyValidationModeEnumValues Enumerates the set of values for BodyValidationRequestPolicyValidationModeEnum

func GetMappingBodyValidationRequestPolicyValidationModeEnum 

func GetMappingBodyValidationRequestPolicyValidationModeEnum(val string) (BodyValidationRequestPolicyValidationModeEnum, bool)

GetMappingBodyValidationRequestPolicyValidationModeEnum performs case Insensitive comparison on enum value and return the desired enum

type CaBundle 

type CaBundle interface {
}

CaBundle Reference to the CA bundle that should be used on the gateway

type CaBundleTypeEnum 

type CaBundleTypeEnum string

CaBundleTypeEnum Enum with underlying type: string 

const (
	CaBundleTypeCaBundle             CaBundleTypeEnum = "CA_BUNDLE"
	CaBundleTypeCertificateAuthority CaBundleTypeEnum = "CERTIFICATE_AUTHORITY"
)

Set of constants representing the allowable values for CaBundleTypeEnum

func GetCaBundleTypeEnumValues 

func GetCaBundleTypeEnumValues() []CaBundleTypeEnum

GetCaBundleTypeEnumValues Enumerates the set of values for CaBundleTypeEnum

func GetMappingCaBundleTypeEnum 

func GetMappingCaBundleTypeEnum(val string) (CaBundleTypeEnum, bool)

GetMappingCaBundleTypeEnum performs case Insensitive comparison on enum value and return the desired enum

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

CancelWorkRequestRequest wrapper for the CancelWorkRequest operation

See also

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

func (CancelWorkRequestRequest) BinaryRequestBody 

func (request CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CancelWorkRequestRequest) HTTPRequest 

func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (CancelWorkRequestRequest) ValidateEnumValue 

func (request CancelWorkRequestRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CancelWorkRequestResponse 

type CancelWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

CancelWorkRequestResponse wrapper for the CancelWorkRequest operation

func (CancelWorkRequestResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CancelWorkRequestResponse) String 

func (response CancelWorkRequestResponse) String() string

type Certificate 

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

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

func (Certificate) String 

func (m Certificate) String() string

func (Certificate) ValidateEnumValue 

func (m Certificate) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CertificateCollection 

type CertificateCollection struct {

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

CertificateCollection Collection of certificate summaries.

func (CertificateCollection) String 

func (m CertificateCollection) String() string

func (CertificateCollection) ValidateEnumValue 

func (m CertificateCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CertificateLifecycleStateEnum 

type CertificateLifecycleStateEnum string

CertificateLifecycleStateEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for CertificateLifecycleStateEnum

func GetCertificateLifecycleStateEnumValues 

func GetCertificateLifecycleStateEnumValues() []CertificateLifecycleStateEnum

GetCertificateLifecycleStateEnumValues Enumerates the set of values for CertificateLifecycleStateEnum

func GetMappingCertificateLifecycleStateEnum 

func GetMappingCertificateLifecycleStateEnum(val string) (CertificateLifecycleStateEnum, bool)

GetMappingCertificateLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type CertificateSummary 

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

CertificateSummary A summary of the certificate.

func (CertificateSummary) String 

func (m CertificateSummary) String() string

func (CertificateSummary) ValidateEnumValue 

func (m CertificateSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CertificatesCaBundle 

type CertificatesCaBundle struct {

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

CertificatesCaBundle CA bundle from Certificates Service that should be used on the gateway for TLS validation

func (CertificatesCaBundle) MarshalJSON 

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

MarshalJSON marshals to json representation

func (CertificatesCaBundle) String 

func (m CertificatesCaBundle) String() string

func (CertificatesCaBundle) ValidateEnumValue 

func (m CertificatesCaBundle) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CertificatesCertificateAuthority 

type CertificatesCertificateAuthority struct {

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

CertificatesCertificateAuthority Certificate Authority from Certificates Service that should be used on the gateway for TLS validation

func (CertificatesCertificateAuthority) MarshalJSON 

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

MarshalJSON marshals to json representation

func (CertificatesCertificateAuthority) String 

func (m CertificatesCertificateAuthority) String() string

func (CertificatesCertificateAuthority) ValidateEnumValue 

func (m CertificatesCertificateAuthority) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeApiCompartmentDetails 

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

ChangeApiCompartmentDetails The new compartment details for the API.

func (ChangeApiCompartmentDetails) String 

func (m ChangeApiCompartmentDetails) String() string

func (ChangeApiCompartmentDetails) ValidateEnumValue 

func (m ChangeApiCompartmentDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

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

ChangeApiCompartmentRequest wrapper for the ChangeApiCompartment operation

See also

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

func (ChangeApiCompartmentRequest) BinaryRequestBody 

func (request ChangeApiCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeApiCompartmentRequest) HTTPRequest 

func (request ChangeApiCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (ChangeApiCompartmentRequest) ValidateEnumValue 

func (request ChangeApiCompartmentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeApiCompartmentResponse 

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

ChangeApiCompartmentResponse wrapper for the ChangeApiCompartment operation

func (ChangeApiCompartmentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ChangeApiCompartmentResponse) String 

func (response ChangeApiCompartmentResponse) String() string

type ChangeCertificateCompartmentDetails 

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

ChangeCertificateCompartmentDetails The new compartment details for the certificate.

func (ChangeCertificateCompartmentDetails) String 

func (m ChangeCertificateCompartmentDetails) String() string

func (ChangeCertificateCompartmentDetails) ValidateEnumValue 

func (m ChangeCertificateCompartmentDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

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

ChangeCertificateCompartmentRequest wrapper for the ChangeCertificateCompartment operation

See also

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

func (ChangeCertificateCompartmentRequest) BinaryRequestBody 

func (request ChangeCertificateCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeCertificateCompartmentRequest) HTTPRequest 

func (request ChangeCertificateCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (ChangeCertificateCompartmentRequest) ValidateEnumValue 

func (request ChangeCertificateCompartmentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeCertificateCompartmentResponse 

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

ChangeCertificateCompartmentResponse wrapper for the ChangeCertificateCompartment operation

func (ChangeCertificateCompartmentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ChangeCertificateCompartmentResponse) String 

func (response ChangeCertificateCompartmentResponse) String() string

type ChangeDeploymentCompartmentDetails 

type ChangeDeploymentCompartmentDetails struct {

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

ChangeDeploymentCompartmentDetails The new compartment details for the deployment.

func (ChangeDeploymentCompartmentDetails) String 

func (m ChangeDeploymentCompartmentDetails) String() string

func (ChangeDeploymentCompartmentDetails) ValidateEnumValue 

func (m ChangeDeploymentCompartmentDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

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

ChangeDeploymentCompartmentRequest wrapper for the ChangeDeploymentCompartment operation

See also

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

func (ChangeDeploymentCompartmentRequest) BinaryRequestBody 

func (request ChangeDeploymentCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeDeploymentCompartmentRequest) HTTPRequest 

func (request ChangeDeploymentCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (ChangeDeploymentCompartmentRequest) ValidateEnumValue 

func (request ChangeDeploymentCompartmentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeDeploymentCompartmentResponse 

type ChangeDeploymentCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

ChangeDeploymentCompartmentResponse wrapper for the ChangeDeploymentCompartment operation

func (ChangeDeploymentCompartmentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ChangeDeploymentCompartmentResponse) String 

func (response ChangeDeploymentCompartmentResponse) String() string

type ChangeGatewayCompartmentDetails 

type ChangeGatewayCompartmentDetails struct {

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

ChangeGatewayCompartmentDetails The new compartment details for the gateway.

func (ChangeGatewayCompartmentDetails) String 

func (m ChangeGatewayCompartmentDetails) String() string

func (ChangeGatewayCompartmentDetails) ValidateEnumValue 

func (m ChangeGatewayCompartmentDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

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

ChangeGatewayCompartmentRequest wrapper for the ChangeGatewayCompartment operation

See also

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

func (ChangeGatewayCompartmentRequest) BinaryRequestBody 

func (request ChangeGatewayCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeGatewayCompartmentRequest) HTTPRequest 

func (request ChangeGatewayCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (ChangeGatewayCompartmentRequest) ValidateEnumValue 

func (request ChangeGatewayCompartmentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeGatewayCompartmentResponse 

type ChangeGatewayCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

ChangeGatewayCompartmentResponse wrapper for the ChangeGatewayCompartment operation

func (ChangeGatewayCompartmentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ChangeGatewayCompartmentResponse) String 

func (response ChangeGatewayCompartmentResponse) String() string

type ChangeSubscriberCompartmentDetails added in v65.7.0 

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

ChangeSubscriberCompartmentDetails The new compartment details for the subscriber.

func (ChangeSubscriberCompartmentDetails) String added in v65.7.0 

func (m ChangeSubscriberCompartmentDetails) String() string

func (ChangeSubscriberCompartmentDetails) ValidateEnumValue added in v65.7.0 

func (m ChangeSubscriberCompartmentDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeSubscriberCompartmentRequest added in v65.7.0 

type ChangeSubscriberCompartmentRequest struct {

	// The ocid of the subscriber.
	SubscriberId *string `mandatory:"true" contributesTo:"path" name:"subscriberId"`

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

ChangeSubscriberCompartmentRequest wrapper for the ChangeSubscriberCompartment operation

See also

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

func (ChangeSubscriberCompartmentRequest) BinaryRequestBody added in v65.7.0 

func (request ChangeSubscriberCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeSubscriberCompartmentRequest) HTTPRequest added in v65.7.0 

func (request ChangeSubscriberCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeSubscriberCompartmentRequest) RetryPolicy added in v65.7.0 

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

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

func (ChangeSubscriberCompartmentRequest) String added in v65.7.0 

func (request ChangeSubscriberCompartmentRequest) String() string

func (ChangeSubscriberCompartmentRequest) ValidateEnumValue added in v65.7.0 

func (request ChangeSubscriberCompartmentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeSubscriberCompartmentResponse added in v65.7.0 

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

ChangeSubscriberCompartmentResponse wrapper for the ChangeSubscriberCompartment operation

func (ChangeSubscriberCompartmentResponse) HTTPResponse added in v65.7.0 

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

HTTPResponse implements the OCIResponse interface

func (ChangeSubscriberCompartmentResponse) String added in v65.7.0 

func (response ChangeSubscriberCompartmentResponse) String() string

type ChangeUsagePlanCompartmentDetails added in v65.7.0 

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

ChangeUsagePlanCompartmentDetails The new compartment details for the usage plan.

func (ChangeUsagePlanCompartmentDetails) String added in v65.7.0 

func (m ChangeUsagePlanCompartmentDetails) String() string

func (ChangeUsagePlanCompartmentDetails) ValidateEnumValue added in v65.7.0 

func (m ChangeUsagePlanCompartmentDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeUsagePlanCompartmentRequest added in v65.7.0 

type ChangeUsagePlanCompartmentRequest struct {

	// The ocid of the usage plan.
	UsagePlanId *string `mandatory:"true" contributesTo:"path" name:"usagePlanId"`

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

ChangeUsagePlanCompartmentRequest wrapper for the ChangeUsagePlanCompartment operation

See also

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

func (ChangeUsagePlanCompartmentRequest) BinaryRequestBody added in v65.7.0 

func (request ChangeUsagePlanCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeUsagePlanCompartmentRequest) HTTPRequest added in v65.7.0 

func (request ChangeUsagePlanCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeUsagePlanCompartmentRequest) RetryPolicy added in v65.7.0 

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

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

func (ChangeUsagePlanCompartmentRequest) String added in v65.7.0 

func (request ChangeUsagePlanCompartmentRequest) String() string

func (ChangeUsagePlanCompartmentRequest) ValidateEnumValue added in v65.7.0 

func (request ChangeUsagePlanCompartmentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeUsagePlanCompartmentResponse added in v65.7.0 

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

ChangeUsagePlanCompartmentResponse wrapper for the ChangeUsagePlanCompartment operation

func (ChangeUsagePlanCompartmentResponse) HTTPResponse added in v65.7.0 

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

HTTPResponse implements the OCIResponse interface

func (ChangeUsagePlanCompartmentResponse) String added in v65.7.0 

func (response ChangeUsagePlanCompartmentResponse) String() string

type Client added in v65.7.0 

type Client struct {

	// The name of the client. Must be unique within a subscriber.
	Name *string `mandatory:"true" json:"name"`

	// The token for the client. Must be unique within a tenancy.
	Token *string `mandatory:"true" json:"token"`
}

Client A Client.

func (Client) String added in v65.7.0 

func (m Client) String() string

func (Client) ValidateEnumValue added in v65.7.0 

func (m Client) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ClientAppDetails added in v65.27.0 

type ClientAppDetails interface {
}

ClientAppDetails Client App Credential details.

type ClientAppDetailsTypeEnum added in v65.27.0 

type ClientAppDetailsTypeEnum string

ClientAppDetailsTypeEnum Enum with underlying type: string 

const (
	ClientAppDetailsTypeValidationBlock ClientAppDetailsTypeEnum = "VALIDATION_BLOCK"
	ClientAppDetailsTypeCustom          ClientAppDetailsTypeEnum = "CUSTOM"
)

Set of constants representing the allowable values for ClientAppDetailsTypeEnum

func GetClientAppDetailsTypeEnumValues added in v65.27.0 

func GetClientAppDetailsTypeEnumValues() []ClientAppDetailsTypeEnum

GetClientAppDetailsTypeEnumValues Enumerates the set of values for ClientAppDetailsTypeEnum

func GetMappingClientAppDetailsTypeEnum added in v65.27.0 

func GetMappingClientAppDetailsTypeEnum(val string) (ClientAppDetailsTypeEnum, bool)

GetMappingClientAppDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ClientSummary added in v65.7.0 

type ClientSummary struct {

	// The client name.
	Name *string `mandatory:"true" json:"name"`
}

ClientSummary A summary of a client.

func (ClientSummary) String added in v65.7.0 

func (m ClientSummary) String() string

func (ClientSummary) ValidateEnumValue added in v65.7.0 

func (m ClientSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ContentValidation 

type ContentValidation interface {
}

ContentValidation Content validation properties.

type ContentValidationValidationTypeEnum 

type ContentValidationValidationTypeEnum string

ContentValidationValidationTypeEnum Enum with underlying type: string 

const (
	ContentValidationValidationTypeNone ContentValidationValidationTypeEnum = "NONE"
)

Set of constants representing the allowable values for ContentValidationValidationTypeEnum

func GetContentValidationValidationTypeEnumValues 

func GetContentValidationValidationTypeEnumValues() []ContentValidationValidationTypeEnum

GetContentValidationValidationTypeEnumValues Enumerates the set of values for ContentValidationValidationTypeEnum

func GetMappingContentValidationValidationTypeEnum 

func GetMappingContentValidationValidationTypeEnum(val string) (ContentValidationValidationTypeEnum, bool)

GetMappingContentValidationValidationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type CorsPolicy 

type CorsPolicy struct {

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

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

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

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

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

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

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

func (CorsPolicy) String 

func (m CorsPolicy) String() string

func (CorsPolicy) ValidateEnumValue 

func (m CorsPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateApiDetails 

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

CreateApiDetails Information about the new API.

func (CreateApiDetails) String 

func (m CreateApiDetails) String() string

func (CreateApiDetails) ValidateEnumValue 

func (m CreateApiDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

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

CreateApiRequest wrapper for the CreateApi operation

See also

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

func (CreateApiRequest) BinaryRequestBody 

func (request CreateApiRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateApiRequest) HTTPRequest 

func (request CreateApiRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (CreateApiRequest) ValidateEnumValue 

func (request CreateApiRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateApiResponse 

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

CreateApiResponse wrapper for the CreateApi operation

func (CreateApiResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateApiResponse) String 

func (response CreateApiResponse) String() string

type CreateCertificateDetails 

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

CreateCertificateDetails Information about a new certificate.

func (CreateCertificateDetails) String 

func (m CreateCertificateDetails) String() string

func (CreateCertificateDetails) ValidateEnumValue 

func (m CreateCertificateDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

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

CreateCertificateRequest wrapper for the CreateCertificate operation

See also

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

func (CreateCertificateRequest) BinaryRequestBody 

func (request CreateCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateCertificateRequest) HTTPRequest 

func (request CreateCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (CreateCertificateRequest) ValidateEnumValue 

func (request CreateCertificateRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateCertificateResponse 

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

CreateCertificateResponse wrapper for the CreateCertificate operation

func (CreateCertificateResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateCertificateResponse) String 

func (response CreateCertificateResponse) String() string

type CreateDeploymentDetails 

type CreateDeploymentDetails struct {

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

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

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

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

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

	// Free-form tags for this resource. Each tag is a simple key-value pair
	// with no predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a
	// namespace. For more information, see
	// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateDeploymentDetails Information about a new deployment.

func (CreateDeploymentDetails) String 

func (m CreateDeploymentDetails) String() string

func (CreateDeploymentDetails) ValidateEnumValue 

func (m CreateDeploymentDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

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

CreateDeploymentRequest wrapper for the CreateDeployment operation

See also

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

func (CreateDeploymentRequest) BinaryRequestBody 

func (request CreateDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateDeploymentRequest) HTTPRequest 

func (request CreateDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (CreateDeploymentRequest) ValidateEnumValue 

func (request CreateDeploymentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateDeploymentResponse 

type CreateDeploymentResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

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

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

CreateDeploymentResponse wrapper for the CreateDeployment operation

func (CreateDeploymentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateDeploymentResponse) String 

func (response CreateDeploymentResponse) String() string

type CreateGatewayDetails 

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

	// An array of Network Security Groups OCIDs associated with this API Gateway.
	NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`

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

	ResponseCacheDetails ResponseCacheDetails `mandatory:"false" json:"responseCacheDetails"`

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

	// An array of CA bundles that should be used on the Gateway for TLS validation.
	CaBundles []CaBundle `mandatory:"false" json:"caBundles"`
}

CreateGatewayDetails Information about the new gateway.

func (CreateGatewayDetails) String 

func (m CreateGatewayDetails) String() string

func (*CreateGatewayDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (CreateGatewayDetails) ValidateEnumValue 

func (m CreateGatewayDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

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

CreateGatewayRequest wrapper for the CreateGateway operation

See also

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

func (CreateGatewayRequest) BinaryRequestBody 

func (request CreateGatewayRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateGatewayRequest) HTTPRequest 

func (request CreateGatewayRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (CreateGatewayRequest) ValidateEnumValue 

func (request CreateGatewayRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateGatewayResponse 

type CreateGatewayResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

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

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

CreateGatewayResponse wrapper for the CreateGateway operation

func (CreateGatewayResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateGatewayResponse) String 

func (response CreateGatewayResponse) String() string

type CreateSdkDetails 

type CreateSdkDetails struct {

	// The string representing the target programming language for generating the SDK.
	TargetLanguage *string `mandatory:"true" json:"targetLanguage"`

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

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

	// Additional optional configurations that can be passed to generate SDK Api.
	// The applicable parameters are listed under "parameters" when "/sdkLanguageTypes" is called.
	// Example: `{"configName": "configValue"}`
	Parameters map[string]string `mandatory:"false" json:"parameters"`
}

CreateSdkDetails Information about the new SDK.

func (CreateSdkDetails) String 

func (m CreateSdkDetails) String() string

func (CreateSdkDetails) ValidateEnumValue 

func (m CreateSdkDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateSdkRequest 

type CreateSdkRequest struct {

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

CreateSdkRequest wrapper for the CreateSdk operation

See also

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

func (CreateSdkRequest) BinaryRequestBody 

func (request CreateSdkRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateSdkRequest) HTTPRequest 

func (request CreateSdkRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateSdkRequest) RetryPolicy 

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

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

func (CreateSdkRequest) String 

func (request CreateSdkRequest) String() string

func (CreateSdkRequest) ValidateEnumValue 

func (request CreateSdkRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateSdkResponse 

type CreateSdkResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

CreateSdkResponse wrapper for the CreateSdk operation

func (CreateSdkResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateSdkResponse) String 

func (response CreateSdkResponse) String() string

type CreateSubscriberDetails added in v65.7.0 

type CreateSubscriberDetails 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 clients belonging to this subscriber.
	Clients []Client `mandatory:"true" json:"clients"`

	// An array of OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)s of usage
	// plan resources.
	UsagePlans []string `mandatory:"true" json:"usagePlans"`

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

CreateSubscriberDetails Information about a new subscriber.

func (CreateSubscriberDetails) String added in v65.7.0 

func (m CreateSubscriberDetails) String() string

func (CreateSubscriberDetails) ValidateEnumValue added in v65.7.0 

func (m CreateSubscriberDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateSubscriberRequest added in v65.7.0 

type CreateSubscriberRequest struct {

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

CreateSubscriberRequest wrapper for the CreateSubscriber operation

See also

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

func (CreateSubscriberRequest) BinaryRequestBody added in v65.7.0 

func (request CreateSubscriberRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateSubscriberRequest) HTTPRequest added in v65.7.0 

func (request CreateSubscriberRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateSubscriberRequest) RetryPolicy added in v65.7.0 

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

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

func (CreateSubscriberRequest) String added in v65.7.0 

func (request CreateSubscriberRequest) String() string

func (CreateSubscriberRequest) ValidateEnumValue added in v65.7.0 

func (request CreateSubscriberRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateSubscriberResponse added in v65.7.0 

type CreateSubscriberResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

CreateSubscriberResponse wrapper for the CreateSubscriber operation

func (CreateSubscriberResponse) HTTPResponse added in v65.7.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateSubscriberResponse) String added in v65.7.0 

func (response CreateSubscriberResponse) String() string

type CreateUsagePlanDetails added in v65.7.0 

type CreateUsagePlanDetails struct {

	// A collection of entitlements to assign to the newly created usage plan.
	Entitlements []Entitlement `mandatory:"true" json:"entitlements"`

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

CreateUsagePlanDetails Information about a new usage plan.

func (CreateUsagePlanDetails) String added in v65.7.0 

func (m CreateUsagePlanDetails) String() string

func (CreateUsagePlanDetails) ValidateEnumValue added in v65.7.0 

func (m CreateUsagePlanDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateUsagePlanRequest added in v65.7.0 

type CreateUsagePlanRequest struct {

	// Details for the new usage plan.
	CreateUsagePlanDetails `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
}

CreateUsagePlanRequest wrapper for the CreateUsagePlan operation

See also

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

func (CreateUsagePlanRequest) BinaryRequestBody added in v65.7.0 

func (request CreateUsagePlanRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateUsagePlanRequest) HTTPRequest added in v65.7.0 

func (request CreateUsagePlanRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateUsagePlanRequest) RetryPolicy added in v65.7.0 

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

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

func (CreateUsagePlanRequest) String added in v65.7.0 

func (request CreateUsagePlanRequest) String() string

func (CreateUsagePlanRequest) ValidateEnumValue added in v65.7.0 

func (request CreateUsagePlanRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateUsagePlanResponse added in v65.7.0 

type CreateUsagePlanResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

CreateUsagePlanResponse wrapper for the CreateUsagePlan operation

func (CreateUsagePlanResponse) HTTPResponse added in v65.7.0 

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

HTTPResponse implements the OCIResponse interface

func (CreateUsagePlanResponse) String added in v65.7.0 

func (response CreateUsagePlanResponse) String() string

type CustomAuthenticationPolicy 

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

	// A map where key is a user defined string and value is a context expressions whose values will be sent to the custom auth function. Values should contain an expression.
	// Example: `{"foo": "request.header[abc]"}`
	Parameters map[string]string `mandatory:"false" json:"parameters"`

	// A list of keys from "parameters" attribute value whose values will be added to the cache key.
	CacheKey []string `mandatory:"false" json:"cacheKey"`

	ValidationFailurePolicy ValidationFailurePolicy `mandatory:"false" json:"validationFailurePolicy"`
}

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

func (CustomAuthenticationPolicy) GetIsAnonymousAccessAllowed 

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

func (*CustomAuthenticationPolicy) UnmarshalJSON added in v65.20.0 

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

UnmarshalJSON unmarshals from json

func (CustomAuthenticationPolicy) ValidateEnumValue 

func (m CustomAuthenticationPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CustomClientAppDetails added in v65.27.0 

type CustomClientAppDetails struct {

	// Client ID for the OAuth2/OIDC app.
	ClientId *string `mandatory:"true" json:"clientId"`

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.
	ClientSecretId *string `mandatory:"true" json:"clientSecretId"`

	// The version number of the client secret to use.
	ClientSecretVersionNumber *int64 `mandatory:"true" json:"clientSecretVersionNumber"`
}

CustomClientAppDetails Client App Credentials to be provided again.

func (CustomClientAppDetails) MarshalJSON added in v65.27.0 

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

MarshalJSON marshals to json representation

func (CustomClientAppDetails) String added in v65.27.0 

func (m CustomClientAppDetails) String() string

func (CustomClientAppDetails) ValidateEnumValue added in v65.27.0 

func (m CustomClientAppDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

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

DeleteApiRequest wrapper for the DeleteApi operation

See also

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

func (DeleteApiRequest) BinaryRequestBody 

func (request DeleteApiRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteApiRequest) HTTPRequest 

func (request DeleteApiRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (DeleteApiRequest) ValidateEnumValue 

func (request DeleteApiRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteApiResponse 

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

DeleteApiResponse wrapper for the DeleteApi operation

func (DeleteApiResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteApiResponse) String 

func (response DeleteApiResponse) String() string

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

DeleteCertificateRequest wrapper for the DeleteCertificate operation

See also

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

func (DeleteCertificateRequest) BinaryRequestBody 

func (request DeleteCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteCertificateRequest) HTTPRequest 

func (request DeleteCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (DeleteCertificateRequest) ValidateEnumValue 

func (request DeleteCertificateRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteCertificateResponse 

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

DeleteCertificateResponse wrapper for the DeleteCertificate operation

func (DeleteCertificateResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteCertificateResponse) String 

func (response DeleteCertificateResponse) String() string

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

DeleteDeploymentRequest wrapper for the DeleteDeployment operation

See also

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

func (DeleteDeploymentRequest) BinaryRequestBody 

func (request DeleteDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteDeploymentRequest) HTTPRequest 

func (request DeleteDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (DeleteDeploymentRequest) ValidateEnumValue 

func (request DeleteDeploymentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteDeploymentResponse 

type DeleteDeploymentResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

DeleteDeploymentResponse wrapper for the DeleteDeployment operation

func (DeleteDeploymentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteDeploymentResponse) String 

func (response DeleteDeploymentResponse) String() string

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

DeleteGatewayRequest wrapper for the DeleteGateway operation

See also

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

func (DeleteGatewayRequest) BinaryRequestBody 

func (request DeleteGatewayRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteGatewayRequest) HTTPRequest 

func (request DeleteGatewayRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (DeleteGatewayRequest) ValidateEnumValue 

func (request DeleteGatewayRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteGatewayResponse 

type DeleteGatewayResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

DeleteGatewayResponse wrapper for the DeleteGateway operation

func (DeleteGatewayResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteGatewayResponse) String 

func (response DeleteGatewayResponse) String() string

type DeleteSdkRequest 

type DeleteSdkRequest struct {

	// The ocid of the SDK.
	SdkId *string `mandatory:"true" contributesTo:"path" name:"sdkId"`

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

DeleteSdkRequest wrapper for the DeleteSdk operation

See also

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

func (DeleteSdkRequest) BinaryRequestBody 

func (request DeleteSdkRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteSdkRequest) HTTPRequest 

func (request DeleteSdkRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteSdkRequest) RetryPolicy 

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

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

func (DeleteSdkRequest) String 

func (request DeleteSdkRequest) String() string

func (DeleteSdkRequest) ValidateEnumValue 

func (request DeleteSdkRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteSdkResponse 

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

DeleteSdkResponse wrapper for the DeleteSdk operation

func (DeleteSdkResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteSdkResponse) String 

func (response DeleteSdkResponse) String() string

type DeleteSubscriberRequest added in v65.7.0 

type DeleteSubscriberRequest struct {

	// The ocid of the subscriber.
	SubscriberId *string `mandatory:"true" contributesTo:"path" name:"subscriberId"`

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

DeleteSubscriberRequest wrapper for the DeleteSubscriber operation

See also

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

func (DeleteSubscriberRequest) BinaryRequestBody added in v65.7.0 

func (request DeleteSubscriberRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteSubscriberRequest) HTTPRequest added in v65.7.0 

func (request DeleteSubscriberRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteSubscriberRequest) RetryPolicy added in v65.7.0 

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

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

func (DeleteSubscriberRequest) String added in v65.7.0 

func (request DeleteSubscriberRequest) String() string

func (DeleteSubscriberRequest) ValidateEnumValue added in v65.7.0 

func (request DeleteSubscriberRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteSubscriberResponse added in v65.7.0 

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

DeleteSubscriberResponse wrapper for the DeleteSubscriber operation

func (DeleteSubscriberResponse) HTTPResponse added in v65.7.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteSubscriberResponse) String added in v65.7.0 

func (response DeleteSubscriberResponse) String() string

type DeleteUsagePlanRequest added in v65.7.0 

type DeleteUsagePlanRequest struct {

	// The ocid of the usage plan.
	UsagePlanId *string `mandatory:"true" contributesTo:"path" name:"usagePlanId"`

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

DeleteUsagePlanRequest wrapper for the DeleteUsagePlan operation

See also

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

func (DeleteUsagePlanRequest) BinaryRequestBody added in v65.7.0 

func (request DeleteUsagePlanRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteUsagePlanRequest) HTTPRequest added in v65.7.0 

func (request DeleteUsagePlanRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteUsagePlanRequest) RetryPolicy added in v65.7.0 

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

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

func (DeleteUsagePlanRequest) String added in v65.7.0 

func (request DeleteUsagePlanRequest) String() string

func (DeleteUsagePlanRequest) ValidateEnumValue added in v65.7.0 

func (request DeleteUsagePlanRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteUsagePlanResponse added in v65.7.0 

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

DeleteUsagePlanResponse wrapper for the DeleteUsagePlan operation

func (DeleteUsagePlanResponse) HTTPResponse added in v65.7.0 

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

HTTPResponse implements the OCIResponse interface

func (DeleteUsagePlanResponse) String added in v65.7.0 

func (response DeleteUsagePlanResponse) String() string

type Deployment 

type Deployment struct {

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

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

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

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

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

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

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

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

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

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

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

	// Free-form tags for this resource. Each tag is a simple key-value pair
	// with no predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a
	// namespace. For more information, see
	// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

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

func (Deployment) String 

func (m Deployment) String() string

func (Deployment) ValidateEnumValue 

func (m Deployment) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeploymentClient 

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

DeploymentClient a client for Deployment

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/latest/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/latest/apigateway/CreateDeployment.go.html to see an example of how to use CreateDeployment API. A default retry strategy applies to this operation CreateDeployment()

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/latest/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/latest/apigateway/GetDeployment.go.html to see an example of how to use GetDeployment API. A default retry strategy applies to this operation GetDeployment()

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/latest/apigateway/ListDeployments.go.html to see an example of how to use ListDeployments API. A default retry strategy applies to this operation ListDeployments()

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/latest/apigateway/UpdateDeployment.go.html to see an example of how to use UpdateDeployment API.

type DeploymentCollection 

type DeploymentCollection struct {

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

DeploymentCollection Collection of deployment summaries.

func (DeploymentCollection) String 

func (m DeploymentCollection) String() string

func (DeploymentCollection) ValidateEnumValue 

func (m DeploymentCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeploymentLifecycleStateEnum 

type DeploymentLifecycleStateEnum string

DeploymentLifecycleStateEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for DeploymentLifecycleStateEnum

func GetDeploymentLifecycleStateEnumValues 

func GetDeploymentLifecycleStateEnumValues() []DeploymentLifecycleStateEnum

GetDeploymentLifecycleStateEnumValues Enumerates the set of values for DeploymentLifecycleStateEnum

func GetMappingDeploymentLifecycleStateEnum 

func GetMappingDeploymentLifecycleStateEnum(val string) (DeploymentLifecycleStateEnum, bool)

GetMappingDeploymentLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type DeploymentSummary 

type DeploymentSummary struct {

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

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

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

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

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

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

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

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

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

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

	// Free-form tags for this resource. Each tag is a simple key-value pair
	// with no predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a
	// namespace. For more information, see
	// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

DeploymentSummary A summary of the deployment.

func (DeploymentSummary) String 

func (m DeploymentSummary) String() string

func (DeploymentSummary) ValidateEnumValue 

func (m DeploymentSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DiscoveryUriSourceUriDetails added in v65.27.0 

type DiscoveryUriSourceUriDetails struct {

	// The discovery URI for the auth server.
	Uri *string `mandatory:"true" json:"uri"`
}

DiscoveryUriSourceUriDetails Discovery Uri information.

func (DiscoveryUriSourceUriDetails) MarshalJSON added in v65.27.0 

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

MarshalJSON marshals to json representation

func (DiscoveryUriSourceUriDetails) String added in v65.27.0 

func (m DiscoveryUriSourceUriDetails) String() string

func (DiscoveryUriSourceUriDetails) ValidateEnumValue added in v65.27.0 

func (m DiscoveryUriSourceUriDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DynamicAuthenticationPolicy added in v65.20.0 

type DynamicAuthenticationPolicy struct {
	SelectionSource SelectionSourcePolicy `mandatory:"true" json:"selectionSource"`

	// List of authentication servers to choose from during dynamic authentication.
	AuthenticationServers []AuthenticationServerPolicy `mandatory:"true" json:"authenticationServers"`
}

DynamicAuthenticationPolicy Policy on how to authenticate requests when multiple authentication options are configured for a deployment. For an incoming request, the value of selector specified under selectionSource will be matched against the keys specified for each authentication server. The authentication server whose key matches the value of selector will be used for authentication.

func (DynamicAuthenticationPolicy) String added in v65.20.0 

func (m DynamicAuthenticationPolicy) String() string

func (*DynamicAuthenticationPolicy) UnmarshalJSON added in v65.20.0 

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

UnmarshalJSON unmarshals from json

func (DynamicAuthenticationPolicy) ValidateEnumValue added in v65.20.0 

func (m DynamicAuthenticationPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DynamicRoutingBackend added in v65.20.0 

type DynamicRoutingBackend struct {
	SelectionSource SelectionSourcePolicy `mandatory:"true" json:"selectionSource"`

	// List of backends to chose from for Dynamic Routing.
	RoutingBackends []DynamicRoutingTypeRoutingBackend `mandatory:"true" json:"routingBackends"`
}

DynamicRoutingBackend Send the request to the backend dynamically selected based on the incoming request's context.

func (DynamicRoutingBackend) MarshalJSON added in v65.20.0 

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

MarshalJSON marshals to json representation

func (DynamicRoutingBackend) String added in v65.20.0 

func (m DynamicRoutingBackend) String() string

func (*DynamicRoutingBackend) UnmarshalJSON added in v65.20.0 

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

UnmarshalJSON unmarshals from json

func (DynamicRoutingBackend) ValidateEnumValue added in v65.20.0 

func (m DynamicRoutingBackend) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DynamicRoutingTypeRoutingBackend added in v65.20.0 

type DynamicRoutingTypeRoutingBackend struct {
	Key DynamicSelectionKey `mandatory:"true" json:"key"`

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

DynamicRoutingTypeRoutingBackend Policy for the details regarding each routing backend under dynamic routing. We specify the value of selectors for which this routing backend must be selected for a request under keys. We specify the configuration details of routing backend under backend.

func (DynamicRoutingTypeRoutingBackend) String added in v65.20.0 

func (m DynamicRoutingTypeRoutingBackend) String() string

func (*DynamicRoutingTypeRoutingBackend) UnmarshalJSON added in v65.20.0 

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

UnmarshalJSON unmarshals from json

func (DynamicRoutingTypeRoutingBackend) ValidateEnumValue added in v65.20.0 

func (m DynamicRoutingTypeRoutingBackend) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DynamicSelectionKey added in v65.20.0 

type DynamicSelectionKey interface {

	// Name assigned to the branch.
	GetName() *string

	// Specifies whether to use the route or authentication server associated with this selection key as the default. The default is used if the value of a context variable in an incoming request does not match any of the other selection key values when dynamically routing and dynamically authenticating requests.
	GetIsDefault() *bool
}

DynamicSelectionKey Base policy for defining how to match the context variable in an incoming request with selection keys when dynamically routing and dynamically authenticating requests.

type DynamicSelectionKeyTypeEnum added in v65.20.0 

type DynamicSelectionKeyTypeEnum string

DynamicSelectionKeyTypeEnum Enum with underlying type: string 

const (
	DynamicSelectionKeyTypeAnyOf    DynamicSelectionKeyTypeEnum = "ANY_OF"
	DynamicSelectionKeyTypeWildcard DynamicSelectionKeyTypeEnum = "WILDCARD"
)

Set of constants representing the allowable values for DynamicSelectionKeyTypeEnum

func GetDynamicSelectionKeyTypeEnumValues added in v65.20.0 

func GetDynamicSelectionKeyTypeEnumValues() []DynamicSelectionKeyTypeEnum

GetDynamicSelectionKeyTypeEnumValues Enumerates the set of values for DynamicSelectionKeyTypeEnum

func GetMappingDynamicSelectionKeyTypeEnum added in v65.20.0 

func GetMappingDynamicSelectionKeyTypeEnum(val string) (DynamicSelectionKeyTypeEnum, bool)

GetMappingDynamicSelectionKeyTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type Entitlement added in v65.7.0 

type Entitlement struct {

	// An entitlement name, unique within a usage plan.
	Name *string `mandatory:"true" json:"name"`

	// A user-friendly description. To provide some insight about the resource.
	// Avoid entering confidential information.
	Description *string `mandatory:"false" json:"description"`

	RateLimit *RateLimit `mandatory:"false" json:"rateLimit"`

	Quota *Quota `mandatory:"false" json:"quota"`

	// A collection of targeted deployments that the entitlement will be applied to.
	Targets []EntitlementTarget `mandatory:"false" json:"targets"`
}

Entitlement A usage plan entitlement, comprising of rate limits, quotas and the deployments they are applied to.

func (Entitlement) String added in v65.7.0 

func (m Entitlement) String() string

func (Entitlement) ValidateEnumValue added in v65.7.0 

func (m Entitlement) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type EntitlementSummary added in v65.7.0 

type EntitlementSummary struct {

	// An entitlement name, unique within a usage plan.
	Name *string `mandatory:"true" json:"name"`

	// A user-friendly description. To provide some insight about the resource.
	// Avoid entering confidential information.
	Description *string `mandatory:"false" json:"description"`

	RateLimit *RateLimit `mandatory:"false" json:"rateLimit"`

	Quota *Quota `mandatory:"false" json:"quota"`
}

EntitlementSummary A summary of an entitlement included in a usage plan.

func (EntitlementSummary) String added in v65.7.0 

func (m EntitlementSummary) String() string

func (EntitlementSummary) ValidateEnumValue added in v65.7.0 

func (m EntitlementSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type EntitlementTarget added in v65.7.0 

type EntitlementTarget struct {

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a deployment
	// resource.
	DeploymentId *string `mandatory:"true" json:"deploymentId"`
}

EntitlementTarget An entitlement target, describing which deployment the entitlement should be applied to.

func (EntitlementTarget) String added in v65.7.0 

func (m EntitlementTarget) String() string

func (EntitlementTarget) ValidateEnumValue added in v65.7.0 

func (m EntitlementTarget) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ExecutionLogPolicy 

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

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

func (ExecutionLogPolicy) String 

func (m ExecutionLogPolicy) String() string

func (ExecutionLogPolicy) ValidateEnumValue 

func (m ExecutionLogPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ExecutionLogPolicyLogLevelEnum 

type ExecutionLogPolicyLogLevelEnum string

ExecutionLogPolicyLogLevelEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ExecutionLogPolicyLogLevelEnum

func GetExecutionLogPolicyLogLevelEnumValues 

func GetExecutionLogPolicyLogLevelEnumValues() []ExecutionLogPolicyLogLevelEnum

GetExecutionLogPolicyLogLevelEnumValues Enumerates the set of values for ExecutionLogPolicyLogLevelEnum

func GetMappingExecutionLogPolicyLogLevelEnum 

func GetMappingExecutionLogPolicyLogLevelEnum(val string) (ExecutionLogPolicyLogLevelEnum, bool)

GetMappingExecutionLogPolicyLogLevelEnum performs case Insensitive comparison on enum value and return the desired enum

type ExternalRespCache 

type ExternalRespCache struct {

	// The set of cache store members to connect to. At present only a single server is supported.
	Servers []ResponseCacheRespServer `mandatory:"true" json:"servers"`

	// The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.
	AuthenticationSecretId *string `mandatory:"true" json:"authenticationSecretId"`

	// The version number of the authentication secret to use.
	AuthenticationSecretVersionNumber *int64 `mandatory:"true" json:"authenticationSecretVersionNumber"`

	// Defines if the connection should be over SSL.
	IsSslEnabled *bool `mandatory:"false" json:"isSslEnabled"`

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

	// Defines the timeout for establishing a connection with the Response Cache.
	ConnectTimeoutInMs *int `mandatory:"false" json:"connectTimeoutInMs"`

	// Defines the timeout for reading data from the Response Cache.
	ReadTimeoutInMs *int `mandatory:"false" json:"readTimeoutInMs"`

	// Defines the timeout for transmitting data to the Response Cache.
	SendTimeoutInMs *int `mandatory:"false" json:"sendTimeoutInMs"`
}

ExternalRespCache Connection details for an external RESP based cache store for Response Caching.

func (ExternalRespCache) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ExternalRespCache) String 

func (m ExternalRespCache) String() string

func (ExternalRespCache) ValidateEnumValue 

func (m ExternalRespCache) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type FilterHeaderPolicy 

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

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.

func (FilterHeaderPolicy) String 

func (m FilterHeaderPolicy) String() string

func (FilterHeaderPolicy) ValidateEnumValue 

func (m FilterHeaderPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type FilterHeaderPolicyItem 

type FilterHeaderPolicyItem struct {

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

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

func (FilterHeaderPolicyItem) String 

func (m FilterHeaderPolicyItem) String() string

func (FilterHeaderPolicyItem) ValidateEnumValue 

func (m FilterHeaderPolicyItem) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type FilterHeaderPolicyTypeEnum 

type FilterHeaderPolicyTypeEnum string

FilterHeaderPolicyTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for FilterHeaderPolicyTypeEnum

func GetFilterHeaderPolicyTypeEnumValues 

func GetFilterHeaderPolicyTypeEnumValues() []FilterHeaderPolicyTypeEnum

GetFilterHeaderPolicyTypeEnumValues Enumerates the set of values for FilterHeaderPolicyTypeEnum

func GetMappingFilterHeaderPolicyTypeEnum 

func GetMappingFilterHeaderPolicyTypeEnum(val string) (FilterHeaderPolicyTypeEnum, bool)

GetMappingFilterHeaderPolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type FilterQueryParameterPolicy 

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

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.

func (FilterQueryParameterPolicy) String 

func (m FilterQueryParameterPolicy) String() string

func (FilterQueryParameterPolicy) ValidateEnumValue 

func (m FilterQueryParameterPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type FilterQueryParameterPolicyItem 

type FilterQueryParameterPolicyItem struct {

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

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

func (FilterQueryParameterPolicyItem) String 

func (m FilterQueryParameterPolicyItem) String() string

func (FilterQueryParameterPolicyItem) ValidateEnumValue 

func (m FilterQueryParameterPolicyItem) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type FilterQueryParameterPolicyTypeEnum 

type FilterQueryParameterPolicyTypeEnum string

FilterQueryParameterPolicyTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for FilterQueryParameterPolicyTypeEnum

func GetFilterQueryParameterPolicyTypeEnumValues 

func GetFilterQueryParameterPolicyTypeEnumValues() []FilterQueryParameterPolicyTypeEnum

GetFilterQueryParameterPolicyTypeEnumValues Enumerates the set of values for FilterQueryParameterPolicyTypeEnum

func GetMappingFilterQueryParameterPolicyTypeEnum 

func GetMappingFilterQueryParameterPolicyTypeEnum(val string) (FilterQueryParameterPolicyTypeEnum, bool)

GetMappingFilterQueryParameterPolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type FixedTtlResponseCacheStorePolicy 

type FixedTtlResponseCacheStorePolicy struct {

	// Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.
	TimeToLiveInSeconds *int `mandatory:"true" json:"timeToLiveInSeconds"`
}

FixedTtlResponseCacheStorePolicy How a response from a backend is cached in the Response Cache.

func (FixedTtlResponseCacheStorePolicy) MarshalJSON 

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

MarshalJSON marshals to json representation

func (FixedTtlResponseCacheStorePolicy) String 

func (m FixedTtlResponseCacheStorePolicy) String() string

func (FixedTtlResponseCacheStorePolicy) ValidateEnumValue 

func (m FixedTtlResponseCacheStorePolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type Gateway 

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

	// An array of Network Security Groups OCIDs associated with this API Gateway.
	NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`

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

	ResponseCacheDetails ResponseCacheDetails `mandatory:"false" json:"responseCacheDetails"`

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

	// An array of CA bundles that should be used on the Gateway for TLS validation.
	CaBundles []CaBundle `mandatory:"false" json:"caBundles"`
}

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

func (Gateway) String 

func (m Gateway) String() string

func (*Gateway) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (Gateway) ValidateEnumValue 

func (m Gateway) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GatewayClient 

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

GatewayClient a client for Gateway

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/latest/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/latest/apigateway/CreateGateway.go.html to see an example of how to use CreateGateway API. A default retry strategy applies to this operation CreateGateway()

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/latest/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/latest/apigateway/GetGateway.go.html to see an example of how to use GetGateway API. A default retry strategy applies to this operation GetGateway()

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/latest/apigateway/ListGateways.go.html to see an example of how to use ListGateways API. A default retry strategy applies to this operation ListGateways()

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/latest/apigateway/UpdateGateway.go.html to see an example of how to use UpdateGateway API.

type GatewayCollection 

type GatewayCollection struct {

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

GatewayCollection Collection of gateway summaries.

func (GatewayCollection) String 

func (m GatewayCollection) String() string

func (GatewayCollection) ValidateEnumValue 

func (m GatewayCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GatewayEndpointTypeEnum 

type GatewayEndpointTypeEnum string

GatewayEndpointTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for GatewayEndpointTypeEnum

func GetGatewayEndpointTypeEnumValues 

func GetGatewayEndpointTypeEnumValues() []GatewayEndpointTypeEnum

GetGatewayEndpointTypeEnumValues Enumerates the set of values for GatewayEndpointTypeEnum

func GetMappingGatewayEndpointTypeEnum 

func GetMappingGatewayEndpointTypeEnum(val string) (GatewayEndpointTypeEnum, bool)

GetMappingGatewayEndpointTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type GatewayLifecycleStateEnum 

type GatewayLifecycleStateEnum string

GatewayLifecycleStateEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for GatewayLifecycleStateEnum

func GetGatewayLifecycleStateEnumValues 

func GetGatewayLifecycleStateEnumValues() []GatewayLifecycleStateEnum

GetGatewayLifecycleStateEnumValues Enumerates the set of values for GatewayLifecycleStateEnum

func GetMappingGatewayLifecycleStateEnum 

func GetMappingGatewayLifecycleStateEnum(val string) (GatewayLifecycleStateEnum, bool)

GetMappingGatewayLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type GatewaySummary 

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

	// An array of Network Security Groups OCIDs associated with this API Gateway.
	NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`

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

GatewaySummary A summary of the gateway.

func (GatewaySummary) String 

func (m GatewaySummary) String() string

func (GatewaySummary) ValidateEnumValue 

func (m GatewaySummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

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

	// The Range HTTP request header indicates the part of a document that the
	// server should return. RFC 7233 (https://tools.ietf.org/html/rfc7233#section-3.1).
	// Note that only a single range of bytes is supported.
	Range *string `mandatory:"false" contributesTo:"header" name:"range"`

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

GetApiContentRequest wrapper for the GetApiContent operation

See also

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

func (GetApiContentRequest) BinaryRequestBody 

func (request GetApiContentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetApiContentRequest) HTTPRequest 

func (request GetApiContentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (GetApiContentRequest) ValidateEnumValue 

func (request GetApiContentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetApiContentResponse 

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

GetApiContentResponse wrapper for the GetApiContent operation

func (GetApiContentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetApiContentResponse) String 

func (response GetApiContentResponse) String() string

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

GetApiDeploymentSpecificationRequest wrapper for the GetApiDeploymentSpecification operation

See also

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

func (GetApiDeploymentSpecificationRequest) BinaryRequestBody 

func (request GetApiDeploymentSpecificationRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetApiDeploymentSpecificationRequest) HTTPRequest 

func (request GetApiDeploymentSpecificationRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (GetApiDeploymentSpecificationRequest) ValidateEnumValue 

func (request GetApiDeploymentSpecificationRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetApiDeploymentSpecificationResponse 

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

GetApiDeploymentSpecificationResponse wrapper for the GetApiDeploymentSpecification operation

func (GetApiDeploymentSpecificationResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetApiDeploymentSpecificationResponse) String 

func (response GetApiDeploymentSpecificationResponse) String() string

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

GetApiRequest wrapper for the GetApi operation

See also

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

func (GetApiRequest) BinaryRequestBody 

func (request GetApiRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetApiRequest) HTTPRequest 

func (request GetApiRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (GetApiRequest) ValidateEnumValue 

func (request GetApiRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetApiResponse 

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

GetApiResponse wrapper for the GetApi operation

func (GetApiResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetApiResponse) String 

func (response GetApiResponse) String() string

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

GetApiValidationsRequest wrapper for the GetApiValidations operation

See also

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

func (GetApiValidationsRequest) BinaryRequestBody 

func (request GetApiValidationsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetApiValidationsRequest) HTTPRequest 

func (request GetApiValidationsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (GetApiValidationsRequest) ValidateEnumValue 

func (request GetApiValidationsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetApiValidationsResponse 

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

GetApiValidationsResponse wrapper for the GetApiValidations operation

func (GetApiValidationsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetApiValidationsResponse) String 

func (response GetApiValidationsResponse) String() string

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

GetCertificateRequest wrapper for the GetCertificate operation

See also

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

func (GetCertificateRequest) BinaryRequestBody 

func (request GetCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetCertificateRequest) HTTPRequest 

func (request GetCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (GetCertificateRequest) ValidateEnumValue 

func (request GetCertificateRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetCertificateResponse 

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

GetCertificateResponse wrapper for the GetCertificate operation

func (GetCertificateResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetCertificateResponse) String 

func (response GetCertificateResponse) String() string

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

GetDeploymentRequest wrapper for the GetDeployment operation

See also

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

func (GetDeploymentRequest) BinaryRequestBody 

func (request GetDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDeploymentRequest) HTTPRequest 

func (request GetDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (GetDeploymentRequest) ValidateEnumValue 

func (request GetDeploymentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetDeploymentResponse 

type GetDeploymentResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetDeploymentResponse wrapper for the GetDeployment operation

func (GetDeploymentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetDeploymentResponse) String 

func (response GetDeploymentResponse) String() string

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

GetGatewayRequest wrapper for the GetGateway operation

See also

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

func (GetGatewayRequest) BinaryRequestBody 

func (request GetGatewayRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetGatewayRequest) HTTPRequest 

func (request GetGatewayRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (GetGatewayRequest) ValidateEnumValue 

func (request GetGatewayRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetGatewayResponse 

type GetGatewayResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

GetGatewayResponse wrapper for the GetGateway operation

func (GetGatewayResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetGatewayResponse) String 

func (response GetGatewayResponse) String() string

type GetSdkRequest 

type GetSdkRequest struct {

	// The ocid of the SDK.
	SdkId *string `mandatory:"true" contributesTo:"path" name:"sdkId"`

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

GetSdkRequest wrapper for the GetSdk operation

See also

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

func (GetSdkRequest) BinaryRequestBody 

func (request GetSdkRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetSdkRequest) HTTPRequest 

func (request GetSdkRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetSdkRequest) RetryPolicy 

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

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

func (GetSdkRequest) String 

func (request GetSdkRequest) String() string

func (GetSdkRequest) ValidateEnumValue 

func (request GetSdkRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetSdkResponse 

type GetSdkResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

GetSdkResponse wrapper for the GetSdk operation

func (GetSdkResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetSdkResponse) String 

func (response GetSdkResponse) String() string

type GetSubscriberRequest added in v65.7.0 

type GetSubscriberRequest struct {

	// The ocid of the subscriber.
	SubscriberId *string `mandatory:"true" contributesTo:"path" name:"subscriberId"`

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

GetSubscriberRequest wrapper for the GetSubscriber operation

See also

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

func (GetSubscriberRequest) BinaryRequestBody added in v65.7.0 

func (request GetSubscriberRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetSubscriberRequest) HTTPRequest added in v65.7.0 

func (request GetSubscriberRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetSubscriberRequest) RetryPolicy added in v65.7.0 

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

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

func (GetSubscriberRequest) String added in v65.7.0 

func (request GetSubscriberRequest) String() string

func (GetSubscriberRequest) ValidateEnumValue added in v65.7.0 

func (request GetSubscriberRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetSubscriberResponse added in v65.7.0 

type GetSubscriberResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

GetSubscriberResponse wrapper for the GetSubscriber operation

func (GetSubscriberResponse) HTTPResponse added in v65.7.0 

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

HTTPResponse implements the OCIResponse interface

func (GetSubscriberResponse) String added in v65.7.0 

func (response GetSubscriberResponse) String() string

type GetUsagePlanRequest added in v65.7.0 

type GetUsagePlanRequest struct {

	// The ocid of the usage plan.
	UsagePlanId *string `mandatory:"true" contributesTo:"path" name:"usagePlanId"`

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

GetUsagePlanRequest wrapper for the GetUsagePlan operation

See also

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

func (GetUsagePlanRequest) BinaryRequestBody added in v65.7.0 

func (request GetUsagePlanRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetUsagePlanRequest) HTTPRequest added in v65.7.0 

func (request GetUsagePlanRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetUsagePlanRequest) RetryPolicy added in v65.7.0 

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

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

func (GetUsagePlanRequest) String added in v65.7.0 

func (request GetUsagePlanRequest) String() string

func (GetUsagePlanRequest) ValidateEnumValue added in v65.7.0 

func (request GetUsagePlanRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetUsagePlanResponse added in v65.7.0 

type GetUsagePlanResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

GetUsagePlanResponse wrapper for the GetUsagePlan operation

func (GetUsagePlanResponse) HTTPResponse added in v65.7.0 

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

HTTPResponse implements the OCIResponse interface

func (GetUsagePlanResponse) String added in v65.7.0 

func (response GetUsagePlanResponse) String() string

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

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

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

func (GetWorkRequestRequest) BinaryRequestBody 

func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest 

func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (GetWorkRequestRequest) ValidateEnumValue 

func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetWorkRequestResponse 

type GetWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

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

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String 

func (response GetWorkRequestResponse) String() string

type HeaderFieldSpecification 

type HeaderFieldSpecification struct {

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

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

HeaderFieldSpecification Header in key/value pair.

func (HeaderFieldSpecification) String 

func (m HeaderFieldSpecification) String() string

func (HeaderFieldSpecification) ValidateEnumValue 

func (m HeaderFieldSpecification) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type HeaderTransformationPolicy 

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

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

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

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

func (HeaderTransformationPolicy) String 

func (m HeaderTransformationPolicy) String() string

func (HeaderTransformationPolicy) ValidateEnumValue 

func (m HeaderTransformationPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type HeaderValidationItem 

type HeaderValidationItem struct {

	// Parameter name.
	Name *string `mandatory:"true" json:"name"`

	// Determines if the header is required in the request.
	Required *bool `mandatory:"false" json:"required"`
}

HeaderValidationItem Header validation properties.

func (HeaderValidationItem) String 

func (m HeaderValidationItem) String() string

func (HeaderValidationItem) ValidateEnumValue 

func (m HeaderValidationItem) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type HeaderValidationRequestPolicy 

type HeaderValidationRequestPolicy struct {

	// Validation behavior mode.
	// In `ENFORCING` mode, upon a validation failure, the request will be rejected with a 4xx response
	// and not sent to the backend.
	// In `PERMISSIVE` mode, the result of the validation will be exposed as metrics while the request
	// will follow the normal path.
	// `DISABLED` type turns the validation off.
	ValidationMode HeaderValidationRequestPolicyValidationModeEnum `mandatory:"false" json:"validationMode,omitempty"`

	Headers []HeaderValidationItem `mandatory:"false" json:"headers"`
}

HeaderValidationRequestPolicy Validate the HTTP headers on the incoming API requests on a specific route.

func (HeaderValidationRequestPolicy) String 

func (m HeaderValidationRequestPolicy) String() string

func (HeaderValidationRequestPolicy) ValidateEnumValue 

func (m HeaderValidationRequestPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type HeaderValidationRequestPolicyValidationModeEnum 

type HeaderValidationRequestPolicyValidationModeEnum string

HeaderValidationRequestPolicyValidationModeEnum Enum with underlying type: string 

const (
	HeaderValidationRequestPolicyValidationModeEnforcing  HeaderValidationRequestPolicyValidationModeEnum = "ENFORCING"
	HeaderValidationRequestPolicyValidationModePermissive HeaderValidationRequestPolicyValidationModeEnum = "PERMISSIVE"
	HeaderValidationRequestPolicyValidationModeDisabled   HeaderValidationRequestPolicyValidationModeEnum = "DISABLED"
)

Set of constants representing the allowable values for HeaderValidationRequestPolicyValidationModeEnum

func GetHeaderValidationRequestPolicyValidationModeEnumValues 

func GetHeaderValidationRequestPolicyValidationModeEnumValues() []HeaderValidationRequestPolicyValidationModeEnum

GetHeaderValidationRequestPolicyValidationModeEnumValues Enumerates the set of values for HeaderValidationRequestPolicyValidationModeEnum

func GetMappingHeaderValidationRequestPolicyValidationModeEnum 

func GetMappingHeaderValidationRequestPolicyValidationModeEnum(val string) (HeaderValidationRequestPolicyValidationModeEnum, bool)

GetMappingHeaderValidationRequestPolicyValidationModeEnum performs case Insensitive comparison on enum value and return the desired enum

type HttpBackend 

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

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

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

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

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

HttpBackend Send the request to an HTTP backend.

func (HttpBackend) MarshalJSON 

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

MarshalJSON marshals to json representation

func (HttpBackend) String 

func (m HttpBackend) String() string

func (HttpBackend) ValidateEnumValue 

func (m HttpBackend) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type IpAddress 

type IpAddress struct {

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

IpAddress IP address associated with the gateway.

func (IpAddress) String 

func (m IpAddress) String() string

func (IpAddress) ValidateEnumValue 

func (m IpAddress) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type JsonWebKey 

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

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

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

func (JsonWebKey) ValidateEnumValue 

func (m JsonWebKey) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type JsonWebKeyKeyOpsEnum 

type JsonWebKeyKeyOpsEnum string

JsonWebKeyKeyOpsEnum Enum with underlying type: string 

const (
	JsonWebKeyKeyOpsVerify JsonWebKeyKeyOpsEnum = "verify"
)

Set of constants representing the allowable values for JsonWebKeyKeyOpsEnum

func GetJsonWebKeyKeyOpsEnumValues 

func GetJsonWebKeyKeyOpsEnumValues() []JsonWebKeyKeyOpsEnum

GetJsonWebKeyKeyOpsEnumValues Enumerates the set of values for JsonWebKeyKeyOpsEnum

func GetMappingJsonWebKeyKeyOpsEnum 

func GetMappingJsonWebKeyKeyOpsEnum(val string) (JsonWebKeyKeyOpsEnum, bool)

GetMappingJsonWebKeyKeyOpsEnum performs case Insensitive comparison on enum value and return the desired enum

type JsonWebKeyKtyEnum 

type JsonWebKeyKtyEnum string

JsonWebKeyKtyEnum Enum with underlying type: string 

const (
	JsonWebKeyKtyRsa JsonWebKeyKtyEnum = "RSA"
)

Set of constants representing the allowable values for JsonWebKeyKtyEnum

func GetJsonWebKeyKtyEnumValues 

func GetJsonWebKeyKtyEnumValues() []JsonWebKeyKtyEnum

GetJsonWebKeyKtyEnumValues Enumerates the set of values for JsonWebKeyKtyEnum

func GetMappingJsonWebKeyKtyEnum 

func GetMappingJsonWebKeyKtyEnum(val string) (JsonWebKeyKtyEnum, bool)

GetMappingJsonWebKeyKtyEnum performs case Insensitive comparison on enum value and return the desired enum

type JsonWebKeyUseEnum 

type JsonWebKeyUseEnum string

JsonWebKeyUseEnum Enum with underlying type: string 

const (
	JsonWebKeyUseSig JsonWebKeyUseEnum = "sig"
)

Set of constants representing the allowable values for JsonWebKeyUseEnum

func GetJsonWebKeyUseEnumValues 

func GetJsonWebKeyUseEnumValues() []JsonWebKeyUseEnum

GetJsonWebKeyUseEnumValues Enumerates the set of values for JsonWebKeyUseEnum

func GetMappingJsonWebKeyUseEnum 

func GetMappingJsonWebKeyUseEnum(val string) (JsonWebKeyUseEnum, bool)

GetMappingJsonWebKeyUseEnum performs case Insensitive comparison on enum value and return the desired enum

type JsonWebTokenClaim 

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

JsonWebTokenClaim An individual JWT claim.

func (JsonWebTokenClaim) String 

func (m JsonWebTokenClaim) String() string

func (JsonWebTokenClaim) ValidateEnumValue 

func (m JsonWebTokenClaim) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type JwtAuthenticationPolicy 

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

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

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

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

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

func (JwtAuthenticationPolicy) ValidateEnumValue 

func (m JwtAuthenticationPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

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

ListApisRequest wrapper for the ListApis operation

See also

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

func (ListApisRequest) BinaryRequestBody 

func (request ListApisRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListApisRequest) HTTPRequest 

func (request ListApisRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (ListApisRequest) ValidateEnumValue 

func (request ListApisRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListApisResponse 

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

ListApisResponse wrapper for the ListApis operation

func (ListApisResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListApisResponse) String 

func (response ListApisResponse) String() string

type ListApisSortByEnum 

type ListApisSortByEnum string

ListApisSortByEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListApisSortByEnum

func GetListApisSortByEnumValues 

func GetListApisSortByEnumValues() []ListApisSortByEnum

GetListApisSortByEnumValues Enumerates the set of values for ListApisSortByEnum

func GetMappingListApisSortByEnum 

func GetMappingListApisSortByEnum(val string) (ListApisSortByEnum, bool)

GetMappingListApisSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListApisSortOrderEnum 

type ListApisSortOrderEnum string

ListApisSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListApisSortOrderEnum

func GetListApisSortOrderEnumValues 

func GetListApisSortOrderEnumValues() []ListApisSortOrderEnum

GetListApisSortOrderEnumValues Enumerates the set of values for ListApisSortOrderEnum

func GetMappingListApisSortOrderEnum 

func GetMappingListApisSortOrderEnum(val string) (ListApisSortOrderEnum, bool)

GetMappingListApisSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

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

ListCertificatesRequest wrapper for the ListCertificates operation

See also

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

func (ListCertificatesRequest) BinaryRequestBody 

func (request ListCertificatesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListCertificatesRequest) HTTPRequest 

func (request ListCertificatesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (ListCertificatesRequest) ValidateEnumValue 

func (request ListCertificatesRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListCertificatesResponse 

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

ListCertificatesResponse wrapper for the ListCertificates operation

func (ListCertificatesResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListCertificatesResponse) String 

func (response ListCertificatesResponse) String() string

type ListCertificatesSortByEnum 

type ListCertificatesSortByEnum string

ListCertificatesSortByEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListCertificatesSortByEnum

func GetListCertificatesSortByEnumValues 

func GetListCertificatesSortByEnumValues() []ListCertificatesSortByEnum

GetListCertificatesSortByEnumValues Enumerates the set of values for ListCertificatesSortByEnum

func GetMappingListCertificatesSortByEnum 

func GetMappingListCertificatesSortByEnum(val string) (ListCertificatesSortByEnum, bool)

GetMappingListCertificatesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListCertificatesSortOrderEnum 

type ListCertificatesSortOrderEnum string

ListCertificatesSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListCertificatesSortOrderEnum

func GetListCertificatesSortOrderEnumValues 

func GetListCertificatesSortOrderEnumValues() []ListCertificatesSortOrderEnum

GetListCertificatesSortOrderEnumValues Enumerates the set of values for ListCertificatesSortOrderEnum

func GetMappingListCertificatesSortOrderEnum 

func GetMappingListCertificatesSortOrderEnum(val string) (ListCertificatesSortOrderEnum, bool)

GetMappingListCertificatesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

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

ListDeploymentsRequest wrapper for the ListDeployments operation

See also

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

func (ListDeploymentsRequest) BinaryRequestBody 

func (request ListDeploymentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDeploymentsRequest) HTTPRequest 

func (request ListDeploymentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (ListDeploymentsRequest) ValidateEnumValue 

func (request ListDeploymentsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListDeploymentsResponse 

type ListDeploymentsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

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

ListDeploymentsResponse wrapper for the ListDeployments operation

func (ListDeploymentsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListDeploymentsResponse) String 

func (response ListDeploymentsResponse) String() string

type ListDeploymentsSortByEnum 

type ListDeploymentsSortByEnum string

ListDeploymentsSortByEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListDeploymentsSortByEnum

func GetListDeploymentsSortByEnumValues 

func GetListDeploymentsSortByEnumValues() []ListDeploymentsSortByEnum

GetListDeploymentsSortByEnumValues Enumerates the set of values for ListDeploymentsSortByEnum

func GetMappingListDeploymentsSortByEnum 

func GetMappingListDeploymentsSortByEnum(val string) (ListDeploymentsSortByEnum, bool)

GetMappingListDeploymentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDeploymentsSortOrderEnum 

type ListDeploymentsSortOrderEnum string

ListDeploymentsSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListDeploymentsSortOrderEnum

func GetListDeploymentsSortOrderEnumValues 

func GetListDeploymentsSortOrderEnumValues() []ListDeploymentsSortOrderEnum

GetListDeploymentsSortOrderEnumValues Enumerates the set of values for ListDeploymentsSortOrderEnum

func GetMappingListDeploymentsSortOrderEnum 

func GetMappingListDeploymentsSortOrderEnum(val string) (ListDeploymentsSortOrderEnum, bool)

GetMappingListDeploymentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

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

ListGatewaysRequest wrapper for the ListGateways operation

See also

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

func (ListGatewaysRequest) BinaryRequestBody 

func (request ListGatewaysRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListGatewaysRequest) HTTPRequest 

func (request ListGatewaysRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (ListGatewaysRequest) ValidateEnumValue 

func (request ListGatewaysRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListGatewaysResponse 

type ListGatewaysResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

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

ListGatewaysResponse wrapper for the ListGateways operation

func (ListGatewaysResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListGatewaysResponse) String 

func (response ListGatewaysResponse) String() string

type ListGatewaysSortByEnum 

type ListGatewaysSortByEnum string

ListGatewaysSortByEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListGatewaysSortByEnum

func GetListGatewaysSortByEnumValues 

func GetListGatewaysSortByEnumValues() []ListGatewaysSortByEnum

GetListGatewaysSortByEnumValues Enumerates the set of values for ListGatewaysSortByEnum

func GetMappingListGatewaysSortByEnum 

func GetMappingListGatewaysSortByEnum(val string) (ListGatewaysSortByEnum, bool)

GetMappingListGatewaysSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListGatewaysSortOrderEnum 

type ListGatewaysSortOrderEnum string

ListGatewaysSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListGatewaysSortOrderEnum

func GetListGatewaysSortOrderEnumValues 

func GetListGatewaysSortOrderEnumValues() []ListGatewaysSortOrderEnum

GetListGatewaysSortOrderEnumValues Enumerates the set of values for ListGatewaysSortOrderEnum

func GetMappingListGatewaysSortOrderEnum 

func GetMappingListGatewaysSortOrderEnum(val string) (ListGatewaysSortOrderEnum, bool)

GetMappingListGatewaysSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSdkLanguageTypesRequest 

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

	// 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 ListSdkLanguageTypesSortOrderEnum `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 ListSdkLanguageTypesSortByEnum `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
}

ListSdkLanguageTypesRequest wrapper for the ListSdkLanguageTypes operation

See also

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

func (ListSdkLanguageTypesRequest) BinaryRequestBody 

func (request ListSdkLanguageTypesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListSdkLanguageTypesRequest) HTTPRequest 

func (request ListSdkLanguageTypesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListSdkLanguageTypesRequest) RetryPolicy 

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

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

func (ListSdkLanguageTypesRequest) String 

func (request ListSdkLanguageTypesRequest) String() string

func (ListSdkLanguageTypesRequest) ValidateEnumValue 

func (request ListSdkLanguageTypesRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListSdkLanguageTypesResponse 

type ListSdkLanguageTypesResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

ListSdkLanguageTypesResponse wrapper for the ListSdkLanguageTypes operation

func (ListSdkLanguageTypesResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListSdkLanguageTypesResponse) String 

func (response ListSdkLanguageTypesResponse) String() string

type ListSdkLanguageTypesSortByEnum 

type ListSdkLanguageTypesSortByEnum string

ListSdkLanguageTypesSortByEnum Enum with underlying type: string 

const (
	ListSdkLanguageTypesSortByTimecreated ListSdkLanguageTypesSortByEnum = "timeCreated"
	ListSdkLanguageTypesSortByDisplayname ListSdkLanguageTypesSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListSdkLanguageTypesSortByEnum

func GetListSdkLanguageTypesSortByEnumValues 

func GetListSdkLanguageTypesSortByEnumValues() []ListSdkLanguageTypesSortByEnum

GetListSdkLanguageTypesSortByEnumValues Enumerates the set of values for ListSdkLanguageTypesSortByEnum

func GetMappingListSdkLanguageTypesSortByEnum 

func GetMappingListSdkLanguageTypesSortByEnum(val string) (ListSdkLanguageTypesSortByEnum, bool)

GetMappingListSdkLanguageTypesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSdkLanguageTypesSortOrderEnum 

type ListSdkLanguageTypesSortOrderEnum string

ListSdkLanguageTypesSortOrderEnum Enum with underlying type: string 

const (
	ListSdkLanguageTypesSortOrderAsc  ListSdkLanguageTypesSortOrderEnum = "ASC"
	ListSdkLanguageTypesSortOrderDesc ListSdkLanguageTypesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSdkLanguageTypesSortOrderEnum

func GetListSdkLanguageTypesSortOrderEnumValues 

func GetListSdkLanguageTypesSortOrderEnumValues() []ListSdkLanguageTypesSortOrderEnum

GetListSdkLanguageTypesSortOrderEnumValues Enumerates the set of values for ListSdkLanguageTypesSortOrderEnum

func GetMappingListSdkLanguageTypesSortOrderEnum 

func GetMappingListSdkLanguageTypesSortOrderEnum(val string) (ListSdkLanguageTypesSortOrderEnum, bool)

GetMappingListSdkLanguageTypesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSdksRequest 

type ListSdksRequest struct {

	// The ocid of the SDK.
	SdkId *string `mandatory:"false" contributesTo:"query" name:"sdkId"`

	// 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 SdkLifecycleStateEnum `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 ListSdksSortOrderEnum `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 ListSdksSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The ocid of the API.
	ApiId *string `mandatory:"false" contributesTo:"query" 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
}

ListSdksRequest wrapper for the ListSdks operation

See also

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

func (ListSdksRequest) BinaryRequestBody 

func (request ListSdksRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListSdksRequest) HTTPRequest 

func (request ListSdksRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListSdksRequest) RetryPolicy 

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

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

func (ListSdksRequest) String 

func (request ListSdksRequest) String() string

func (ListSdksRequest) ValidateEnumValue 

func (request ListSdksRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListSdksResponse 

type ListSdksResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

ListSdksResponse wrapper for the ListSdks operation

func (ListSdksResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListSdksResponse) String 

func (response ListSdksResponse) String() string

type ListSdksSortByEnum 

type ListSdksSortByEnum string

ListSdksSortByEnum Enum with underlying type: string 

const (
	ListSdksSortByTimecreated ListSdksSortByEnum = "timeCreated"
	ListSdksSortByDisplayname ListSdksSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListSdksSortByEnum

func GetListSdksSortByEnumValues 

func GetListSdksSortByEnumValues() []ListSdksSortByEnum

GetListSdksSortByEnumValues Enumerates the set of values for ListSdksSortByEnum

func GetMappingListSdksSortByEnum 

func GetMappingListSdksSortByEnum(val string) (ListSdksSortByEnum, bool)

GetMappingListSdksSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSdksSortOrderEnum 

type ListSdksSortOrderEnum string

ListSdksSortOrderEnum Enum with underlying type: string 

const (
	ListSdksSortOrderAsc  ListSdksSortOrderEnum = "ASC"
	ListSdksSortOrderDesc ListSdksSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSdksSortOrderEnum

func GetListSdksSortOrderEnumValues 

func GetListSdksSortOrderEnumValues() []ListSdksSortOrderEnum

GetListSdksSortOrderEnumValues Enumerates the set of values for ListSdksSortOrderEnum

func GetMappingListSdksSortOrderEnum 

func GetMappingListSdksSortOrderEnum(val string) (ListSdksSortOrderEnum, bool)

GetMappingListSdksSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSubscribersRequest added in v65.7.0 

type ListSubscribersRequest 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 SubscriberLifecycleStateEnum `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 ListSubscribersSortOrderEnum `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 ListSubscribersSortByEnum `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
}

ListSubscribersRequest wrapper for the ListSubscribers operation

See also

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

func (ListSubscribersRequest) BinaryRequestBody added in v65.7.0 

func (request ListSubscribersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListSubscribersRequest) HTTPRequest added in v65.7.0 

func (request ListSubscribersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListSubscribersRequest) RetryPolicy added in v65.7.0 

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

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

func (ListSubscribersRequest) String added in v65.7.0 

func (request ListSubscribersRequest) String() string

func (ListSubscribersRequest) ValidateEnumValue added in v65.7.0 

func (request ListSubscribersRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListSubscribersResponse added in v65.7.0 

type ListSubscribersResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

ListSubscribersResponse wrapper for the ListSubscribers operation

func (ListSubscribersResponse) HTTPResponse added in v65.7.0 

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

HTTPResponse implements the OCIResponse interface

func (ListSubscribersResponse) String added in v65.7.0 

func (response ListSubscribersResponse) String() string

type ListSubscribersSortByEnum added in v65.7.0 

type ListSubscribersSortByEnum string

ListSubscribersSortByEnum Enum with underlying type: string 

const (
	ListSubscribersSortByTimecreated ListSubscribersSortByEnum = "timeCreated"
	ListSubscribersSortByDisplayname ListSubscribersSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListSubscribersSortByEnum

func GetListSubscribersSortByEnumValues added in v65.7.0 

func GetListSubscribersSortByEnumValues() []ListSubscribersSortByEnum

GetListSubscribersSortByEnumValues Enumerates the set of values for ListSubscribersSortByEnum

func GetMappingListSubscribersSortByEnum added in v65.7.0 

func GetMappingListSubscribersSortByEnum(val string) (ListSubscribersSortByEnum, bool)

GetMappingListSubscribersSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSubscribersSortOrderEnum added in v65.7.0 

type ListSubscribersSortOrderEnum string

ListSubscribersSortOrderEnum Enum with underlying type: string 

const (
	ListSubscribersSortOrderAsc  ListSubscribersSortOrderEnum = "ASC"
	ListSubscribersSortOrderDesc ListSubscribersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSubscribersSortOrderEnum

func GetListSubscribersSortOrderEnumValues added in v65.7.0 

func GetListSubscribersSortOrderEnumValues() []ListSubscribersSortOrderEnum

GetListSubscribersSortOrderEnumValues Enumerates the set of values for ListSubscribersSortOrderEnum

func GetMappingListSubscribersSortOrderEnum added in v65.7.0 

func GetMappingListSubscribersSortOrderEnum(val string) (ListSubscribersSortOrderEnum, bool)

GetMappingListSubscribersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListUsagePlansRequest added in v65.7.0 

type ListUsagePlansRequest 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 UsagePlanLifecycleStateEnum `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 ListUsagePlansSortOrderEnum `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 ListUsagePlansSortByEnum `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
}

ListUsagePlansRequest wrapper for the ListUsagePlans operation

See also

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

func (ListUsagePlansRequest) BinaryRequestBody added in v65.7.0 

func (request ListUsagePlansRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListUsagePlansRequest) HTTPRequest added in v65.7.0 

func (request ListUsagePlansRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListUsagePlansRequest) RetryPolicy added in v65.7.0 

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

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

func (ListUsagePlansRequest) String added in v65.7.0 

func (request ListUsagePlansRequest) String() string

func (ListUsagePlansRequest) ValidateEnumValue added in v65.7.0 

func (request ListUsagePlansRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListUsagePlansResponse added in v65.7.0 

type ListUsagePlansResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

ListUsagePlansResponse wrapper for the ListUsagePlans operation

func (ListUsagePlansResponse) HTTPResponse added in v65.7.0 

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

HTTPResponse implements the OCIResponse interface

func (ListUsagePlansResponse) String added in v65.7.0 

func (response ListUsagePlansResponse) String() string

type ListUsagePlansSortByEnum added in v65.7.0 

type ListUsagePlansSortByEnum string

ListUsagePlansSortByEnum Enum with underlying type: string 

const (
	ListUsagePlansSortByTimecreated ListUsagePlansSortByEnum = "timeCreated"
	ListUsagePlansSortByDisplayname ListUsagePlansSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListUsagePlansSortByEnum

func GetListUsagePlansSortByEnumValues added in v65.7.0 

func GetListUsagePlansSortByEnumValues() []ListUsagePlansSortByEnum

GetListUsagePlansSortByEnumValues Enumerates the set of values for ListUsagePlansSortByEnum

func GetMappingListUsagePlansSortByEnum added in v65.7.0 

func GetMappingListUsagePlansSortByEnum(val string) (ListUsagePlansSortByEnum, bool)

GetMappingListUsagePlansSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListUsagePlansSortOrderEnum added in v65.7.0 

type ListUsagePlansSortOrderEnum string

ListUsagePlansSortOrderEnum Enum with underlying type: string 

const (
	ListUsagePlansSortOrderAsc  ListUsagePlansSortOrderEnum = "ASC"
	ListUsagePlansSortOrderDesc ListUsagePlansSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListUsagePlansSortOrderEnum

func GetListUsagePlansSortOrderEnumValues added in v65.7.0 

func GetListUsagePlansSortOrderEnumValues() []ListUsagePlansSortOrderEnum

GetListUsagePlansSortOrderEnumValues Enumerates the set of values for ListUsagePlansSortOrderEnum

func GetMappingListUsagePlansSortOrderEnum added in v65.7.0 

func GetMappingListUsagePlansSortOrderEnum(val string) (ListUsagePlansSortOrderEnum, bool)

GetMappingListUsagePlansSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

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

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

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

func (ListWorkRequestErrorsRequest) BinaryRequestBody 

func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest 

func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (ListWorkRequestErrorsRequest) ValidateEnumValue 

func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListWorkRequestErrorsResponse 

type ListWorkRequestErrorsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

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

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String 

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum 

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues 

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum 

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestErrorsSortOrderEnum 

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues 

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum 

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

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

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

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

func (ListWorkRequestLogsRequest) BinaryRequestBody 

func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest 

func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (ListWorkRequestLogsRequest) ValidateEnumValue 

func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListWorkRequestLogsResponse 

type ListWorkRequestLogsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

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

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String 

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum 

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues 

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum 

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestLogsSortOrderEnum 

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues 

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum 

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

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

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

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

func (ListWorkRequestsRequest) BinaryRequestBody 

func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest 

func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (ListWorkRequestsRequest) ValidateEnumValue 

func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListWorkRequestsResponse 

type ListWorkRequestsResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

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

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

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String 

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum 

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues 

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum 

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestsSortOrderEnum 

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues 

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum 

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ModifyResponseValidationFailurePolicy added in v65.20.0 

type ModifyResponseValidationFailurePolicy struct {

	// HTTP response code, can include context variables.
	ResponseCode *string `mandatory:"false" json:"responseCode"`

	// HTTP response message.
	ResponseMessage *string `mandatory:"false" json:"responseMessage"`

	ResponseHeaderTransformations *HeaderTransformationPolicy `mandatory:"false" json:"responseHeaderTransformations"`
}

ModifyResponseValidationFailurePolicy Policy to specify how to modify the response code, body and headers.

func (ModifyResponseValidationFailurePolicy) MarshalJSON added in v65.20.0 

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

MarshalJSON marshals to json representation

func (ModifyResponseValidationFailurePolicy) String added in v65.20.0 

func (m ModifyResponseValidationFailurePolicy) String() string

func (ModifyResponseValidationFailurePolicy) ValidateEnumValue added in v65.20.0 

func (m ModifyResponseValidationFailurePolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type MutualTlsDetails 

type MutualTlsDetails struct {

	// Determines whether to enable client verification when API Consumer makes connection to the gateway.
	IsVerifiedCertificateRequired *bool `mandatory:"false" json:"isVerifiedCertificateRequired"`

	// Allowed list of CN or SAN which will be used for verification of certificate.
	AllowedSans []string `mandatory:"false" json:"allowedSans"`
}

MutualTlsDetails Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.

func (MutualTlsDetails) String 

func (m MutualTlsDetails) String() string

func (MutualTlsDetails) ValidateEnumValue 

func (m MutualTlsDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type NoCache 

type NoCache struct {
}

NoCache Configures the gateway with no caching. Cache lookup and store policies will not be supported.

func (NoCache) MarshalJSON 

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

MarshalJSON marshals to json representation

func (NoCache) String 

func (m NoCache) String() string

func (NoCache) ValidateEnumValue 

func (m NoCache) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type NoContentValidation 

type NoContentValidation struct {
}

NoContentValidation No content validation properties.

func (NoContentValidation) MarshalJSON 

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

MarshalJSON marshals to json representation

func (NoContentValidation) String 

func (m NoContentValidation) String() string

func (NoContentValidation) ValidateEnumValue 

func (m NoContentValidation) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type OAuth2LogoutBackend added in v65.27.0 

type OAuth2LogoutBackend struct {
	AllowedPostLogoutUris []string `mandatory:"false" json:"allowedPostLogoutUris"`

	// Defines a state that should be shared on redirecting to postLogout URL.
	PostLogoutState *string `mandatory:"false" json:"postLogoutState"`
}

OAuth2LogoutBackend Backend which when called triggers OAuth2 logout.

func (OAuth2LogoutBackend) MarshalJSON added in v65.27.0 

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

MarshalJSON marshals to json representation

func (OAuth2LogoutBackend) String added in v65.27.0 

func (m OAuth2LogoutBackend) String() string

func (OAuth2LogoutBackend) ValidateEnumValue added in v65.27.0 

func (m OAuth2LogoutBackend) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type OAuth2ResponseValidationFailurePolicy added in v65.27.0 

type OAuth2ResponseValidationFailurePolicy struct {
	ClientDetails ClientAppDetails `mandatory:"true" json:"clientDetails"`

	SourceUriDetails SourceUriDetails `mandatory:"true" json:"sourceUriDetails"`

	// List of scopes.
	Scopes []string `mandatory:"true" json:"scopes"`

	// The duration for which the OAuth2 success token should be cached before it is
	// fetched again.
	MaxExpiryDurationInHours *int `mandatory:"false" json:"maxExpiryDurationInHours"`

	// Defines whether or not to use cookies for session maintenance.
	UseCookiesForSession *bool `mandatory:"false" json:"useCookiesForSession"`

	// Defines whether or not to use cookies for OAuth2 intermediate steps.
	UseCookiesForIntermediateSteps *bool `mandatory:"false" json:"useCookiesForIntermediateSteps"`

	// Defines whether or not to support PKCE.
	UsePkce *bool `mandatory:"false" json:"usePkce"`

	// The path to be used as fallback after OAuth2.
	FallbackRedirectPath *string `mandatory:"false" json:"fallbackRedirectPath"`

	// The path to be used as logout.
	LogoutPath *string `mandatory:"false" json:"logoutPath"`

	// Response Type.
	ResponseType OAuth2ResponseValidationFailurePolicyResponseTypeEnum `mandatory:"true" json:"responseType"`
}

OAuth2ResponseValidationFailurePolicy Policy to specify OAuth2 flow configuration.

func (OAuth2ResponseValidationFailurePolicy) MarshalJSON added in v65.27.0 

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

MarshalJSON marshals to json representation

func (OAuth2ResponseValidationFailurePolicy) String added in v65.27.0 

func (m OAuth2ResponseValidationFailurePolicy) String() string

func (*OAuth2ResponseValidationFailurePolicy) UnmarshalJSON added in v65.27.0 

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

UnmarshalJSON unmarshals from json

func (OAuth2ResponseValidationFailurePolicy) ValidateEnumValue added in v65.27.0 

func (m OAuth2ResponseValidationFailurePolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type OAuth2ResponseValidationFailurePolicyResponseTypeEnum added in v65.27.0 

type OAuth2ResponseValidationFailurePolicyResponseTypeEnum string

OAuth2ResponseValidationFailurePolicyResponseTypeEnum Enum with underlying type: string 

const (
	OAuth2ResponseValidationFailurePolicyResponseTypeCode OAuth2ResponseValidationFailurePolicyResponseTypeEnum = "CODE"
)

Set of constants representing the allowable values for OAuth2ResponseValidationFailurePolicyResponseTypeEnum

func GetMappingOAuth2ResponseValidationFailurePolicyResponseTypeEnum added in v65.27.0 

func GetMappingOAuth2ResponseValidationFailurePolicyResponseTypeEnum(val string) (OAuth2ResponseValidationFailurePolicyResponseTypeEnum, bool)

GetMappingOAuth2ResponseValidationFailurePolicyResponseTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOAuth2ResponseValidationFailurePolicyResponseTypeEnumValues added in v65.27.0 

func GetOAuth2ResponseValidationFailurePolicyResponseTypeEnumValues() []OAuth2ResponseValidationFailurePolicyResponseTypeEnum

GetOAuth2ResponseValidationFailurePolicyResponseTypeEnumValues Enumerates the set of values for OAuth2ResponseValidationFailurePolicyResponseTypeEnum

type OracleFunctionBackend 

type OracleFunctionBackend struct {

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

OracleFunctionBackend Send the request to an Oracle Functions function.

func (OracleFunctionBackend) MarshalJSON 

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

MarshalJSON marshals to json representation

func (OracleFunctionBackend) String 

func (m OracleFunctionBackend) String() string

func (OracleFunctionBackend) ValidateEnumValue 

func (m OracleFunctionBackend) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type PemEncodedPublicKey 

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

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

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

func (PemEncodedPublicKey) ValidateEnumValue 

func (m PemEncodedPublicKey) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type PublicKeySet 

type PublicKeySet interface {
}

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

type PublicKeySetTypeEnum 

type PublicKeySetTypeEnum string

PublicKeySetTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for PublicKeySetTypeEnum

func GetMappingPublicKeySetTypeEnum 

func GetMappingPublicKeySetTypeEnum(val string) (PublicKeySetTypeEnum, bool)

GetMappingPublicKeySetTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetPublicKeySetTypeEnumValues 

func GetPublicKeySetTypeEnumValues() []PublicKeySetTypeEnum

GetPublicKeySetTypeEnumValues Enumerates the set of values for PublicKeySetTypeEnum

type QueryParameterTransformationPolicy 

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

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

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

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

func (QueryParameterTransformationPolicy) String 

func (m QueryParameterTransformationPolicy) String() string

func (QueryParameterTransformationPolicy) ValidateEnumValue 

func (m QueryParameterTransformationPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type QueryParameterValidationItem 

type QueryParameterValidationItem struct {

	// Parameter name.
	Name *string `mandatory:"true" json:"name"`

	// Determines if the parameter is required in the request.
	Required *bool `mandatory:"false" json:"required"`
}

QueryParameterValidationItem Query parameter validation properties.

func (QueryParameterValidationItem) String 

func (m QueryParameterValidationItem) String() string

func (QueryParameterValidationItem) ValidateEnumValue 

func (m QueryParameterValidationItem) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type QueryParameterValidationRequestPolicy 

type QueryParameterValidationRequestPolicy struct {

	// Validation behavior mode.
	// In `ENFORCING` mode, upon a validation failure, the request will be rejected with a 4xx response
	// and not sent to the backend.
	// In `PERMISSIVE` mode, the result of the validation will be exposed as metrics while the request
	// will follow the normal path.
	// `DISABLED` type turns the validation off.
	ValidationMode QueryParameterValidationRequestPolicyValidationModeEnum `mandatory:"false" json:"validationMode,omitempty"`

	Parameters []QueryParameterValidationItem `mandatory:"false" json:"parameters"`
}

QueryParameterValidationRequestPolicy Validate the URL query parameters on the incoming API requests on a specific route.

func (QueryParameterValidationRequestPolicy) String 

func (m QueryParameterValidationRequestPolicy) String() string

func (QueryParameterValidationRequestPolicy) ValidateEnumValue 

func (m QueryParameterValidationRequestPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type QueryParameterValidationRequestPolicyValidationModeEnum 

type QueryParameterValidationRequestPolicyValidationModeEnum string

QueryParameterValidationRequestPolicyValidationModeEnum Enum with underlying type: string 

const (
	QueryParameterValidationRequestPolicyValidationModeEnforcing  QueryParameterValidationRequestPolicyValidationModeEnum = "ENFORCING"
	QueryParameterValidationRequestPolicyValidationModePermissive QueryParameterValidationRequestPolicyValidationModeEnum = "PERMISSIVE"
	QueryParameterValidationRequestPolicyValidationModeDisabled   QueryParameterValidationRequestPolicyValidationModeEnum = "DISABLED"
)

Set of constants representing the allowable values for QueryParameterValidationRequestPolicyValidationModeEnum

func GetMappingQueryParameterValidationRequestPolicyValidationModeEnum 

func GetMappingQueryParameterValidationRequestPolicyValidationModeEnum(val string) (QueryParameterValidationRequestPolicyValidationModeEnum, bool)

GetMappingQueryParameterValidationRequestPolicyValidationModeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetQueryParameterValidationRequestPolicyValidationModeEnumValues 

func GetQueryParameterValidationRequestPolicyValidationModeEnumValues() []QueryParameterValidationRequestPolicyValidationModeEnum

GetQueryParameterValidationRequestPolicyValidationModeEnumValues Enumerates the set of values for QueryParameterValidationRequestPolicyValidationModeEnum

type Quota added in v65.7.0 

type Quota struct {

	// The number of requests that can be made per time period.
	Value *int `mandatory:"true" json:"value"`

	// The unit of time over which quotas are calculated.
	// Example: `MINUTE` or `MONTH`
	Unit QuotaUnitEnum `mandatory:"true" json:"unit"`

	// The policy that controls when quotas will reset.
	// Example: `CALENDAR`
	ResetPolicy QuotaResetPolicyEnum `mandatory:"true" json:"resetPolicy"`

	// What the usage plan will do when a quota is breached:
	// `REJECT` will allow no further requests
	// `ALLOW` will continue to allow further requests
	OperationOnBreach QuotaOperationOnBreachEnum `mandatory:"true" json:"operationOnBreach"`
}

Quota Quota policy for a usage plan.

func (Quota) String added in v65.7.0 

func (m Quota) String() string

func (Quota) ValidateEnumValue added in v65.7.0 

func (m Quota) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type QuotaOperationOnBreachEnum added in v65.7.0 

type QuotaOperationOnBreachEnum string

QuotaOperationOnBreachEnum Enum with underlying type: string 

const (
	QuotaOperationOnBreachReject QuotaOperationOnBreachEnum = "REJECT"
	QuotaOperationOnBreachAllow  QuotaOperationOnBreachEnum = "ALLOW"
)

Set of constants representing the allowable values for QuotaOperationOnBreachEnum

func GetMappingQuotaOperationOnBreachEnum added in v65.7.0 

func GetMappingQuotaOperationOnBreachEnum(val string) (QuotaOperationOnBreachEnum, bool)

GetMappingQuotaOperationOnBreachEnum performs case Insensitive comparison on enum value and return the desired enum

func GetQuotaOperationOnBreachEnumValues added in v65.7.0 

func GetQuotaOperationOnBreachEnumValues() []QuotaOperationOnBreachEnum

GetQuotaOperationOnBreachEnumValues Enumerates the set of values for QuotaOperationOnBreachEnum

type QuotaResetPolicyEnum added in v65.7.0 

type QuotaResetPolicyEnum string

QuotaResetPolicyEnum Enum with underlying type: string 

const (
	QuotaResetPolicyCalendar QuotaResetPolicyEnum = "CALENDAR"
)

Set of constants representing the allowable values for QuotaResetPolicyEnum

func GetMappingQuotaResetPolicyEnum added in v65.7.0 

func GetMappingQuotaResetPolicyEnum(val string) (QuotaResetPolicyEnum, bool)

GetMappingQuotaResetPolicyEnum performs case Insensitive comparison on enum value and return the desired enum

func GetQuotaResetPolicyEnumValues added in v65.7.0 

func GetQuotaResetPolicyEnumValues() []QuotaResetPolicyEnum

GetQuotaResetPolicyEnumValues Enumerates the set of values for QuotaResetPolicyEnum

type QuotaUnitEnum added in v65.7.0 

type QuotaUnitEnum string

QuotaUnitEnum Enum with underlying type: string 

const (
	QuotaUnitMinute QuotaUnitEnum = "MINUTE"
	QuotaUnitHour   QuotaUnitEnum = "HOUR"
	QuotaUnitDay    QuotaUnitEnum = "DAY"
	QuotaUnitWeek   QuotaUnitEnum = "WEEK"
	QuotaUnitMonth  QuotaUnitEnum = "MONTH"
)

Set of constants representing the allowable values for QuotaUnitEnum

func GetMappingQuotaUnitEnum added in v65.7.0 

func GetMappingQuotaUnitEnum(val string) (QuotaUnitEnum, bool)

GetMappingQuotaUnitEnum performs case Insensitive comparison on enum value and return the desired enum

func GetQuotaUnitEnumValues added in v65.7.0 

func GetQuotaUnitEnumValues() []QuotaUnitEnum

GetQuotaUnitEnumValues Enumerates the set of values for QuotaUnitEnum

type RateLimit added in v65.7.0 

type RateLimit struct {

	// The number of requests that can be made per time period.
	Value *int `mandatory:"true" json:"value"`

	// The unit of time over which rate limits are calculated.
	// Example: `SECOND`
	Unit RateLimitUnitEnum `mandatory:"true" json:"unit"`
}

RateLimit Rate-limiting policy for a usage plan.

func (RateLimit) String added in v65.7.0 

func (m RateLimit) String() string

func (RateLimit) ValidateEnumValue added in v65.7.0 

func (m RateLimit) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type RateLimitUnitEnum added in v65.7.0 

type RateLimitUnitEnum string

RateLimitUnitEnum Enum with underlying type: string 

const (
	RateLimitUnitSecond RateLimitUnitEnum = "SECOND"
)

Set of constants representing the allowable values for RateLimitUnitEnum

func GetMappingRateLimitUnitEnum added in v65.7.0 

func GetMappingRateLimitUnitEnum(val string) (RateLimitUnitEnum, bool)

GetMappingRateLimitUnitEnum performs case Insensitive comparison on enum value and return the desired enum

func GetRateLimitUnitEnumValues added in v65.7.0 

func GetRateLimitUnitEnumValues() []RateLimitUnitEnum

GetRateLimitUnitEnumValues Enumerates the set of values for RateLimitUnitEnum

type RateLimitingPolicy 

type RateLimitingPolicy struct {

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

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

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

func (RateLimitingPolicy) String 

func (m RateLimitingPolicy) String() string

func (RateLimitingPolicy) ValidateEnumValue 

func (m RateLimitingPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type RateLimitingPolicyRateKeyEnum 

type RateLimitingPolicyRateKeyEnum string

RateLimitingPolicyRateKeyEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for RateLimitingPolicyRateKeyEnum

func GetMappingRateLimitingPolicyRateKeyEnum 

func GetMappingRateLimitingPolicyRateKeyEnum(val string) (RateLimitingPolicyRateKeyEnum, bool)

GetMappingRateLimitingPolicyRateKeyEnum performs case Insensitive comparison on enum value and return the desired enum

func GetRateLimitingPolicyRateKeyEnumValues 

func GetRateLimitingPolicyRateKeyEnumValues() []RateLimitingPolicyRateKeyEnum

GetRateLimitingPolicyRateKeyEnumValues Enumerates the set of values for RateLimitingPolicyRateKeyEnum

type RemoteJsonWebKeySet 

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

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.

func (RemoteJsonWebKeySet) MarshalJSON 

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

MarshalJSON marshals to json representation

func (RemoteJsonWebKeySet) String 

func (m RemoteJsonWebKeySet) String() string

func (RemoteJsonWebKeySet) ValidateEnumValue 

func (m RemoteJsonWebKeySet) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type RenameHeaderPolicy 

type RenameHeaderPolicy struct {

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

RenameHeaderPolicy Rename HTTP headers as they pass through the gateway.

func (RenameHeaderPolicy) String 

func (m RenameHeaderPolicy) String() string

func (RenameHeaderPolicy) ValidateEnumValue 

func (m RenameHeaderPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type RenameHeaderPolicyItem 

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

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.

func (RenameHeaderPolicyItem) String 

func (m RenameHeaderPolicyItem) String() string

func (RenameHeaderPolicyItem) ValidateEnumValue 

func (m RenameHeaderPolicyItem) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type RenameQueryParameterPolicy 

type RenameQueryParameterPolicy struct {

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

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

func (RenameQueryParameterPolicy) String 

func (m RenameQueryParameterPolicy) String() string

func (RenameQueryParameterPolicy) ValidateEnumValue 

func (m RenameQueryParameterPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type RenameQueryParameterPolicyItem 

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

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.

func (RenameQueryParameterPolicyItem) String 

func (m RenameQueryParameterPolicyItem) String() string

func (RenameQueryParameterPolicyItem) ValidateEnumValue 

func (m RenameQueryParameterPolicyItem) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type RequestParameterValidation 

type RequestParameterValidation struct {

	// Parameter name.
	Name *string `mandatory:"true" json:"name"`
}

RequestParameterValidation Common parameter validation properties.

func (RequestParameterValidation) String 

func (m RequestParameterValidation) String() string

func (RequestParameterValidation) ValidateEnumValue 

func (m RequestParameterValidation) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ResponseCacheDetails 

type ResponseCacheDetails interface {
}

ResponseCacheDetails Base Gateway response cache.

type ResponseCacheDetailsTypeEnum 

type ResponseCacheDetailsTypeEnum string

ResponseCacheDetailsTypeEnum Enum with underlying type: string 

const (
	ResponseCacheDetailsTypeExternalRespCache ResponseCacheDetailsTypeEnum = "EXTERNAL_RESP_CACHE"
	ResponseCacheDetailsTypeNone              ResponseCacheDetailsTypeEnum = "NONE"
)

Set of constants representing the allowable values for ResponseCacheDetailsTypeEnum

func GetMappingResponseCacheDetailsTypeEnum 

func GetMappingResponseCacheDetailsTypeEnum(val string) (ResponseCacheDetailsTypeEnum, bool)

GetMappingResponseCacheDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetResponseCacheDetailsTypeEnumValues 

func GetResponseCacheDetailsTypeEnumValues() []ResponseCacheDetailsTypeEnum

GetResponseCacheDetailsTypeEnumValues Enumerates the set of values for ResponseCacheDetailsTypeEnum

type ResponseCacheLookupPolicy 

type ResponseCacheLookupPolicy interface {

	// Whether this policy is currently enabled.
	GetIsEnabled() *bool

	// Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your
	// cache key additions to get the level of isolation across authenticated requests that you require.
	// When false, any request with an Authorization header will not be stored in the Response Cache.
	// If using the CustomAuthenticationPolicy then the tokenHeader/tokenQueryParam are also subject to this check.
	GetIsPrivateCachingEnabled() *bool
}

ResponseCacheLookupPolicy Base policy for Response Cache lookup.

type ResponseCacheLookupPolicyTypeEnum 

type ResponseCacheLookupPolicyTypeEnum string

ResponseCacheLookupPolicyTypeEnum Enum with underlying type: string 

const (
	ResponseCacheLookupPolicyTypeSimpleLookupPolicy ResponseCacheLookupPolicyTypeEnum = "SIMPLE_LOOKUP_POLICY"
)

Set of constants representing the allowable values for ResponseCacheLookupPolicyTypeEnum

func GetMappingResponseCacheLookupPolicyTypeEnum 

func GetMappingResponseCacheLookupPolicyTypeEnum(val string) (ResponseCacheLookupPolicyTypeEnum, bool)

GetMappingResponseCacheLookupPolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetResponseCacheLookupPolicyTypeEnumValues 

func GetResponseCacheLookupPolicyTypeEnumValues() []ResponseCacheLookupPolicyTypeEnum

GetResponseCacheLookupPolicyTypeEnumValues Enumerates the set of values for ResponseCacheLookupPolicyTypeEnum

type ResponseCacheRespServer 

type ResponseCacheRespServer struct {

	// Hostname or IP address (IPv4 only) where the cache store is running.
	Host *string `mandatory:"true" json:"host"`

	// The port the cache store is exposed on.
	Port *int `mandatory:"true" json:"port"`
}

ResponseCacheRespServer Details of a RESP based cache store server

func (ResponseCacheRespServer) String 

func (m ResponseCacheRespServer) String() string

func (ResponseCacheRespServer) ValidateEnumValue 

func (m ResponseCacheRespServer) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ResponseCacheStorePolicy 

type ResponseCacheStorePolicy interface {
}

ResponseCacheStorePolicy Base policy for how a response from a backend is cached in the Response Cache.

type ResponseCacheStorePolicyTypeEnum 

type ResponseCacheStorePolicyTypeEnum string

ResponseCacheStorePolicyTypeEnum Enum with underlying type: string 

const (
	ResponseCacheStorePolicyTypeFixedTtlStorePolicy ResponseCacheStorePolicyTypeEnum = "FIXED_TTL_STORE_POLICY"
)

Set of constants representing the allowable values for ResponseCacheStorePolicyTypeEnum

func GetMappingResponseCacheStorePolicyTypeEnum 

func GetMappingResponseCacheStorePolicyTypeEnum(val string) (ResponseCacheStorePolicyTypeEnum, bool)

GetMappingResponseCacheStorePolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetResponseCacheStorePolicyTypeEnumValues 

func GetResponseCacheStorePolicyTypeEnumValues() []ResponseCacheStorePolicyTypeEnum

GetResponseCacheStorePolicyTypeEnumValues Enumerates the set of values for ResponseCacheStorePolicyTypeEnum

type RouteAuthorizationPolicy 

type RouteAuthorizationPolicy interface {
}

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

type RouteAuthorizationPolicyTypeEnum 

type RouteAuthorizationPolicyTypeEnum string

RouteAuthorizationPolicyTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for RouteAuthorizationPolicyTypeEnum

func GetMappingRouteAuthorizationPolicyTypeEnum 

func GetMappingRouteAuthorizationPolicyTypeEnum(val string) (RouteAuthorizationPolicyTypeEnum, bool)

GetMappingRouteAuthorizationPolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetRouteAuthorizationPolicyTypeEnumValues 

func GetRouteAuthorizationPolicyTypeEnumValues() []RouteAuthorizationPolicyTypeEnum

GetRouteAuthorizationPolicyTypeEnumValues Enumerates the set of values for RouteAuthorizationPolicyTypeEnum

type Sdk 

type Sdk 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 API resource
	ApiId *string `mandatory:"true" json:"apiId"`

	// 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 string representing the target programming language for generating the SDK.
	TargetLanguage *string `mandatory:"true" json:"targetLanguage"`

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

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

	// File location for generated SDK.
	ArtifactUrl *string `mandatory:"false" json:"artifactUrl"`

	// Expiry of artifact url.
	TimeArtifactUrlExpiresAt *common.SDKTime `mandatory:"false" json:"timeArtifactUrlExpiresAt"`

	// The current state of the SDK.
	// - The SDK will be in CREATING state if the SDK creation is in progress.
	// - The SDK will be in ACTIVE state if create is successful.
	// - The SDK will be in FAILED state if the create, or delete fails.
	// - The SDK will be in DELETING state if the deletion in in progress.
	// - The SDK will be in DELETED state if the delete is successful.
	LifecycleState SdkLifecycleStateEnum `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"`

	// Additional optional configurations passed.
	// The applicable config keys are listed under "parameters" when "/sdkLanguageTypes" is called.
	// Example: `{"configName": "configValue"}`
	Parameters map[string]string `mandatory:"false" json:"parameters"`
}

Sdk Information about the SDK.

func (Sdk) String 

func (m Sdk) String() string

func (Sdk) ValidateEnumValue 

func (m Sdk) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SdkCollection 

type SdkCollection struct {

	// SDK summaries.
	Items []SdkSummary `mandatory:"true" json:"items"`
}

SdkCollection Collection of the existing SDKs.

func (SdkCollection) String 

func (m SdkCollection) String() string

func (SdkCollection) ValidateEnumValue 

func (m SdkCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SdkLanguageOptionalParameters 

type SdkLanguageOptionalParameters struct {

	// Name of the parameter.
	ParamName *string `mandatory:"true" json:"paramName"`

	// Display name of the parameter.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Description for the parameter.
	Description *string `mandatory:"false" json:"description"`

	// Information on whether the parameter is required or not.
	IsRequired *bool `mandatory:"false" json:"isRequired"`

	// Maximum size as input value for this parameter.
	MaxSize *float32 `mandatory:"false" json:"maxSize"`

	// The input type for this param.
	// - Input type is ENUM when only specific list of input strings are allowed.
	// - Input type is EMAIL when input type is an email ID.
	// - Input type is URI when input type is an URI.
	// - Input type is STRING in all other cases.
	InputType SdkLanguageOptionalParametersInputTypeEnum `mandatory:"false" json:"inputType,omitempty"`

	// List of allowed input values.
	// Example: `[{"name": "name1", "description": "description1"}, ...]`
	AllowedValues []SdkLanguageOptionalParametersAllowedValue `mandatory:"false" json:"allowedValues"`
}

SdkLanguageOptionalParameters List of additional applicable parameters for any given target language.

func (SdkLanguageOptionalParameters) String 

func (m SdkLanguageOptionalParameters) String() string

func (SdkLanguageOptionalParameters) ValidateEnumValue 

func (m SdkLanguageOptionalParameters) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SdkLanguageOptionalParametersAllowedValue 

type SdkLanguageOptionalParametersAllowedValue struct {

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

	// Description for the allowed value.
	Description *string `mandatory:"false" json:"description"`
}

SdkLanguageOptionalParametersAllowedValue Allowed value object.

func (SdkLanguageOptionalParametersAllowedValue) String 

func (m SdkLanguageOptionalParametersAllowedValue) String() string

func (SdkLanguageOptionalParametersAllowedValue) ValidateEnumValue 

func (m SdkLanguageOptionalParametersAllowedValue) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SdkLanguageOptionalParametersInputTypeEnum 

type SdkLanguageOptionalParametersInputTypeEnum string

SdkLanguageOptionalParametersInputTypeEnum Enum with underlying type: string 

const (
	SdkLanguageOptionalParametersInputTypeEnumvalue SdkLanguageOptionalParametersInputTypeEnum = "ENUM"
	SdkLanguageOptionalParametersInputTypeEmail     SdkLanguageOptionalParametersInputTypeEnum = "EMAIL"
	SdkLanguageOptionalParametersInputTypeUri       SdkLanguageOptionalParametersInputTypeEnum = "URI"
	SdkLanguageOptionalParametersInputTypeString    SdkLanguageOptionalParametersInputTypeEnum = "STRING"
)

Set of constants representing the allowable values for SdkLanguageOptionalParametersInputTypeEnum

func GetMappingSdkLanguageOptionalParametersInputTypeEnum 

func GetMappingSdkLanguageOptionalParametersInputTypeEnum(val string) (SdkLanguageOptionalParametersInputTypeEnum, bool)

GetMappingSdkLanguageOptionalParametersInputTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSdkLanguageOptionalParametersInputTypeEnumValues 

func GetSdkLanguageOptionalParametersInputTypeEnumValues() []SdkLanguageOptionalParametersInputTypeEnum

GetSdkLanguageOptionalParametersInputTypeEnumValues Enumerates the set of values for SdkLanguageOptionalParametersInputTypeEnum

type SdkLanguageTypeCollection 

type SdkLanguageTypeCollection struct {

	// SDK target language details.
	Items []SdkLanguageTypeSummary `mandatory:"true" json:"items"`
}

SdkLanguageTypeCollection Collection of available SDK target languages.

func (SdkLanguageTypeCollection) String 

func (m SdkLanguageTypeCollection) String() string

func (SdkLanguageTypeCollection) ValidateEnumValue 

func (m SdkLanguageTypeCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SdkLanguageTypeSummary 

type SdkLanguageTypeSummary struct {

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

	// Version string of the programming language defined in name.
	Version *string `mandatory:"true" json:"version"`

	// Display name of the target programming language.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Additional details.
	Description *string `mandatory:"false" json:"description"`

	// List of optional configurations that can be used while generating SDK for the given target language.
	Parameters []SdkLanguageOptionalParameters `mandatory:"false" json:"parameters"`
}

SdkLanguageTypeSummary SDK target language details.

func (SdkLanguageTypeSummary) String 

func (m SdkLanguageTypeSummary) String() string

func (SdkLanguageTypeSummary) ValidateEnumValue 

func (m SdkLanguageTypeSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SdkLanguageTypes 

type SdkLanguageTypes struct {

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

	// Version string of the programming language defined in name.
	Version *string `mandatory:"true" json:"version"`

	// Display name of the target programming language.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Additional details.
	Description *string `mandatory:"false" json:"description"`

	// List of optional configurations that can be used while generating SDK for the given target language.
	Parameters []SdkLanguageOptionalParameters `mandatory:"false" json:"parameters"`
}

SdkLanguageTypes SDK target language details.

func (SdkLanguageTypes) String 

func (m SdkLanguageTypes) String() string

func (SdkLanguageTypes) ValidateEnumValue 

func (m SdkLanguageTypes) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SdkLifecycleStateEnum 

type SdkLifecycleStateEnum string

SdkLifecycleStateEnum Enum with underlying type: string 

const (
	SdkLifecycleStateCreating SdkLifecycleStateEnum = "CREATING"
	SdkLifecycleStateActive   SdkLifecycleStateEnum = "ACTIVE"
	SdkLifecycleStateFailed   SdkLifecycleStateEnum = "FAILED"
	SdkLifecycleStateDeleting SdkLifecycleStateEnum = "DELETING"
	SdkLifecycleStateDeleted  SdkLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for SdkLifecycleStateEnum

func GetMappingSdkLifecycleStateEnum 

func GetMappingSdkLifecycleStateEnum(val string) (SdkLifecycleStateEnum, bool)

GetMappingSdkLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSdkLifecycleStateEnumValues 

func GetSdkLifecycleStateEnumValues() []SdkLifecycleStateEnum

GetSdkLifecycleStateEnumValues Enumerates the set of values for SdkLifecycleStateEnum

type SdkSummary 

type SdkSummary struct {

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

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

	// 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 string representing the target programming language for generating the SDK.
	TargetLanguage *string `mandatory:"true" json:"targetLanguage"`

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

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

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

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

SdkSummary A summary of the SDK.

func (SdkSummary) String 

func (m SdkSummary) String() string

func (SdkSummary) ValidateEnumValue 

func (m SdkSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SelectionSourcePolicy added in v65.20.0 

type SelectionSourcePolicy interface {
}

SelectionSourcePolicy The type of selector to use when dynamically routing and dynamically authenticating requests.

type SelectionSourcePolicyTypeEnum added in v65.20.0 

type SelectionSourcePolicyTypeEnum string

SelectionSourcePolicyTypeEnum Enum with underlying type: string 

const (
	SelectionSourcePolicyTypeSingle SelectionSourcePolicyTypeEnum = "SINGLE"
)

Set of constants representing the allowable values for SelectionSourcePolicyTypeEnum

func GetMappingSelectionSourcePolicyTypeEnum added in v65.20.0 

func GetMappingSelectionSourcePolicyTypeEnum(val string) (SelectionSourcePolicyTypeEnum, bool)

GetMappingSelectionSourcePolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSelectionSourcePolicyTypeEnumValues added in v65.20.0 

func GetSelectionSourcePolicyTypeEnumValues() []SelectionSourcePolicyTypeEnum

GetSelectionSourcePolicyTypeEnumValues Enumerates the set of values for SelectionSourcePolicyTypeEnum

type SetHeaderPolicy 

type SetHeaderPolicy struct {

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

SetHeaderPolicy Set HTTP headers as they pass through the gateway.

func (SetHeaderPolicy) String 

func (m SetHeaderPolicy) String() string

func (SetHeaderPolicy) ValidateEnumValue 

func (m SetHeaderPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SetHeaderPolicyItem 

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

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.

func (SetHeaderPolicyItem) String 

func (m SetHeaderPolicyItem) String() string

func (SetHeaderPolicyItem) ValidateEnumValue 

func (m SetHeaderPolicyItem) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SetHeaderPolicyItemIfExistsEnum 

type SetHeaderPolicyItemIfExistsEnum string

SetHeaderPolicyItemIfExistsEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for SetHeaderPolicyItemIfExistsEnum

func GetMappingSetHeaderPolicyItemIfExistsEnum 

func GetMappingSetHeaderPolicyItemIfExistsEnum(val string) (SetHeaderPolicyItemIfExistsEnum, bool)

GetMappingSetHeaderPolicyItemIfExistsEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSetHeaderPolicyItemIfExistsEnumValues 

func GetSetHeaderPolicyItemIfExistsEnumValues() []SetHeaderPolicyItemIfExistsEnum

GetSetHeaderPolicyItemIfExistsEnumValues Enumerates the set of values for SetHeaderPolicyItemIfExistsEnum

type SetQueryParameterPolicy 

type SetQueryParameterPolicy struct {

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

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

func (SetQueryParameterPolicy) String 

func (m SetQueryParameterPolicy) String() string

func (SetQueryParameterPolicy) ValidateEnumValue 

func (m SetQueryParameterPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SetQueryParameterPolicyItem 

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

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.

func (SetQueryParameterPolicyItem) String 

func (m SetQueryParameterPolicyItem) String() string

func (SetQueryParameterPolicyItem) ValidateEnumValue 

func (m SetQueryParameterPolicyItem) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SetQueryParameterPolicyItemIfExistsEnum 

type SetQueryParameterPolicyItemIfExistsEnum string

SetQueryParameterPolicyItemIfExistsEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for SetQueryParameterPolicyItemIfExistsEnum

func GetMappingSetQueryParameterPolicyItemIfExistsEnum 

func GetMappingSetQueryParameterPolicyItemIfExistsEnum(val string) (SetQueryParameterPolicyItemIfExistsEnum, bool)

GetMappingSetQueryParameterPolicyItemIfExistsEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSetQueryParameterPolicyItemIfExistsEnumValues 

func GetSetQueryParameterPolicyItemIfExistsEnumValues() []SetQueryParameterPolicyItemIfExistsEnum

GetSetQueryParameterPolicyItemIfExistsEnumValues Enumerates the set of values for SetQueryParameterPolicyItemIfExistsEnum

type SimpleLookupPolicy 

type SimpleLookupPolicy struct {

	// Whether this policy is currently enabled.
	IsEnabled *bool `mandatory:"false" json:"isEnabled"`

	// Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your
	// cache key additions to get the level of isolation across authenticated requests that you require.
	// When false, any request with an Authorization header will not be stored in the Response Cache.
	// If using the CustomAuthenticationPolicy then the tokenHeader/tokenQueryParam are also subject to this check.
	IsPrivateCachingEnabled *bool `mandatory:"false" json:"isPrivateCachingEnabled"`

	// A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within
	// ${} delimiters. Only the request context is available.
	CacheKeyAdditions []string `mandatory:"false" json:"cacheKeyAdditions"`
}

SimpleLookupPolicy Provides ability to vary the cache key using context expressions.

func (SimpleLookupPolicy) GetIsEnabled 

func (m SimpleLookupPolicy) GetIsEnabled() *bool

GetIsEnabled returns IsEnabled

func (SimpleLookupPolicy) GetIsPrivateCachingEnabled 

func (m SimpleLookupPolicy) GetIsPrivateCachingEnabled() *bool

GetIsPrivateCachingEnabled returns IsPrivateCachingEnabled

func (SimpleLookupPolicy) MarshalJSON 

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

MarshalJSON marshals to json representation

func (SimpleLookupPolicy) String 

func (m SimpleLookupPolicy) String() string

func (SimpleLookupPolicy) ValidateEnumValue 

func (m SimpleLookupPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SingleSelectionSourcePolicy added in v65.20.0 

type SingleSelectionSourcePolicy struct {

	// String describing the context variable used as selector.
	Selector *string `mandatory:"true" json:"selector"`
}

SingleSelectionSourcePolicy The single context variable in an incoming request to match against specified selection keys when dynamically routing and dynamically authenticating requests.

func (SingleSelectionSourcePolicy) MarshalJSON added in v65.20.0 

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

MarshalJSON marshals to json representation

func (SingleSelectionSourcePolicy) String added in v65.20.0 

func (m SingleSelectionSourcePolicy) String() string

func (SingleSelectionSourcePolicy) ValidateEnumValue added in v65.20.0 

func (m SingleSelectionSourcePolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SourceUriDetails added in v65.27.0 

type SourceUriDetails interface {
}

SourceUriDetails Auth endpoint details.

type SourceUriDetailsTypeEnum added in v65.27.0 

type SourceUriDetailsTypeEnum string

SourceUriDetailsTypeEnum Enum with underlying type: string 

const (
	SourceUriDetailsTypeDiscoveryUri    SourceUriDetailsTypeEnum = "DISCOVERY_URI"
	SourceUriDetailsTypeValidationBlock SourceUriDetailsTypeEnum = "VALIDATION_BLOCK"
)

Set of constants representing the allowable values for SourceUriDetailsTypeEnum

func GetMappingSourceUriDetailsTypeEnum added in v65.27.0 

func GetMappingSourceUriDetailsTypeEnum(val string) (SourceUriDetailsTypeEnum, bool)

GetMappingSourceUriDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSourceUriDetailsTypeEnumValues added in v65.27.0 

func GetSourceUriDetailsTypeEnumValues() []SourceUriDetailsTypeEnum

GetSourceUriDetailsTypeEnumValues Enumerates the set of values for SourceUriDetailsTypeEnum

type StaticPublicKey 

type StaticPublicKey interface {

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

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

type StaticPublicKeyFormatEnum 

type StaticPublicKeyFormatEnum string

StaticPublicKeyFormatEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for StaticPublicKeyFormatEnum

func GetMappingStaticPublicKeyFormatEnum 

func GetMappingStaticPublicKeyFormatEnum(val string) (StaticPublicKeyFormatEnum, bool)

GetMappingStaticPublicKeyFormatEnum performs case Insensitive comparison on enum value and return the desired enum

func GetStaticPublicKeyFormatEnumValues 

func GetStaticPublicKeyFormatEnumValues() []StaticPublicKeyFormatEnum

GetStaticPublicKeyFormatEnumValues Enumerates the set of values for StaticPublicKeyFormatEnum

type StaticPublicKeySet 

type StaticPublicKeySet struct {

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

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

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

func (StaticPublicKeySet) ValidateEnumValue 

func (m StaticPublicKeySet) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type StockResponseBackend 

type StockResponseBackend struct {

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

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

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

StockResponseBackend Send the request to a mock backend.

func (StockResponseBackend) MarshalJSON 

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

MarshalJSON marshals to json representation

func (StockResponseBackend) String 

func (m StockResponseBackend) String() string

func (StockResponseBackend) ValidateEnumValue 

func (m StockResponseBackend) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type Subscriber added in v65.7.0 

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

	// The clients belonging to this subscriber.
	Clients []Client `mandatory:"true" json:"clients"`

	// An array of OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)s of usage
	// plan resources.
	UsagePlans []string `mandatory:"true" json:"usagePlans"`

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

	// The current state of the subscriber.
	LifecycleState SubscriberLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

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

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

Subscriber A subscriber, which encapsulates a number of clients and usage plans that they are subscribed to.

func (Subscriber) String added in v65.7.0 

func (m Subscriber) String() string

func (Subscriber) ValidateEnumValue added in v65.7.0 

func (m Subscriber) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SubscriberCollection added in v65.7.0 

type SubscriberCollection struct {

	// Subscriber summaries.
	Items []SubscriberSummary `mandatory:"true" json:"items"`
}

SubscriberCollection Collection of subscriber summaries.

func (SubscriberCollection) String added in v65.7.0 

func (m SubscriberCollection) String() string

func (SubscriberCollection) ValidateEnumValue added in v65.7.0 

func (m SubscriberCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SubscriberLifecycleStateEnum added in v65.7.0 

type SubscriberLifecycleStateEnum string

SubscriberLifecycleStateEnum Enum with underlying type: string 

const (
	SubscriberLifecycleStateCreating SubscriberLifecycleStateEnum = "CREATING"
	SubscriberLifecycleStateActive   SubscriberLifecycleStateEnum = "ACTIVE"
	SubscriberLifecycleStateUpdating SubscriberLifecycleStateEnum = "UPDATING"
	SubscriberLifecycleStateDeleting SubscriberLifecycleStateEnum = "DELETING"
	SubscriberLifecycleStateDeleted  SubscriberLifecycleStateEnum = "DELETED"
	SubscriberLifecycleStateFailed   SubscriberLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for SubscriberLifecycleStateEnum

func GetMappingSubscriberLifecycleStateEnum added in v65.7.0 

func GetMappingSubscriberLifecycleStateEnum(val string) (SubscriberLifecycleStateEnum, bool)

GetMappingSubscriberLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSubscriberLifecycleStateEnumValues added in v65.7.0 

func GetSubscriberLifecycleStateEnumValues() []SubscriberLifecycleStateEnum

GetSubscriberLifecycleStateEnumValues Enumerates the set of values for SubscriberLifecycleStateEnum

type SubscriberSummary added in v65.7.0 

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

	// The clients belonging to this subscriber.
	Clients []ClientSummary `mandatory:"true" json:"clients"`

	// An array of OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)s of usage
	// plan resources.
	UsagePlans []string `mandatory:"true" json:"usagePlans"`

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

	// The current state of the subscriber.
	LifecycleState SubscriberLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

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

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

SubscriberSummary A summary of a subscriber.

func (SubscriberSummary) String added in v65.7.0 

func (m SubscriberSummary) String() string

func (SubscriberSummary) ValidateEnumValue added in v65.7.0 

func (m SubscriberSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SubscribersClient added in v65.7.0 

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

SubscribersClient a client for Subscribers

func NewSubscribersClientWithConfigurationProvider added in v65.7.0 

func NewSubscribersClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client SubscribersClient, err error)

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

func NewSubscribersClientWithOboToken added in v65.7.0 

func NewSubscribersClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client SubscribersClient, err error)

NewSubscribersClientWithOboToken Creates a new default Subscribers 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 (SubscribersClient) ChangeSubscriberCompartment added in v65.7.0 

func (client SubscribersClient) ChangeSubscriberCompartment(ctx context.Context, request ChangeSubscriberCompartmentRequest) (response ChangeSubscriberCompartmentResponse, err error)

ChangeSubscriberCompartment Changes the subscriber compartment.

See also

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

func (*SubscribersClient) ConfigurationProvider added in v65.7.0 

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

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

func (SubscribersClient) CreateSubscriber added in v65.7.0 

func (client SubscribersClient) CreateSubscriber(ctx context.Context, request CreateSubscriberRequest) (response CreateSubscriberResponse, err error)

CreateSubscriber Creates a new subscriber.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apigateway/CreateSubscriber.go.html to see an example of how to use CreateSubscriber API. A default retry strategy applies to this operation CreateSubscriber()

func (SubscribersClient) DeleteSubscriber added in v65.7.0 

func (client SubscribersClient) DeleteSubscriber(ctx context.Context, request DeleteSubscriberRequest) (response DeleteSubscriberResponse, err error)

DeleteSubscriber Deletes the subscriber with the given identifier.

See also

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

func (SubscribersClient) GetSubscriber added in v65.7.0 

func (client SubscribersClient) GetSubscriber(ctx context.Context, request GetSubscriberRequest) (response GetSubscriberResponse, err error)

GetSubscriber Gets a subscriber by identifier.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apigateway/GetSubscriber.go.html to see an example of how to use GetSubscriber API. A default retry strategy applies to this operation GetSubscriber()

func (SubscribersClient) ListSubscribers added in v65.7.0 

func (client SubscribersClient) ListSubscribers(ctx context.Context, request ListSubscribersRequest) (response ListSubscribersResponse, err error)

ListSubscribers Returns a list of subscribers.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apigateway/ListSubscribers.go.html to see an example of how to use ListSubscribers API. A default retry strategy applies to this operation ListSubscribers()

func (*SubscribersClient) SetRegion added in v65.7.0 

func (client *SubscribersClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (SubscribersClient) UpdateSubscriber added in v65.7.0 

func (client SubscribersClient) UpdateSubscriber(ctx context.Context, request UpdateSubscriberRequest) (response UpdateSubscriberResponse, err error)

UpdateSubscriber Updates the subscriber with the given identifier.

See also

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

type TokenAuthenticationPolicy added in v65.27.0 

type TokenAuthenticationPolicy struct {
	ValidationPolicy TokenAuthenticationValidationPolicy `mandatory:"true" json:"validationPolicy"`

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

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

	ValidationFailurePolicy ValidationFailurePolicy `mandatory:"false" json:"validationFailurePolicy"`
}

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

func (TokenAuthenticationPolicy) GetIsAnonymousAccessAllowed added in v65.27.0 

func (m TokenAuthenticationPolicy) GetIsAnonymousAccessAllowed() *bool

GetIsAnonymousAccessAllowed returns IsAnonymousAccessAllowed

func (TokenAuthenticationPolicy) MarshalJSON added in v65.27.0 

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

MarshalJSON marshals to json representation

func (TokenAuthenticationPolicy) String added in v65.27.0 

func (m TokenAuthenticationPolicy) String() string

func (*TokenAuthenticationPolicy) UnmarshalJSON added in v65.27.0 

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

UnmarshalJSON unmarshals from json

func (TokenAuthenticationPolicy) ValidateEnumValue added in v65.27.0 

func (m TokenAuthenticationPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type TokenAuthenticationRemoteDiscoveryValidationPolicy added in v65.27.0 

type TokenAuthenticationRemoteDiscoveryValidationPolicy struct {
	ClientDetails ClientAppDetails `mandatory:"true" json:"clientDetails"`

	SourceUriDetails SourceUriDetails `mandatory:"true" json:"sourceUriDetails"`

	AdditionalValidationPolicy *AdditionalValidationPolicy `mandatory:"false" json:"additionalValidationPolicy"`

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

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

TokenAuthenticationRemoteDiscoveryValidationPolicy Instrospect Url based validation retrieved at run-time from a remote location to verify the provided token.

func (TokenAuthenticationRemoteDiscoveryValidationPolicy) GetAdditionalValidationPolicy added in v65.27.0 

func (m TokenAuthenticationRemoteDiscoveryValidationPolicy) GetAdditionalValidationPolicy() *AdditionalValidationPolicy

GetAdditionalValidationPolicy returns AdditionalValidationPolicy

func (TokenAuthenticationRemoteDiscoveryValidationPolicy) MarshalJSON added in v65.27.0 

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

MarshalJSON marshals to json representation

func (TokenAuthenticationRemoteDiscoveryValidationPolicy) String added in v65.27.0 

func (m TokenAuthenticationRemoteDiscoveryValidationPolicy) String() string

func (*TokenAuthenticationRemoteDiscoveryValidationPolicy) UnmarshalJSON added in v65.27.0 

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

UnmarshalJSON unmarshals from json

func (TokenAuthenticationRemoteDiscoveryValidationPolicy) ValidateEnumValue added in v65.27.0 

func (m TokenAuthenticationRemoteDiscoveryValidationPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type TokenAuthenticationRemoteJwksValidationPolicy added in v65.27.0 

type TokenAuthenticationRemoteJwksValidationPolicy struct {

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

	AdditionalValidationPolicy *AdditionalValidationPolicy `mandatory:"false" json:"additionalValidationPolicy"`

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

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

func (TokenAuthenticationRemoteJwksValidationPolicy) GetAdditionalValidationPolicy added in v65.27.0 

func (m TokenAuthenticationRemoteJwksValidationPolicy) GetAdditionalValidationPolicy() *AdditionalValidationPolicy

GetAdditionalValidationPolicy returns AdditionalValidationPolicy

func (TokenAuthenticationRemoteJwksValidationPolicy) MarshalJSON added in v65.27.0 

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

MarshalJSON marshals to json representation

func (TokenAuthenticationRemoteJwksValidationPolicy) String added in v65.27.0 

func (m TokenAuthenticationRemoteJwksValidationPolicy) String() string

func (TokenAuthenticationRemoteJwksValidationPolicy) ValidateEnumValue added in v65.27.0 

func (m TokenAuthenticationRemoteJwksValidationPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type TokenAuthenticationStaticKeysValidationPolicy added in v65.27.0 

type TokenAuthenticationStaticKeysValidationPolicy struct {
	AdditionalValidationPolicy *AdditionalValidationPolicy `mandatory:"false" json:"additionalValidationPolicy"`

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

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

func (TokenAuthenticationStaticKeysValidationPolicy) GetAdditionalValidationPolicy added in v65.27.0 

func (m TokenAuthenticationStaticKeysValidationPolicy) GetAdditionalValidationPolicy() *AdditionalValidationPolicy

GetAdditionalValidationPolicy returns AdditionalValidationPolicy

func (TokenAuthenticationStaticKeysValidationPolicy) MarshalJSON added in v65.27.0 

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

MarshalJSON marshals to json representation

func (TokenAuthenticationStaticKeysValidationPolicy) String added in v65.27.0 

func (m TokenAuthenticationStaticKeysValidationPolicy) String() string

func (*TokenAuthenticationStaticKeysValidationPolicy) UnmarshalJSON added in v65.27.0 

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

UnmarshalJSON unmarshals from json

func (TokenAuthenticationStaticKeysValidationPolicy) ValidateEnumValue added in v65.27.0 

func (m TokenAuthenticationStaticKeysValidationPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type TokenAuthenticationValidationPolicy added in v65.27.0 

type TokenAuthenticationValidationPolicy interface {
	GetAdditionalValidationPolicy() *AdditionalValidationPolicy
}

TokenAuthenticationValidationPolicy Authentication Policies for the Token Authentication types.

type TokenAuthenticationValidationPolicyTypeEnum added in v65.27.0 

type TokenAuthenticationValidationPolicyTypeEnum string

TokenAuthenticationValidationPolicyTypeEnum Enum with underlying type: string 

const (
	TokenAuthenticationValidationPolicyTypeStaticKeys      TokenAuthenticationValidationPolicyTypeEnum = "STATIC_KEYS"
	TokenAuthenticationValidationPolicyTypeRemoteJwks      TokenAuthenticationValidationPolicyTypeEnum = "REMOTE_JWKS"
	TokenAuthenticationValidationPolicyTypeRemoteDiscovery TokenAuthenticationValidationPolicyTypeEnum = "REMOTE_DISCOVERY"
)

Set of constants representing the allowable values for TokenAuthenticationValidationPolicyTypeEnum

func GetMappingTokenAuthenticationValidationPolicyTypeEnum added in v65.27.0 

func GetMappingTokenAuthenticationValidationPolicyTypeEnum(val string) (TokenAuthenticationValidationPolicyTypeEnum, bool)

GetMappingTokenAuthenticationValidationPolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTokenAuthenticationValidationPolicyTypeEnumValues added in v65.27.0 

func GetTokenAuthenticationValidationPolicyTypeEnumValues() []TokenAuthenticationValidationPolicyTypeEnum

GetTokenAuthenticationValidationPolicyTypeEnumValues Enumerates the set of values for TokenAuthenticationValidationPolicyTypeEnum

type UpdateApiDetails 

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

UpdateApiDetails The information to be updated.

func (UpdateApiDetails) String 

func (m UpdateApiDetails) String() string

func (UpdateApiDetails) ValidateEnumValue 

func (m UpdateApiDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

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

UpdateApiRequest wrapper for the UpdateApi operation

See also

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

func (UpdateApiRequest) BinaryRequestBody 

func (request UpdateApiRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateApiRequest) HTTPRequest 

func (request UpdateApiRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (UpdateApiRequest) ValidateEnumValue 

func (request UpdateApiRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateApiResponse 

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

UpdateApiResponse wrapper for the UpdateApi operation

func (UpdateApiResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateApiResponse) String 

func (response UpdateApiResponse) String() string

type UpdateCertificateDetails 

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

UpdateCertificateDetails The information to be updated.

func (UpdateCertificateDetails) String 

func (m UpdateCertificateDetails) String() string

func (UpdateCertificateDetails) ValidateEnumValue 

func (m UpdateCertificateDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

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

UpdateCertificateRequest wrapper for the UpdateCertificate operation

See also

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

func (UpdateCertificateRequest) BinaryRequestBody 

func (request UpdateCertificateRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateCertificateRequest) HTTPRequest 

func (request UpdateCertificateRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (UpdateCertificateRequest) ValidateEnumValue 

func (request UpdateCertificateRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateCertificateResponse 

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

UpdateCertificateResponse wrapper for the UpdateCertificate operation

func (UpdateCertificateResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateCertificateResponse) String 

func (response UpdateCertificateResponse) String() string

type UpdateDeploymentDetails 

type UpdateDeploymentDetails struct {

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

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

	// Free-form tags for this resource. Each tag is a simple key-value pair
	// with no predefined name, type, or namespace. For more information, see
	// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a
	// namespace. For more information, see
	// Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateDeploymentDetails The information to be updated.

func (UpdateDeploymentDetails) String 

func (m UpdateDeploymentDetails) String() string

func (UpdateDeploymentDetails) ValidateEnumValue 

func (m UpdateDeploymentDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

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

UpdateDeploymentRequest wrapper for the UpdateDeployment operation

See also

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

func (UpdateDeploymentRequest) BinaryRequestBody 

func (request UpdateDeploymentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateDeploymentRequest) HTTPRequest 

func (request UpdateDeploymentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (UpdateDeploymentRequest) ValidateEnumValue 

func (request UpdateDeploymentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateDeploymentResponse 

type UpdateDeploymentResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

UpdateDeploymentResponse wrapper for the UpdateDeployment operation

func (UpdateDeploymentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateDeploymentResponse) String 

func (response UpdateDeploymentResponse) String() string

type UpdateGatewayDetails 

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

	// An array of Network Security Groups OCIDs associated with this API Gateway.
	NetworkSecurityGroupIds []string `mandatory:"false" json:"networkSecurityGroupIds"`

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

	ResponseCacheDetails ResponseCacheDetails `mandatory:"false" json:"responseCacheDetails"`

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

	// An array of CA bundles that should be used on the Gateway for TLS validation.
	CaBundles []CaBundle `mandatory:"false" json:"caBundles"`
}

UpdateGatewayDetails The information to be updated.

func (UpdateGatewayDetails) String 

func (m UpdateGatewayDetails) String() string

func (*UpdateGatewayDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

func (UpdateGatewayDetails) ValidateEnumValue 

func (m UpdateGatewayDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

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

UpdateGatewayRequest wrapper for the UpdateGateway operation

See also

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

func (UpdateGatewayRequest) BinaryRequestBody 

func (request UpdateGatewayRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateGatewayRequest) HTTPRequest 

func (request UpdateGatewayRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]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

func (UpdateGatewayRequest) ValidateEnumValue 

func (request UpdateGatewayRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateGatewayResponse 

type UpdateGatewayResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

UpdateGatewayResponse wrapper for the UpdateGateway operation

func (UpdateGatewayResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateGatewayResponse) String 

func (response UpdateGatewayResponse) String() string

type UpdateSdkDetails 

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

UpdateSdkDetails The information to be updated.

func (UpdateSdkDetails) String 

func (m UpdateSdkDetails) String() string

func (UpdateSdkDetails) ValidateEnumValue 

func (m UpdateSdkDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateSdkRequest 

type UpdateSdkRequest struct {

	// The ocid of the SDK.
	SdkId *string `mandatory:"true" contributesTo:"path" name:"sdkId"`

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

UpdateSdkRequest wrapper for the UpdateSdk operation

See also

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

func (UpdateSdkRequest) BinaryRequestBody 

func (request UpdateSdkRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateSdkRequest) HTTPRequest 

func (request UpdateSdkRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateSdkRequest) RetryPolicy 

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

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

func (UpdateSdkRequest) String 

func (request UpdateSdkRequest) String() string

func (UpdateSdkRequest) ValidateEnumValue 

func (request UpdateSdkRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateSdkResponse 

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

UpdateSdkResponse wrapper for the UpdateSdk operation

func (UpdateSdkResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateSdkResponse) String 

func (response UpdateSdkResponse) String() string

type UpdateSubscriberDetails added in v65.7.0 

type UpdateSubscriberDetails 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 clients belonging to the subscriber.
	Clients []Client `mandatory:"false" json:"clients"`

	// An array of OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)s of usage
	// plan resources.
	UsagePlans []string `mandatory:"false" json:"usagePlans"`

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

UpdateSubscriberDetails The information to be updated.

func (UpdateSubscriberDetails) String added in v65.7.0 

func (m UpdateSubscriberDetails) String() string

func (UpdateSubscriberDetails) ValidateEnumValue added in v65.7.0 

func (m UpdateSubscriberDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateSubscriberRequest added in v65.7.0 

type UpdateSubscriberRequest struct {

	// The ocid of the subscriber.
	SubscriberId *string `mandatory:"true" contributesTo:"path" name:"subscriberId"`

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

UpdateSubscriberRequest wrapper for the UpdateSubscriber operation

See also

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

func (UpdateSubscriberRequest) BinaryRequestBody added in v65.7.0 

func (request UpdateSubscriberRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateSubscriberRequest) HTTPRequest added in v65.7.0 

func (request UpdateSubscriberRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateSubscriberRequest) RetryPolicy added in v65.7.0 

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

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

func (UpdateSubscriberRequest) String added in v65.7.0 

func (request UpdateSubscriberRequest) String() string

func (UpdateSubscriberRequest) ValidateEnumValue added in v65.7.0 

func (request UpdateSubscriberRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateSubscriberResponse added in v65.7.0 

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

UpdateSubscriberResponse wrapper for the UpdateSubscriber operation

func (UpdateSubscriberResponse) HTTPResponse added in v65.7.0 

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

HTTPResponse implements the OCIResponse interface

func (UpdateSubscriberResponse) String added in v65.7.0 

func (response UpdateSubscriberResponse) String() string

type UpdateUsagePlanDetails added in v65.7.0 

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

	// A collection of entitlements to update the current usage plan with.
	Entitlements []Entitlement `mandatory:"false" json:"entitlements"`

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

UpdateUsagePlanDetails The information to be updated.

func (UpdateUsagePlanDetails) String added in v65.7.0 

func (m UpdateUsagePlanDetails) String() string

func (UpdateUsagePlanDetails) ValidateEnumValue added in v65.7.0 

func (m UpdateUsagePlanDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateUsagePlanRequest added in v65.7.0 

type UpdateUsagePlanRequest struct {

	// The ocid of the usage plan.
	UsagePlanId *string `mandatory:"true" contributesTo:"path" name:"usagePlanId"`

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

UpdateUsagePlanRequest wrapper for the UpdateUsagePlan operation

See also

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

func (UpdateUsagePlanRequest) BinaryRequestBody added in v65.7.0 

func (request UpdateUsagePlanRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateUsagePlanRequest) HTTPRequest added in v65.7.0 

func (request UpdateUsagePlanRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateUsagePlanRequest) RetryPolicy added in v65.7.0 

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

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

func (UpdateUsagePlanRequest) String added in v65.7.0 

func (request UpdateUsagePlanRequest) String() string

func (UpdateUsagePlanRequest) ValidateEnumValue added in v65.7.0 

func (request UpdateUsagePlanRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateUsagePlanResponse added in v65.7.0 

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

UpdateUsagePlanResponse wrapper for the UpdateUsagePlan operation

func (UpdateUsagePlanResponse) HTTPResponse added in v65.7.0 

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

HTTPResponse implements the OCIResponse interface

func (UpdateUsagePlanResponse) String added in v65.7.0 

func (response UpdateUsagePlanResponse) String() string

type UsagePlan added in v65.7.0 

type UsagePlan struct {

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

	// A collection of entitlements currently assigned to the usage plan.
	Entitlements []Entitlement `mandatory:"true" json:"entitlements"`

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

	// The current state of the usage plan.
	LifecycleState UsagePlanLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

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

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

UsagePlan A usage plan controls access of subscribers to deployments, controlling rate limits and quotas for usage.

func (UsagePlan) String added in v65.7.0 

func (m UsagePlan) String() string

func (UsagePlan) ValidateEnumValue added in v65.7.0 

func (m UsagePlan) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UsagePlanCollection added in v65.7.0 

type UsagePlanCollection struct {

	// Usage plan summaries.
	Items []UsagePlanSummary `mandatory:"true" json:"items"`
}

UsagePlanCollection Collection of usage plan summaries.

func (UsagePlanCollection) String added in v65.7.0 

func (m UsagePlanCollection) String() string

func (UsagePlanCollection) ValidateEnumValue added in v65.7.0 

func (m UsagePlanCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UsagePlanLifecycleStateEnum added in v65.7.0 

type UsagePlanLifecycleStateEnum string

UsagePlanLifecycleStateEnum Enum with underlying type: string 

const (
	UsagePlanLifecycleStateCreating UsagePlanLifecycleStateEnum = "CREATING"
	UsagePlanLifecycleStateActive   UsagePlanLifecycleStateEnum = "ACTIVE"
	UsagePlanLifecycleStateUpdating UsagePlanLifecycleStateEnum = "UPDATING"
	UsagePlanLifecycleStateDeleting UsagePlanLifecycleStateEnum = "DELETING"
	UsagePlanLifecycleStateDeleted  UsagePlanLifecycleStateEnum = "DELETED"
	UsagePlanLifecycleStateFailed   UsagePlanLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for UsagePlanLifecycleStateEnum

func GetMappingUsagePlanLifecycleStateEnum added in v65.7.0 

func GetMappingUsagePlanLifecycleStateEnum(val string) (UsagePlanLifecycleStateEnum, bool)

GetMappingUsagePlanLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetUsagePlanLifecycleStateEnumValues added in v65.7.0 

func GetUsagePlanLifecycleStateEnumValues() []UsagePlanLifecycleStateEnum

GetUsagePlanLifecycleStateEnumValues Enumerates the set of values for UsagePlanLifecycleStateEnum

type UsagePlanSummary added in v65.7.0 

type UsagePlanSummary struct {

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

	// A collection of entitlements applied by the usage plan.
	Entitlements []EntitlementSummary `mandatory:"true" json:"entitlements"`

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

	// The current state of the usage plan.
	LifecycleState UsagePlanLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

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

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

UsagePlanSummary A summary of the usage plan.

func (UsagePlanSummary) String added in v65.7.0 

func (m UsagePlanSummary) String() string

func (UsagePlanSummary) ValidateEnumValue added in v65.7.0 

func (m UsagePlanSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UsagePlansClient added in v65.7.0 

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

UsagePlansClient a client for UsagePlans

func NewUsagePlansClientWithConfigurationProvider added in v65.7.0 

func NewUsagePlansClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client UsagePlansClient, err error)

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

func NewUsagePlansClientWithOboToken added in v65.7.0 

func NewUsagePlansClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client UsagePlansClient, err error)

NewUsagePlansClientWithOboToken Creates a new default UsagePlans 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 (UsagePlansClient) ChangeUsagePlanCompartment added in v65.7.0 

func (client UsagePlansClient) ChangeUsagePlanCompartment(ctx context.Context, request ChangeUsagePlanCompartmentRequest) (response ChangeUsagePlanCompartmentResponse, err error)

ChangeUsagePlanCompartment Changes the usage plan compartment.

See also

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

func (*UsagePlansClient) ConfigurationProvider added in v65.7.0 

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

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

func (UsagePlansClient) CreateUsagePlan added in v65.7.0 

func (client UsagePlansClient) CreateUsagePlan(ctx context.Context, request CreateUsagePlanRequest) (response CreateUsagePlanResponse, err error)

CreateUsagePlan Creates a new usage plan.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apigateway/CreateUsagePlan.go.html to see an example of how to use CreateUsagePlan API. A default retry strategy applies to this operation CreateUsagePlan()

func (UsagePlansClient) DeleteUsagePlan added in v65.7.0 

func (client UsagePlansClient) DeleteUsagePlan(ctx context.Context, request DeleteUsagePlanRequest) (response DeleteUsagePlanResponse, err error)

DeleteUsagePlan Deletes the usage plan with the given identifier.

See also

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

func (UsagePlansClient) GetUsagePlan added in v65.7.0 

func (client UsagePlansClient) GetUsagePlan(ctx context.Context, request GetUsagePlanRequest) (response GetUsagePlanResponse, err error)

GetUsagePlan Gets a usage plan by identifier.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apigateway/GetUsagePlan.go.html to see an example of how to use GetUsagePlan API. A default retry strategy applies to this operation GetUsagePlan()

func (UsagePlansClient) ListUsagePlans added in v65.7.0 

func (client UsagePlansClient) ListUsagePlans(ctx context.Context, request ListUsagePlansRequest) (response ListUsagePlansResponse, err error)

ListUsagePlans Returns a list of usage plans.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/apigateway/ListUsagePlans.go.html to see an example of how to use ListUsagePlans API. A default retry strategy applies to this operation ListUsagePlans()

func (*UsagePlansClient) SetRegion added in v65.7.0 

func (client *UsagePlansClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (UsagePlansClient) UpdateUsagePlan added in v65.7.0 

func (client UsagePlansClient) UpdateUsagePlan(ctx context.Context, request UpdateUsagePlanRequest) (response UpdateUsagePlanResponse, err error)

UpdateUsagePlan Updates the usage plan with the given identifier.

See also

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

type UsagePlansPolicy added in v65.7.0 

type UsagePlansPolicy struct {

	// A list of context variables specifying where API tokens may be located in a request.
	// Example locations:
	//   - "request.headers[token]"
	//   - "request.query[token]"
	//   - "request.auth[Token]"
	//   - "request.path[TOKEN]"
	TokenLocations []string `mandatory:"true" json:"tokenLocations"`
}

UsagePlansPolicy Usage plan policies for this deployment

func (UsagePlansPolicy) String added in v65.7.0 

func (m UsagePlansPolicy) String() string

func (UsagePlansPolicy) ValidateEnumValue added in v65.7.0 

func (m UsagePlansPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ValidationBlockClientAppDetails added in v65.27.0 

type ValidationBlockClientAppDetails struct {
}

ValidationBlockClientAppDetails Client App Credentials to be used from validation block.

func (ValidationBlockClientAppDetails) MarshalJSON added in v65.27.0 

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

MarshalJSON marshals to json representation

func (ValidationBlockClientAppDetails) String added in v65.27.0 

func (m ValidationBlockClientAppDetails) String() string

func (ValidationBlockClientAppDetails) ValidateEnumValue added in v65.27.0 

func (m ValidationBlockClientAppDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ValidationBlockSourceUriDetails added in v65.27.0 

type ValidationBlockSourceUriDetails struct {
}

ValidationBlockSourceUriDetails Source Uri information to be used from validation block.

func (ValidationBlockSourceUriDetails) MarshalJSON added in v65.27.0 

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

MarshalJSON marshals to json representation

func (ValidationBlockSourceUriDetails) String added in v65.27.0 

func (m ValidationBlockSourceUriDetails) String() string

func (ValidationBlockSourceUriDetails) ValidateEnumValue added in v65.27.0 

func (m ValidationBlockSourceUriDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ValidationFailurePolicy added in v65.20.0 

type ValidationFailurePolicy interface {
}

ValidationFailurePolicy Policy for defining behaviour on validation failure.

type ValidationFailurePolicyTypeEnum added in v65.20.0 

type ValidationFailurePolicyTypeEnum string

ValidationFailurePolicyTypeEnum Enum with underlying type: string 

const (
	ValidationFailurePolicyTypeModifyResponse ValidationFailurePolicyTypeEnum = "MODIFY_RESPONSE"
	ValidationFailurePolicyTypeOauth2         ValidationFailurePolicyTypeEnum = "OAUTH2"
)

Set of constants representing the allowable values for ValidationFailurePolicyTypeEnum

func GetMappingValidationFailurePolicyTypeEnum added in v65.20.0 

func GetMappingValidationFailurePolicyTypeEnum(val string) (ValidationFailurePolicyTypeEnum, bool)

GetMappingValidationFailurePolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetValidationFailurePolicyTypeEnumValues added in v65.20.0 

func GetValidationFailurePolicyTypeEnumValues() []ValidationFailurePolicyTypeEnum

GetValidationFailurePolicyTypeEnumValues Enumerates the set of values for ValidationFailurePolicyTypeEnum

type ValidationRequestPolicy 

type ValidationRequestPolicy struct {

	// Validation behavior mode.
	// In `ENFORCING` mode, upon a validation failure, the request will be rejected with a 4xx response
	// and not sent to the backend.
	// In `PERMISSIVE` mode, the result of the validation will be exposed as metrics while the request
	// will follow the normal path.
	// `DISABLED` type turns the validation off.
	ValidationMode ValidationRequestPolicyValidationModeEnum `mandatory:"false" json:"validationMode,omitempty"`
}

ValidationRequestPolicy Top-level validation policy mixin (not directly used).

func (ValidationRequestPolicy) String 

func (m ValidationRequestPolicy) String() string

func (ValidationRequestPolicy) ValidateEnumValue 

func (m ValidationRequestPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ValidationRequestPolicyValidationModeEnum 

type ValidationRequestPolicyValidationModeEnum string

ValidationRequestPolicyValidationModeEnum Enum with underlying type: string 

const (
	ValidationRequestPolicyValidationModeEnforcing  ValidationRequestPolicyValidationModeEnum = "ENFORCING"
	ValidationRequestPolicyValidationModePermissive ValidationRequestPolicyValidationModeEnum = "PERMISSIVE"
	ValidationRequestPolicyValidationModeDisabled   ValidationRequestPolicyValidationModeEnum = "DISABLED"
)

Set of constants representing the allowable values for ValidationRequestPolicyValidationModeEnum

func GetMappingValidationRequestPolicyValidationModeEnum 

func GetMappingValidationRequestPolicyValidationModeEnum(val string) (ValidationRequestPolicyValidationModeEnum, bool)

GetMappingValidationRequestPolicyValidationModeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetValidationRequestPolicyValidationModeEnumValues 

func GetValidationRequestPolicyValidationModeEnumValues() []ValidationRequestPolicyValidationModeEnum

GetValidationRequestPolicyValidationModeEnumValues Enumerates the set of values for ValidationRequestPolicyValidationModeEnum

type WildcardSelectionKey added in v65.20.0 

type WildcardSelectionKey struct {

	// Name assigned to the branch.
	Name *string `mandatory:"true" json:"name"`

	// A selection key string containing a wildcard to match with the context variable in an incoming request. If the context variable matches the string, the request is sent to the route or authentication server associated with the selection key. Valid wildcards are '*' (zero or more characters) and '+' (one or more characters). The string can only contain one wildcard, and the wildcard must be at the start or the end of the string.
	Expression *string `mandatory:"true" json:"expression"`

	// Specifies whether to use the route or authentication server associated with this selection key as the default. The default is used if the value of a context variable in an incoming request does not match any of the other selection key values when dynamically routing and dynamically authenticating requests.
	IsDefault *bool `mandatory:"false" json:"isDefault"`
}

WildcardSelectionKey When dynamically routing and dynamically authenticating requests, the route or authentication server associated with a selection key containing a wildcard is used if the context variable in an incoming request matches that key.

func (WildcardSelectionKey) GetIsDefault added in v65.20.0 

func (m WildcardSelectionKey) GetIsDefault() *bool

GetIsDefault returns IsDefault

func (WildcardSelectionKey) GetName added in v65.20.0 

func (m WildcardSelectionKey) GetName() *string

GetName returns Name

func (WildcardSelectionKey) MarshalJSON added in v65.20.0 

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

MarshalJSON marshals to json representation

func (WildcardSelectionKey) String added in v65.20.0 

func (m WildcardSelectionKey) String() string

func (WildcardSelectionKey) ValidateEnumValue added in v65.20.0 

func (m WildcardSelectionKey) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequest 

type WorkRequest struct {

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

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

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

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

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

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

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

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

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

WorkRequest A description of the work request status.

func (WorkRequest) String 

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue 

func (m WorkRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestCollection 

type WorkRequestCollection struct {

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

WorkRequestCollection Collection of work request summaries.

func (WorkRequestCollection) String 

func (m WorkRequestCollection) String() string

func (WorkRequestCollection) ValidateEnumValue 

func (m WorkRequestCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestError 

type WorkRequestError struct {

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

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

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

WorkRequestError An error encountered while executing a work request.

func (WorkRequestError) String 

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue 

func (m WorkRequestError) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestErrorCollection 

type WorkRequestErrorCollection struct {

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

WorkRequestErrorCollection Collection of work request errors.

func (WorkRequestErrorCollection) String 

func (m WorkRequestErrorCollection) String() string

func (WorkRequestErrorCollection) ValidateEnumValue 

func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestLog 

type WorkRequestLog struct {

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

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

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

func (WorkRequestLog) String 

func (m WorkRequestLog) String() string

func (WorkRequestLog) ValidateEnumValue 

func (m WorkRequestLog) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestLogCollection 

type WorkRequestLogCollection struct {

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

WorkRequestLogCollection Collection of work request logs.

func (WorkRequestLogCollection) String 

func (m WorkRequestLogCollection) String() string

func (WorkRequestLogCollection) ValidateEnumValue 

func (m WorkRequestLogCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestOperationTypeEnum 

type WorkRequestOperationTypeEnum string

WorkRequestOperationTypeEnum Enum with underlying type: string 

const (
	WorkRequestOperationTypeCreateGateway     WorkRequestOperationTypeEnum = "CREATE_GATEWAY"
	WorkRequestOperationTypeUpdateGateway     WorkRequestOperationTypeEnum = "UPDATE_GATEWAY"
	WorkRequestOperationTypeDeleteGateway     WorkRequestOperationTypeEnum = "DELETE_GATEWAY"
	WorkRequestOperationTypeCreateDeployment  WorkRequestOperationTypeEnum = "CREATE_DEPLOYMENT"
	WorkRequestOperationTypeUpdateDeployment  WorkRequestOperationTypeEnum = "UPDATE_DEPLOYMENT"
	WorkRequestOperationTypeDeleteDeployment  WorkRequestOperationTypeEnum = "DELETE_DEPLOYMENT"
	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"
	WorkRequestOperationTypeCreateSdk         WorkRequestOperationTypeEnum = "CREATE_SDK"
	WorkRequestOperationTypeDeleteSdk         WorkRequestOperationTypeEnum = "DELETE_SDK"
	WorkRequestOperationTypeCreateUsagePlan   WorkRequestOperationTypeEnum = "CREATE_USAGE_PLAN"
	WorkRequestOperationTypeUpdateUsagePlan   WorkRequestOperationTypeEnum = "UPDATE_USAGE_PLAN"
	WorkRequestOperationTypeDeleteUsagePlan   WorkRequestOperationTypeEnum = "DELETE_USAGE_PLAN"
	WorkRequestOperationTypeCreateSubscriber  WorkRequestOperationTypeEnum = "CREATE_SUBSCRIBER"
	WorkRequestOperationTypeUpdateSubscriber  WorkRequestOperationTypeEnum = "UPDATE_SUBSCRIBER"
	WorkRequestOperationTypeDeleteSubscriber  WorkRequestOperationTypeEnum = "DELETE_SUBSCRIBER"
)

Set of constants representing the allowable values for WorkRequestOperationTypeEnum

func GetMappingWorkRequestOperationTypeEnum 

func GetMappingWorkRequestOperationTypeEnum(val string) (WorkRequestOperationTypeEnum, bool)

GetMappingWorkRequestOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestOperationTypeEnumValues 

func GetWorkRequestOperationTypeEnumValues() []WorkRequestOperationTypeEnum

GetWorkRequestOperationTypeEnumValues Enumerates the set of values for WorkRequestOperationTypeEnum

type WorkRequestResource 

type WorkRequestResource struct {

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

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

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

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

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

func (WorkRequestResource) String 

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue 

func (m WorkRequestResource) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestResourceActionTypeEnum 

type WorkRequestResourceActionTypeEnum string

WorkRequestResourceActionTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum

func GetMappingWorkRequestResourceActionTypeEnum 

func GetMappingWorkRequestResourceActionTypeEnum(val string) (WorkRequestResourceActionTypeEnum, bool)

GetMappingWorkRequestResourceActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestResourceActionTypeEnumValues 

func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum

GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum

type WorkRequestStatusEnum 

type WorkRequestStatusEnum string

WorkRequestStatusEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for WorkRequestStatusEnum

func GetMappingWorkRequestStatusEnum 

func GetMappingWorkRequestStatusEnum(val string) (WorkRequestStatusEnum, bool)

GetMappingWorkRequestStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestStatusEnumValues 

func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum

GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum

type WorkRequestSummary 

type WorkRequestSummary struct {

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

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

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

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

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

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

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

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

WorkRequestSummary A summary of the work request.

func (WorkRequestSummary) String 

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue 

func (m WorkRequestSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestsClient 

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

WorkRequestsClient a client for WorkRequests

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/latest/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/latest/apigateway/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()

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/latest/apigateway/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()

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/latest/apigateway/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()

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/latest/apigateway/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()

func (*WorkRequestsClient) SetRegion 

func (client *WorkRequestsClient) SetRegion(region string)

SetRegion overrides the region of this client.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.