func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetAddDrgRouteDistributionStatementDetailsActionEnumStringValues() []string
GetAddDrgRouteDistributionStatementDetailsActionEnumStringValues Enumerates the set of values in String for AddDrgRouteDistributionStatementDetailsActionEnum
func GetAddDrgRouteRuleDetailsDestinationTypeEnumStringValues() []string
GetAddDrgRouteRuleDetailsDestinationTypeEnumStringValues Enumerates the set of values in String for AddDrgRouteRuleDetailsDestinationTypeEnum
func GetAddSecurityRuleDetailsDestinationTypeEnumStringValues() []string
GetAddSecurityRuleDetailsDestinationTypeEnumStringValues Enumerates the set of values in String for AddSecurityRuleDetailsDestinationTypeEnum
func GetAddSecurityRuleDetailsDirectionEnumStringValues() []string
GetAddSecurityRuleDetailsDirectionEnumStringValues Enumerates the set of values in String for AddSecurityRuleDetailsDirectionEnum
func GetAddSecurityRuleDetailsSourceTypeEnumStringValues() []string
GetAddSecurityRuleDetailsSourceTypeEnumStringValues Enumerates the set of values in String for AddSecurityRuleDetailsSourceTypeEnum
func GetAllowedSecurityConfigurationTypeEnumStringValues() []string
GetAllowedSecurityConfigurationTypeEnumStringValues Enumerates the set of values in String for AllowedSecurityConfigurationTypeEnum
func GetBgpSessionInfoBgpIpv6StateEnumStringValues() []string
GetBgpSessionInfoBgpIpv6StateEnumStringValues Enumerates the set of values in String for BgpSessionInfoBgpIpv6StateEnum
func GetBgpSessionInfoBgpStateEnumStringValues() []string
GetBgpSessionInfoBgpStateEnumStringValues Enumerates the set of values in String for BgpSessionInfoBgpStateEnum
func GetByoipRangeLifecycleDetailsEnumStringValues() []string
GetByoipRangeLifecycleDetailsEnumStringValues Enumerates the set of values in String for ByoipRangeLifecycleDetailsEnum
func GetByoipRangeLifecycleStateEnumStringValues() []string
GetByoipRangeLifecycleStateEnumStringValues Enumerates the set of values in String for ByoipRangeLifecycleStateEnum
func GetCaptureFilterFilterTypeEnumStringValues() []string
GetCaptureFilterFilterTypeEnumStringValues Enumerates the set of values in String for CaptureFilterFilterTypeEnum
func GetCaptureFilterLifecycleStateEnumStringValues() []string
GetCaptureFilterLifecycleStateEnumStringValues Enumerates the set of values in String for CaptureFilterLifecycleStateEnum
func GetCreateCaptureFilterDetailsFilterTypeEnumStringValues() []string
GetCreateCaptureFilterDetailsFilterTypeEnumStringValues Enumerates the set of values in String for CreateCaptureFilterDetailsFilterTypeEnum
func GetCreateDhcpDetailsDomainNameTypeEnumStringValues() []string
GetCreateDhcpDetailsDomainNameTypeEnumStringValues Enumerates the set of values in String for CreateDhcpDetailsDomainNameTypeEnum
func GetCreateDrgRouteDistributionDetailsDistributionTypeEnumStringValues() []string
GetCreateDrgRouteDistributionDetailsDistributionTypeEnumStringValues Enumerates the set of values in String for CreateDrgRouteDistributionDetailsDistributionTypeEnum
func GetCreateIpSecConnectionDetailsCpeLocalIdentifierTypeEnumStringValues() []string
GetCreateIpSecConnectionDetailsCpeLocalIdentifierTypeEnumStringValues Enumerates the set of values in String for CreateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum
func GetCreateIpSecConnectionTunnelDetailsIkeVersionEnumStringValues() []string
GetCreateIpSecConnectionTunnelDetailsIkeVersionEnumStringValues Enumerates the set of values in String for CreateIpSecConnectionTunnelDetailsIkeVersionEnum
func GetCreateIpSecConnectionTunnelDetailsNatTranslationEnabledEnumStringValues() []string
GetCreateIpSecConnectionTunnelDetailsNatTranslationEnabledEnumStringValues Enumerates the set of values in String for CreateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum
func GetCreateIpSecConnectionTunnelDetailsOracleInitiationEnumStringValues() []string
GetCreateIpSecConnectionTunnelDetailsOracleInitiationEnumStringValues Enumerates the set of values in String for CreateIpSecConnectionTunnelDetailsOracleInitiationEnum
func GetCreateIpSecConnectionTunnelDetailsRoutingEnumStringValues() []string
GetCreateIpSecConnectionTunnelDetailsRoutingEnumStringValues Enumerates the set of values in String for CreateIpSecConnectionTunnelDetailsRoutingEnum
func GetCreatePublicIpDetailsLifetimeEnumStringValues() []string
GetCreatePublicIpDetailsLifetimeEnumStringValues Enumerates the set of values in String for CreatePublicIpDetailsLifetimeEnum
func GetCreateVirtualCircuitDetailsBgpAdminStateEnumStringValues() []string
GetCreateVirtualCircuitDetailsBgpAdminStateEnumStringValues Enumerates the set of values in String for CreateVirtualCircuitDetailsBgpAdminStateEnum
func GetCreateVirtualCircuitDetailsRoutingPolicyEnumStringValues() []string
GetCreateVirtualCircuitDetailsRoutingPolicyEnumStringValues Enumerates the set of values in String for CreateVirtualCircuitDetailsRoutingPolicyEnum
func GetCreateVirtualCircuitDetailsTypeEnumStringValues() []string
GetCreateVirtualCircuitDetailsTypeEnumStringValues Enumerates the set of values in String for CreateVirtualCircuitDetailsTypeEnum
func GetCreateVtapDetailsEncapsulationProtocolEnumStringValues() []string
GetCreateVtapDetailsEncapsulationProtocolEnumStringValues Enumerates the set of values in String for CreateVtapDetailsEncapsulationProtocolEnum
func GetCreateVtapDetailsSourceTypeEnumStringValues() []string
GetCreateVtapDetailsSourceTypeEnumStringValues Enumerates the set of values in String for CreateVtapDetailsSourceTypeEnum
func GetCreateVtapDetailsTargetTypeEnumStringValues() []string
GetCreateVtapDetailsTargetTypeEnumStringValues Enumerates the set of values in String for CreateVtapDetailsTargetTypeEnum
func GetCreateVtapDetailsTrafficModeEnumStringValues() []string
GetCreateVtapDetailsTrafficModeEnumStringValues Enumerates the set of values in String for CreateVtapDetailsTrafficModeEnum
func GetCrossConnectGroupLifecycleStateEnumStringValues() []string
GetCrossConnectGroupLifecycleStateEnumStringValues Enumerates the set of values in String for CrossConnectGroupLifecycleStateEnum
func GetCrossConnectLifecycleStateEnumStringValues() []string
GetCrossConnectLifecycleStateEnumStringValues Enumerates the set of values in String for CrossConnectLifecycleStateEnum
func GetCrossConnectMappingDetailsIpv4BgpStatusEnumStringValues() []string
GetCrossConnectMappingDetailsIpv4BgpStatusEnumStringValues Enumerates the set of values in String for CrossConnectMappingDetailsIpv4BgpStatusEnum
func GetCrossConnectMappingDetailsIpv6BgpStatusEnumStringValues() []string
GetCrossConnectMappingDetailsIpv6BgpStatusEnumStringValues Enumerates the set of values in String for CrossConnectMappingDetailsIpv6BgpStatusEnum
func GetCrossConnectStatusEncryptionStatusEnumStringValues() []string
GetCrossConnectStatusEncryptionStatusEnumStringValues Enumerates the set of values in String for CrossConnectStatusEncryptionStatusEnum
func GetCrossConnectStatusInterfaceStateEnumStringValues() []string
GetCrossConnectStatusInterfaceStateEnumStringValues Enumerates the set of values in String for CrossConnectStatusInterfaceStateEnum
func GetCrossConnectStatusLightLevelIndicatorEnumStringValues() []string
GetCrossConnectStatusLightLevelIndicatorEnumStringValues Enumerates the set of values in String for CrossConnectStatusLightLevelIndicatorEnum
func GetDhcpDnsOptionServerTypeEnumStringValues() []string
GetDhcpDnsOptionServerTypeEnumStringValues Enumerates the set of values in String for DhcpDnsOptionServerTypeEnum
func GetDhcpOptionsDomainNameTypeEnumStringValues() []string
GetDhcpOptionsDomainNameTypeEnumStringValues Enumerates the set of values in String for DhcpOptionsDomainNameTypeEnum
func GetDhcpOptionsLifecycleStateEnumStringValues() []string
GetDhcpOptionsLifecycleStateEnumStringValues Enumerates the set of values in String for DhcpOptionsLifecycleStateEnum
func GetDpdConfigDpdModeEnumStringValues() []string
GetDpdConfigDpdModeEnumStringValues Enumerates the set of values in String for DpdConfigDpdModeEnum
func GetDrgAttachmentLifecycleStateEnumStringValues() []string
GetDrgAttachmentLifecycleStateEnumStringValues Enumerates the set of values in String for DrgAttachmentLifecycleStateEnum
func GetDrgAttachmentNetworkCreateDetailsTypeEnumStringValues() []string
GetDrgAttachmentNetworkCreateDetailsTypeEnumStringValues Enumerates the set of values in String for DrgAttachmentNetworkCreateDetailsTypeEnum
func GetDrgAttachmentNetworkDetailsTypeEnumStringValues() []string
GetDrgAttachmentNetworkDetailsTypeEnumStringValues Enumerates the set of values in String for DrgAttachmentNetworkDetailsTypeEnum
func GetDrgAttachmentNetworkUpdateDetailsTypeEnumStringValues() []string
GetDrgAttachmentNetworkUpdateDetailsTypeEnumStringValues Enumerates the set of values in String for DrgAttachmentNetworkUpdateDetailsTypeEnum
func GetDrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeEnumStringValues() []string
GetDrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeEnumStringValues Enumerates the set of values in String for DrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeEnum
func GetDrgLifecycleStateEnumStringValues() []string
GetDrgLifecycleStateEnumStringValues Enumerates the set of values in String for DrgLifecycleStateEnum
func GetDrgRedundancyStatusStatusEnumStringValues() []string
GetDrgRedundancyStatusStatusEnumStringValues Enumerates the set of values in String for DrgRedundancyStatusStatusEnum
func GetDrgRouteDistributionDistributionTypeEnumStringValues() []string
GetDrgRouteDistributionDistributionTypeEnumStringValues Enumerates the set of values in String for DrgRouteDistributionDistributionTypeEnum
func GetDrgRouteDistributionLifecycleStateEnumStringValues() []string
GetDrgRouteDistributionLifecycleStateEnumStringValues Enumerates the set of values in String for DrgRouteDistributionLifecycleStateEnum
func GetDrgRouteDistributionMatchCriteriaMatchTypeEnumStringValues() []string
GetDrgRouteDistributionMatchCriteriaMatchTypeEnumStringValues Enumerates the set of values in String for DrgRouteDistributionMatchCriteriaMatchTypeEnum
func GetDrgRouteDistributionStatementActionEnumStringValues() []string
GetDrgRouteDistributionStatementActionEnumStringValues Enumerates the set of values in String for DrgRouteDistributionStatementActionEnum
func GetDrgRouteRuleDestinationTypeEnumStringValues() []string
GetDrgRouteRuleDestinationTypeEnumStringValues Enumerates the set of values in String for DrgRouteRuleDestinationTypeEnum
func GetDrgRouteRuleRouteProvenanceEnumStringValues() []string
GetDrgRouteRuleRouteProvenanceEnumStringValues Enumerates the set of values in String for DrgRouteRuleRouteProvenanceEnum
func GetDrgRouteRuleRouteTypeEnumStringValues() []string
GetDrgRouteRuleRouteTypeEnumStringValues Enumerates the set of values in String for DrgRouteRuleRouteTypeEnum
func GetDrgRouteTableLifecycleStateEnumStringValues() []string
GetDrgRouteTableLifecycleStateEnumStringValues Enumerates the set of values in String for DrgRouteTableLifecycleStateEnum
func GetEgressSecurityRuleDestinationTypeEnumStringValues() []string
GetEgressSecurityRuleDestinationTypeEnumStringValues Enumerates the set of values in String for EgressSecurityRuleDestinationTypeEnum
func GetEndpointTypeEnumStringValues() []string
GetEndpointTypeEnumStringValues Enumerates the set of values in String for EndpointTypeEnum
func GetFastConnectProviderServiceBandwithShapeManagementEnumStringValues() []string
GetFastConnectProviderServiceBandwithShapeManagementEnumStringValues Enumerates the set of values in String for FastConnectProviderServiceBandwithShapeManagementEnum
func GetFastConnectProviderServiceCustomerAsnManagementEnumStringValues() []string
GetFastConnectProviderServiceCustomerAsnManagementEnumStringValues Enumerates the set of values in String for FastConnectProviderServiceCustomerAsnManagementEnum
func GetFastConnectProviderServicePrivatePeeringBgpManagementEnumStringValues() []string
GetFastConnectProviderServicePrivatePeeringBgpManagementEnumStringValues Enumerates the set of values in String for FastConnectProviderServicePrivatePeeringBgpManagementEnum
func GetFastConnectProviderServiceProviderServiceKeyManagementEnumStringValues() []string
GetFastConnectProviderServiceProviderServiceKeyManagementEnumStringValues Enumerates the set of values in String for FastConnectProviderServiceProviderServiceKeyManagementEnum
func GetFastConnectProviderServicePublicPeeringBgpManagementEnumStringValues() []string
GetFastConnectProviderServicePublicPeeringBgpManagementEnumStringValues Enumerates the set of values in String for FastConnectProviderServicePublicPeeringBgpManagementEnum
func GetFastConnectProviderServiceSupportedVirtualCircuitTypesEnumStringValues() []string
GetFastConnectProviderServiceSupportedVirtualCircuitTypesEnumStringValues Enumerates the set of values in String for FastConnectProviderServiceSupportedVirtualCircuitTypesEnum
func GetFastConnectProviderServiceTypeEnumStringValues() []string
GetFastConnectProviderServiceTypeEnumStringValues Enumerates the set of values in String for FastConnectProviderServiceTypeEnum
func GetFlowLogCaptureFilterRuleDetailsFlowLogTypeEnumStringValues() []string
GetFlowLogCaptureFilterRuleDetailsFlowLogTypeEnumStringValues Enumerates the set of values in String for FlowLogCaptureFilterRuleDetailsFlowLogTypeEnum
func GetFlowLogCaptureFilterRuleDetailsRuleActionEnumStringValues() []string
GetFlowLogCaptureFilterRuleDetailsRuleActionEnumStringValues Enumerates the set of values in String for FlowLogCaptureFilterRuleDetailsRuleActionEnum
func GetForwardedRoutingConfigurationTypeEnumStringValues() []string
GetForwardedRoutingConfigurationTypeEnumStringValues Enumerates the set of values in String for ForwardedRoutingConfigurationTypeEnum
func GetGetPathAnalysisDetailsTypeEnumStringValues() []string
GetGetPathAnalysisDetailsTypeEnumStringValues Enumerates the set of values in String for GetPathAnalysisDetailsTypeEnum
func GetIngressSecurityRuleSourceTypeEnumStringValues() []string
GetIngressSecurityRuleSourceTypeEnumStringValues Enumerates the set of values in String for IngressSecurityRuleSourceTypeEnum
func GetInternetGatewayLifecycleStateEnumStringValues() []string
GetInternetGatewayLifecycleStateEnumStringValues Enumerates the set of values in String for InternetGatewayLifecycleStateEnum
func GetIpSecConnectionCpeLocalIdentifierTypeEnumStringValues() []string
GetIpSecConnectionCpeLocalIdentifierTypeEnumStringValues Enumerates the set of values in String for IpSecConnectionCpeLocalIdentifierTypeEnum
func GetIpSecConnectionLifecycleStateEnumStringValues() []string
GetIpSecConnectionLifecycleStateEnumStringValues Enumerates the set of values in String for IpSecConnectionLifecycleStateEnum
func GetIpSecConnectionTransportTypeEnumStringValues() []string
GetIpSecConnectionTransportTypeEnumStringValues Enumerates the set of values in String for IpSecConnectionTransportTypeEnum
func GetIpSecConnectionTunnelDpdModeEnumStringValues() []string
GetIpSecConnectionTunnelDpdModeEnumStringValues Enumerates the set of values in String for IpSecConnectionTunnelDpdModeEnum
func GetIpSecConnectionTunnelIkeVersionEnumStringValues() []string
GetIpSecConnectionTunnelIkeVersionEnumStringValues Enumerates the set of values in String for IpSecConnectionTunnelIkeVersionEnum
func GetIpSecConnectionTunnelLifecycleStateEnumStringValues() []string
GetIpSecConnectionTunnelLifecycleStateEnumStringValues Enumerates the set of values in String for IpSecConnectionTunnelLifecycleStateEnum
func GetIpSecConnectionTunnelNatTranslationEnabledEnumStringValues() []string
GetIpSecConnectionTunnelNatTranslationEnabledEnumStringValues Enumerates the set of values in String for IpSecConnectionTunnelNatTranslationEnabledEnum
func GetIpSecConnectionTunnelOracleCanInitiateEnumStringValues() []string
GetIpSecConnectionTunnelOracleCanInitiateEnumStringValues Enumerates the set of values in String for IpSecConnectionTunnelOracleCanInitiateEnum
func GetIpSecConnectionTunnelRoutingEnumStringValues() []string
GetIpSecConnectionTunnelRoutingEnumStringValues Enumerates the set of values in String for IpSecConnectionTunnelRoutingEnum
func GetIpSecConnectionTunnelStatusEnumStringValues() []string
GetIpSecConnectionTunnelStatusEnumStringValues Enumerates the set of values in String for IpSecConnectionTunnelStatusEnum
func GetIpv6LifecycleStateEnumStringValues() []string
GetIpv6LifecycleStateEnumStringValues Enumerates the set of values in String for Ipv6LifecycleStateEnum
func GetLetterOfAuthorityCircuitTypeEnumStringValues() []string
GetLetterOfAuthorityCircuitTypeEnumStringValues Enumerates the set of values in String for LetterOfAuthorityCircuitTypeEnum
func GetListPathAnalyzerTestsSortByEnumStringValues() []string
GetListPathAnalyzerTestsSortByEnumStringValues Enumerates the set of values in String for ListPathAnalyzerTestsSortByEnum
func GetListPathAnalyzerTestsSortOrderEnumStringValues() []string
GetListPathAnalyzerTestsSortOrderEnumStringValues Enumerates the set of values in String for ListPathAnalyzerTestsSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetLocalPeeringGatewayLifecycleStateEnumStringValues() []string
GetLocalPeeringGatewayLifecycleStateEnumStringValues Enumerates the set of values in String for LocalPeeringGatewayLifecycleStateEnum
func GetLocalPeeringGatewayPeeringStatusEnumStringValues() []string
GetLocalPeeringGatewayPeeringStatusEnumStringValues Enumerates the set of values in String for LocalPeeringGatewayPeeringStatusEnum
func GetMacsecEncryptionCipherEnumStringValues() []string
GetMacsecEncryptionCipherEnumStringValues Enumerates the set of values in String for MacsecEncryptionCipherEnum
func GetMacsecStateEnumStringValues() []string
GetMacsecStateEnumStringValues Enumerates the set of values in String for MacsecStateEnum
func GetNatGatewayLifecycleStateEnumStringValues() []string
GetNatGatewayLifecycleStateEnumStringValues Enumerates the set of values in String for NatGatewayLifecycleStateEnum
func GetNetworkSecurityGroupLifecycleStateEnumStringValues() []string
GetNetworkSecurityGroupLifecycleStateEnumStringValues Enumerates the set of values in String for NetworkSecurityGroupLifecycleStateEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetPathAnalyzerTestLifecycleStateEnumStringValues() []string
GetPathAnalyzerTestLifecycleStateEnumStringValues Enumerates the set of values in String for PathAnalyzerTestLifecycleStateEnum
func GetPhaseOneConfigDetailsAuthenticationAlgorithmEnumStringValues() []string
GetPhaseOneConfigDetailsAuthenticationAlgorithmEnumStringValues Enumerates the set of values in String for PhaseOneConfigDetailsAuthenticationAlgorithmEnum
func GetPhaseOneConfigDetailsDiffieHelmanGroupEnumStringValues() []string
GetPhaseOneConfigDetailsDiffieHelmanGroupEnumStringValues Enumerates the set of values in String for PhaseOneConfigDetailsDiffieHelmanGroupEnum
func GetPhaseOneConfigDetailsEncryptionAlgorithmEnumStringValues() []string
GetPhaseOneConfigDetailsEncryptionAlgorithmEnumStringValues Enumerates the set of values in String for PhaseOneConfigDetailsEncryptionAlgorithmEnum
func GetPhaseTwoConfigDetailsAuthenticationAlgorithmEnumStringValues() []string
GetPhaseTwoConfigDetailsAuthenticationAlgorithmEnumStringValues Enumerates the set of values in String for PhaseTwoConfigDetailsAuthenticationAlgorithmEnum
func GetPhaseTwoConfigDetailsEncryptionAlgorithmEnumStringValues() []string
GetPhaseTwoConfigDetailsEncryptionAlgorithmEnumStringValues Enumerates the set of values in String for PhaseTwoConfigDetailsEncryptionAlgorithmEnum
func GetPhaseTwoConfigDetailsPfsDhGroupEnumStringValues() []string
GetPhaseTwoConfigDetailsPfsDhGroupEnumStringValues Enumerates the set of values in String for PhaseTwoConfigDetailsPfsDhGroupEnum
func GetProtocolParametersTypeEnumStringValues() []string
GetProtocolParametersTypeEnumStringValues Enumerates the set of values in String for ProtocolParametersTypeEnum
func GetPublicIpAssignedEntityTypeEnumStringValues() []string
GetPublicIpAssignedEntityTypeEnumStringValues Enumerates the set of values in String for PublicIpAssignedEntityTypeEnum
func GetPublicIpLifecycleStateEnumStringValues() []string
GetPublicIpLifecycleStateEnumStringValues Enumerates the set of values in String for PublicIpLifecycleStateEnum
func GetPublicIpLifetimeEnumStringValues() []string
GetPublicIpLifetimeEnumStringValues Enumerates the set of values in String for PublicIpLifetimeEnum
func GetPublicIpPoolLifecycleStateEnumStringValues() []string
GetPublicIpPoolLifecycleStateEnumStringValues Enumerates the set of values in String for PublicIpPoolLifecycleStateEnum
func GetPublicIpScopeEnumStringValues() []string
GetPublicIpScopeEnumStringValues Enumerates the set of values in String for PublicIpScopeEnum
func GetRemotePeeringConnectionLifecycleStateEnumStringValues() []string
GetRemotePeeringConnectionLifecycleStateEnumStringValues Enumerates the set of values in String for RemotePeeringConnectionLifecycleStateEnum
func GetRemotePeeringConnectionPeeringStatusEnumStringValues() []string
GetRemotePeeringConnectionPeeringStatusEnumStringValues Enumerates the set of values in String for RemotePeeringConnectionPeeringStatusEnum
func GetRouteRuleDestinationTypeEnumStringValues() []string
GetRouteRuleDestinationTypeEnumStringValues Enumerates the set of values in String for RouteRuleDestinationTypeEnum
func GetRouteRuleRouteTypeEnumStringValues() []string
GetRouteRuleRouteTypeEnumStringValues Enumerates the set of values in String for RouteRuleRouteTypeEnum
func GetRouteTableLifecycleStateEnumStringValues() []string
GetRouteTableLifecycleStateEnumStringValues Enumerates the set of values in String for RouteTableLifecycleStateEnum
func GetRoutingActionActionEnumStringValues() []string
GetRoutingActionActionEnumStringValues Enumerates the set of values in String for RoutingActionActionEnum
func GetRoutingActionActionTypeEnumStringValues() []string
GetRoutingActionActionTypeEnumStringValues Enumerates the set of values in String for RoutingActionActionTypeEnum
func GetSecurityActionActionEnumStringValues() []string
GetSecurityActionActionEnumStringValues Enumerates the set of values in String for SecurityActionActionEnum
func GetSecurityActionActionTypeEnumStringValues() []string
GetSecurityActionActionTypeEnumStringValues Enumerates the set of values in String for SecurityActionActionTypeEnum
func GetSecurityListLifecycleStateEnumStringValues() []string
GetSecurityListLifecycleStateEnumStringValues Enumerates the set of values in String for SecurityListLifecycleStateEnum
func GetSecurityRuleDestinationTypeEnumStringValues() []string
GetSecurityRuleDestinationTypeEnumStringValues Enumerates the set of values in String for SecurityRuleDestinationTypeEnum
func GetSecurityRuleDirectionEnumStringValues() []string
GetSecurityRuleDirectionEnumStringValues Enumerates the set of values in String for SecurityRuleDirectionEnum
func GetSecurityRuleSourceTypeEnumStringValues() []string
GetSecurityRuleSourceTypeEnumStringValues Enumerates the set of values in String for SecurityRuleSourceTypeEnum
func GetServiceGatewayLifecycleStateEnumStringValues() []string
GetServiceGatewayLifecycleStateEnumStringValues Enumerates the set of values in String for ServiceGatewayLifecycleStateEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetSubnetLifecycleStateEnumStringValues() []string
GetSubnetLifecycleStateEnumStringValues Enumerates the set of values in String for SubnetLifecycleStateEnum
func GetTopologyEntityRelationshipTypeEnumStringValues() []string
GetTopologyEntityRelationshipTypeEnumStringValues Enumerates the set of values in String for TopologyEntityRelationshipTypeEnum
func GetTopologyRoutesToRelationshipDetailsRouteTypeEnumStringValues() []string
GetTopologyRoutesToRelationshipDetailsRouteTypeEnumStringValues Enumerates the set of values in String for TopologyRoutesToRelationshipDetailsRouteTypeEnum
func GetTopologyTypeEnumStringValues() []string
GetTopologyTypeEnumStringValues Enumerates the set of values in String for TopologyTypeEnum
func GetTrafficNodeTypeEnumStringValues() []string
GetTrafficNodeTypeEnumStringValues Enumerates the set of values in String for TrafficNodeTypeEnum
func GetTrafficProtocolParametersTypeEnumStringValues() []string
GetTrafficProtocolParametersTypeEnumStringValues Enumerates the set of values in String for TrafficProtocolParametersTypeEnum
func GetTrafficRouteReachabilityStatusEnumStringValues() []string
GetTrafficRouteReachabilityStatusEnumStringValues Enumerates the set of values in String for TrafficRouteReachabilityStatusEnum
func GetTunnelRouteSummaryAdvertiserEnumStringValues() []string
GetTunnelRouteSummaryAdvertiserEnumStringValues Enumerates the set of values in String for TunnelRouteSummaryAdvertiserEnum
func GetTunnelSecurityAssociationSummaryTunnelSaStatusEnumStringValues() []string
GetTunnelSecurityAssociationSummaryTunnelSaStatusEnumStringValues Enumerates the set of values in String for TunnelSecurityAssociationSummaryTunnelSaStatusEnum
func GetTunnelStatusLifecycleStateEnumStringValues() []string
GetTunnelStatusLifecycleStateEnumStringValues Enumerates the set of values in String for TunnelStatusLifecycleStateEnum
func GetUpdateDhcpDetailsDomainNameTypeEnumStringValues() []string
GetUpdateDhcpDetailsDomainNameTypeEnumStringValues Enumerates the set of values in String for UpdateDhcpDetailsDomainNameTypeEnum
func GetUpdateDrgRouteRuleDetailsDestinationTypeEnumStringValues() []string
GetUpdateDrgRouteRuleDetailsDestinationTypeEnumStringValues Enumerates the set of values in String for UpdateDrgRouteRuleDetailsDestinationTypeEnum
func GetUpdateIpSecConnectionDetailsCpeLocalIdentifierTypeEnumStringValues() []string
GetUpdateIpSecConnectionDetailsCpeLocalIdentifierTypeEnumStringValues Enumerates the set of values in String for UpdateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum
func GetUpdateIpSecConnectionTunnelDetailsIkeVersionEnumStringValues() []string
GetUpdateIpSecConnectionTunnelDetailsIkeVersionEnumStringValues Enumerates the set of values in String for UpdateIpSecConnectionTunnelDetailsIkeVersionEnum
func GetUpdateIpSecConnectionTunnelDetailsNatTranslationEnabledEnumStringValues() []string
GetUpdateIpSecConnectionTunnelDetailsNatTranslationEnabledEnumStringValues Enumerates the set of values in String for UpdateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum
func GetUpdateIpSecConnectionTunnelDetailsOracleInitiationEnumStringValues() []string
GetUpdateIpSecConnectionTunnelDetailsOracleInitiationEnumStringValues Enumerates the set of values in String for UpdateIpSecConnectionTunnelDetailsOracleInitiationEnum
func GetUpdateIpSecConnectionTunnelDetailsRoutingEnumStringValues() []string
GetUpdateIpSecConnectionTunnelDetailsRoutingEnumStringValues Enumerates the set of values in String for UpdateIpSecConnectionTunnelDetailsRoutingEnum
func GetUpdateSecurityRuleDetailsDestinationTypeEnumStringValues() []string
GetUpdateSecurityRuleDetailsDestinationTypeEnumStringValues Enumerates the set of values in String for UpdateSecurityRuleDetailsDestinationTypeEnum
func GetUpdateSecurityRuleDetailsDirectionEnumStringValues() []string
GetUpdateSecurityRuleDetailsDirectionEnumStringValues Enumerates the set of values in String for UpdateSecurityRuleDetailsDirectionEnum
func GetUpdateSecurityRuleDetailsSourceTypeEnumStringValues() []string
GetUpdateSecurityRuleDetailsSourceTypeEnumStringValues Enumerates the set of values in String for UpdateSecurityRuleDetailsSourceTypeEnum
func GetUpdateVirtualCircuitDetailsBgpAdminStateEnumStringValues() []string
GetUpdateVirtualCircuitDetailsBgpAdminStateEnumStringValues Enumerates the set of values in String for UpdateVirtualCircuitDetailsBgpAdminStateEnum
func GetUpdateVirtualCircuitDetailsProviderStateEnumStringValues() []string
GetUpdateVirtualCircuitDetailsProviderStateEnumStringValues Enumerates the set of values in String for UpdateVirtualCircuitDetailsProviderStateEnum
func GetUpdateVirtualCircuitDetailsRoutingPolicyEnumStringValues() []string
GetUpdateVirtualCircuitDetailsRoutingPolicyEnumStringValues Enumerates the set of values in String for UpdateVirtualCircuitDetailsRoutingPolicyEnum
func GetUpdateVtapDetailsEncapsulationProtocolEnumStringValues() []string
GetUpdateVtapDetailsEncapsulationProtocolEnumStringValues Enumerates the set of values in String for UpdateVtapDetailsEncapsulationProtocolEnum
func GetUpdateVtapDetailsSourceTypeEnumStringValues() []string
GetUpdateVtapDetailsSourceTypeEnumStringValues Enumerates the set of values in String for UpdateVtapDetailsSourceTypeEnum
func GetUpdateVtapDetailsTargetTypeEnumStringValues() []string
GetUpdateVtapDetailsTargetTypeEnumStringValues Enumerates the set of values in String for UpdateVtapDetailsTargetTypeEnum
func GetUpdateVtapDetailsTrafficModeEnumStringValues() []string
GetUpdateVtapDetailsTrafficModeEnumStringValues Enumerates the set of values in String for UpdateVtapDetailsTrafficModeEnum
func GetUpgradeStatusStatusEnumStringValues() []string
GetUpgradeStatusStatusEnumStringValues Enumerates the set of values in String for UpgradeStatusStatusEnum
func GetVcnDnsResolverAssociationLifecycleStateEnumStringValues() []string
GetVcnDnsResolverAssociationLifecycleStateEnumStringValues Enumerates the set of values in String for VcnDnsResolverAssociationLifecycleStateEnum
func GetVcnDrgAttachmentNetworkDetailsVcnRouteTypeEnumStringValues() []string
GetVcnDrgAttachmentNetworkDetailsVcnRouteTypeEnumStringValues Enumerates the set of values in String for VcnDrgAttachmentNetworkDetailsVcnRouteTypeEnum
func GetVcnLifecycleStateEnumStringValues() []string
GetVcnLifecycleStateEnumStringValues Enumerates the set of values in String for VcnLifecycleStateEnum
func GetVirtualCircuitAssociatedTunnelDetailsTunnelTypeEnumStringValues() []string
GetVirtualCircuitAssociatedTunnelDetailsTunnelTypeEnumStringValues Enumerates the set of values in String for VirtualCircuitAssociatedTunnelDetailsTunnelTypeEnum
func GetVirtualCircuitBgpAdminStateEnumStringValues() []string
GetVirtualCircuitBgpAdminStateEnumStringValues Enumerates the set of values in String for VirtualCircuitBgpAdminStateEnum
func GetVirtualCircuitBgpIpv6SessionStateEnumStringValues() []string
GetVirtualCircuitBgpIpv6SessionStateEnumStringValues Enumerates the set of values in String for VirtualCircuitBgpIpv6SessionStateEnum
func GetVirtualCircuitBgpManagementEnumStringValues() []string
GetVirtualCircuitBgpManagementEnumStringValues Enumerates the set of values in String for VirtualCircuitBgpManagementEnum
func GetVirtualCircuitBgpSessionStateEnumStringValues() []string
GetVirtualCircuitBgpSessionStateEnumStringValues Enumerates the set of values in String for VirtualCircuitBgpSessionStateEnum
func GetVirtualCircuitIpMtuEnumStringValues() []string
GetVirtualCircuitIpMtuEnumStringValues Enumerates the set of values in String for VirtualCircuitIpMtuEnum
func GetVirtualCircuitLifecycleStateEnumStringValues() []string
GetVirtualCircuitLifecycleStateEnumStringValues Enumerates the set of values in String for VirtualCircuitLifecycleStateEnum
func GetVirtualCircuitProviderStateEnumStringValues() []string
GetVirtualCircuitProviderStateEnumStringValues Enumerates the set of values in String for VirtualCircuitProviderStateEnum
func GetVirtualCircuitPublicPrefixVerificationStateEnumStringValues() []string
GetVirtualCircuitPublicPrefixVerificationStateEnumStringValues Enumerates the set of values in String for VirtualCircuitPublicPrefixVerificationStateEnum
func GetVirtualCircuitRoutingPolicyEnumStringValues() []string
GetVirtualCircuitRoutingPolicyEnumStringValues Enumerates the set of values in String for VirtualCircuitRoutingPolicyEnum
func GetVirtualCircuitServiceTypeEnumStringValues() []string
GetVirtualCircuitServiceTypeEnumStringValues Enumerates the set of values in String for VirtualCircuitServiceTypeEnum
func GetVirtualCircuitTypeEnumStringValues() []string
GetVirtualCircuitTypeEnumStringValues Enumerates the set of values in String for VirtualCircuitTypeEnum
func GetVlanLifecycleStateEnumStringValues() []string
GetVlanLifecycleStateEnumStringValues Enumerates the set of values in String for VlanLifecycleStateEnum
func GetVnicLifecycleStateEnumStringValues() []string
GetVnicLifecycleStateEnumStringValues Enumerates the set of values in String for VnicLifecycleStateEnum
func GetVtapCaptureFilterRuleDetailsRuleActionEnumStringValues() []string
GetVtapCaptureFilterRuleDetailsRuleActionEnumStringValues Enumerates the set of values in String for VtapCaptureFilterRuleDetailsRuleActionEnum
func GetVtapCaptureFilterRuleDetailsTrafficDirectionEnumStringValues() []string
GetVtapCaptureFilterRuleDetailsTrafficDirectionEnumStringValues Enumerates the set of values in String for VtapCaptureFilterRuleDetailsTrafficDirectionEnum
func GetVtapEncapsulationProtocolEnumStringValues() []string
GetVtapEncapsulationProtocolEnumStringValues Enumerates the set of values in String for VtapEncapsulationProtocolEnum
func GetVtapLifecycleStateDetailsEnumStringValues() []string
GetVtapLifecycleStateDetailsEnumStringValues Enumerates the set of values in String for VtapLifecycleStateDetailsEnum
func GetVtapLifecycleStateEnumStringValues() []string
GetVtapLifecycleStateEnumStringValues Enumerates the set of values in String for VtapLifecycleStateEnum
func GetVtapSourceTypeEnumStringValues() []string
GetVtapSourceTypeEnumStringValues Enumerates the set of values in String for VtapSourceTypeEnum
func GetVtapTargetTypeEnumStringValues() []string
GetVtapTargetTypeEnumStringValues Enumerates the set of values in String for VtapTargetTypeEnum
func GetVtapTrafficModeEnumStringValues() []string
GetVtapTrafficModeEnumStringValues Enumerates the set of values in String for VtapTrafficModeEnum
func GetWorkRequestResultResultTypeEnumStringValues() []string
GetWorkRequestResultResultTypeEnumStringValues Enumerates the set of values in String for WorkRequestResultResultTypeEnum
AccessDeniedTrafficNode Defines the configuration of a traffic node to which the user is denied access.
type AccessDeniedTrafficNode struct {
EgressTraffic *EgressTrafficSpec `mandatory:"false" json:"egressTraffic"`
NextHopRoutingAction RoutingAction `mandatory:"false" json:"nextHopRoutingAction"`
EgressSecurityAction SecurityAction `mandatory:"false" json:"egressSecurityAction"`
IngressSecurityAction SecurityAction `mandatory:"false" json:"ingressSecurityAction"`
}
func (m AccessDeniedTrafficNode) GetEgressSecurityAction() SecurityAction
GetEgressSecurityAction returns EgressSecurityAction
func (m AccessDeniedTrafficNode) GetEgressTraffic() *EgressTrafficSpec
GetEgressTraffic returns EgressTraffic
func (m AccessDeniedTrafficNode) GetIngressSecurityAction() SecurityAction
GetIngressSecurityAction returns IngressSecurityAction
func (m AccessDeniedTrafficNode) GetNextHopRoutingAction() RoutingAction
GetNextHopRoutingAction returns NextHopRoutingAction
func (m AccessDeniedTrafficNode) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AccessDeniedTrafficNode) String() string
func (m *AccessDeniedTrafficNode) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m AccessDeniedTrafficNode) 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
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AddDrgRouteDistributionStatementDetails Details used to add a route distribution statement.
type AddDrgRouteDistributionStatementDetails struct {
// The action is applied only if all of the match criteria is met.
MatchCriteria []DrgRouteDistributionMatchCriteria `mandatory:"true" json:"matchCriteria"`
// Accept: import/export the route "as is"
Action AddDrgRouteDistributionStatementDetailsActionEnum `mandatory:"true" json:"action"`
// This field is used to specify the priority of each statement in a route distribution.
// The priority will be represented as a number between 0 and 65535 where a lower number
// indicates a higher priority. When a route is processed, statements are applied in the order
// defined by their priority. The first matching rule dictates the action that will be taken
// on the route.
Priority *int `mandatory:"true" json:"priority"`
}
func (m AddDrgRouteDistributionStatementDetails) String() string
func (m *AddDrgRouteDistributionStatementDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m AddDrgRouteDistributionStatementDetails) 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
AddDrgRouteDistributionStatementDetailsActionEnum Enum with underlying type: string
type AddDrgRouteDistributionStatementDetailsActionEnum string
Set of constants representing the allowable values for AddDrgRouteDistributionStatementDetailsActionEnum
const (
AddDrgRouteDistributionStatementDetailsActionAccept AddDrgRouteDistributionStatementDetailsActionEnum = "ACCEPT"
)
func GetAddDrgRouteDistributionStatementDetailsActionEnumValues() []AddDrgRouteDistributionStatementDetailsActionEnum
GetAddDrgRouteDistributionStatementDetailsActionEnumValues Enumerates the set of values for AddDrgRouteDistributionStatementDetailsActionEnum
func GetMappingAddDrgRouteDistributionStatementDetailsActionEnum(val string) (AddDrgRouteDistributionStatementDetailsActionEnum, bool)
GetMappingAddDrgRouteDistributionStatementDetailsActionEnum performs case Insensitive comparison on enum value and return the desired enum
AddDrgRouteDistributionStatementsDetails Details request to add statements to a route distribution.
type AddDrgRouteDistributionStatementsDetails struct {
// The collection of route distribution statements to insert into the route distribution.
Statements []AddDrgRouteDistributionStatementDetails `mandatory:"true" json:"statements"`
}
func (m AddDrgRouteDistributionStatementsDetails) String() string
func (m AddDrgRouteDistributionStatementsDetails) 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
AddDrgRouteRuleDetails Details needed when adding a DRG route rule.
type AddDrgRouteRuleDetails struct {
// Type of destination for the rule.
// Allowed values:
// * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.
DestinationType AddDrgRouteRuleDetailsDestinationTypeEnum `mandatory:"true" json:"destinationType"`
// This is the range of IP addresses used for matching when routing
// traffic. Only CIDR_BLOCK values are allowed.
// Potential values:
// * IP address range in CIDR notation. This can be an IPv4 or IPv6 CIDR. For example: `192.168.1.0/24`
// or `2001:0db8:0123:45::/56`.
Destination *string `mandatory:"true" json:"destination"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the next hop DRG attachment. The next hop DRG attachment is responsible
// for reaching the network destination.
NextHopDrgAttachmentId *string `mandatory:"true" json:"nextHopDrgAttachmentId"`
}
func (m AddDrgRouteRuleDetails) String() string
func (m AddDrgRouteRuleDetails) 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
AddDrgRouteRuleDetailsDestinationTypeEnum Enum with underlying type: string
type AddDrgRouteRuleDetailsDestinationTypeEnum string
Set of constants representing the allowable values for AddDrgRouteRuleDetailsDestinationTypeEnum
const (
AddDrgRouteRuleDetailsDestinationTypeCidrBlock AddDrgRouteRuleDetailsDestinationTypeEnum = "CIDR_BLOCK"
)
func GetAddDrgRouteRuleDetailsDestinationTypeEnumValues() []AddDrgRouteRuleDetailsDestinationTypeEnum
GetAddDrgRouteRuleDetailsDestinationTypeEnumValues Enumerates the set of values for AddDrgRouteRuleDetailsDestinationTypeEnum
func GetMappingAddDrgRouteRuleDetailsDestinationTypeEnum(val string) (AddDrgRouteRuleDetailsDestinationTypeEnum, bool)
GetMappingAddDrgRouteRuleDetailsDestinationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AddDrgRouteRulesDetails Details used in a request to add static routes to a DRG route table.
type AddDrgRouteRulesDetails struct {
// The collection of static rules used to insert routes into the DRG route table.
RouteRules []AddDrgRouteRuleDetails `mandatory:"false" json:"routeRules"`
}
func (m AddDrgRouteRulesDetails) String() string
func (m AddDrgRouteRulesDetails) 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
AddNetworkSecurityGroupSecurityRulesDetails The representation of AddNetworkSecurityGroupSecurityRulesDetails
type AddNetworkSecurityGroupSecurityRulesDetails struct {
// The NSG security rules to add.
SecurityRules []AddSecurityRuleDetails `mandatory:"false" json:"securityRules"`
}
func (m AddNetworkSecurityGroupSecurityRulesDetails) String() string
func (m AddNetworkSecurityGroupSecurityRulesDetails) 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
AddPublicIpPoolCapacityDetails The information used to add capacity to an IP pool.
type AddPublicIpPoolCapacityDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs.
ByoipRangeId *string `mandatory:"true" json:"byoipRangeId"`
// The CIDR block to add to the public IP pool. It could be all of the CIDR block identified in `byoipRangeId`, or a subrange.
// Example: `10.0.1.0/24`
CidrBlock *string `mandatory:"true" json:"cidrBlock"`
}
func (m AddPublicIpPoolCapacityDetails) String() string
func (m AddPublicIpPoolCapacityDetails) 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
AddSecurityRuleDetails A rule for allowing inbound (INGRESS) or outbound (EGRESS) IP packets.
type AddSecurityRuleDetails struct {
// Direction of the security rule. Set to `EGRESS` for rules to allow outbound IP packets,
// or `INGRESS` for rules to allow inbound IP packets.
Direction AddSecurityRuleDetailsDirectionEnum `mandatory:"true" json:"direction"`
// The transport protocol. Specify either `all` or an IPv4 protocol number as
// defined in
// Protocol Numbers (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
// Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58").
Protocol *string `mandatory:"true" json:"protocol"`
// An optional description of your choice for the rule. Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
// Conceptually, this is the range of IP addresses that a packet originating from the instance
// can go to.
// Allowed values:
// * An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`
// IPv6 addressing is supported for all commercial and government regions. See
// IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// * The `cidrBlock` value for a Service, if you're
// setting up a security rule for traffic destined for a particular `Service` through
// a service gateway. For example: `oci-phx-objectstorage`.
// * The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a NetworkSecurityGroup in the same
// VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control
// traffic between VNICs in the same NSG.
Destination *string `mandatory:"false" json:"destination"`
// Type of destination for the rule. Required if `direction` = `EGRESS`.
// Allowed values:
// * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.
// * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a
// Service (the rule is for traffic destined for a
// particular `Service` through a service gateway).
// * `NETWORK_SECURITY_GROUP`: If the rule's `destination` is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a
// NetworkSecurityGroup.
DestinationType AddSecurityRuleDetailsDestinationTypeEnum `mandatory:"false" json:"destinationType,omitempty"`
IcmpOptions *IcmpOptions `mandatory:"false" json:"icmpOptions"`
// A stateless rule allows traffic in one direction. Remember to add a corresponding
// stateless rule in the other direction if you need to support bidirectional traffic. For
// example, if egress traffic allows TCP destination port 80, there should be an ingress
// rule to allow TCP source port 80. Defaults to false, which means the rule is stateful
// and a corresponding rule is not necessary for bidirectional traffic.
IsStateless *bool `mandatory:"false" json:"isStateless"`
// Conceptually, this is the range of IP addresses that a packet coming into the instance
// can come from.
// Allowed values:
// * An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`
// IPv6 addressing is supported for all commercial and government regions. See
// IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// * The `cidrBlock` value for a Service, if you're
// setting up a security rule for traffic coming from a particular `Service` through
// a service gateway. For example: `oci-phx-objectstorage`.
// * The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a NetworkSecurityGroup in the same
// VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control
// traffic between VNICs in the same NSG.
Source *string `mandatory:"false" json:"source"`
// Type of source for the rule. Required if `direction` = `INGRESS`.
// * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation.
// * `SERVICE_CIDR_BLOCK`: If the rule's `source` is the `cidrBlock` value for a
// Service (the rule is for traffic coming from a
// particular `Service` through a service gateway).
// * `NETWORK_SECURITY_GROUP`: If the rule's `source` is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a
// NetworkSecurityGroup.
SourceType AddSecurityRuleDetailsSourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`
TcpOptions *TcpOptions `mandatory:"false" json:"tcpOptions"`
UdpOptions *UdpOptions `mandatory:"false" json:"udpOptions"`
}
func (m AddSecurityRuleDetails) String() string
func (m AddSecurityRuleDetails) 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
AddSecurityRuleDetailsDestinationTypeEnum Enum with underlying type: string
type AddSecurityRuleDetailsDestinationTypeEnum string
Set of constants representing the allowable values for AddSecurityRuleDetailsDestinationTypeEnum
const (
AddSecurityRuleDetailsDestinationTypeCidrBlock AddSecurityRuleDetailsDestinationTypeEnum = "CIDR_BLOCK"
AddSecurityRuleDetailsDestinationTypeServiceCidrBlock AddSecurityRuleDetailsDestinationTypeEnum = "SERVICE_CIDR_BLOCK"
AddSecurityRuleDetailsDestinationTypeNetworkSecurityGroup AddSecurityRuleDetailsDestinationTypeEnum = "NETWORK_SECURITY_GROUP"
)
func GetAddSecurityRuleDetailsDestinationTypeEnumValues() []AddSecurityRuleDetailsDestinationTypeEnum
GetAddSecurityRuleDetailsDestinationTypeEnumValues Enumerates the set of values for AddSecurityRuleDetailsDestinationTypeEnum
func GetMappingAddSecurityRuleDetailsDestinationTypeEnum(val string) (AddSecurityRuleDetailsDestinationTypeEnum, bool)
GetMappingAddSecurityRuleDetailsDestinationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AddSecurityRuleDetailsDirectionEnum Enum with underlying type: string
type AddSecurityRuleDetailsDirectionEnum string
Set of constants representing the allowable values for AddSecurityRuleDetailsDirectionEnum
const (
AddSecurityRuleDetailsDirectionEgress AddSecurityRuleDetailsDirectionEnum = "EGRESS"
AddSecurityRuleDetailsDirectionIngress AddSecurityRuleDetailsDirectionEnum = "INGRESS"
)
func GetAddSecurityRuleDetailsDirectionEnumValues() []AddSecurityRuleDetailsDirectionEnum
GetAddSecurityRuleDetailsDirectionEnumValues Enumerates the set of values for AddSecurityRuleDetailsDirectionEnum
func GetMappingAddSecurityRuleDetailsDirectionEnum(val string) (AddSecurityRuleDetailsDirectionEnum, bool)
GetMappingAddSecurityRuleDetailsDirectionEnum performs case Insensitive comparison on enum value and return the desired enum
AddSecurityRuleDetailsSourceTypeEnum Enum with underlying type: string
type AddSecurityRuleDetailsSourceTypeEnum string
Set of constants representing the allowable values for AddSecurityRuleDetailsSourceTypeEnum
const (
AddSecurityRuleDetailsSourceTypeCidrBlock AddSecurityRuleDetailsSourceTypeEnum = "CIDR_BLOCK"
AddSecurityRuleDetailsSourceTypeServiceCidrBlock AddSecurityRuleDetailsSourceTypeEnum = "SERVICE_CIDR_BLOCK"
AddSecurityRuleDetailsSourceTypeNetworkSecurityGroup AddSecurityRuleDetailsSourceTypeEnum = "NETWORK_SECURITY_GROUP"
)
func GetAddSecurityRuleDetailsSourceTypeEnumValues() []AddSecurityRuleDetailsSourceTypeEnum
GetAddSecurityRuleDetailsSourceTypeEnumValues Enumerates the set of values for AddSecurityRuleDetailsSourceTypeEnum
func GetMappingAddSecurityRuleDetailsSourceTypeEnum(val string) (AddSecurityRuleDetailsSourceTypeEnum, bool)
GetMappingAddSecurityRuleDetailsSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AddSubnetIpv6CidrDetails Details used when adding an IPv6 CIDR block to a subnet.
type AddSubnetIpv6CidrDetails struct {
// This field is not required and should only be specified when adding an IPv6 CIDR
// to a subnet's IPv6 address space.
// SeeIPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// Example: `2001:0db8:0123::/64`
Ipv6CidrBlock *string `mandatory:"true" json:"ipv6CidrBlock"`
}
func (m AddSubnetIpv6CidrDetails) String() string
func (m AddSubnetIpv6CidrDetails) 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
AddVcnCidrDetails Details used to add a CIDR block to a VCN.
type AddVcnCidrDetails struct {
// The CIDR block to add.
CidrBlock *string `mandatory:"true" json:"cidrBlock"`
}
func (m AddVcnCidrDetails) String() string
func (m AddVcnCidrDetails) 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
AddVcnIpv6CidrDetails Details used when adding a ULA or private IPv6 prefix or an IPv6 GUA assigned by Oracle or a BYOIPv6 prefix. You can add only one of these per request.
type AddVcnIpv6CidrDetails struct {
// This field is not required and should only be specified if a ULA or private IPv6 prefix is desired for VCN's private IP address space.
// SeeIPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// Example: `2001:0db8:0123::/48` or `fd00:1000:0:1::/64`
Ipv6PrivateCidrBlock *string `mandatory:"false" json:"ipv6PrivateCidrBlock"`
// Indicates whether Oracle will allocate an IPv6 GUA. Only one prefix of /56 size can be allocated by Oracle as a GUA.
IsOracleGuaAllocationEnabled *bool `mandatory:"false" json:"isOracleGuaAllocationEnabled"`
Byoipv6CidrDetail *Byoipv6CidrDetails `mandatory:"false" json:"byoipv6CidrDetail"`
}
func (m AddVcnIpv6CidrDetails) String() string
func (m AddVcnIpv6CidrDetails) 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
AddedNetworkSecurityGroupSecurityRules The representation of AddedNetworkSecurityGroupSecurityRules
type AddedNetworkSecurityGroupSecurityRules struct {
// The NSG security rules that were added.
SecurityRules []SecurityRule `mandatory:"false" json:"securityRules"`
}
func (m AddedNetworkSecurityGroupSecurityRules) String() string
func (m AddedNetworkSecurityGroupSecurityRules) 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
AdhocGetPathAnalysisDetails Defines the configuration for getting an ad-hoc path analysis.
type AdhocGetPathAnalysisDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The IP protocol to used for the path analysis.
Protocol *int `mandatory:"true" json:"protocol"`
SourceEndpoint Endpoint `mandatory:"true" json:"sourceEndpoint"`
DestinationEndpoint Endpoint `mandatory:"true" json:"destinationEndpoint"`
ProtocolParameters ProtocolParameters `mandatory:"false" json:"protocolParameters"`
QueryOptions *QueryOptions `mandatory:"false" json:"queryOptions"`
}
func (m AdhocGetPathAnalysisDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AdhocGetPathAnalysisDetails) String() string
func (m *AdhocGetPathAnalysisDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m AdhocGetPathAnalysisDetails) 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
AllowedIkeIpSecParameters Lists the current allowed and default IPSec tunnel parameters.
type AllowedIkeIpSecParameters struct {
AllowedPhaseOneParameters *AllowedPhaseOneParameters `mandatory:"true" json:"allowedPhaseOneParameters"`
AllowedPhaseTwoParameters *AllowedPhaseTwoParameters `mandatory:"true" json:"allowedPhaseTwoParameters"`
DefaultPhaseOneParameters *DefaultPhaseOneParameters `mandatory:"true" json:"defaultPhaseOneParameters"`
DefaultPhaseTwoParameters *DefaultPhaseTwoParameters `mandatory:"true" json:"defaultPhaseTwoParameters"`
}
func (m AllowedIkeIpSecParameters) String() string
func (m AllowedIkeIpSecParameters) 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
AllowedPhaseOneParameters Allowed phase one parameters.
type AllowedPhaseOneParameters struct {
// Allowed phase one encryption algorithms.
EncryptionAlgorithms []string `mandatory:"false" json:"encryptionAlgorithms"`
// Allowed phase one authentication algorithms.
AuthenticationAlgorithms []string `mandatory:"false" json:"authenticationAlgorithms"`
// Allowed phase one Diffie-Hellman groups.
DhGroups []string `mandatory:"false" json:"dhGroups"`
}
func (m AllowedPhaseOneParameters) String() string
func (m AllowedPhaseOneParameters) 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
AllowedPhaseTwoParameters Allowed phase two parameters.
type AllowedPhaseTwoParameters struct {
// Allowed phase two encryption algorithms.
EncryptionAlgorithms []string `mandatory:"false" json:"encryptionAlgorithms"`
// Allowed phase two authentication algorithms.
AuthenticationAlgorithms []string `mandatory:"false" json:"authenticationAlgorithms"`
// Allowed perfect forward secrecy Diffie-Hellman groups.
PfsDhGroups []string `mandatory:"false" json:"pfsDhGroups"`
}
func (m AllowedPhaseTwoParameters) String() string
func (m AllowedPhaseTwoParameters) 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
AllowedSecurityAction Defines the security action taken on allowed traffic.
type AllowedSecurityAction struct {
AllowedSecurityActionDetails *AllowedSecurityActionDetails `mandatory:"false" json:"allowedSecurityActionDetails"`
// Type of the `SecurityAction`.
ActionType SecurityActionActionTypeEnum `mandatory:"true" json:"actionType"`
}
func (m AllowedSecurityAction) GetActionType() SecurityActionActionTypeEnum
GetActionType returns ActionType
func (m AllowedSecurityAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AllowedSecurityAction) String() string
func (m AllowedSecurityAction) 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
AllowedSecurityActionDetails Defines details for the security action taken on allowed traffic.
type AllowedSecurityActionDetails struct {
// If true, the allowed security configuration details are incomplete.
IsRestrictedOrPartial *bool `mandatory:"true" json:"isRestrictedOrPartial"`
AllowedSecurityConfiguration AllowedSecurityConfiguration `mandatory:"false" json:"allowedSecurityConfiguration"`
}
func (m AllowedSecurityActionDetails) String() string
func (m *AllowedSecurityActionDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m AllowedSecurityActionDetails) 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
AllowedSecurityConfiguration Defines the allowed security configuration for the traffic.
type AllowedSecurityConfiguration interface {
}
AllowedSecurityConfigurationTypeEnum Enum with underlying type: string
type AllowedSecurityConfigurationTypeEnum string
Set of constants representing the allowable values for AllowedSecurityConfigurationTypeEnum
const (
AllowedSecurityConfigurationTypeNsg AllowedSecurityConfigurationTypeEnum = "NSG"
AllowedSecurityConfigurationTypeStatefulNsg AllowedSecurityConfigurationTypeEnum = "STATEFUL_NSG"
AllowedSecurityConfigurationTypeIngressSecurityList AllowedSecurityConfigurationTypeEnum = "INGRESS_SECURITY_LIST"
AllowedSecurityConfigurationTypeStatefulIngressSecurityList AllowedSecurityConfigurationTypeEnum = "STATEFUL_INGRESS_SECURITY_LIST"
AllowedSecurityConfigurationTypeEgressSecurityList AllowedSecurityConfigurationTypeEnum = "EGRESS_SECURITY_LIST"
AllowedSecurityConfigurationTypeStatefulEgressSecurityList AllowedSecurityConfigurationTypeEnum = "STATEFUL_EGRESS_SECURITY_LIST"
)
func GetAllowedSecurityConfigurationTypeEnumValues() []AllowedSecurityConfigurationTypeEnum
GetAllowedSecurityConfigurationTypeEnumValues Enumerates the set of values for AllowedSecurityConfigurationTypeEnum
func GetMappingAllowedSecurityConfigurationTypeEnum(val string) (AllowedSecurityConfigurationTypeEnum, bool)
GetMappingAllowedSecurityConfigurationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BgpSessionInfo Information for establishing a BGP session for the IPSec tunnel.
type BgpSessionInfo struct {
// The IP address for the Oracle end of the inside tunnel interface.
// If the tunnel's `routing` attribute is set to `BGP`
// (see IPSecConnectionTunnel), this IP address
// is required and used for the tunnel's BGP session.
// If `routing` is instead set to `STATIC`, this IP address is optional. You can set this IP
// address so you can troubleshoot or monitor the tunnel.
// The value must be a /30 or /31.
// Example: `10.0.0.4/31`
OracleInterfaceIp *string `mandatory:"false" json:"oracleInterfaceIp"`
// The IP address for the CPE end of the inside tunnel interface.
// If the tunnel's `routing` attribute is set to `BGP`
// (see IPSecConnectionTunnel), this IP address
// is required and used for the tunnel's BGP session.
// If `routing` is instead set to `STATIC`, this IP address is optional. You can set this IP
// address so you can troubleshoot or monitor the tunnel.
// The value must be a /30 or /31.
// Example: `10.0.0.5/31`
CustomerInterfaceIp *string `mandatory:"false" json:"customerInterfaceIp"`
// The IPv6 address for the Oracle end of the inside tunnel interface. This IP address is optional.
// If the tunnel's `routing` attribute is set to `BGP`
// (see IPSecConnectionTunnel), this IP address
// is used for the tunnel's BGP session.
// If `routing` is instead set to `STATIC`, you can set this IP
// address to troubleshoot or monitor the tunnel.
// Only subnet masks from /64 up to /127 are allowed.
// Example: `2001:db8::1/64`
OracleInterfaceIpv6 *string `mandatory:"false" json:"oracleInterfaceIpv6"`
// The IPv6 address for the CPE end of the inside tunnel interface. This IP address is optional.
// If the tunnel's `routing` attribute is set to `BGP`
// (see IPSecConnectionTunnel), this IP address
// is used for the tunnel's BGP session.
// If `routing` is instead set to `STATIC`, you can set this IP
// address to troubleshoot or monitor the tunnel.
// Only subnet masks from /64 up to /127 are allowed.
// Example: `2001:db8::1/64`
CustomerInterfaceIpv6 *string `mandatory:"false" json:"customerInterfaceIpv6"`
// The Oracle BGP ASN.
OracleBgpAsn *string `mandatory:"false" json:"oracleBgpAsn"`
// If the tunnel's `routing` attribute is set to `BGP`
// (see IPSecConnectionTunnel), this ASN
// is required and used for the tunnel's BGP session. This is the ASN of the network on the
// CPE end of the BGP session. Can be a 2-byte or 4-byte ASN. Uses "asplain" format.
// If the tunnel uses static routing, the `customerBgpAsn` must be null.
// Example: `12345` (2-byte) or `1587232876` (4-byte)
CustomerBgpAsn *string `mandatory:"false" json:"customerBgpAsn"`
// The state of the BGP session.
BgpState BgpSessionInfoBgpStateEnum `mandatory:"false" json:"bgpState,omitempty"`
// The state of the BGP IPv6 session.
BgpIpv6State BgpSessionInfoBgpIpv6StateEnum `mandatory:"false" json:"bgpIpv6State,omitempty"`
}
func (m BgpSessionInfo) String() string
func (m BgpSessionInfo) 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
BgpSessionInfoBgpIpv6StateEnum Enum with underlying type: string
type BgpSessionInfoBgpIpv6StateEnum string
Set of constants representing the allowable values for BgpSessionInfoBgpIpv6StateEnum
const (
BgpSessionInfoBgpIpv6StateUp BgpSessionInfoBgpIpv6StateEnum = "UP"
BgpSessionInfoBgpIpv6StateDown BgpSessionInfoBgpIpv6StateEnum = "DOWN"
)
func GetBgpSessionInfoBgpIpv6StateEnumValues() []BgpSessionInfoBgpIpv6StateEnum
GetBgpSessionInfoBgpIpv6StateEnumValues Enumerates the set of values for BgpSessionInfoBgpIpv6StateEnum
func GetMappingBgpSessionInfoBgpIpv6StateEnum(val string) (BgpSessionInfoBgpIpv6StateEnum, bool)
GetMappingBgpSessionInfoBgpIpv6StateEnum performs case Insensitive comparison on enum value and return the desired enum
BgpSessionInfoBgpStateEnum Enum with underlying type: string
type BgpSessionInfoBgpStateEnum string
Set of constants representing the allowable values for BgpSessionInfoBgpStateEnum
const (
BgpSessionInfoBgpStateUp BgpSessionInfoBgpStateEnum = "UP"
BgpSessionInfoBgpStateDown BgpSessionInfoBgpStateEnum = "DOWN"
)
func GetBgpSessionInfoBgpStateEnumValues() []BgpSessionInfoBgpStateEnum
GetBgpSessionInfoBgpStateEnumValues Enumerates the set of values for BgpSessionInfoBgpStateEnum
func GetMappingBgpSessionInfoBgpStateEnum(val string) (BgpSessionInfoBgpStateEnum, bool)
GetMappingBgpSessionInfoBgpStateEnum performs case Insensitive comparison on enum value and return the desired enum
BulkAddVirtualCircuitPublicPrefixesDetails The representation of BulkAddVirtualCircuitPublicPrefixesDetails
type BulkAddVirtualCircuitPublicPrefixesDetails struct {
// The public IP prefixes (CIDRs) to add to the public virtual circuit.
PublicPrefixes []CreateVirtualCircuitPublicPrefixDetails `mandatory:"true" json:"publicPrefixes"`
}
func (m BulkAddVirtualCircuitPublicPrefixesDetails) String() string
func (m BulkAddVirtualCircuitPublicPrefixesDetails) 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
BulkDeleteVirtualCircuitPublicPrefixesDetails The representation of BulkDeleteVirtualCircuitPublicPrefixesDetails
type BulkDeleteVirtualCircuitPublicPrefixesDetails struct {
// The public IP prefixes (CIDRs) to remove from the public virtual circuit.
PublicPrefixes []DeleteVirtualCircuitPublicPrefixDetails `mandatory:"true" json:"publicPrefixes"`
}
func (m BulkDeleteVirtualCircuitPublicPrefixesDetails) String() string
func (m BulkDeleteVirtualCircuitPublicPrefixesDetails) 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
ByoipAllocatedRangeCollection Results of a `ListByoipAllocatedRanges` operation.
type ByoipAllocatedRangeCollection struct {
// A list of subranges of a BYOIP CIDR block allocated to an IP pool.
Items []ByoipAllocatedRangeSummary `mandatory:"true" json:"items"`
}
func (m ByoipAllocatedRangeCollection) String() string
func (m ByoipAllocatedRangeCollection) 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
ByoipAllocatedRangeSummary A summary of CIDR block subranges that are currently allocated to an IP pool.
type ByoipAllocatedRangeSummary struct {
// The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block.
CidrBlock *string `mandatory:"false" json:"cidrBlock"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IP pool containing the CIDR block.
PublicIpPoolId *string `mandatory:"false" json:"publicIpPoolId"`
}
func (m ByoipAllocatedRangeSummary) String() string
func (m ByoipAllocatedRangeSummary) 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
ByoipRange Oracle offers the ability to Bring Your Own IP (BYOIP), importing public IP addresses or IPv6 addresses that you currently own to Oracle Cloud Infrastructure. A `ByoipRange` resource is a record of the imported address block (a BYOIP CIDR block) and also some associated metadata. The process used to Bring Your Own IP (https://docs.oracle.com/iaas/Content/Network/Concepts/BYOIP.htm) is explained in the documentation.
type ByoipRange struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the BYOIP CIDR block.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource.
Id *string `mandatory:"true" json:"id"`
// The `ByoipRange` resource's current state.
LifecycleState ByoipRangeLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the `ByoipRange` resource was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The validation token is an internally-generated ASCII string used in the validation process. See Importing a CIDR block (https://docs.oracle.com/iaas/Content/Network/Concepts/BYOIP.htm#import_cidr) for details.
ValidationToken *string `mandatory:"true" json:"validationToken"`
// A list of `ByoipRangeVcnIpv6AllocationSummary` objects.
ByoipRangeVcnIpv6Allocations []ByoipRangeVcnIpv6AllocationSummary `mandatory:"false" json:"byoipRangeVcnIpv6Allocations"`
// The public IPv4 CIDR block being imported from on-premises to the Oracle cloud.
CidrBlock *string `mandatory:"false" json:"cidrBlock"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The IPv6 CIDR block being imported to the Oracle cloud. This CIDR block must be /48 or larger, and can be subdivided into sub-ranges used
// across multiple VCNs. A BYOIPv6 prefix can be also assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify
// a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size.
Ipv6CidrBlock *string `mandatory:"false" json:"ipv6CidrBlock"`
// The `ByoipRange` resource's current status.
LifecycleDetails ByoipRangeLifecycleDetailsEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`
// The date and time the `ByoipRange` resource was validated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeValidated *common.SDKTime `mandatory:"false" json:"timeValidated"`
// The date and time the `ByoipRange` resource was advertised to the internet by BGP, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeAdvertised *common.SDKTime `mandatory:"false" json:"timeAdvertised"`
// The date and time the `ByoipRange` resource was withdrawn from advertisement by BGP to the internet, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeWithdrawn *common.SDKTime `mandatory:"false" json:"timeWithdrawn"`
}
func (m ByoipRange) String() string
func (m ByoipRange) 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
ByoipRangeCollection The results returned by a `ListByoipRange` operation.
type ByoipRangeCollection struct {
// A list of `ByoipRange` resource summaries.
Items []ByoipRangeSummary `mandatory:"true" json:"items"`
}
func (m ByoipRangeCollection) String() string
func (m ByoipRangeCollection) 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
ByoipRangeLifecycleDetailsEnum Enum with underlying type: string
type ByoipRangeLifecycleDetailsEnum string
Set of constants representing the allowable values for ByoipRangeLifecycleDetailsEnum
const (
ByoipRangeLifecycleDetailsCreating ByoipRangeLifecycleDetailsEnum = "CREATING"
ByoipRangeLifecycleDetailsValidating ByoipRangeLifecycleDetailsEnum = "VALIDATING"
ByoipRangeLifecycleDetailsProvisioned ByoipRangeLifecycleDetailsEnum = "PROVISIONED"
ByoipRangeLifecycleDetailsActive ByoipRangeLifecycleDetailsEnum = "ACTIVE"
ByoipRangeLifecycleDetailsFailed ByoipRangeLifecycleDetailsEnum = "FAILED"
ByoipRangeLifecycleDetailsDeleting ByoipRangeLifecycleDetailsEnum = "DELETING"
ByoipRangeLifecycleDetailsDeleted ByoipRangeLifecycleDetailsEnum = "DELETED"
ByoipRangeLifecycleDetailsAdvertising ByoipRangeLifecycleDetailsEnum = "ADVERTISING"
ByoipRangeLifecycleDetailsWithdrawing ByoipRangeLifecycleDetailsEnum = "WITHDRAWING"
)
func GetByoipRangeLifecycleDetailsEnumValues() []ByoipRangeLifecycleDetailsEnum
GetByoipRangeLifecycleDetailsEnumValues Enumerates the set of values for ByoipRangeLifecycleDetailsEnum
func GetMappingByoipRangeLifecycleDetailsEnum(val string) (ByoipRangeLifecycleDetailsEnum, bool)
GetMappingByoipRangeLifecycleDetailsEnum performs case Insensitive comparison on enum value and return the desired enum
ByoipRangeLifecycleStateEnum Enum with underlying type: string
type ByoipRangeLifecycleStateEnum string
Set of constants representing the allowable values for ByoipRangeLifecycleStateEnum
const (
ByoipRangeLifecycleStateInactive ByoipRangeLifecycleStateEnum = "INACTIVE"
ByoipRangeLifecycleStateUpdating ByoipRangeLifecycleStateEnum = "UPDATING"
ByoipRangeLifecycleStateActive ByoipRangeLifecycleStateEnum = "ACTIVE"
ByoipRangeLifecycleStateDeleting ByoipRangeLifecycleStateEnum = "DELETING"
ByoipRangeLifecycleStateDeleted ByoipRangeLifecycleStateEnum = "DELETED"
)
func GetByoipRangeLifecycleStateEnumValues() []ByoipRangeLifecycleStateEnum
GetByoipRangeLifecycleStateEnumValues Enumerates the set of values for ByoipRangeLifecycleStateEnum
func GetMappingByoipRangeLifecycleStateEnum(val string) (ByoipRangeLifecycleStateEnum, bool)
GetMappingByoipRangeLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ByoipRangeSummary Information about a `ByoipRange` resource.
type ByoipRangeSummary struct {
// A list of `ByoipRangeVcnIpv6AllocationSummary` objects.
ByoipRangeVcnIpv6Allocations []ByoipRangeVcnIpv6AllocationSummary `mandatory:"false" json:"byoipRangeVcnIpv6Allocations"`
// The public IPv4 address range you are importing to the Oracle cloud.
CidrBlock *string `mandatory:"false" json:"cidrBlock"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `ByoipRange` resource.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource.
Id *string `mandatory:"false" json:"id"`
// The IPv6 CIDR block being imported to the Oracle cloud. This CIDR block must be /48 or larger, and can be subdivided into sub-ranges used
// across multiple VCNs. A BYOIPv6 prefix can be assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify
// a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size.
Ipv6CidrBlock *string `mandatory:"false" json:"ipv6CidrBlock"`
// The `ByoipRange` resource's current state.
LifecycleState ByoipRangeLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The Byoip Range's current lifeCycle substate.
LifecycleDetails ByoipRangeLifecycleDetailsEnum `mandatory:"false" json:"lifecycleDetails,omitempty"`
// The date and time the `ByoipRange` resource was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}
func (m ByoipRangeSummary) String() string
func (m ByoipRangeSummary) 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
ByoipRangeVcnIpv6AllocationSummary A summary of IPv6 CIDR block subranges currently allocated to a VCN.
type ByoipRangeVcnIpv6AllocationSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs.
ByoipRangeId *string `mandatory:"false" json:"byoipRangeId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `ByoipRange`.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The BYOIPv6 CIDR block range or subrange allocated to a VCN. This could be all or part of a BYOIPv6 CIDR block.
// Each VCN allocation must be /64 or larger.
Ipv6CidrBlock *string `mandatory:"false" json:"ipv6CidrBlock"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `Vcn` resource to which the ByoipRange belongs.
VcnId *string `mandatory:"false" json:"vcnId"`
}
func (m ByoipRangeVcnIpv6AllocationSummary) String() string
func (m ByoipRangeVcnIpv6AllocationSummary) 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
Byoipv6CidrDetails The list of one or more BYOIPv6 CIDR blocks for the VCN that meets the following criteria: - The CIDR must from a BYOIPv6 range. - The IPv6 CIDR blocks must be valid. - Multiple CIDR blocks must not overlap each other or the on-premises network CIDR block. - The number of CIDR blocks must not exceed the limit of IPv6 CIDR blocks allowed to a VCN.
type Byoipv6CidrDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs.
Byoipv6RangeId *string `mandatory:"true" json:"byoipv6RangeId"`
// An IPv6 CIDR block required to create a VCN with a BYOIP prefix. It could be the whole CIDR block identified in `byoipv6RangeId`, or a subrange.
// Example: `2001:0db8:0123::/48`
Ipv6CidrBlock *string `mandatory:"true" json:"ipv6CidrBlock"`
}
func (m Byoipv6CidrDetails) String() string
func (m Byoipv6CidrDetails) 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
CaptureFilter A capture filter contains a set of *CaptureFilterRuleDetails* governing what traffic a *Vtap* mirrors. The capture filter is created with no rules defined, and it must have at least one rule for the VTAP to start mirroring traffic.
type CaptureFilter struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the capture filter.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The capture filter's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"true" json:"id"`
// The capture filter's current administrative state.
LifecycleState CaptureFilterLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Indicates which service will use this capture filter
FilterType CaptureFilterFilterTypeEnum `mandatory:"false" json:"filterType,omitempty"`
// The date and time the capture filter was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2021-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The set of rules governing what traffic a VTAP mirrors.
VtapCaptureFilterRules []VtapCaptureFilterRuleDetails `mandatory:"false" json:"vtapCaptureFilterRules"`
// The set of rules governing what traffic the Flow Log collects when creating a flow log capture filter.
FlowLogCaptureFilterRules []FlowLogCaptureFilterRuleDetails `mandatory:"false" json:"flowLogCaptureFilterRules"`
}
func (m CaptureFilter) String() string
func (m CaptureFilter) 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
CaptureFilterFilterTypeEnum Enum with underlying type: string
type CaptureFilterFilterTypeEnum string
Set of constants representing the allowable values for CaptureFilterFilterTypeEnum
const (
CaptureFilterFilterTypeVtap CaptureFilterFilterTypeEnum = "VTAP"
CaptureFilterFilterTypeFlowlog CaptureFilterFilterTypeEnum = "FLOWLOG"
)
func GetCaptureFilterFilterTypeEnumValues() []CaptureFilterFilterTypeEnum
GetCaptureFilterFilterTypeEnumValues Enumerates the set of values for CaptureFilterFilterTypeEnum
func GetMappingCaptureFilterFilterTypeEnum(val string) (CaptureFilterFilterTypeEnum, bool)
GetMappingCaptureFilterFilterTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CaptureFilterLifecycleStateEnum Enum with underlying type: string
type CaptureFilterLifecycleStateEnum string
Set of constants representing the allowable values for CaptureFilterLifecycleStateEnum
const (
CaptureFilterLifecycleStateProvisioning CaptureFilterLifecycleStateEnum = "PROVISIONING"
CaptureFilterLifecycleStateAvailable CaptureFilterLifecycleStateEnum = "AVAILABLE"
CaptureFilterLifecycleStateUpdating CaptureFilterLifecycleStateEnum = "UPDATING"
CaptureFilterLifecycleStateTerminating CaptureFilterLifecycleStateEnum = "TERMINATING"
CaptureFilterLifecycleStateTerminated CaptureFilterLifecycleStateEnum = "TERMINATED"
)
func GetCaptureFilterLifecycleStateEnumValues() []CaptureFilterLifecycleStateEnum
GetCaptureFilterLifecycleStateEnumValues Enumerates the set of values for CaptureFilterLifecycleStateEnum
func GetMappingCaptureFilterLifecycleStateEnum(val string) (CaptureFilterLifecycleStateEnum, bool)
GetMappingCaptureFilterLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ChangeByoipRangeCompartmentDetails The configuration details for the move operation.
type ChangeByoipRangeCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the destination compartment for the BYOIP CIDR block move.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeByoipRangeCompartmentDetails) String() string
func (m ChangeByoipRangeCompartmentDetails) 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
ChangeCaptureFilterCompartmentDetails These configuration details are used in the move operation when changing the compartment containing a virtual test access point (VTAP) capture filter.
type ChangeCaptureFilterCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the destination compartment for the VTAP
// capture filter move.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeCaptureFilterCompartmentDetails) String() string
func (m ChangeCaptureFilterCompartmentDetails) 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
ChangeCpeCompartmentDetails The configuration details for the move operation.
type ChangeCpeCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the
// CPE object to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeCpeCompartmentDetails) String() string
func (m ChangeCpeCompartmentDetails) 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
ChangeCrossConnectCompartmentDetails The configuration details for the move operation.
type ChangeCrossConnectCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the
// cross-connect to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeCrossConnectCompartmentDetails) String() string
func (m ChangeCrossConnectCompartmentDetails) 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
ChangeCrossConnectGroupCompartmentDetails The configuration details for the move operation.
type ChangeCrossConnectGroupCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the
// cross-connect group to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeCrossConnectGroupCompartmentDetails) String() string
func (m ChangeCrossConnectGroupCompartmentDetails) 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
ChangeDhcpOptionsCompartmentDetails The configuration details for the move operation.
type ChangeDhcpOptionsCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the
// set of DHCP options to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeDhcpOptionsCompartmentDetails) String() string
func (m ChangeDhcpOptionsCompartmentDetails) 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
ChangeDrgCompartmentDetails The configuration details for the move operation.
type ChangeDrgCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the
// DRG to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeDrgCompartmentDetails) String() string
func (m ChangeDrgCompartmentDetails) 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
ChangeInternetGatewayCompartmentDetails The configuration details for the move operation.
type ChangeInternetGatewayCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the
// internet gateway to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeInternetGatewayCompartmentDetails) String() string
func (m ChangeInternetGatewayCompartmentDetails) 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
ChangeIpSecConnectionCompartmentDetails The configuration details for the move operation.
type ChangeIpSecConnectionCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the
// IPSec connection to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeIpSecConnectionCompartmentDetails) String() string
func (m ChangeIpSecConnectionCompartmentDetails) 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
ChangeLocalPeeringGatewayCompartmentDetails The configuration details for the move operation.
type ChangeLocalPeeringGatewayCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the
// local peering gateway to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeLocalPeeringGatewayCompartmentDetails) String() string
func (m ChangeLocalPeeringGatewayCompartmentDetails) 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
ChangeNatGatewayCompartmentDetails The configuration details for the move operation.
type ChangeNatGatewayCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the NAT gateway to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeNatGatewayCompartmentDetails) String() string
func (m ChangeNatGatewayCompartmentDetails) 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
ChangeNetworkSecurityGroupCompartmentDetails The representation of ChangeNetworkSecurityGroupCompartmentDetails
type ChangeNetworkSecurityGroupCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the network
// security group to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeNetworkSecurityGroupCompartmentDetails) String() string
func (m ChangeNetworkSecurityGroupCompartmentDetails) 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
ChangePathAnalyzerTestCompartmentDetails Details of the new `compartmentId` for the `PathAnalyzerTest` resource.
type ChangePathAnalyzerTestCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment
// into which the `PathAnalyzerTest` resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangePathAnalyzerTestCompartmentDetails) String() string
func (m ChangePathAnalyzerTestCompartmentDetails) 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
ChangePathAnalyzerTestCompartmentRequest wrapper for the ChangePathAnalyzerTestCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/ChangePathAnalyzerTestCompartment.go.html to see an example of how to use ChangePathAnalyzerTestCompartmentRequest.
type ChangePathAnalyzerTestCompartmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `PathAnalyzerTest` resource.
PathAnalyzerTestId *string `mandatory:"true" contributesTo:"path" name:"pathAnalyzerTestId"`
// The information to update.
ChangePathAnalyzerTestCompartmentDetails `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"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangePathAnalyzerTestCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangePathAnalyzerTestCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangePathAnalyzerTestCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangePathAnalyzerTestCompartmentRequest) String() string
func (request ChangePathAnalyzerTestCompartmentRequest) 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
ChangePathAnalyzerTestCompartmentResponse wrapper for the ChangePathAnalyzerTestCompartment operation
type ChangePathAnalyzerTestCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangePathAnalyzerTestCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangePathAnalyzerTestCompartmentResponse) String() string
ChangePublicIpCompartmentDetails The configuration details for the move operation.
type ChangePublicIpCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the
// public IP to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangePublicIpCompartmentDetails) String() string
func (m ChangePublicIpCompartmentDetails) 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
ChangePublicIpPoolCompartmentDetails The configuration details for the move operation.
type ChangePublicIpPoolCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the destination compartment for the public IP pool move.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangePublicIpPoolCompartmentDetails) String() string
func (m ChangePublicIpPoolCompartmentDetails) 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
ChangeRemotePeeringConnectionCompartmentDetails The configuration details for the move operation.
type ChangeRemotePeeringConnectionCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the
// remote peering connection to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeRemotePeeringConnectionCompartmentDetails) String() string
func (m ChangeRemotePeeringConnectionCompartmentDetails) 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
ChangeRouteTableCompartmentDetails The configuration details for the move operation.
type ChangeRouteTableCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the
// route table to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeRouteTableCompartmentDetails) String() string
func (m ChangeRouteTableCompartmentDetails) 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
ChangeSecurityListCompartmentDetails The configuration details for the move operation.
type ChangeSecurityListCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the
// security list to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeSecurityListCompartmentDetails) String() string
func (m ChangeSecurityListCompartmentDetails) 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
ChangeServiceGatewayCompartmentDetails The configuration details for the move operation.
type ChangeServiceGatewayCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the
// service gateway to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeServiceGatewayCompartmentDetails) String() string
func (m ChangeServiceGatewayCompartmentDetails) 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
ChangeSubnetCompartmentDetails The configuration details for the move operation.
type ChangeSubnetCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the
// subnet to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeSubnetCompartmentDetails) String() string
func (m ChangeSubnetCompartmentDetails) 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
ChangeVcnCompartmentDetails The configuration details for the move operation.
type ChangeVcnCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the
// VCN to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeVcnCompartmentDetails) String() string
func (m ChangeVcnCompartmentDetails) 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
ChangeVirtualCircuitCompartmentDetails The configuration details for the move operation.
type ChangeVirtualCircuitCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the
// virtual circuit to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeVirtualCircuitCompartmentDetails) String() string
func (m ChangeVirtualCircuitCompartmentDetails) 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
ChangeVlanCompartmentDetails The configuration details for the move operation.
type ChangeVlanCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the VLAN to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeVlanCompartmentDetails) String() string
func (m ChangeVlanCompartmentDetails) 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
ChangeVtapCompartmentDetails These configuration details are used in the move operation when changing the compartment containing a virtual test access point (VTAP).
type ChangeVtapCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the destination compartment for the VTAP move.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeVtapCompartmentDetails) String() string
func (m ChangeVtapCompartmentDetails) 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
CompartmentInternal Helper definition required to perform authZ using SPLAT expressions on a Compartment
type CompartmentInternal struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
Id *string `mandatory:"false" json:"id"`
}
func (m CompartmentInternal) String() string
func (m CompartmentInternal) 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
ComputeInstanceEndpoint Defines the details required for a COMPUTE_INSTANCE-type `Endpoint`.
type ComputeInstanceEndpoint struct {
// The IPv4 address of the COMPUTE_INSTANCE-type `Endpoint` object.
Address *string `mandatory:"true" json:"address"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute instance.
InstanceId *string `mandatory:"true" json:"instanceId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC attached to the compute instance.
VnicId *string `mandatory:"true" json:"vnicId"`
}
func (m ComputeInstanceEndpoint) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ComputeInstanceEndpoint) String() string
func (m ComputeInstanceEndpoint) 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
ConnectLocalPeeringGatewaysDetails Information about the other local peering gateway (LPG).
type ConnectLocalPeeringGatewaysDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the LPG you want to peer with.
PeerId *string `mandatory:"true" json:"peerId"`
}
func (m ConnectLocalPeeringGatewaysDetails) String() string
func (m ConnectLocalPeeringGatewaysDetails) 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
ConnectRemotePeeringConnectionsDetails Information about the other remote peering connection (RPC).
type ConnectRemotePeeringConnectionsDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the RPC you want to peer with.
PeerId *string `mandatory:"true" json:"peerId"`
// The name of the region that contains the RPC you want to peer with.
// Example: `us-ashburn-1`
PeerRegionName *string `mandatory:"true" json:"peerRegionName"`
}
func (m ConnectRemotePeeringConnectionsDetails) String() string
func (m ConnectRemotePeeringConnectionsDetails) 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
Cpe An object you create when setting up a Site-to-Site VPN between your on-premises network and VCN. The `Cpe` is a virtual representation of your customer-premises equipment, which is the actual router on-premises at your site at your end of the Site-to-Site VPN IPSec connection. For more information, see Overview of the Networking Service (https://docs.oracle.com/iaas/Content/Network/Concepts/overview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type Cpe struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the CPE.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The CPE's Oracle ID (OCID).
Id *string `mandatory:"true" json:"id"`
// The public IP address of the on-premises router.
IpAddress *string `mandatory:"true" json:"ipAddress"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the CPE's device type.
// The Networking service maintains a general list of CPE device types (for example,
// Cisco ASA). For each type, Oracle provides CPE configuration content that can help
// a network engineer configure the CPE. The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) uniquely identifies the type of
// device. To get the OCIDs for the device types on the list, see
// ListCpeDeviceShapes.
// For information about how to generate CPE configuration content for a
// CPE device type, see:
// * GetCpeDeviceConfigContent
// * GetIpsecCpeDeviceConfigContent
// * GetTunnelCpeDeviceConfigContent
// * GetTunnelCpeDeviceConfig
CpeDeviceShapeId *string `mandatory:"false" json:"cpeDeviceShapeId"`
// The date and time the CPE was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Indicates whether this CPE is of type `private` or not.
IsPrivate *bool `mandatory:"false" json:"isPrivate"`
}
func (m Cpe) String() string
func (m Cpe) 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
CpeDeviceConfigAnswer An individual answer to a CPE device question. The answers correlate to the questions that are specific to the CPE device type (see the `parameters` attribute of CpeDeviceShapeDetail).
type CpeDeviceConfigAnswer struct {
// A string that identifies the question to be answered. See the `key` attribute in
// CpeDeviceConfigQuestion.
Key *string `mandatory:"false" json:"key"`
// The answer to the question.
Value *string `mandatory:"false" json:"value"`
}
func (m CpeDeviceConfigAnswer) String() string
func (m CpeDeviceConfigAnswer) 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
CpeDeviceConfigQuestion An individual question that the customer can answer about the CPE device. The customer provides answers to these questions in UpdateTunnelCpeDeviceConfig.
type CpeDeviceConfigQuestion struct {
// A string that identifies the question.
Key *string `mandatory:"false" json:"key"`
// A descriptive label for the question (for example, to display in a form in a graphical interface).
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A description or explanation of the question, to help the customer answer accurately.
Explanation *string `mandatory:"false" json:"explanation"`
}
func (m CpeDeviceConfigQuestion) String() string
func (m CpeDeviceConfigQuestion) 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
CpeDeviceInfo Basic information about a particular CPE device type.
type CpeDeviceInfo struct {
// The vendor that makes the CPE device.
Vendor *string `mandatory:"false" json:"vendor"`
// The platform or software version of the CPE device.
PlatformSoftwareVersion *string `mandatory:"false" json:"platformSoftwareVersion"`
}
func (m CpeDeviceInfo) String() string
func (m CpeDeviceInfo) 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
CpeDeviceShapeDetail The detailed information about a particular CPE device type. Compare with CpeDeviceShapeSummary.
type CpeDeviceShapeDetail struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape.
// This value uniquely identifies the type of CPE device.
CpeDeviceShapeId *string `mandatory:"false" json:"cpeDeviceShapeId"`
CpeDeviceInfo *CpeDeviceInfo `mandatory:"false" json:"cpeDeviceInfo"`
// For certain CPE devices types, the customer can provide answers to
// questions that are specific to the device type. This attribute contains
// a list of those questions. The Networking service merges the answers with
// other information and renders a set of CPE configuration content. To
// provide the answers, use
// UpdateTunnelCpeDeviceConfig.
Parameters []CpeDeviceConfigQuestion `mandatory:"false" json:"parameters"`
// A template of CPE device configuration information that will be merged with the customer's
// answers to the questions to render the final CPE device configuration content. Also see:
// * GetCpeDeviceConfigContent
// * GetIpsecCpeDeviceConfigContent
// * GetTunnelCpeDeviceConfigContent
Template *string `mandatory:"false" json:"template"`
}
func (m CpeDeviceShapeDetail) String() string
func (m CpeDeviceShapeDetail) 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
CpeDeviceShapeSummary A summary of information about a particular CPE device type. Compare with CpeDeviceShapeDetail.
type CpeDeviceShapeSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape.
// This value uniquely identifies the type of CPE device.
Id *string `mandatory:"false" json:"id"`
CpeDeviceInfo *CpeDeviceInfo `mandatory:"false" json:"cpeDeviceInfo"`
}
func (m CpeDeviceShapeSummary) String() string
func (m CpeDeviceShapeSummary) 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
CreateByoipRangeDetails The information used to create a `ByoipRange` resource.
type CreateByoipRangeDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the BYOIP CIDR block.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The BYOIP CIDR block. You can assign some or all of it to a public IP pool after it is validated.
// Example: `10.0.1.0/24`
CidrBlock *string `mandatory:"false" json:"cidrBlock"`
// The BYOIPv6 CIDR block. You can assign some or all of it to a VCN after it is validated.
Ipv6CidrBlock *string `mandatory:"false" json:"ipv6CidrBlock"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m CreateByoipRangeDetails) String() string
func (m CreateByoipRangeDetails) 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
CreateCaptureFilterDetails A capture filter contains a set of rules governing what traffic a VTAP mirrors.
type CreateCaptureFilterDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the capture filter.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Indicates which service will use this capture filter
FilterType CreateCaptureFilterDetailsFilterTypeEnum `mandatory:"true" json:"filterType"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The set of rules governing what traffic a VTAP mirrors.
VtapCaptureFilterRules []VtapCaptureFilterRuleDetails `mandatory:"false" json:"vtapCaptureFilterRules"`
// The set of rules governing what traffic the Flow Log collects when creating a flow log capture filter.
FlowLogCaptureFilterRules []FlowLogCaptureFilterRuleDetails `mandatory:"false" json:"flowLogCaptureFilterRules"`
}
func (m CreateCaptureFilterDetails) String() string
func (m CreateCaptureFilterDetails) 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
CreateCaptureFilterDetailsFilterTypeEnum Enum with underlying type: string
type CreateCaptureFilterDetailsFilterTypeEnum string
Set of constants representing the allowable values for CreateCaptureFilterDetailsFilterTypeEnum
const (
CreateCaptureFilterDetailsFilterTypeVtap CreateCaptureFilterDetailsFilterTypeEnum = "VTAP"
CreateCaptureFilterDetailsFilterTypeFlowlog CreateCaptureFilterDetailsFilterTypeEnum = "FLOWLOG"
)
func GetCreateCaptureFilterDetailsFilterTypeEnumValues() []CreateCaptureFilterDetailsFilterTypeEnum
GetCreateCaptureFilterDetailsFilterTypeEnumValues Enumerates the set of values for CreateCaptureFilterDetailsFilterTypeEnum
func GetMappingCreateCaptureFilterDetailsFilterTypeEnum(val string) (CreateCaptureFilterDetailsFilterTypeEnum, bool)
GetMappingCreateCaptureFilterDetailsFilterTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateCpeDetails The representation of CreateCpeDetails
type CreateCpeDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the CPE.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The public IP address of the on-premises router.
// Example: `203.0.113.2`
IpAddress *string `mandatory:"true" json:"ipAddress"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the CPE device type. You can provide
// a value if you want to later generate CPE device configuration content for IPSec connections
// that use this CPE. You can also call UpdateCpe later to
// provide a value. For a list of possible values, see
// ListCpeDeviceShapes.
// For more information about generating CPE device configuration content, see:
// * GetCpeDeviceConfigContent
// * GetIpsecCpeDeviceConfigContent
// * GetTunnelCpeDeviceConfigContent
// * GetTunnelCpeDeviceConfig
CpeDeviceShapeId *string `mandatory:"false" json:"cpeDeviceShapeId"`
// Indicates whether this CPE is of type `private` or not.
IsPrivate *bool `mandatory:"false" json:"isPrivate"`
}
func (m CreateCpeDetails) String() string
func (m CreateCpeDetails) 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
CreateCrossConnectDetails The representation of CreateCrossConnectDetails
type CreateCrossConnectDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the cross-connect.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The name of the FastConnect location where this cross-connect will be installed.
// To get a list of the available locations, see
// ListCrossConnectLocations.
// Example: `CyrusOne, Chandler, AZ`
LocationName *string `mandatory:"true" json:"locationName"`
// The port speed for this cross-connect. To get a list of the available port speeds, see
// ListCrossconnectPortSpeedShapes.
// Example: `10 Gbps`
PortSpeedShapeName *string `mandatory:"true" json:"portSpeedShapeName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group to put this cross-connect in.
CrossConnectGroupId *string `mandatory:"false" json:"crossConnectGroupId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// If you already have an existing cross-connect or cross-connect group at this FastConnect
// location, and you want this new cross-connect to be on a different router (for the
// purposes of redundancy), provide the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of that existing cross-connect or
// cross-connect group.
FarCrossConnectOrCrossConnectGroupId *string `mandatory:"false" json:"farCrossConnectOrCrossConnectGroupId"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// If you already have an existing cross-connect or cross-connect group at this FastConnect
// location, and you want this new cross-connect to be on the same router, provide the
// OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of that existing cross-connect or cross-connect group.
NearCrossConnectOrCrossConnectGroupId *string `mandatory:"false" json:"nearCrossConnectOrCrossConnectGroupId"`
// A reference name or identifier for the physical fiber connection that this cross-connect
// uses.
CustomerReferenceName *string `mandatory:"false" json:"customerReferenceName"`
MacsecProperties *CreateMacsecProperties `mandatory:"false" json:"macsecProperties"`
}
func (m CreateCrossConnectDetails) String() string
func (m CreateCrossConnectDetails) 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
CreateCrossConnectGroupDetails The representation of CreateCrossConnectGroupDetails
type CreateCrossConnectGroupDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the cross-connect group.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A reference name or identifier for the physical fiber connection that this cross-connect
// group uses.
CustomerReferenceName *string `mandatory:"false" json:"customerReferenceName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
MacsecProperties *CreateMacsecProperties `mandatory:"false" json:"macsecProperties"`
}
func (m CreateCrossConnectGroupDetails) String() string
func (m CreateCrossConnectGroupDetails) 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
CreateDhcpDetails The representation of CreateDhcpDetails
type CreateDhcpDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the set of DHCP options.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A set of DHCP options.
Options []DhcpOption `mandatory:"true" json:"options"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN the set of DHCP options belongs to.
VcnId *string `mandatory:"true" json:"vcnId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The search domain name type of DHCP options
DomainNameType CreateDhcpDetailsDomainNameTypeEnum `mandatory:"false" json:"domainNameType,omitempty"`
}
func (m CreateDhcpDetails) String() string
func (m *CreateDhcpDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateDhcpDetails) 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
CreateDhcpDetailsDomainNameTypeEnum Enum with underlying type: string
type CreateDhcpDetailsDomainNameTypeEnum string
Set of constants representing the allowable values for CreateDhcpDetailsDomainNameTypeEnum
const (
CreateDhcpDetailsDomainNameTypeSubnetDomain CreateDhcpDetailsDomainNameTypeEnum = "SUBNET_DOMAIN"
CreateDhcpDetailsDomainNameTypeVcnDomain CreateDhcpDetailsDomainNameTypeEnum = "VCN_DOMAIN"
CreateDhcpDetailsDomainNameTypeCustomDomain CreateDhcpDetailsDomainNameTypeEnum = "CUSTOM_DOMAIN"
)
func GetCreateDhcpDetailsDomainNameTypeEnumValues() []CreateDhcpDetailsDomainNameTypeEnum
GetCreateDhcpDetailsDomainNameTypeEnumValues Enumerates the set of values for CreateDhcpDetailsDomainNameTypeEnum
func GetMappingCreateDhcpDetailsDomainNameTypeEnum(val string) (CreateDhcpDetailsDomainNameTypeEnum, bool)
GetMappingCreateDhcpDetailsDomainNameTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateDrgAttachmentDetails The representation of CreateDrgAttachmentDetails
type CreateDrgAttachmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG.
DrgId *string `mandatory:"true" json:"drgId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table that is assigned to this attachment.
// The DRG route table manages traffic inside the DRG.
DrgRouteTableId *string `mandatory:"false" json:"drgRouteTableId"`
NetworkDetails DrgAttachmentNetworkCreateDetails `mandatory:"false" json:"networkDetails"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the DRG attachment.
// If you don't specify a route table here, the DRG attachment is created without an associated route
// table. The Networking service does NOT automatically associate the attached VCN's default route table
// with the DRG attachment.
// For information about why you would associate a route table with a DRG attachment, see:
// * Transit Routing: Access to Multiple VCNs in Same Region (https://docs.oracle.com/iaas/Content/Network/Tasks/transitrouting.htm)
// * Transit Routing: Private Access to Oracle Services (https://docs.oracle.com/iaas/Content/Network/Tasks/transitroutingoracleservices.htm)
// This field is deprecated. Instead, use the networkDetails field to specify the VCN route table for this attachment.
RouteTableId *string `mandatory:"false" json:"routeTableId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN.
// This field is deprecated. Instead, use the `networkDetails` field to specify the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the attached resource.
VcnId *string `mandatory:"false" json:"vcnId"`
}
func (m CreateDrgAttachmentDetails) String() string
func (m *CreateDrgAttachmentDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateDrgAttachmentDetails) 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
CreateDrgDetails The representation of CreateDrgDetails
type CreateDrgDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the DRG.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m CreateDrgDetails) String() string
func (m CreateDrgDetails) 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
CreateDrgRouteDistributionDetails Details used to create a route distribution.
type CreateDrgRouteDistributionDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG the DRG route table belongs to.
DrgId *string `mandatory:"true" json:"drgId"`
// Whether this distribution defines how routes get imported into route tables or exported through DRG Attachments
DistributionType CreateDrgRouteDistributionDetailsDistributionTypeEnum `mandatory:"true" json:"distributionType"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m CreateDrgRouteDistributionDetails) String() string
func (m CreateDrgRouteDistributionDetails) 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
CreateDrgRouteDistributionDetailsDistributionTypeEnum Enum with underlying type: string
type CreateDrgRouteDistributionDetailsDistributionTypeEnum string
Set of constants representing the allowable values for CreateDrgRouteDistributionDetailsDistributionTypeEnum
const (
CreateDrgRouteDistributionDetailsDistributionTypeImport CreateDrgRouteDistributionDetailsDistributionTypeEnum = "IMPORT"
)
func GetCreateDrgRouteDistributionDetailsDistributionTypeEnumValues() []CreateDrgRouteDistributionDetailsDistributionTypeEnum
GetCreateDrgRouteDistributionDetailsDistributionTypeEnumValues Enumerates the set of values for CreateDrgRouteDistributionDetailsDistributionTypeEnum
func GetMappingCreateDrgRouteDistributionDetailsDistributionTypeEnum(val string) (CreateDrgRouteDistributionDetailsDistributionTypeEnum, bool)
GetMappingCreateDrgRouteDistributionDetailsDistributionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateDrgRouteTableDetails Details used in a request to create a DRG route table.
type CreateDrgRouteTableDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG the DRG route table belongs to.
DrgId *string `mandatory:"true" json:"drgId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution used to specify how incoming route advertisements through
// referenced attachments are inserted into the DRG route table.
ImportDrgRouteDistributionId *string `mandatory:"false" json:"importDrgRouteDistributionId"`
// If you want traffic to be routed using ECMP across your virtual circuits or IPSec tunnels to
// your on-premises networks, enable ECMP on the DRG route table.
IsEcmpEnabled *bool `mandatory:"false" json:"isEcmpEnabled"`
}
func (m CreateDrgRouteTableDetails) String() string
func (m CreateDrgRouteTableDetails) 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
CreateInternetGatewayDetails The representation of CreateInternetGatewayDetails
type CreateInternetGatewayDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the internet gateway.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Whether the gateway is enabled upon creation.
IsEnabled *bool `mandatory:"true" json:"isEnabled"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN the Internet Gateway is attached to.
VcnId *string `mandatory:"true" json:"vcnId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the Internet Gateway is using.
RouteTableId *string `mandatory:"false" json:"routeTableId"`
}
func (m CreateInternetGatewayDetails) String() string
func (m CreateInternetGatewayDetails) 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
CreateIpSecConnectionDetails The representation of CreateIpSecConnectionDetails
type CreateIpSecConnectionDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the IPSec connection.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Cpe object.
CpeId *string `mandatory:"true" json:"cpeId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG.
DrgId *string `mandatory:"true" json:"drgId"`
// Static routes to the CPE. A static route's CIDR must not be a
// multicast address or class E address.
// Used for routing a given IPSec tunnel's traffic only if the tunnel
// is using static routing. If you configure at least one tunnel to use static routing, then
// you must provide at least one valid static route. If you configure both
// tunnels to use BGP dynamic routing, you can provide an empty list for the static routes.
// For more information, see the important note in IPSecConnection.
// The CIDR can be either IPv4 or IPv6. IPv6 addressing is supported for all commercial and government regions.
// See IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// Example: `10.0.1.0/24`
// Example: `2001:db8::/32`
StaticRoutes []string `mandatory:"true" json:"staticRoutes"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the
// fully qualified domain name (FQDN)). The type of identifier you provide here must correspond
// to the value for `cpeLocalIdentifierType`.
// If you don't provide a value, the `ipAddress` attribute for the Cpe
// object specified by `cpeId` is used as the `cpeLocalIdentifier`.
// For information about why you'd provide this value, see
// If Your CPE Is Behind a NAT Device (https://docs.oracle.com/iaas/Content/Network/Tasks/overviewIPsec.htm#nat).
// Example IP address: `10.0.3.3`
// Example hostname: `cpe.example.com`
CpeLocalIdentifier *string `mandatory:"false" json:"cpeLocalIdentifier"`
// The type of identifier for your CPE device. The value you provide here must correspond to the value
// for `cpeLocalIdentifier`.
CpeLocalIdentifierType CreateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum `mandatory:"false" json:"cpeLocalIdentifierType,omitempty"`
// Information for creating the individual tunnels in the IPSec connection. You can provide a
// maximum of 2 `tunnelConfiguration` objects in the array (one for each of the
// two tunnels).
TunnelConfiguration []CreateIpSecConnectionTunnelDetails `mandatory:"false" json:"tunnelConfiguration"`
// The count of tunnels in the IPsec connection. This value should be equal to the number of
// `tunnelConfiguration` objects specified in the `CreateIPSecConnection` request.
TunnelCount *int `mandatory:"false" json:"tunnelCount"`
}
func (m CreateIpSecConnectionDetails) String() string
func (m CreateIpSecConnectionDetails) 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
CreateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum Enum with underlying type: string
type CreateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum string
Set of constants representing the allowable values for CreateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum
const (
CreateIpSecConnectionDetailsCpeLocalIdentifierTypeIpAddress CreateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum = "IP_ADDRESS"
CreateIpSecConnectionDetailsCpeLocalIdentifierTypeHostname CreateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum = "HOSTNAME"
)
func GetCreateIpSecConnectionDetailsCpeLocalIdentifierTypeEnumValues() []CreateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum
GetCreateIpSecConnectionDetailsCpeLocalIdentifierTypeEnumValues Enumerates the set of values for CreateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum
func GetMappingCreateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum(val string) (CreateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum, bool)
GetMappingCreateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateIpSecConnectionTunnelDetails The representation of CreateIpSecConnectionTunnelDetails
type CreateIpSecConnectionTunnelDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The type of routing to use for this tunnel (BGP dynamic routing, static routing, or policy-based routing).
Routing CreateIpSecConnectionTunnelDetailsRoutingEnum `mandatory:"false" json:"routing,omitempty"`
// Internet Key Exchange protocol version.
IkeVersion CreateIpSecConnectionTunnelDetailsIkeVersionEnum `mandatory:"false" json:"ikeVersion,omitempty"`
// The shared secret (pre-shared key) to use for the IPSec tunnel. Only numbers, letters, and
// spaces are allowed. If you don't provide a value,
// Oracle generates a value for you. You can specify your own shared secret later if
// you like with UpdateIPSecConnectionTunnelSharedSecret.
SharedSecret *string `mandatory:"false" json:"sharedSecret"`
BgpSessionConfig *CreateIpSecTunnelBgpSessionDetails `mandatory:"false" json:"bgpSessionConfig"`
// Indicates whether the Oracle end of the IPSec connection is able to initiate starting up the IPSec tunnel.
OracleInitiation CreateIpSecConnectionTunnelDetailsOracleInitiationEnum `mandatory:"false" json:"oracleInitiation,omitempty"`
// By default (the `AUTO` setting), IKE sends packets with a source and destination port set to 500,
// and when it detects that the port used to forward packets has changed (most likely because a NAT device
// is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T.
// The `ENABLED` option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets.
// The `DISABLED` option directs IKE to completely refuse to negotiate NAT-T
// even if it senses there may be a NAT device in use.
NatTranslationEnabled CreateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum `mandatory:"false" json:"natTranslationEnabled,omitempty"`
PhaseOneConfig *PhaseOneConfigDetails `mandatory:"false" json:"phaseOneConfig"`
PhaseTwoConfig *PhaseTwoConfigDetails `mandatory:"false" json:"phaseTwoConfig"`
DpdConfig *DpdConfig `mandatory:"false" json:"dpdConfig"`
// The headend IP that you can choose on the Oracle side to terminate your private IPSec tunnel.
OracleTunnelIp *string `mandatory:"false" json:"oracleTunnelIp"`
// The list of virtual circuit OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s over which your network can reach this tunnel.
AssociatedVirtualCircuits []string `mandatory:"false" json:"associatedVirtualCircuits"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table assigned to this attachment.
// The DRG route table manages traffic inside the DRG.
DrgRouteTableId *string `mandatory:"false" json:"drgRouteTableId"`
EncryptionDomainConfig *CreateIpSecTunnelEncryptionDomainDetails `mandatory:"false" json:"encryptionDomainConfig"`
}
func (m CreateIpSecConnectionTunnelDetails) String() string
func (m CreateIpSecConnectionTunnelDetails) 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
CreateIpSecConnectionTunnelDetailsIkeVersionEnum Enum with underlying type: string
type CreateIpSecConnectionTunnelDetailsIkeVersionEnum string
Set of constants representing the allowable values for CreateIpSecConnectionTunnelDetailsIkeVersionEnum
const (
CreateIpSecConnectionTunnelDetailsIkeVersionV1 CreateIpSecConnectionTunnelDetailsIkeVersionEnum = "V1"
CreateIpSecConnectionTunnelDetailsIkeVersionV2 CreateIpSecConnectionTunnelDetailsIkeVersionEnum = "V2"
)
func GetCreateIpSecConnectionTunnelDetailsIkeVersionEnumValues() []CreateIpSecConnectionTunnelDetailsIkeVersionEnum
GetCreateIpSecConnectionTunnelDetailsIkeVersionEnumValues Enumerates the set of values for CreateIpSecConnectionTunnelDetailsIkeVersionEnum
func GetMappingCreateIpSecConnectionTunnelDetailsIkeVersionEnum(val string) (CreateIpSecConnectionTunnelDetailsIkeVersionEnum, bool)
GetMappingCreateIpSecConnectionTunnelDetailsIkeVersionEnum performs case Insensitive comparison on enum value and return the desired enum
CreateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum Enum with underlying type: string
type CreateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum string
Set of constants representing the allowable values for CreateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum
const (
CreateIpSecConnectionTunnelDetailsNatTranslationEnabledEnabled CreateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum = "ENABLED"
CreateIpSecConnectionTunnelDetailsNatTranslationEnabledDisabled CreateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum = "DISABLED"
CreateIpSecConnectionTunnelDetailsNatTranslationEnabledAuto CreateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum = "AUTO"
)
func GetCreateIpSecConnectionTunnelDetailsNatTranslationEnabledEnumValues() []CreateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum
GetCreateIpSecConnectionTunnelDetailsNatTranslationEnabledEnumValues Enumerates the set of values for CreateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum
func GetMappingCreateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum(val string) (CreateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum, bool)
GetMappingCreateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum performs case Insensitive comparison on enum value and return the desired enum
CreateIpSecConnectionTunnelDetailsOracleInitiationEnum Enum with underlying type: string
type CreateIpSecConnectionTunnelDetailsOracleInitiationEnum string
Set of constants representing the allowable values for CreateIpSecConnectionTunnelDetailsOracleInitiationEnum
const (
CreateIpSecConnectionTunnelDetailsOracleInitiationInitiatorOrResponder CreateIpSecConnectionTunnelDetailsOracleInitiationEnum = "INITIATOR_OR_RESPONDER"
CreateIpSecConnectionTunnelDetailsOracleInitiationResponderOnly CreateIpSecConnectionTunnelDetailsOracleInitiationEnum = "RESPONDER_ONLY"
)
func GetCreateIpSecConnectionTunnelDetailsOracleInitiationEnumValues() []CreateIpSecConnectionTunnelDetailsOracleInitiationEnum
GetCreateIpSecConnectionTunnelDetailsOracleInitiationEnumValues Enumerates the set of values for CreateIpSecConnectionTunnelDetailsOracleInitiationEnum
func GetMappingCreateIpSecConnectionTunnelDetailsOracleInitiationEnum(val string) (CreateIpSecConnectionTunnelDetailsOracleInitiationEnum, bool)
GetMappingCreateIpSecConnectionTunnelDetailsOracleInitiationEnum performs case Insensitive comparison on enum value and return the desired enum
CreateIpSecConnectionTunnelDetailsRoutingEnum Enum with underlying type: string
type CreateIpSecConnectionTunnelDetailsRoutingEnum string
Set of constants representing the allowable values for CreateIpSecConnectionTunnelDetailsRoutingEnum
const (
CreateIpSecConnectionTunnelDetailsRoutingBgp CreateIpSecConnectionTunnelDetailsRoutingEnum = "BGP"
CreateIpSecConnectionTunnelDetailsRoutingStatic CreateIpSecConnectionTunnelDetailsRoutingEnum = "STATIC"
CreateIpSecConnectionTunnelDetailsRoutingPolicy CreateIpSecConnectionTunnelDetailsRoutingEnum = "POLICY"
)
func GetCreateIpSecConnectionTunnelDetailsRoutingEnumValues() []CreateIpSecConnectionTunnelDetailsRoutingEnum
GetCreateIpSecConnectionTunnelDetailsRoutingEnumValues Enumerates the set of values for CreateIpSecConnectionTunnelDetailsRoutingEnum
func GetMappingCreateIpSecConnectionTunnelDetailsRoutingEnum(val string) (CreateIpSecConnectionTunnelDetailsRoutingEnum, bool)
GetMappingCreateIpSecConnectionTunnelDetailsRoutingEnum performs case Insensitive comparison on enum value and return the desired enum
CreateIpSecTunnelBgpSessionDetails The representation of CreateIpSecTunnelBgpSessionDetails
type CreateIpSecTunnelBgpSessionDetails struct {
// The IP address for the Oracle end of the inside tunnel interface.
// If the tunnel's `routing` attribute is set to `BGP`
// (see IPSecConnectionTunnel), this IP address
// is required and used for the tunnel's BGP session.
// If `routing` is instead set to `STATIC`, this IP address is optional. You can set this IP
// address to troubleshoot or monitor the tunnel.
// The value must be a /30 or /31.
// Example: `10.0.0.4/31`
OracleInterfaceIp *string `mandatory:"false" json:"oracleInterfaceIp"`
// The IP address for the CPE end of the inside tunnel interface.
// If the tunnel's `routing` attribute is set to `BGP`
// (see IPSecConnectionTunnel), this IP address
// is required and used for the tunnel's BGP session.
// If `routing` is instead set to `STATIC`, this IP address is optional. You can set this IP
// address to troubleshoot or monitor the tunnel.
// The value must be a /30 or /31.
// Example: `10.0.0.5/31`
CustomerInterfaceIp *string `mandatory:"false" json:"customerInterfaceIp"`
// The IPv6 address for the Oracle end of the inside tunnel interface. This IP address is optional.
// If the tunnel's `routing` attribute is set to `BGP`
// (see IPSecConnectionTunnel), this IP address
// is used for the tunnel's BGP session.
// If `routing` is instead set to `STATIC`, you can set this IP
// address to troubleshoot or monitor the tunnel.
// Only subnet masks from /64 up to /127 are allowed.
// Example: `2001:db8::1/64`
OracleInterfaceIpv6 *string `mandatory:"false" json:"oracleInterfaceIpv6"`
// The IPv6 address for the CPE end of the inside tunnel interface. This IP address is optional.
// If the tunnel's `routing` attribute is set to `BGP`
// (see IPSecConnectionTunnel), this IP address
// is used for the tunnel's BGP session.
// If `routing` is instead set to `STATIC`, you can set this IP
// address to troubleshoot or monitor the tunnel.
// Only subnet masks from /64 up to /127 are allowed.
// Example: `2001:db8::1/64`
CustomerInterfaceIpv6 *string `mandatory:"false" json:"customerInterfaceIpv6"`
// If the tunnel's `routing` attribute is set to `BGP`
// (see IPSecConnectionTunnel), this ASN
// is required and used for the tunnel's BGP session. This is the ASN of the network on the
// CPE end of the BGP session. Can be a 2-byte or 4-byte ASN. Uses "asplain" format.
// If the tunnel's `routing` attribute is set to `STATIC`, the `customerBgpAsn` must be null.
// Example: `12345` (2-byte) or `1587232876` (4-byte)
CustomerBgpAsn *string `mandatory:"false" json:"customerBgpAsn"`
}
func (m CreateIpSecTunnelBgpSessionDetails) String() string
func (m CreateIpSecTunnelBgpSessionDetails) 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
CreateIpSecTunnelEncryptionDomainDetails Request to enable a multi-encryption domain policy on the IPSec tunnel. There can't be more than 50 security associations in use at one time. See Encryption domain for policy-based tunnels (https://docs.oracle.com/iaas/Content/Network/Tasks/ipsecencryptiondomains.htm#spi_policy_based_tunnel) for more.
type CreateIpSecTunnelEncryptionDomainDetails struct {
// Lists IPv4 or IPv6-enabled subnets in your Oracle tenancy.
OracleTrafficSelector []string `mandatory:"false" json:"oracleTrafficSelector"`
// Lists IPv4 or IPv6-enabled subnets in your on-premises network.
CpeTrafficSelector []string `mandatory:"false" json:"cpeTrafficSelector"`
}
func (m CreateIpSecTunnelEncryptionDomainDetails) String() string
func (m CreateIpSecTunnelEncryptionDomainDetails) 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
CreateIpv6Details The representation of CreateIpv6Details
type CreateIpv6Details struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to assign the IPv6 to. The
// IPv6 will be in the VNIC's subnet.
VnicId *string `mandatory:"true" json:"vnicId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// An IPv6 address of your choice. Must be an available IP address within
// the subnet's CIDR. If you don't specify a value, Oracle automatically
// assigns an IPv6 address from the subnet. The subnet is the one that
// contains the VNIC you specify in `vnicId`.
// Example: `2001:DB8::`
IpAddress *string `mandatory:"false" json:"ipAddress"`
// The IPv6 CIDR allocated to the subnet. This is required if more than one IPv6 CIDR exists on the subnet.
Ipv6SubnetCidr *string `mandatory:"false" json:"ipv6SubnetCidr"`
}
func (m CreateIpv6Details) String() string
func (m CreateIpv6Details) 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
CreateLocalPeeringGatewayDetails The representation of CreateLocalPeeringGatewayDetails
type CreateLocalPeeringGatewayDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the local peering gateway (LPG).
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN the LPG belongs to.
VcnId *string `mandatory:"true" json:"vcnId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the LPG will use.
// If you don't specify a route table here, the LPG is created without an associated route
// table. The Networking service does NOT automatically associate the attached VCN's default route table
// with the LPG.
// For information about why you would associate a route table with an LPG, see
// Transit Routing: Access to Multiple VCNs in Same Region (https://docs.oracle.com/iaas/Content/Network/Tasks/transitrouting.htm).
RouteTableId *string `mandatory:"false" json:"routeTableId"`
}
func (m CreateLocalPeeringGatewayDetails) String() string
func (m CreateLocalPeeringGatewayDetails) 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
CreateMacsecKey Defines the secret OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s held in Vault that represent the MACsec key.
type CreateMacsecKey struct {
// Secret OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key.
// NOTE: Only the latest secret version will be used.
ConnectivityAssociationNameSecretId *string `mandatory:"true" json:"connectivityAssociationNameSecretId"`
// Secret OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key.
// NOTE: Only the latest secret version will be used.
ConnectivityAssociationKeySecretId *string `mandatory:"true" json:"connectivityAssociationKeySecretId"`
}
func (m CreateMacsecKey) String() string
func (m CreateMacsecKey) 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
CreateMacsecProperties Properties used to configure MACsec (if capable).
type CreateMacsecProperties struct {
// Indicates whether or not MACsec is enabled.
State MacsecStateEnum `mandatory:"true" json:"state"`
PrimaryKey *CreateMacsecKey `mandatory:"false" json:"primaryKey"`
// Type of encryption cipher suite to use for the MACsec connection.
EncryptionCipher MacsecEncryptionCipherEnum `mandatory:"false" json:"encryptionCipher,omitempty"`
}
func (m CreateMacsecProperties) String() string
func (m CreateMacsecProperties) 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
CreateNatGatewayDetails The representation of CreateNatGatewayDetails
type CreateNatGatewayDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the
// NAT gateway.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN the gateway belongs to.
VcnId *string `mandatory:"true" json:"vcnId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Whether the NAT gateway blocks traffic through it. The default is `false`.
// Example: `true`
BlockTraffic *bool `mandatory:"false" json:"blockTraffic"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the public IP address associated with the NAT gateway.
PublicIpId *string `mandatory:"false" json:"publicIpId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the NAT gateway.
// If you don't specify a route table here, the NAT gateway is created without an associated route
// table. The Networking service does NOT automatically associate the attached VCN's default route table
// with the NAT gateway.
RouteTableId *string `mandatory:"false" json:"routeTableId"`
}
func (m CreateNatGatewayDetails) String() string
func (m CreateNatGatewayDetails) 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
CreateNetworkSecurityGroupDetails The representation of CreateNetworkSecurityGroupDetails
type CreateNetworkSecurityGroupDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the
// network security group.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN to create the network
// security group in.
VcnId *string `mandatory:"true" json:"vcnId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m CreateNetworkSecurityGroupDetails) String() string
func (m CreateNetworkSecurityGroupDetails) 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
CreatePathAnalyzerTestDetails Details used to create a `PathAnalyzerTest` resource.
type CreatePathAnalyzerTestDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the `PathAnalyzerTest` resource's compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The IP protocol to use in the `PathAnalyzerTest` resource.
Protocol *int `mandatory:"true" json:"protocol"`
SourceEndpoint Endpoint `mandatory:"true" json:"sourceEndpoint"`
DestinationEndpoint Endpoint `mandatory:"true" json:"destinationEndpoint"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
ProtocolParameters ProtocolParameters `mandatory:"false" json:"protocolParameters"`
QueryOptions *QueryOptions `mandatory:"false" json:"queryOptions"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreatePathAnalyzerTestDetails) String() string
func (m *CreatePathAnalyzerTestDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreatePathAnalyzerTestDetails) 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
CreatePathAnalyzerTestRequest wrapper for the CreatePathAnalyzerTest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/CreatePathAnalyzerTest.go.html to see an example of how to use CreatePathAnalyzerTestRequest.
type CreatePathAnalyzerTestRequest struct {
// Details for creating a new PathAnalyzerTest.
CreatePathAnalyzerTestDetails `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
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreatePathAnalyzerTestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreatePathAnalyzerTestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreatePathAnalyzerTestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreatePathAnalyzerTestRequest) String() string
func (request CreatePathAnalyzerTestRequest) 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
CreatePathAnalyzerTestResponse wrapper for the CreatePathAnalyzerTest operation
type CreatePathAnalyzerTestResponse struct {
// The underlying http response
RawResponse *http.Response
// The PathAnalyzerTest instance
PathAnalyzerTest `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreatePathAnalyzerTestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreatePathAnalyzerTestResponse) String() string
CreatePrivateIpDetails The representation of CreatePrivateIpDetails
type CreatePrivateIpDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The hostname for the private IP. Used for DNS. The value
// is the hostname portion of the private IP's fully qualified domain name (FQDN)
// (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`).
// Must be unique across all VNICs in the subnet and comply with
// RFC 952 (https://tools.ietf.org/html/rfc952) and
// RFC 1123 (https://tools.ietf.org/html/rfc1123).
// For more information, see
// DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm).
// Example: `bminstance1`
HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`
// A private IP address of your choice. Must be an available IP address within
// the subnet's CIDR. If you don't specify a value, Oracle automatically
// assigns a private IP address from the subnet.
// Example: `10.0.3.3`
IpAddress *string `mandatory:"false" json:"ipAddress"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to assign the private IP to. The VNIC and private IP
// must be in the same subnet.
VnicId *string `mandatory:"false" json:"vnicId"`
// Use this attribute only with the Oracle Cloud VMware Solution.
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN from which the private IP is to be drawn. The IP address,
// *if supplied*, must be valid for the given VLAN. See Vlan.
VlanId *string `mandatory:"false" json:"vlanId"`
}
func (m CreatePrivateIpDetails) String() string
func (m CreatePrivateIpDetails) 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
CreatePublicIpDetails The representation of CreatePublicIpDetails
type CreatePublicIpDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the public IP. For ephemeral public IPs,
// you must set this to the private IP's compartment OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Defines when the public IP is deleted and released back to the Oracle Cloud
// Infrastructure public IP pool. For more information, see
// Public IP Addresses (https://docs.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm).
Lifetime CreatePublicIpDetailsLifetimeEnum `mandatory:"true" json:"lifetime"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private IP to assign the public IP to.
// Required for an ephemeral public IP because it must always be assigned to a private IP
// (specifically a *primary* private IP).
// Optional for a reserved public IP. If you don't provide it, the public IP is created but not
// assigned to a private IP. You can later assign the public IP with
// UpdatePublicIp.
PrivateIpId *string `mandatory:"false" json:"privateIpId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool.
PublicIpPoolId *string `mandatory:"false" json:"publicIpPoolId"`
}
func (m CreatePublicIpDetails) String() string
func (m CreatePublicIpDetails) 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
CreatePublicIpDetailsLifetimeEnum Enum with underlying type: string
type CreatePublicIpDetailsLifetimeEnum string
Set of constants representing the allowable values for CreatePublicIpDetailsLifetimeEnum
const (
CreatePublicIpDetailsLifetimeEphemeral CreatePublicIpDetailsLifetimeEnum = "EPHEMERAL"
CreatePublicIpDetailsLifetimeReserved CreatePublicIpDetailsLifetimeEnum = "RESERVED"
)
func GetCreatePublicIpDetailsLifetimeEnumValues() []CreatePublicIpDetailsLifetimeEnum
GetCreatePublicIpDetailsLifetimeEnumValues Enumerates the set of values for CreatePublicIpDetailsLifetimeEnum
func GetMappingCreatePublicIpDetailsLifetimeEnum(val string) (CreatePublicIpDetailsLifetimeEnum, bool)
GetMappingCreatePublicIpDetailsLifetimeEnum performs case Insensitive comparison on enum value and return the desired enum
CreatePublicIpPoolDetails The information used to create a public IP pool.
type CreatePublicIpPoolDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the public IP pool.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m CreatePublicIpPoolDetails) String() string
func (m CreatePublicIpPoolDetails) 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
CreateRemotePeeringConnectionDetails The representation of CreateRemotePeeringConnectionDetails
type CreateRemotePeeringConnectionDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the RPC.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG the RPC belongs to.
DrgId *string `mandatory:"true" json:"drgId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m CreateRemotePeeringConnectionDetails) String() string
func (m CreateRemotePeeringConnectionDetails) 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
CreateRouteTableDetails The representation of CreateRouteTableDetails
type CreateRouteTableDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the route table.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The collection of rules used for routing destination IPs to network devices.
RouteRules []RouteRule `mandatory:"true" json:"routeRules"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN the route table belongs to.
VcnId *string `mandatory:"true" json:"vcnId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m CreateRouteTableDetails) String() string
func (m CreateRouteTableDetails) 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
CreateSecurityListDetails The representation of CreateSecurityListDetails
type CreateSecurityListDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the security list.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Rules for allowing egress IP packets.
EgressSecurityRules []EgressSecurityRule `mandatory:"true" json:"egressSecurityRules"`
// Rules for allowing ingress IP packets.
IngressSecurityRules []IngressSecurityRule `mandatory:"true" json:"ingressSecurityRules"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN the security list belongs to.
VcnId *string `mandatory:"true" json:"vcnId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m CreateSecurityListDetails) String() string
func (m CreateSecurityListDetails) 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
CreateServiceGatewayDetails The representation of CreateServiceGatewayDetails
type CreateServiceGatewayDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the service gateway.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// List of the OCIDs of the Service objects to
// enable for the service gateway. This list can be empty if you don't want to enable any
// `Service` objects when you create the gateway. You can enable a `Service`
// object later by using either AttachServiceId
// or UpdateServiceGateway.
// For each enabled `Service`, make sure there's a route rule with the `Service` object's `cidrBlock`
// as the rule's destination and the service gateway as the rule's target. See
// RouteTable.
Services []ServiceIdRequestDetails `mandatory:"true" json:"services"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN.
VcnId *string `mandatory:"true" json:"vcnId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the service gateway will use.
// If you don't specify a route table here, the service gateway is created without an associated route
// table. The Networking service does NOT automatically associate the attached VCN's default route table
// with the service gateway.
// For information about why you would associate a route table with a service gateway, see
// Transit Routing: Private Access to Oracle Services (https://docs.oracle.com/iaas/Content/Network/Tasks/transitroutingoracleservices.htm).
RouteTableId *string `mandatory:"false" json:"routeTableId"`
}
func (m CreateServiceGatewayDetails) String() string
func (m CreateServiceGatewayDetails) 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
CreateSubnetDetails The representation of CreateSubnetDetails
type CreateSubnetDetails struct {
// The CIDR IP address range of the subnet. The CIDR must maintain the following rules -
// a. The CIDR block is valid and correctly formatted.
// b. The new range is within one of the parent VCN ranges.
// Example: `10.0.1.0/24`
CidrBlock *string `mandatory:"true" json:"cidrBlock"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the subnet.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN to contain the subnet.
VcnId *string `mandatory:"true" json:"vcnId"`
// Controls whether the subnet is regional or specific to an availability domain. Oracle
// recommends creating regional subnets because they're more flexible and make it easier to
// implement failover across availability domains. Originally, AD-specific subnets were the
// only kind available to use.
// To create a regional subnet, omit this attribute. Then any resources later created in this
// subnet (such as a Compute instance) can be created in any availability domain in the region.
// To instead create an AD-specific subnet, set this attribute to the availability domain you
// want this subnet to be in. Then any resources later created in this subnet can only be
// created in that availability domain.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the set of DHCP options the subnet will use. If you don't
// provide a value, the subnet uses the VCN's default set of DHCP options.
DhcpOptionsId *string `mandatory:"false" json:"dhcpOptionsId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A DNS label for the subnet, used in conjunction with the VNIC's hostname and
// VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC
// within this subnet (for example, `bminstance1.subnet123.vcn1.oraclevcn.com`).
// Must be an alphanumeric string that begins with a letter and is unique within the VCN.
// The value cannot be changed.
// This value must be set if you want to use the Internet and VCN Resolver to resolve the
// hostnames of instances in the subnet. It can only be set if the VCN itself
// was created with a DNS label.
// For more information, see
// DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm).
// Example: `subnet123`
DnsLabel *string `mandatory:"false" json:"dnsLabel"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Use this to enable IPv6 addressing for this subnet. The VCN must be enabled for IPv6.
// You can't change this subnet characteristic later. All subnets are /64 in size. The subnet
// portion of the IPv6 address is the fourth hextet from the left (1111 in the following example).
// For important details about IPv6 addressing in a VCN, see IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// Example: `2001:0db8:0123:1111::/64`
Ipv6CidrBlock *string `mandatory:"false" json:"ipv6CidrBlock"`
// The list of all IPv6 CIDR blocks (Oracle allocated IPv6 GUA, ULA or private IPv6 CIDR blocks, BYOIPv6 CIDR blocks) for the subnet that meets the following criteria:
// - The CIDR blocks must be valid.
// - Multiple CIDR blocks must not overlap each other or the on-premises network CIDR block.
// - The number of CIDR blocks must not exceed the limit of IPv6 CIDR blocks allowed to a subnet.
Ipv6CidrBlocks []string `mandatory:"false" json:"ipv6CidrBlocks"`
// Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false.
// For IPv6, if `prohibitInternetIngress` is set to `true`, internet access is not allowed for any
// IPv6s assigned to VNICs in the subnet. Otherwise, ingress internet traffic is allowed by default.
// `prohibitPublicIpOnVnic` will be set to the value of `prohibitInternetIngress` to dictate IPv4
// behavior in this subnet. Only one or the other flag should be specified.
// Example: `true`
ProhibitInternetIngress *bool `mandatory:"false" json:"prohibitInternetIngress"`
// Whether VNICs within this subnet can have public IP addresses.
// Defaults to false, which means VNICs created in this subnet will
// automatically be assigned public IP addresses unless specified
// otherwise during instance launch or VNIC creation (with the
// `assignPublicIp` flag in CreateVnicDetails).
// If `prohibitPublicIpOnVnic` is set to true, VNICs created in this
// subnet cannot have public IP addresses (that is, it's a private
// subnet).
// If you intend to use an IPv6 CIDR block, you should use the flag `prohibitInternetIngress` to
// specify ingress internet traffic behavior of the subnet.
// Example: `true`
ProhibitPublicIpOnVnic *bool `mandatory:"false" json:"prohibitPublicIpOnVnic"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the subnet will use. If you don't provide a value,
// the subnet uses the VCN's default route table.
RouteTableId *string `mandatory:"false" json:"routeTableId"`
// The OCIDs of the security list or lists the subnet will use. If you don't
// provide a value, the subnet uses the VCN's default security list.
// Remember that security lists are associated *with the subnet*, but the
// rules are applied to the individual VNICs in the subnet.
SecurityListIds []string `mandatory:"false" json:"securityListIds"`
}
func (m CreateSubnetDetails) String() string
func (m CreateSubnetDetails) 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
CreateVcnDetails The representation of CreateVcnDetails
type CreateVcnDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the VCN.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// **Deprecated.** Do *not* set this value. Use `cidrBlocks` instead.
// Example: `10.0.0.0/16`
CidrBlock *string `mandatory:"false" json:"cidrBlock"`
// The list of one or more IPv4 CIDR blocks for the VCN that meet the following criteria:
// - The CIDR blocks must be valid.
// - They must not overlap with each other or with the on-premises network CIDR block.
// - The number of CIDR blocks must not exceed the limit of CIDR blocks allowed per VCN.
// **Important:** Do *not* specify a value for `cidrBlock`. Use this parameter instead.
CidrBlocks []string `mandatory:"false" json:"cidrBlocks"`
// The list of one or more ULA or Private IPv6 CIDR blocks for the vcn that meets the following criteria:
// - The CIDR blocks must be valid.
// - Multiple CIDR blocks must not overlap each other or the on-premises network CIDR block.
// - The number of CIDR blocks must not exceed the limit of IPv6 CIDR blocks allowed to a vcn.
// **Important:** Do *not* specify a value for `ipv6CidrBlock`. Use this parameter instead.
Ipv6PrivateCidrBlocks []string `mandatory:"false" json:"ipv6PrivateCidrBlocks"`
// Specifies whether to skip Oracle allocated IPv6 GUA. By default, Oracle will allocate one GUA of /56
// size for an IPv6 enabled VCN.
IsOracleGuaAllocationEnabled *bool `mandatory:"false" json:"isOracleGuaAllocationEnabled"`
// The list of BYOIPv6 OCIDs and BYOIPv6 CIDR blocks required to create a VCN that uses BYOIPv6 ranges.
Byoipv6CidrDetails []Byoipv6CidrDetails `mandatory:"false" json:"byoipv6CidrDetails"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A DNS label for the VCN, used in conjunction with the VNIC's hostname and
// subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC
// within this subnet (for example, `bminstance1.subnet123.vcn1.oraclevcn.com`).
// Not required to be unique, but it's a best practice to set unique DNS labels
// for VCNs in your tenancy. Must be an alphanumeric string that begins with a letter.
// The value cannot be changed.
// You must set this value if you want instances to be able to use hostnames to
// resolve other instances in the VCN. Otherwise the Internet and VCN Resolver
// will not work.
// For more information, see
// DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm).
// Example: `vcn1`
DnsLabel *string `mandatory:"false" json:"dnsLabel"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Whether IPv6 is enabled for the VCN. Default is `false`.
// If enabled, Oracle will assign the VCN a IPv6 /56 CIDR block.
// You may skip having Oracle allocate the VCN a IPv6 /56 CIDR block by setting isOracleGuaAllocationEnabled to `false`.
// For important details about IPv6 addressing in a VCN, see IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// Example: `true`
IsIpv6Enabled *bool `mandatory:"false" json:"isIpv6Enabled"`
}
func (m CreateVcnDetails) String() string
func (m CreateVcnDetails) 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
CreateVirtualCircuitDetails The representation of CreateVirtualCircuitDetails
type CreateVirtualCircuitDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the virtual circuit.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The type of IP addresses used in this virtual circuit. PRIVATE
// means RFC 1918 (https://tools.ietf.org/html/rfc1918) addresses
// (10.0.0.0/8, 172.16/12, and 192.168/16).
Type CreateVirtualCircuitDetailsTypeEnum `mandatory:"true" json:"type"`
// The provisioned data rate of the connection. To get a list of the
// available bandwidth levels (that is, shapes), see
// ListFastConnectProviderVirtualCircuitBandwidthShapes.
// Example: `10 Gbps`
BandwidthShapeName *string `mandatory:"false" json:"bandwidthShapeName"`
// Create a `CrossConnectMapping` for each cross-connect or cross-connect
// group this virtual circuit will run on.
CrossConnectMappings []CrossConnectMapping `mandatory:"false" json:"crossConnectMappings"`
// The routing policy sets how routing information about the Oracle cloud is shared over a public virtual circuit.
// Policies available are: `ORACLE_SERVICE_NETWORK`, `REGIONAL`, `MARKET_LEVEL`, and `GLOBAL`.
// See Route Filtering (https://docs.oracle.com/iaas/Content/Network/Concepts/routingonprem.htm#route_filtering) for details.
// By default, routing information is shared for all routes in the same market.
RoutingPolicy []CreateVirtualCircuitDetailsRoutingPolicyEnum `mandatory:"false" json:"routingPolicy,omitempty"`
// Set to `ENABLED` (the default) to activate the BGP session of the virtual circuit, set to `DISABLED` to deactivate the virtual circuit.
BgpAdminState CreateVirtualCircuitDetailsBgpAdminStateEnum `mandatory:"false" json:"bgpAdminState,omitempty"`
// Set to `true` to enable BFD for IPv4 BGP peering, or set to `false` to disable BFD. If this is not set, the default is `false`.
IsBfdEnabled *bool `mandatory:"false" json:"isBfdEnabled"`
// Set to `true` for the virtual circuit to carry only encrypted traffic, or set to `false` for the virtual circuit to carry unencrypted traffic. If this is not set, the default is `false`.
IsTransportMode *bool `mandatory:"false" json:"isTransportMode"`
// Deprecated. Instead use `customerAsn`.
// If you specify values for both, the request will be rejected.
CustomerBgpAsn *int `mandatory:"false" json:"customerBgpAsn"`
// Your BGP ASN (either public or private). Provide this value only if
// there's a BGP session that goes from your edge router to Oracle.
// Otherwise, leave this empty or null.
// Can be a 2-byte or 4-byte ASN. Uses "asplain" format.
// Example: `12345` (2-byte) or `1587232876` (4-byte)
CustomerAsn *int64 `mandatory:"false" json:"customerAsn"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// For private virtual circuits only. The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Drg
// that this virtual circuit uses.
GatewayId *string `mandatory:"false" json:"gatewayId"`
// Deprecated. Instead use `providerServiceId`.
// To get a list of the provider names, see
// ListFastConnectProviderServices.
ProviderName *string `mandatory:"false" json:"providerName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the service offered by the provider (if you're connecting
// via a provider). To get a list of the available service offerings, see
// ListFastConnectProviderServices.
ProviderServiceId *string `mandatory:"false" json:"providerServiceId"`
// The service key name offered by the provider (if the customer is connecting via a provider).
ProviderServiceKeyName *string `mandatory:"false" json:"providerServiceKeyName"`
// Deprecated. Instead use `providerServiceId`.
// To get a list of the provider names, see
// ListFastConnectProviderServices.
ProviderServiceName *string `mandatory:"false" json:"providerServiceName"`
// For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to
// advertise across the connection.
PublicPrefixes []CreateVirtualCircuitPublicPrefixDetails `mandatory:"false" json:"publicPrefixes"`
// The Oracle Cloud Infrastructure region where this virtual
// circuit is located.
// Example: `phx`
Region *string `mandatory:"false" json:"region"`
// The layer 3 IP MTU to use with this virtual circuit.
IpMtu VirtualCircuitIpMtuEnum `mandatory:"false" json:"ipMtu,omitempty"`
}
func (m CreateVirtualCircuitDetails) String() string
func (m CreateVirtualCircuitDetails) 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
CreateVirtualCircuitDetailsBgpAdminStateEnum Enum with underlying type: string
type CreateVirtualCircuitDetailsBgpAdminStateEnum string
Set of constants representing the allowable values for CreateVirtualCircuitDetailsBgpAdminStateEnum
const (
CreateVirtualCircuitDetailsBgpAdminStateEnabled CreateVirtualCircuitDetailsBgpAdminStateEnum = "ENABLED"
CreateVirtualCircuitDetailsBgpAdminStateDisabled CreateVirtualCircuitDetailsBgpAdminStateEnum = "DISABLED"
)
func GetCreateVirtualCircuitDetailsBgpAdminStateEnumValues() []CreateVirtualCircuitDetailsBgpAdminStateEnum
GetCreateVirtualCircuitDetailsBgpAdminStateEnumValues Enumerates the set of values for CreateVirtualCircuitDetailsBgpAdminStateEnum
func GetMappingCreateVirtualCircuitDetailsBgpAdminStateEnum(val string) (CreateVirtualCircuitDetailsBgpAdminStateEnum, bool)
GetMappingCreateVirtualCircuitDetailsBgpAdminStateEnum performs case Insensitive comparison on enum value and return the desired enum
CreateVirtualCircuitDetailsRoutingPolicyEnum Enum with underlying type: string
type CreateVirtualCircuitDetailsRoutingPolicyEnum string
Set of constants representing the allowable values for CreateVirtualCircuitDetailsRoutingPolicyEnum
const (
CreateVirtualCircuitDetailsRoutingPolicyOracleServiceNetwork CreateVirtualCircuitDetailsRoutingPolicyEnum = "ORACLE_SERVICE_NETWORK"
CreateVirtualCircuitDetailsRoutingPolicyRegional CreateVirtualCircuitDetailsRoutingPolicyEnum = "REGIONAL"
CreateVirtualCircuitDetailsRoutingPolicyMarketLevel CreateVirtualCircuitDetailsRoutingPolicyEnum = "MARKET_LEVEL"
CreateVirtualCircuitDetailsRoutingPolicyGlobal CreateVirtualCircuitDetailsRoutingPolicyEnum = "GLOBAL"
)
func GetCreateVirtualCircuitDetailsRoutingPolicyEnumValues() []CreateVirtualCircuitDetailsRoutingPolicyEnum
GetCreateVirtualCircuitDetailsRoutingPolicyEnumValues Enumerates the set of values for CreateVirtualCircuitDetailsRoutingPolicyEnum
func GetMappingCreateVirtualCircuitDetailsRoutingPolicyEnum(val string) (CreateVirtualCircuitDetailsRoutingPolicyEnum, bool)
GetMappingCreateVirtualCircuitDetailsRoutingPolicyEnum performs case Insensitive comparison on enum value and return the desired enum
CreateVirtualCircuitDetailsTypeEnum Enum with underlying type: string
type CreateVirtualCircuitDetailsTypeEnum string
Set of constants representing the allowable values for CreateVirtualCircuitDetailsTypeEnum
const (
CreateVirtualCircuitDetailsTypePublic CreateVirtualCircuitDetailsTypeEnum = "PUBLIC"
CreateVirtualCircuitDetailsTypePrivate CreateVirtualCircuitDetailsTypeEnum = "PRIVATE"
)
func GetCreateVirtualCircuitDetailsTypeEnumValues() []CreateVirtualCircuitDetailsTypeEnum
GetCreateVirtualCircuitDetailsTypeEnumValues Enumerates the set of values for CreateVirtualCircuitDetailsTypeEnum
func GetMappingCreateVirtualCircuitDetailsTypeEnum(val string) (CreateVirtualCircuitDetailsTypeEnum, bool)
GetMappingCreateVirtualCircuitDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateVirtualCircuitPublicPrefixDetails The representation of CreateVirtualCircuitPublicPrefixDetails
type CreateVirtualCircuitPublicPrefixDetails struct {
// An individual public IP prefix (CIDR) to add to the public virtual circuit.
// All prefix sizes are allowed.
CidrBlock *string `mandatory:"true" json:"cidrBlock"`
}
func (m CreateVirtualCircuitPublicPrefixDetails) String() string
func (m CreateVirtualCircuitPublicPrefixDetails) 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
CreateVlanDetails The representation of CreateVlanDetails
type CreateVlanDetails struct {
// The range of IPv4 addresses that will be used for layer 3 communication with
// hosts outside the VLAN. The CIDR must maintain the following rules -
// 1. The CIDR block is valid and correctly formatted.
// 2. The new range is within one of the parent VCN ranges.
// Example: `192.0.2.0/24`
CidrBlock *string `mandatory:"true" json:"cidrBlock"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the VLAN.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN to contain the VLAN.
VcnId *string `mandatory:"true" json:"vcnId"`
// Controls whether the VLAN is regional or specific to an availability domain.
// A regional VLAN has the flexibility to implement failover across availability domains.
// Previously, all VLANs were AD-specific.
// To create a regional VLAN, omit this attribute. Resources created subsequently in this
// VLAN (such as a Compute instance) can be created in any availability domain in the region.
// To create an AD-specific VLAN, use this attribute to specify the availability domain.
// Resources created in this VLAN must be in that availability domain.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// A list of the OCIDs of the network security groups (NSGs) to add all VNICs in the VLAN to. For more
// information about NSGs, see
// NetworkSecurityGroup.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the VLAN will use. If you don't provide a value,
// the VLAN uses the VCN's default route table.
RouteTableId *string `mandatory:"false" json:"routeTableId"`
// The IEEE 802.1Q VLAN tag for this VLAN. The value must be unique across all
// VLANs in the VCN. If you don't provide a value, Oracle assigns one.
// You cannot change the value later. VLAN tag 0 is reserved for use by Oracle.
VlanTag *int `mandatory:"false" json:"vlanTag"`
}
func (m CreateVlanDetails) String() string
func (m CreateVlanDetails) 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
CreateVnicDetails Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see Virtual Network Interface Cards (VNICs) (https://docs.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).
type CreateVnicDetails struct {
// Whether the VNIC should be assigned a public IP address. Defaults to whether
// the subnet is public or private. If not set and the VNIC is being created
// in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the
// Subnet), then no public IP address is assigned.
// If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then
// a public IP address is assigned. If set to true and
// `prohibitPublicIpOnVnic` = true, an error is returned.
// **Note:** This public IP address is associated with the primary private IP
// on the VNIC. For more information, see
// IP Addresses (https://docs.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm).
// **Note:** There's a limit to the number of PublicIp
// a VNIC or instance can have. If you try to create a secondary VNIC
// with an assigned public IP for an instance that has already
// reached its public IP limit, an error is returned. For information
// about the public IP limits, see
// Public IP Addresses (https://docs.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm).
// Example: `false`
// If you specify a `vlanId`, then `assignPublicIp` must be set to false. See
// Vlan.
AssignPublicIp *bool `mandatory:"false" json:"assignPublicIp"`
// Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record
// registration for the VNIC. If set to true, the DNS record will be registered. The default
// value is true.
// If you specify a `hostnameLabel`, then `assignPrivateDnsRecord` must be set to true.
AssignPrivateDnsRecord *bool `mandatory:"false" json:"assignPrivateDnsRecord"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname
// portion of the primary private IP's fully qualified domain name (FQDN)
// (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`).
// Must be unique across all VNICs in the subnet and comply with
// RFC 952 (https://tools.ietf.org/html/rfc952) and
// RFC 1123 (https://tools.ietf.org/html/rfc1123).
// The value appears in the Vnic object and also the
// PrivateIp object returned by
// ListPrivateIps and
// GetPrivateIp.
// For more information, see
// DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm).
// When launching an instance, use this `hostnameLabel` instead
// of the deprecated `hostnameLabel` in
// LaunchInstanceDetails.
// If you provide both, the values must match.
// Example: `bminstance1`
// If you specify a `vlanId`, the `hostnameLabel` cannot be specified. VNICs on a VLAN
// can not be assigned a hostname. See Vlan.
HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`
// A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more
// information about NSGs, see
// NetworkSecurityGroup.
// If a `vlanId` is specified, the `nsgIds` cannot be specified. The `vlanId`
// indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs,
// all VNICs in the VLAN belong to the NSGs that are associated with the VLAN.
// See Vlan.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// A private IP address of your choice to assign to the VNIC. Must be an
// available IP address within the subnet's CIDR. If you don't specify a
// value, Oracle automatically assigns a private IP address from the subnet.
// This is the VNIC's *primary* private IP address. The value appears in
// the Vnic object and also the
// PrivateIp object returned by
// ListPrivateIps and
// GetPrivateIp.
//
// If you specify a `vlanId`, the `privateIp` cannot be specified.
// See Vlan.
// Example: `10.0.3.3`
PrivateIp *string `mandatory:"false" json:"privateIp"`
// Whether the source/destination check is disabled on the VNIC.
// Defaults to `false`, which means the check is performed. For information
// about why you would skip the source/destination check, see
// Using a Private IP as a Route Target (https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip).
//
// If you specify a `vlanId`, the `skipSourceDestCheck` cannot be specified because the
// source/destination check is always disabled for VNICs in a VLAN. See
// Vlan.
// Example: `true`
SkipSourceDestCheck *bool `mandatory:"false" json:"skipSourceDestCheck"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create the VNIC in. When launching an instance,
// use this `subnetId` instead of the deprecated `subnetId` in
// LaunchInstanceDetails.
// At least one of them is required; if you provide both, the values must match.
// If you are an Oracle Cloud VMware Solution customer and creating a secondary
// VNIC in a VLAN instead of a subnet, provide a `vlanId` instead of a `subnetId`.
// If you provide both a `vlanId` and `subnetId`, the request fails.
SubnetId *string `mandatory:"false" json:"subnetId"`
// Provide this attribute only if you are an Oracle Cloud VMware Solution
// customer and creating a secondary VNIC in a VLAN. The value is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN.
// See Vlan.
// Provide a `vlanId` instead of a `subnetId`. If you provide both a
// `vlanId` and `subnetId`, the request fails.
VlanId *string `mandatory:"false" json:"vlanId"`
}
func (m CreateVnicDetails) String() string
func (m CreateVnicDetails) 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
CreateVtapDetails These details are included in a request to create a virtual test access point (VTAP).
type CreateVtapDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `Vtap` resource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN containing the `Vtap` resource.
VcnId *string `mandatory:"true" json:"vcnId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source point where packets are captured.
SourceId *string `mandatory:"true" json:"sourceId"`
// The capture filter's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
CaptureFilterId *string `mandatory:"true" json:"captureFilterId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the destination resource where mirrored packets are sent.
TargetId *string `mandatory:"false" json:"targetId"`
// The IP address of the destination resource where mirrored packets are sent.
TargetIp *string `mandatory:"false" json:"targetIp"`
// Defines an encapsulation header type for the VTAP's mirrored traffic.
EncapsulationProtocol CreateVtapDetailsEncapsulationProtocolEnum `mandatory:"false" json:"encapsulationProtocol,omitempty"`
// The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.
VxlanNetworkIdentifier *int64 `mandatory:"false" json:"vxlanNetworkIdentifier"`
// Used to start or stop a `Vtap` resource.
// * `TRUE` directs the VTAP to start mirroring traffic.
// * `FALSE` (Default) directs the VTAP to stop mirroring traffic.
IsVtapEnabled *bool `mandatory:"false" json:"isVtapEnabled"`
// The source type for the VTAP.
SourceType CreateVtapDetailsSourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`
// Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
TrafficMode CreateVtapDetailsTrafficModeEnum `mandatory:"false" json:"trafficMode,omitempty"`
// The maximum size of the packets to be included in the filter.
MaxPacketSize *int `mandatory:"false" json:"maxPacketSize"`
// The target type for the VTAP.
TargetType CreateVtapDetailsTargetTypeEnum `mandatory:"false" json:"targetType,omitempty"`
// The IP Address of the source private endpoint.
SourcePrivateEndpointIp *string `mandatory:"false" json:"sourcePrivateEndpointIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet that source private endpoint belongs to.
SourcePrivateEndpointSubnetId *string `mandatory:"false" json:"sourcePrivateEndpointSubnetId"`
}
func (m CreateVtapDetails) String() string
func (m CreateVtapDetails) 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
CreateVtapDetailsEncapsulationProtocolEnum Enum with underlying type: string
type CreateVtapDetailsEncapsulationProtocolEnum string
Set of constants representing the allowable values for CreateVtapDetailsEncapsulationProtocolEnum
const (
CreateVtapDetailsEncapsulationProtocolVxlan CreateVtapDetailsEncapsulationProtocolEnum = "VXLAN"
)
func GetCreateVtapDetailsEncapsulationProtocolEnumValues() []CreateVtapDetailsEncapsulationProtocolEnum
GetCreateVtapDetailsEncapsulationProtocolEnumValues Enumerates the set of values for CreateVtapDetailsEncapsulationProtocolEnum
func GetMappingCreateVtapDetailsEncapsulationProtocolEnum(val string) (CreateVtapDetailsEncapsulationProtocolEnum, bool)
GetMappingCreateVtapDetailsEncapsulationProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
CreateVtapDetailsSourceTypeEnum Enum with underlying type: string
type CreateVtapDetailsSourceTypeEnum string
Set of constants representing the allowable values for CreateVtapDetailsSourceTypeEnum
const (
CreateVtapDetailsSourceTypeVnic CreateVtapDetailsSourceTypeEnum = "VNIC"
CreateVtapDetailsSourceTypeSubnet CreateVtapDetailsSourceTypeEnum = "SUBNET"
CreateVtapDetailsSourceTypeLoadBalancer CreateVtapDetailsSourceTypeEnum = "LOAD_BALANCER"
CreateVtapDetailsSourceTypeDbSystem CreateVtapDetailsSourceTypeEnum = "DB_SYSTEM"
CreateVtapDetailsSourceTypeExadataVmCluster CreateVtapDetailsSourceTypeEnum = "EXADATA_VM_CLUSTER"
CreateVtapDetailsSourceTypeAutonomousDataWarehouse CreateVtapDetailsSourceTypeEnum = "AUTONOMOUS_DATA_WAREHOUSE"
)
func GetCreateVtapDetailsSourceTypeEnumValues() []CreateVtapDetailsSourceTypeEnum
GetCreateVtapDetailsSourceTypeEnumValues Enumerates the set of values for CreateVtapDetailsSourceTypeEnum
func GetMappingCreateVtapDetailsSourceTypeEnum(val string) (CreateVtapDetailsSourceTypeEnum, bool)
GetMappingCreateVtapDetailsSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateVtapDetailsTargetTypeEnum Enum with underlying type: string
type CreateVtapDetailsTargetTypeEnum string
Set of constants representing the allowable values for CreateVtapDetailsTargetTypeEnum
const (
CreateVtapDetailsTargetTypeVnic CreateVtapDetailsTargetTypeEnum = "VNIC"
CreateVtapDetailsTargetTypeNetworkLoadBalancer CreateVtapDetailsTargetTypeEnum = "NETWORK_LOAD_BALANCER"
CreateVtapDetailsTargetTypeIpAddress CreateVtapDetailsTargetTypeEnum = "IP_ADDRESS"
)
func GetCreateVtapDetailsTargetTypeEnumValues() []CreateVtapDetailsTargetTypeEnum
GetCreateVtapDetailsTargetTypeEnumValues Enumerates the set of values for CreateVtapDetailsTargetTypeEnum
func GetMappingCreateVtapDetailsTargetTypeEnum(val string) (CreateVtapDetailsTargetTypeEnum, bool)
GetMappingCreateVtapDetailsTargetTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateVtapDetailsTrafficModeEnum Enum with underlying type: string
type CreateVtapDetailsTrafficModeEnum string
Set of constants representing the allowable values for CreateVtapDetailsTrafficModeEnum
const (
CreateVtapDetailsTrafficModeDefault CreateVtapDetailsTrafficModeEnum = "DEFAULT"
CreateVtapDetailsTrafficModePriority CreateVtapDetailsTrafficModeEnum = "PRIORITY"
)
func GetCreateVtapDetailsTrafficModeEnumValues() []CreateVtapDetailsTrafficModeEnum
GetCreateVtapDetailsTrafficModeEnumValues Enumerates the set of values for CreateVtapDetailsTrafficModeEnum
func GetMappingCreateVtapDetailsTrafficModeEnum(val string) (CreateVtapDetailsTrafficModeEnum, bool)
GetMappingCreateVtapDetailsTrafficModeEnum performs case Insensitive comparison on enum value and return the desired enum
CrossConnect For use with Oracle Cloud Infrastructure FastConnect. A cross-connect represents a physical connection between an existing network and Oracle. Customers who are colocated with Oracle in a FastConnect location create and use cross-connects. For more information, see FastConnect Overview (https://docs.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm). Oracle recommends you create each cross-connect in a CrossConnectGroup so you can use link aggregation with the connection. **Note:** If you're a provider who is setting up a physical connection to Oracle so customers can use FastConnect over the connection, be aware that your connection is modeled the same way as a colocated customer's (with `CrossConnect` and `CrossConnectGroup` objects, and so on). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type CrossConnect struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the cross-connect group.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group this cross-connect belongs to (if any).
CrossConnectGroupId *string `mandatory:"false" json:"crossConnectGroupId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The cross-connect's Oracle ID (OCID).
Id *string `mandatory:"false" json:"id"`
// The cross-connect's current state.
LifecycleState CrossConnectLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The name of the FastConnect location where this cross-connect is installed.
LocationName *string `mandatory:"false" json:"locationName"`
// A string identifying the meet-me room port for this cross-connect.
PortName *string `mandatory:"false" json:"portName"`
// The port speed for this cross-connect.
// Example: `10 Gbps`
PortSpeedShapeName *string `mandatory:"false" json:"portSpeedShapeName"`
// A reference name or identifier for the physical fiber connection that this cross-connect
// uses.
CustomerReferenceName *string `mandatory:"false" json:"customerReferenceName"`
// The date and time the cross-connect was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
MacsecProperties *MacsecProperties `mandatory:"false" json:"macsecProperties"`
// The FastConnect device that terminates the physical connection.
OciPhysicalDeviceName *string `mandatory:"false" json:"ociPhysicalDeviceName"`
// The FastConnect device that terminates the logical connection.
// This device might be different than the device that terminates the physical connection.
OciLogicalDeviceName *string `mandatory:"false" json:"ociLogicalDeviceName"`
}
func (m CrossConnect) String() string
func (m CrossConnect) 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
CrossConnectGroup For use with Oracle Cloud Infrastructure FastConnect. A cross-connect group is a link aggregation group (LAG), which can contain one or more CrossConnect. Customers who are colocated with Oracle in a FastConnect location create and use cross-connect groups. For more information, see FastConnect Overview (https://docs.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm). **Note:** If you're a provider who is setting up a physical connection to Oracle so customers can use FastConnect over the connection, be aware that your connection is modeled the same way as a colocated customer's (with `CrossConnect` and `CrossConnectGroup` objects, and so on). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type CrossConnectGroup struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the cross-connect group.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The cross-connect group's Oracle ID (OCID).
Id *string `mandatory:"false" json:"id"`
// The cross-connect group's current state.
LifecycleState CrossConnectGroupLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// A reference name or identifier for the physical fiber connection that this cross-connect
// group uses.
CustomerReferenceName *string `mandatory:"false" json:"customerReferenceName"`
// The date and time the cross-connect group was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
MacsecProperties *MacsecProperties `mandatory:"false" json:"macsecProperties"`
// The FastConnect device that terminates the physical connection.
OciPhysicalDeviceName *string `mandatory:"false" json:"ociPhysicalDeviceName"`
// The FastConnect device that terminates the logical connection.
// This device might be different than the device that terminates the physical connection.
OciLogicalDeviceName *string `mandatory:"false" json:"ociLogicalDeviceName"`
}
func (m CrossConnectGroup) String() string
func (m CrossConnectGroup) 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
CrossConnectGroupLifecycleStateEnum Enum with underlying type: string
type CrossConnectGroupLifecycleStateEnum string
Set of constants representing the allowable values for CrossConnectGroupLifecycleStateEnum
const (
CrossConnectGroupLifecycleStateProvisioning CrossConnectGroupLifecycleStateEnum = "PROVISIONING"
CrossConnectGroupLifecycleStateProvisioned CrossConnectGroupLifecycleStateEnum = "PROVISIONED"
CrossConnectGroupLifecycleStateInactive CrossConnectGroupLifecycleStateEnum = "INACTIVE"
CrossConnectGroupLifecycleStateTerminating CrossConnectGroupLifecycleStateEnum = "TERMINATING"
CrossConnectGroupLifecycleStateTerminated CrossConnectGroupLifecycleStateEnum = "TERMINATED"
)
func GetCrossConnectGroupLifecycleStateEnumValues() []CrossConnectGroupLifecycleStateEnum
GetCrossConnectGroupLifecycleStateEnumValues Enumerates the set of values for CrossConnectGroupLifecycleStateEnum
func GetMappingCrossConnectGroupLifecycleStateEnum(val string) (CrossConnectGroupLifecycleStateEnum, bool)
GetMappingCrossConnectGroupLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
CrossConnectLifecycleStateEnum Enum with underlying type: string
type CrossConnectLifecycleStateEnum string
Set of constants representing the allowable values for CrossConnectLifecycleStateEnum
const (
CrossConnectLifecycleStatePendingCustomer CrossConnectLifecycleStateEnum = "PENDING_CUSTOMER"
CrossConnectLifecycleStateProvisioning CrossConnectLifecycleStateEnum = "PROVISIONING"
CrossConnectLifecycleStateProvisioned CrossConnectLifecycleStateEnum = "PROVISIONED"
CrossConnectLifecycleStateInactive CrossConnectLifecycleStateEnum = "INACTIVE"
CrossConnectLifecycleStateTerminating CrossConnectLifecycleStateEnum = "TERMINATING"
CrossConnectLifecycleStateTerminated CrossConnectLifecycleStateEnum = "TERMINATED"
)
func GetCrossConnectLifecycleStateEnumValues() []CrossConnectLifecycleStateEnum
GetCrossConnectLifecycleStateEnumValues Enumerates the set of values for CrossConnectLifecycleStateEnum
func GetMappingCrossConnectLifecycleStateEnum(val string) (CrossConnectLifecycleStateEnum, bool)
GetMappingCrossConnectLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
CrossConnectLocation An individual FastConnect location.
type CrossConnectLocation struct {
// A description of the location.
Description *string `mandatory:"true" json:"description"`
// The name of the location.
// Example: `CyrusOne, Chandler, AZ`
Name *string `mandatory:"true" json:"name"`
}
func (m CrossConnectLocation) String() string
func (m CrossConnectLocation) 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
CrossConnectMapping For use with Oracle Cloud Infrastructure FastConnect. Each VirtualCircuit runs on one or more cross-connects or cross-connect groups. A `CrossConnectMapping` contains the properties for an individual cross-connect or cross-connect group associated with a given virtual circuit. The mapping includes information about the cross-connect or cross-connect group, the VLAN, and the BGP peering session. If you're a customer who is colocated with Oracle, that means you own both the virtual circuit and the physical connection it runs on (cross-connect or cross-connect group), so you specify all the information in the mapping. There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses. If you're a provider, then you own the physical connection that the customer's virtual circuit runs on, so you contribute information about the cross-connect or cross-connect group and VLAN. Who specifies the BGP peering information in the case of customer connection via provider? If the BGP session goes from Oracle to the provider's edge router, then the provider also specifies the BGP peering information. If the BGP session instead goes from Oracle to the customer's edge router, then the customer specifies the BGP peering information. There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses. Every `CrossConnectMapping` must have BGP IPv4 peering addresses. BGP IPv6 peering addresses are optional. If BGP IPv6 addresses are provided, the customer can exchange IPv6 routes with Oracle.
type CrossConnectMapping struct {
// The key for BGP MD5 authentication. Only applicable if your system
// requires MD5 authentication. If empty or not set (null), that
// means you don't use BGP MD5 authentication.
BgpMd5AuthKey *string `mandatory:"false" json:"bgpMd5AuthKey"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect or cross-connect group for this mapping.
// Specified by the owner of the cross-connect or cross-connect group (the
// customer if the customer is colocated with Oracle, or the provider if the
// customer is connecting via provider).
CrossConnectOrCrossConnectGroupId *string `mandatory:"false" json:"crossConnectOrCrossConnectGroupId"`
// The BGP IPv4 address for the router on the other end of the BGP session from
// Oracle. Specified by the owner of that router. If the session goes from Oracle
// to a customer, this is the BGP IPv4 address of the customer's edge router. If the
// session goes from Oracle to a provider, this is the BGP IPv4 address of the
// provider's edge router. Must use a subnet mask from /28 to /31.
// There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.
// Example: `10.0.0.18/31`
CustomerBgpPeeringIp *string `mandatory:"false" json:"customerBgpPeeringIp"`
// The IPv4 address for Oracle's end of the BGP session. Must use a subnet mask from /28 to /31.
// If the session goes from Oracle to a customer's edge router,
// the customer specifies this information. If the session goes from Oracle to
// a provider's edge router, the provider specifies this.
// There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.
// Example: `10.0.0.19/31`
OracleBgpPeeringIp *string `mandatory:"false" json:"oracleBgpPeeringIp"`
// The BGP IPv6 address for the router on the other end of the BGP session from
// Oracle. Specified by the owner of that router. If the session goes from Oracle
// to a customer, this is the BGP IPv6 address of the customer's edge router. If the
// session goes from Oracle to a provider, this is the BGP IPv6 address of the
// provider's edge router. Only subnet masks from /64 up to /127 are allowed.
// There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.
// IPv6 addressing is supported for all commercial and government regions. See
// IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// Example: `2001:db8::1/64`
CustomerBgpPeeringIpv6 *string `mandatory:"false" json:"customerBgpPeeringIpv6"`
// The IPv6 address for Oracle's end of the BGP session. Only subnet masks from /64 up to /127 are allowed.
// If the session goes from Oracle to a customer's edge router,
// the customer specifies this information. If the session goes from Oracle to
// a provider's edge router, the provider specifies this.
// There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.
// Note that IPv6 addressing is currently supported only in certain regions. See
// IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// Example: `2001:db8::2/64`
OracleBgpPeeringIpv6 *string `mandatory:"false" json:"oracleBgpPeeringIpv6"`
// The number of the specific VLAN (on the cross-connect or cross-connect group)
// that is assigned to this virtual circuit. Specified by the owner of the cross-connect
// or cross-connect group (the customer if the customer is colocated with Oracle, or
// the provider if the customer is connecting via provider).
// Example: `200`
Vlan *int `mandatory:"false" json:"vlan"`
}
func (m CrossConnectMapping) String() string
func (m CrossConnectMapping) 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
CrossConnectMappingDetails For use with Oracle Cloud Infrastructure FastConnect. Each VirtualCircuit runs on one or more cross-connects or cross-connect groups. A `CrossConnectMappingDetails` contains the properties for an individual cross-connect or cross-connect group associated with a given virtual circuit. The details includes information about the cross-connect or cross-connect group, the VLAN, and the BGP peering session.
type CrossConnectMappingDetails struct {
// The key for BGP MD5 authentication. Only applicable if your system
// requires MD5 authentication. If empty or not set (null), that
// means you don't use BGP MD5 authentication.
BgpMd5AuthKey *string `mandatory:"false" json:"bgpMd5AuthKey"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect or cross-connect group for this mapping.
// Specified by the owner of the cross-connect or cross-connect group (the
// customer if the customer is colocated with Oracle, or the provider if the
// customer is connecting via provider).
CrossConnectOrCrossConnectGroupId *string `mandatory:"false" json:"crossConnectOrCrossConnectGroupId"`
// The BGP IPv4 address for the router on the other end of the BGP session from
// Oracle. Specified by the owner of that router. If the session goes from Oracle
// to a customer, this is the BGP IPv4 address of the customer's edge router. If the
// session goes from Oracle to a provider, this is the BGP IPv4 address of the
// provider's edge router. Must use a subnet mask from /28 to /31.
// There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.
// Example: `10.0.0.18/31`
CustomerBgpPeeringIp *string `mandatory:"false" json:"customerBgpPeeringIp"`
// The IPv4 address for Oracle's end of the BGP session. Must use a subnet mask from /28 to /31.
// If the session goes from Oracle to a customer's edge router,
// the customer specifies this information. If the session goes from Oracle to
// a provider's edge router, the provider specifies this.
// There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.
// Example: `10.0.0.19/31`
OracleBgpPeeringIp *string `mandatory:"false" json:"oracleBgpPeeringIp"`
// The BGP IPv6 address for the router on the other end of the BGP session from
// Oracle. Specified by the owner of that router. If the session goes from Oracle
// to a customer, this is the BGP IPv6 address of the customer's edge router. If the
// session goes from Oracle to a provider, this is the BGP IPv6 address of the
// provider's edge router. Only subnet masks from /64 up to /127 are allowed.
// There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.
// Example: `2001:db8::1/64`
CustomerBgpPeeringIpv6 *string `mandatory:"false" json:"customerBgpPeeringIpv6"`
// The IPv6 address for Oracle's end of the BGP session. Only subnet masks from /64 up to /127 are allowed.
// If the session goes from Oracle to a customer's edge router,
// the customer specifies this information. If the session goes from Oracle to
// a provider's edge router, the provider specifies this.
// There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.
// Example: `2001:db8::2/64`
OracleBgpPeeringIpv6 *string `mandatory:"false" json:"oracleBgpPeeringIpv6"`
// The number of the specific VLAN (on the cross-connect or cross-connect group)
// that is assigned to this virtual circuit. Specified by the owner of the cross-connect
// or cross-connect group (the customer if the customer is colocated with Oracle, or
// the provider if the customer is connecting via provider).
// Example: `200`
Vlan *int `mandatory:"false" json:"vlan"`
// The state of the Ipv4 BGP session.
Ipv4BgpStatus CrossConnectMappingDetailsIpv4BgpStatusEnum `mandatory:"false" json:"ipv4BgpStatus,omitempty"`
// The state of the Ipv6 BGP session.
Ipv6BgpStatus CrossConnectMappingDetailsIpv6BgpStatusEnum `mandatory:"false" json:"ipv6BgpStatus,omitempty"`
// The FastConnect device that terminates the logical connection.
OciLogicalDeviceName *string `mandatory:"false" json:"ociLogicalDeviceName"`
}
func (m CrossConnectMappingDetails) String() string
func (m CrossConnectMappingDetails) 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
CrossConnectMappingDetailsCollection An array of CrossConnectMappingDetails
type CrossConnectMappingDetailsCollection struct {
// CrossConnectMappingDetails items
Items []CrossConnectMappingDetails `mandatory:"true" json:"items"`
}
func (m CrossConnectMappingDetailsCollection) String() string
func (m CrossConnectMappingDetailsCollection) 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
CrossConnectMappingDetailsIpv4BgpStatusEnum Enum with underlying type: string
type CrossConnectMappingDetailsIpv4BgpStatusEnum string
Set of constants representing the allowable values for CrossConnectMappingDetailsIpv4BgpStatusEnum
const (
CrossConnectMappingDetailsIpv4BgpStatusUp CrossConnectMappingDetailsIpv4BgpStatusEnum = "UP"
CrossConnectMappingDetailsIpv4BgpStatusDown CrossConnectMappingDetailsIpv4BgpStatusEnum = "DOWN"
)
func GetCrossConnectMappingDetailsIpv4BgpStatusEnumValues() []CrossConnectMappingDetailsIpv4BgpStatusEnum
GetCrossConnectMappingDetailsIpv4BgpStatusEnumValues Enumerates the set of values for CrossConnectMappingDetailsIpv4BgpStatusEnum
func GetMappingCrossConnectMappingDetailsIpv4BgpStatusEnum(val string) (CrossConnectMappingDetailsIpv4BgpStatusEnum, bool)
GetMappingCrossConnectMappingDetailsIpv4BgpStatusEnum performs case Insensitive comparison on enum value and return the desired enum
CrossConnectMappingDetailsIpv6BgpStatusEnum Enum with underlying type: string
type CrossConnectMappingDetailsIpv6BgpStatusEnum string
Set of constants representing the allowable values for CrossConnectMappingDetailsIpv6BgpStatusEnum
const (
CrossConnectMappingDetailsIpv6BgpStatusUp CrossConnectMappingDetailsIpv6BgpStatusEnum = "UP"
CrossConnectMappingDetailsIpv6BgpStatusDown CrossConnectMappingDetailsIpv6BgpStatusEnum = "DOWN"
)
func GetCrossConnectMappingDetailsIpv6BgpStatusEnumValues() []CrossConnectMappingDetailsIpv6BgpStatusEnum
GetCrossConnectMappingDetailsIpv6BgpStatusEnumValues Enumerates the set of values for CrossConnectMappingDetailsIpv6BgpStatusEnum
func GetMappingCrossConnectMappingDetailsIpv6BgpStatusEnum(val string) (CrossConnectMappingDetailsIpv6BgpStatusEnum, bool)
GetMappingCrossConnectMappingDetailsIpv6BgpStatusEnum performs case Insensitive comparison on enum value and return the desired enum
CrossConnectPortSpeedShape An individual port speed level for cross-connects.
type CrossConnectPortSpeedShape struct {
// The name of the port speed shape.
// Example: `10 Gbps`
Name *string `mandatory:"true" json:"name"`
// The port speed in Gbps.
// Example: `10`
PortSpeedInGbps *int `mandatory:"true" json:"portSpeedInGbps"`
}
func (m CrossConnectPortSpeedShape) String() string
func (m CrossConnectPortSpeedShape) 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
CrossConnectStatus The status of the cross-connect.
type CrossConnectStatus struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect.
CrossConnectId *string `mandatory:"true" json:"crossConnectId"`
// Indicates whether Oracle's side of the interface is up or down.
InterfaceState CrossConnectStatusInterfaceStateEnum `mandatory:"false" json:"interfaceState,omitempty"`
// The light level of the cross-connect (in dBm).
// Example: `14.0`
LightLevelIndBm *float32 `mandatory:"false" json:"lightLevelIndBm"`
// Status indicator corresponding to the light level.
// * **NO_LIGHT:** No measurable light
// * **LOW_WARN:** There's measurable light but it's too low
// * **HIGH_WARN:** Light level is too high
// * **BAD:** There's measurable light but the signal-to-noise ratio is bad
// * **GOOD:** Good light level
LightLevelIndicator CrossConnectStatusLightLevelIndicatorEnum `mandatory:"false" json:"lightLevelIndicator,omitempty"`
// Encryption status of this cross connect.
// Possible values:
// * **UP:** Traffic is encrypted over this cross-connect
// * **DOWN:** Traffic is not encrypted over this cross-connect
// * **CIPHER_MISMATCH:** The MACsec encryption cipher doesn't match the cipher on the CPE
// * **CKN_MISMATCH:** The MACsec Connectivity association Key Name (CKN) doesn't match the CKN on the CPE
// * **CAK_MISMATCH:** The MACsec Connectivity Association Key (CAK) doesn't match the CAK on the CPE
EncryptionStatus CrossConnectStatusEncryptionStatusEnum `mandatory:"false" json:"encryptionStatus,omitempty"`
// The light levels of the cross-connect (in dBm).
// Example: `[14.0, -14.0, 2.1, -10.1]`
LightLevelsInDBm []float32 `mandatory:"false" json:"lightLevelsInDBm"`
}
func (m CrossConnectStatus) String() string
func (m CrossConnectStatus) 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
CrossConnectStatusEncryptionStatusEnum Enum with underlying type: string
type CrossConnectStatusEncryptionStatusEnum string
Set of constants representing the allowable values for CrossConnectStatusEncryptionStatusEnum
const (
CrossConnectStatusEncryptionStatusUp CrossConnectStatusEncryptionStatusEnum = "UP"
CrossConnectStatusEncryptionStatusDown CrossConnectStatusEncryptionStatusEnum = "DOWN"
CrossConnectStatusEncryptionStatusCipherMismatch CrossConnectStatusEncryptionStatusEnum = "CIPHER_MISMATCH"
CrossConnectStatusEncryptionStatusCknMismatch CrossConnectStatusEncryptionStatusEnum = "CKN_MISMATCH"
CrossConnectStatusEncryptionStatusCakMismatch CrossConnectStatusEncryptionStatusEnum = "CAK_MISMATCH"
)
func GetCrossConnectStatusEncryptionStatusEnumValues() []CrossConnectStatusEncryptionStatusEnum
GetCrossConnectStatusEncryptionStatusEnumValues Enumerates the set of values for CrossConnectStatusEncryptionStatusEnum
func GetMappingCrossConnectStatusEncryptionStatusEnum(val string) (CrossConnectStatusEncryptionStatusEnum, bool)
GetMappingCrossConnectStatusEncryptionStatusEnum performs case Insensitive comparison on enum value and return the desired enum
CrossConnectStatusInterfaceStateEnum Enum with underlying type: string
type CrossConnectStatusInterfaceStateEnum string
Set of constants representing the allowable values for CrossConnectStatusInterfaceStateEnum
const (
CrossConnectStatusInterfaceStateUp CrossConnectStatusInterfaceStateEnum = "UP"
CrossConnectStatusInterfaceStateDown CrossConnectStatusInterfaceStateEnum = "DOWN"
)
func GetCrossConnectStatusInterfaceStateEnumValues() []CrossConnectStatusInterfaceStateEnum
GetCrossConnectStatusInterfaceStateEnumValues Enumerates the set of values for CrossConnectStatusInterfaceStateEnum
func GetMappingCrossConnectStatusInterfaceStateEnum(val string) (CrossConnectStatusInterfaceStateEnum, bool)
GetMappingCrossConnectStatusInterfaceStateEnum performs case Insensitive comparison on enum value and return the desired enum
CrossConnectStatusLightLevelIndicatorEnum Enum with underlying type: string
type CrossConnectStatusLightLevelIndicatorEnum string
Set of constants representing the allowable values for CrossConnectStatusLightLevelIndicatorEnum
const (
CrossConnectStatusLightLevelIndicatorNoLight CrossConnectStatusLightLevelIndicatorEnum = "NO_LIGHT"
CrossConnectStatusLightLevelIndicatorLowWarn CrossConnectStatusLightLevelIndicatorEnum = "LOW_WARN"
CrossConnectStatusLightLevelIndicatorHighWarn CrossConnectStatusLightLevelIndicatorEnum = "HIGH_WARN"
CrossConnectStatusLightLevelIndicatorBad CrossConnectStatusLightLevelIndicatorEnum = "BAD"
CrossConnectStatusLightLevelIndicatorGood CrossConnectStatusLightLevelIndicatorEnum = "GOOD"
)
func GetCrossConnectStatusLightLevelIndicatorEnumValues() []CrossConnectStatusLightLevelIndicatorEnum
GetCrossConnectStatusLightLevelIndicatorEnumValues Enumerates the set of values for CrossConnectStatusLightLevelIndicatorEnum
func GetMappingCrossConnectStatusLightLevelIndicatorEnum(val string) (CrossConnectStatusLightLevelIndicatorEnum, bool)
GetMappingCrossConnectStatusLightLevelIndicatorEnum performs case Insensitive comparison on enum value and return the desired enum
DefaultDrgRouteTables The default DRG route table for this DRG. Each network type has a default DRG route table. You can update a network type to use a different DRG route table, but each network type must have a default DRG route table. You cannot delete a default DRG route table.
type DefaultDrgRouteTables struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table to be assigned to DRG attachments
// of type VCN on creation.
Vcn *string `mandatory:"false" json:"vcn"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table assigned to DRG attachments
// of type IPSEC_TUNNEL on creation.
IpsecTunnel *string `mandatory:"false" json:"ipsecTunnel"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table to be assigned to DRG attachments
// of type VIRTUAL_CIRCUIT on creation.
VirtualCircuit *string `mandatory:"false" json:"virtualCircuit"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table to be assigned to DRG attachments
// of type REMOTE_PEERING_CONNECTION on creation.
RemotePeeringConnection *string `mandatory:"false" json:"remotePeeringConnection"`
}
func (m DefaultDrgRouteTables) String() string
func (m DefaultDrgRouteTables) 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
DefaultPhaseOneParameters Default phase one parameters.
type DefaultPhaseOneParameters struct {
// Default phase one encryption algorithms.
DefaultEncryptionAlgorithms []string `mandatory:"false" json:"defaultEncryptionAlgorithms"`
// Default phase one authentication algorithms.
DefaultAuthenticationAlgorithms []string `mandatory:"false" json:"defaultAuthenticationAlgorithms"`
// Default phase one Diffie-Hellman groups.
DefaultDhGroups []string `mandatory:"false" json:"defaultDhGroups"`
}
func (m DefaultPhaseOneParameters) String() string
func (m DefaultPhaseOneParameters) 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
DefaultPhaseTwoParameters Default phase two parameters.
type DefaultPhaseTwoParameters struct {
// Default phase two encryption algorithms.
DefaultEncryptionAlgorithms []string `mandatory:"false" json:"defaultEncryptionAlgorithms"`
// Default phase two authentication algorithms.
DefaultAuthenticationAlgorithms []string `mandatory:"false" json:"defaultAuthenticationAlgorithms"`
// Default perfect forward secrecy Diffie-Hellman groups.
DefaultPfsDhGroup *string `mandatory:"false" json:"defaultPfsDhGroup"`
}
func (m DefaultPhaseTwoParameters) String() string
func (m DefaultPhaseTwoParameters) 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
DeletePathAnalyzerTestRequest wrapper for the DeletePathAnalyzerTest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/DeletePathAnalyzerTest.go.html to see an example of how to use DeletePathAnalyzerTestRequest.
type DeletePathAnalyzerTestRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `PathAnalyzerTest` resource.
PathAnalyzerTestId *string `mandatory:"true" contributesTo:"path" name:"pathAnalyzerTestId"`
// 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"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeletePathAnalyzerTestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeletePathAnalyzerTestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeletePathAnalyzerTestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeletePathAnalyzerTestRequest) String() string
func (request DeletePathAnalyzerTestRequest) 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
DeletePathAnalyzerTestResponse wrapper for the DeletePathAnalyzerTest operation
type DeletePathAnalyzerTestResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeletePathAnalyzerTestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeletePathAnalyzerTestResponse) String() string
DeleteVirtualCircuitPublicPrefixDetails The representation of DeleteVirtualCircuitPublicPrefixDetails
type DeleteVirtualCircuitPublicPrefixDetails struct {
// An individual public IP prefix (CIDR) to remove from the public virtual circuit.
CidrBlock *string `mandatory:"true" json:"cidrBlock"`
}
func (m DeleteVirtualCircuitPublicPrefixDetails) String() string
func (m DeleteVirtualCircuitPublicPrefixDetails) 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
DeniedSecurityAction Defines the security action taken on denied traffic.
type DeniedSecurityAction struct {
DeniedSecurityActionDetails *DeniedSecurityActionDetails `mandatory:"false" json:"deniedSecurityActionDetails"`
// Type of the `SecurityAction`.
ActionType SecurityActionActionTypeEnum `mandatory:"true" json:"actionType"`
}
func (m DeniedSecurityAction) GetActionType() SecurityActionActionTypeEnum
GetActionType returns ActionType
func (m DeniedSecurityAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DeniedSecurityAction) String() string
func (m DeniedSecurityAction) 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
DeniedSecurityActionDetails Defines details for the security action taken on denied traffic.
type DeniedSecurityActionDetails struct {
// If true, the evaluated security list and network security group ID details are incomplete.
IsRestrictedOrPartial *bool `mandatory:"true" json:"isRestrictedOrPartial"`
// The list of OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of evaluated security lists associcated
// with the OCI resource's subnet.
EvaluatedSecurityListIds []string `mandatory:"false" json:"evaluatedSecurityListIds"`
// List of OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of evaluated network security groups
// associated with the OCI resource's VNIC.
EvaluatedNsgIds []string `mandatory:"false" json:"evaluatedNsgIds"`
}
func (m DeniedSecurityActionDetails) String() string
func (m DeniedSecurityActionDetails) 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
DhcpDnsOption DHCP option for specifying how DNS (hostname resolution) is handled in the subnets in the VCN. For more information, see DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm).
type DhcpDnsOption struct {
// If you set `serverType` to `CustomDnsServer`, specify the
// IP address of at least one DNS server of your choice (three maximum).
CustomDnsServers []string `mandatory:"false" json:"customDnsServers"`
// * **VcnLocal:** Reserved for future use.
// * **VcnLocalPlusInternet:** Also referred to as "Internet and VCN Resolver".
// Instances can resolve internet hostnames (no internet gateway is required),
// and can resolve hostnames of instances in the VCN. This is the default
// value in the default set of DHCP options in the VCN. For the Internet and
// VCN Resolver to work across the VCN, there must also be a DNS label set for
// the VCN, a DNS label set for each subnet, and a hostname for each instance.
// The Internet and VCN Resolver also enables reverse DNS lookup, which lets
// you determine the hostname corresponding to the private IP address. For more
// information, see
// DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm).
// * **CustomDnsServer:** Instances use a DNS server of your choice (three
// maximum).
ServerType DhcpDnsOptionServerTypeEnum `mandatory:"true" json:"serverType"`
}
func (m DhcpDnsOption) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DhcpDnsOption) String() string
func (m DhcpDnsOption) 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
DhcpDnsOptionServerTypeEnum Enum with underlying type: string
type DhcpDnsOptionServerTypeEnum string
Set of constants representing the allowable values for DhcpDnsOptionServerTypeEnum
const (
DhcpDnsOptionServerTypeVcnlocal DhcpDnsOptionServerTypeEnum = "VcnLocal"
DhcpDnsOptionServerTypeVcnlocalplusinternet DhcpDnsOptionServerTypeEnum = "VcnLocalPlusInternet"
DhcpDnsOptionServerTypeCustomdnsserver DhcpDnsOptionServerTypeEnum = "CustomDnsServer"
)
func GetDhcpDnsOptionServerTypeEnumValues() []DhcpDnsOptionServerTypeEnum
GetDhcpDnsOptionServerTypeEnumValues Enumerates the set of values for DhcpDnsOptionServerTypeEnum
func GetMappingDhcpDnsOptionServerTypeEnum(val string) (DhcpDnsOptionServerTypeEnum, bool)
GetMappingDhcpDnsOptionServerTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DhcpOption A single DHCP option according to RFC 1533 (https://tools.ietf.org/html/rfc1533). The two options available to use are DhcpDnsOption and DhcpSearchDomainOption. For more information, see DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm) and DHCP Options (https://docs.oracle.com/iaas/Content/Network/Tasks/managingDHCP.htm).
type DhcpOption interface {
}
DhcpOptions A set of DHCP options. Used by the VCN to automatically provide configuration information to the instances when they boot up. There are two options you can set: - DhcpDnsOption: Lets you specify how DNS (hostname resolution) is handled in the subnets in your VCN. - DhcpSearchDomainOption: Lets you specify a search domain name to use for DNS queries. For more information, see DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm) and DHCP Options (https://docs.oracle.com/iaas/Content/Network/Tasks/managingDHCP.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type DhcpOptions struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the set of DHCP options.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) for the set of DHCP options.
Id *string `mandatory:"true" json:"id"`
// The current state of the set of DHCP options.
LifecycleState DhcpOptionsLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The collection of individual DHCP options.
Options []DhcpOption `mandatory:"true" json:"options"`
// Date and time the set of DHCP options was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN the set of DHCP options belongs to.
VcnId *string `mandatory:"true" json:"vcnId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The search domain name type of DHCP options
DomainNameType DhcpOptionsDomainNameTypeEnum `mandatory:"false" json:"domainNameType,omitempty"`
}
func (m DhcpOptions) String() string
func (m *DhcpOptions) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m DhcpOptions) 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
DhcpOptionsDomainNameTypeEnum Enum with underlying type: string
type DhcpOptionsDomainNameTypeEnum string
Set of constants representing the allowable values for DhcpOptionsDomainNameTypeEnum
const (
DhcpOptionsDomainNameTypeSubnetDomain DhcpOptionsDomainNameTypeEnum = "SUBNET_DOMAIN"
DhcpOptionsDomainNameTypeVcnDomain DhcpOptionsDomainNameTypeEnum = "VCN_DOMAIN"
DhcpOptionsDomainNameTypeCustomDomain DhcpOptionsDomainNameTypeEnum = "CUSTOM_DOMAIN"
)
func GetDhcpOptionsDomainNameTypeEnumValues() []DhcpOptionsDomainNameTypeEnum
GetDhcpOptionsDomainNameTypeEnumValues Enumerates the set of values for DhcpOptionsDomainNameTypeEnum
func GetMappingDhcpOptionsDomainNameTypeEnum(val string) (DhcpOptionsDomainNameTypeEnum, bool)
GetMappingDhcpOptionsDomainNameTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DhcpOptionsLifecycleStateEnum Enum with underlying type: string
type DhcpOptionsLifecycleStateEnum string
Set of constants representing the allowable values for DhcpOptionsLifecycleStateEnum
const (
DhcpOptionsLifecycleStateProvisioning DhcpOptionsLifecycleStateEnum = "PROVISIONING"
DhcpOptionsLifecycleStateAvailable DhcpOptionsLifecycleStateEnum = "AVAILABLE"
DhcpOptionsLifecycleStateTerminating DhcpOptionsLifecycleStateEnum = "TERMINATING"
DhcpOptionsLifecycleStateTerminated DhcpOptionsLifecycleStateEnum = "TERMINATED"
)
func GetDhcpOptionsLifecycleStateEnumValues() []DhcpOptionsLifecycleStateEnum
GetDhcpOptionsLifecycleStateEnumValues Enumerates the set of values for DhcpOptionsLifecycleStateEnum
func GetMappingDhcpOptionsLifecycleStateEnum(val string) (DhcpOptionsLifecycleStateEnum, bool)
GetMappingDhcpOptionsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DhcpSearchDomainOption DHCP option for specifying a search domain name for DNS queries. For more information, see DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm).
type DhcpSearchDomainOption struct {
// A single search domain name according to RFC 952 (https://tools.ietf.org/html/rfc952)
// and RFC 1123 (https://tools.ietf.org/html/rfc1123). During a DNS query,
// the OS will append this search domain name to the value being queried.
// If you set DhcpDnsOption to `VcnLocalPlusInternet`,
// and you assign a DNS label to the VCN during creation, the search domain name in the
// VCN's default set of DHCP options is automatically set to the VCN domain
// (for example, `vcn1.oraclevcn.com`).
// If you don't want to use a search domain name, omit this option from the
// set of DHCP options. Do not include this option with an empty list
// of search domain names, or with an empty string as the value for any search
// domain name.
SearchDomainNames []string `mandatory:"true" json:"searchDomainNames"`
}
func (m DhcpSearchDomainOption) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DhcpSearchDomainOption) String() string
func (m DhcpSearchDomainOption) 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
DpdConfig These configuration details are used for dead peer detection (DPD). DPD periodically checks the stability of the connection to the customer premises (CPE), and may be used to detect that the link to the CPE has gone down.
type DpdConfig struct {
// This option defines whether DPD can be initiated from the Oracle side of the connection.
DpdMode DpdConfigDpdModeEnum `mandatory:"false" json:"dpdMode,omitempty"`
// DPD timeout in seconds. This sets the longest interval between CPE device health messages before the IPSec connection indicates it has lost contact with the CPE. The default is 20 seconds.
DpdTimeoutInSec *int `mandatory:"false" json:"dpdTimeoutInSec"`
}
func (m DpdConfig) String() string
func (m DpdConfig) 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
DpdConfigDpdModeEnum Enum with underlying type: string
type DpdConfigDpdModeEnum string
Set of constants representing the allowable values for DpdConfigDpdModeEnum
const (
DpdConfigDpdModeInitiateAndRespond DpdConfigDpdModeEnum = "INITIATE_AND_RESPOND"
DpdConfigDpdModeRespondOnly DpdConfigDpdModeEnum = "RESPOND_ONLY"
)
func GetDpdConfigDpdModeEnumValues() []DpdConfigDpdModeEnum
GetDpdConfigDpdModeEnumValues Enumerates the set of values for DpdConfigDpdModeEnum
func GetMappingDpdConfigDpdModeEnum(val string) (DpdConfigDpdModeEnum, bool)
GetMappingDpdConfigDpdModeEnum performs case Insensitive comparison on enum value and return the desired enum
Drg A dynamic routing gateway (DRG) is a virtual router that provides a path for private network traffic between networks. You use it with other Networking Service components to create a connection to your on-premises network using Site-to-Site VPN (https://docs.oracle.com/iaas/Content/Network/Tasks/managingIPsec.htm) or a connection that uses FastConnect (https://docs.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm). For more information, see Networking Overview (https://docs.oracle.com/iaas/Content/Network/Concepts/overview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type Drg struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the DRG.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The DRG's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"true" json:"id"`
// The DRG's current state.
LifecycleState DrgLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The date and time the DRG was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
DefaultDrgRouteTables *DefaultDrgRouteTables `mandatory:"false" json:"defaultDrgRouteTables"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this DRG's default export route distribution for the DRG attachments.
DefaultExportDrgRouteDistributionId *string `mandatory:"false" json:"defaultExportDrgRouteDistributionId"`
}
func (m Drg) String() string
func (m Drg) 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
DrgAttachment A DRG attachment serves as a link between a DRG and a network resource. A DRG can be attached to a VCN, IPSec tunnel, remote peering connection, or virtual circuit. For more information, see Overview of the Networking Service (https://docs.oracle.com/iaas/Content/Network/Concepts/overview.htm).
type DrgAttachment struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the DRG attachment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG.
DrgId *string `mandatory:"true" json:"drgId"`
// The DRG attachment's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"true" json:"id"`
// The DRG attachment's current state.
LifecycleState DrgAttachmentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The date and time the DRG attachment was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table that is assigned to this attachment.
// The DRG route table manages traffic inside the DRG.
DrgRouteTableId *string `mandatory:"false" json:"drgRouteTableId"`
NetworkDetails DrgAttachmentNetworkDetails `mandatory:"false" json:"networkDetails"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the DRG attachment is using.
// For information about why you would associate a route table with a DRG attachment, see:
// * Transit Routing: Access to Multiple VCNs in Same Region (https://docs.oracle.com/iaas/Content/Network/Tasks/transitrouting.htm)
// * Transit Routing: Private Access to Oracle Services (https://docs.oracle.com/iaas/Content/Network/Tasks/transitroutingoracleservices.htm)
// This field is deprecated. Instead, use the `networkDetails` field to view the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the attached resource.
RouteTableId *string `mandatory:"false" json:"routeTableId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN.
// This field is deprecated. Instead, use the `networkDetails` field to view the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the attached resource.
VcnId *string `mandatory:"false" json:"vcnId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the export route distribution used to specify how routes in the assigned DRG route table
// are advertised to the attachment.
// If this value is null, no routes are advertised through this attachment.
ExportDrgRouteDistributionId *string `mandatory:"false" json:"exportDrgRouteDistributionId"`
// Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG.
// Example: `false`
IsCrossTenancy *bool `mandatory:"false" json:"isCrossTenancy"`
}
func (m DrgAttachment) String() string
func (m *DrgAttachment) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m DrgAttachment) 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
DrgAttachmentIdDrgRouteDistributionMatchCriteria The criteria by which a specific attachment will import routes to the DRG.
type DrgAttachmentIdDrgRouteDistributionMatchCriteria struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment.
DrgAttachmentId *string `mandatory:"true" json:"drgAttachmentId"`
}
func (m DrgAttachmentIdDrgRouteDistributionMatchCriteria) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DrgAttachmentIdDrgRouteDistributionMatchCriteria) String() string
func (m DrgAttachmentIdDrgRouteDistributionMatchCriteria) 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
DrgAttachmentInfo The `DrgAttachmentInfo` resource contains the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment.
type DrgAttachmentInfo struct {
// The Oracle-assigned ID of the DRG attachment
Id *string `mandatory:"true" json:"id"`
}
func (m DrgAttachmentInfo) String() string
func (m DrgAttachmentInfo) 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
DrgAttachmentLifecycleStateEnum Enum with underlying type: string
type DrgAttachmentLifecycleStateEnum string
Set of constants representing the allowable values for DrgAttachmentLifecycleStateEnum
const (
DrgAttachmentLifecycleStateAttaching DrgAttachmentLifecycleStateEnum = "ATTACHING"
DrgAttachmentLifecycleStateAttached DrgAttachmentLifecycleStateEnum = "ATTACHED"
DrgAttachmentLifecycleStateDetaching DrgAttachmentLifecycleStateEnum = "DETACHING"
DrgAttachmentLifecycleStateDetached DrgAttachmentLifecycleStateEnum = "DETACHED"
)
func GetDrgAttachmentLifecycleStateEnumValues() []DrgAttachmentLifecycleStateEnum
GetDrgAttachmentLifecycleStateEnumValues Enumerates the set of values for DrgAttachmentLifecycleStateEnum
func GetMappingDrgAttachmentLifecycleStateEnum(val string) (DrgAttachmentLifecycleStateEnum, bool)
GetMappingDrgAttachmentLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DrgAttachmentMatchAllDrgRouteDistributionMatchCriteria All routes are imported or exported.
type DrgAttachmentMatchAllDrgRouteDistributionMatchCriteria struct {
}
func (m DrgAttachmentMatchAllDrgRouteDistributionMatchCriteria) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DrgAttachmentMatchAllDrgRouteDistributionMatchCriteria) String() string
func (m DrgAttachmentMatchAllDrgRouteDistributionMatchCriteria) 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
DrgAttachmentNetworkCreateDetails The representation of DrgAttachmentNetworkCreateDetails
type DrgAttachmentNetworkCreateDetails interface {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG.
GetId() *string
}
DrgAttachmentNetworkCreateDetailsTypeEnum Enum with underlying type: string
type DrgAttachmentNetworkCreateDetailsTypeEnum string
Set of constants representing the allowable values for DrgAttachmentNetworkCreateDetailsTypeEnum
const (
DrgAttachmentNetworkCreateDetailsTypeVcn DrgAttachmentNetworkCreateDetailsTypeEnum = "VCN"
)
func GetDrgAttachmentNetworkCreateDetailsTypeEnumValues() []DrgAttachmentNetworkCreateDetailsTypeEnum
GetDrgAttachmentNetworkCreateDetailsTypeEnumValues Enumerates the set of values for DrgAttachmentNetworkCreateDetailsTypeEnum
func GetMappingDrgAttachmentNetworkCreateDetailsTypeEnum(val string) (DrgAttachmentNetworkCreateDetailsTypeEnum, bool)
GetMappingDrgAttachmentNetworkCreateDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DrgAttachmentNetworkDetails The representation of DrgAttachmentNetworkDetails
type DrgAttachmentNetworkDetails interface {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG.
GetId() *string
}
DrgAttachmentNetworkDetailsTypeEnum Enum with underlying type: string
type DrgAttachmentNetworkDetailsTypeEnum string
Set of constants representing the allowable values for DrgAttachmentNetworkDetailsTypeEnum
const (
DrgAttachmentNetworkDetailsTypeVcn DrgAttachmentNetworkDetailsTypeEnum = "VCN"
DrgAttachmentNetworkDetailsTypeIpsecTunnel DrgAttachmentNetworkDetailsTypeEnum = "IPSEC_TUNNEL"
DrgAttachmentNetworkDetailsTypeVirtualCircuit DrgAttachmentNetworkDetailsTypeEnum = "VIRTUAL_CIRCUIT"
DrgAttachmentNetworkDetailsTypeRemotePeeringConnection DrgAttachmentNetworkDetailsTypeEnum = "REMOTE_PEERING_CONNECTION"
)
func GetDrgAttachmentNetworkDetailsTypeEnumValues() []DrgAttachmentNetworkDetailsTypeEnum
GetDrgAttachmentNetworkDetailsTypeEnumValues Enumerates the set of values for DrgAttachmentNetworkDetailsTypeEnum
func GetMappingDrgAttachmentNetworkDetailsTypeEnum(val string) (DrgAttachmentNetworkDetailsTypeEnum, bool)
GetMappingDrgAttachmentNetworkDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DrgAttachmentNetworkUpdateDetails The representation of DrgAttachmentNetworkUpdateDetails
type DrgAttachmentNetworkUpdateDetails interface {
}
DrgAttachmentNetworkUpdateDetailsTypeEnum Enum with underlying type: string
type DrgAttachmentNetworkUpdateDetailsTypeEnum string
Set of constants representing the allowable values for DrgAttachmentNetworkUpdateDetailsTypeEnum
const (
DrgAttachmentNetworkUpdateDetailsTypeVcn DrgAttachmentNetworkUpdateDetailsTypeEnum = "VCN"
)
func GetDrgAttachmentNetworkUpdateDetailsTypeEnumValues() []DrgAttachmentNetworkUpdateDetailsTypeEnum
GetDrgAttachmentNetworkUpdateDetailsTypeEnumValues Enumerates the set of values for DrgAttachmentNetworkUpdateDetailsTypeEnum
func GetMappingDrgAttachmentNetworkUpdateDetailsTypeEnum(val string) (DrgAttachmentNetworkUpdateDetailsTypeEnum, bool)
GetMappingDrgAttachmentNetworkUpdateDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DrgAttachmentTypeDrgRouteDistributionMatchCriteria The attachment type from which the DRG will import routes. Routes will be imported from all attachments of this type.
type DrgAttachmentTypeDrgRouteDistributionMatchCriteria struct {
// The type of the network resource to be included in this match. A match for a network type implies that all
// DRG attachments of that type insert routes into the table.
AttachmentType DrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeEnum `mandatory:"true" json:"attachmentType"`
}
func (m DrgAttachmentTypeDrgRouteDistributionMatchCriteria) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DrgAttachmentTypeDrgRouteDistributionMatchCriteria) String() string
func (m DrgAttachmentTypeDrgRouteDistributionMatchCriteria) 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
DrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeEnum Enum with underlying type: string
type DrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeEnum string
Set of constants representing the allowable values for DrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeEnum
const (
DrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeVcn DrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeEnum = "VCN"
DrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeVirtualCircuit DrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeEnum = "VIRTUAL_CIRCUIT"
DrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeRemotePeeringConnection DrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeEnum = "REMOTE_PEERING_CONNECTION"
DrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeIpsecTunnel DrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeEnum = "IPSEC_TUNNEL"
)
func GetDrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeEnumValues() []DrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeEnum
GetDrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeEnumValues Enumerates the set of values for DrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeEnum
func GetMappingDrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeEnum(val string) (DrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeEnum, bool)
GetMappingDrgAttachmentTypeDrgRouteDistributionMatchCriteriaAttachmentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DrgLifecycleStateEnum Enum with underlying type: string
type DrgLifecycleStateEnum string
Set of constants representing the allowable values for DrgLifecycleStateEnum
const (
DrgLifecycleStateProvisioning DrgLifecycleStateEnum = "PROVISIONING"
DrgLifecycleStateAvailable DrgLifecycleStateEnum = "AVAILABLE"
DrgLifecycleStateTerminating DrgLifecycleStateEnum = "TERMINATING"
DrgLifecycleStateTerminated DrgLifecycleStateEnum = "TERMINATED"
)
func GetDrgLifecycleStateEnumValues() []DrgLifecycleStateEnum
GetDrgLifecycleStateEnumValues Enumerates the set of values for DrgLifecycleStateEnum
func GetMappingDrgLifecycleStateEnum(val string) (DrgLifecycleStateEnum, bool)
GetMappingDrgLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DrgRedundancyStatus The redundancy status of the DRG. For more information, see Redundancy Remedies (https://docs.oracle.com/iaas/Content/Network/Troubleshoot/drgredundancy.htm).
type DrgRedundancyStatus struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG.
Id *string `mandatory:"false" json:"id"`
// The redundancy status of the DRG.
Status DrgRedundancyStatusStatusEnum `mandatory:"false" json:"status,omitempty"`
}
func (m DrgRedundancyStatus) String() string
func (m DrgRedundancyStatus) 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
DrgRedundancyStatusStatusEnum Enum with underlying type: string
type DrgRedundancyStatusStatusEnum string
Set of constants representing the allowable values for DrgRedundancyStatusStatusEnum
const (
DrgRedundancyStatusStatusNotAvailable DrgRedundancyStatusStatusEnum = "NOT_AVAILABLE"
DrgRedundancyStatusStatusRedundant DrgRedundancyStatusStatusEnum = "REDUNDANT"
DrgRedundancyStatusStatusNotRedundantSingleIpsec DrgRedundancyStatusStatusEnum = "NOT_REDUNDANT_SINGLE_IPSEC"
DrgRedundancyStatusStatusNotRedundantSingleVirtualcircuit DrgRedundancyStatusStatusEnum = "NOT_REDUNDANT_SINGLE_VIRTUALCIRCUIT"
DrgRedundancyStatusStatusNotRedundantMultipleIpsecs DrgRedundancyStatusStatusEnum = "NOT_REDUNDANT_MULTIPLE_IPSECS"
DrgRedundancyStatusStatusNotRedundantMultipleVirtualcircuits DrgRedundancyStatusStatusEnum = "NOT_REDUNDANT_MULTIPLE_VIRTUALCIRCUITS"
DrgRedundancyStatusStatusNotRedundantMixConnections DrgRedundancyStatusStatusEnum = "NOT_REDUNDANT_MIX_CONNECTIONS"
DrgRedundancyStatusStatusNotRedundantNoConnection DrgRedundancyStatusStatusEnum = "NOT_REDUNDANT_NO_CONNECTION"
)
func GetDrgRedundancyStatusStatusEnumValues() []DrgRedundancyStatusStatusEnum
GetDrgRedundancyStatusStatusEnumValues Enumerates the set of values for DrgRedundancyStatusStatusEnum
func GetMappingDrgRedundancyStatusStatusEnum(val string) (DrgRedundancyStatusStatusEnum, bool)
GetMappingDrgRedundancyStatusStatusEnum performs case Insensitive comparison on enum value and return the desired enum
DrgRouteDistribution A route distribution establishes how routes get imported into DRG route tables and exported through the DRG attachments. A route distribution is a list of statements. Each statement consists of a set of matches, all of which must be `True` in order for the statement's action to take place. Each statement determines which routes are propagated. You can assign a route distribution as a route table's import distribution. The statements in an import route distribution specify how how incoming route advertisements through a referenced attachment or all attachments of a certain type are inserted into the route table. You can assign a route distribution as a DRG attachment's export distribution unless the attachment has the type VCN. Exporting routes through a VCN attachment is unsupported. Export route distribution statements specify how routes in a DRG attachment's assigned table are advertised out through the attachment. When a DRG is created, a route distribution is created with a single ACCEPT statement with match criteria MATCH_ALL. By default, all DRG attachments (except for those of type VCN), are assigned this distribution.
The two auto-generated DRG route tables (one as the default for VCN attachments, and the other for all other types of attachments) are each assigned an auto generated import route distribution. The default VCN table's import distribution has a single statement with match criteria MATCH_ALL to import routes from each DRG attachment type. The other table's import distribution has a statement to import routes from attachments with the VCN type. The route distribution is always in the same compartment as the DRG.
type DrgRouteDistribution struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG that contains this route distribution.
DrgId *string `mandatory:"true" json:"drgId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the route distribution.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The route distribution's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"true" json:"id"`
// The route distribution's current state.
LifecycleState DrgRouteDistributionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the route distribution was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Whether this distribution defines how routes get imported into route tables or exported through DRG attachments.
DistributionType DrgRouteDistributionDistributionTypeEnum `mandatory:"true" json:"distributionType"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m DrgRouteDistribution) String() string
func (m DrgRouteDistribution) 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
DrgRouteDistributionDistributionTypeEnum Enum with underlying type: string
type DrgRouteDistributionDistributionTypeEnum string
Set of constants representing the allowable values for DrgRouteDistributionDistributionTypeEnum
const (
DrgRouteDistributionDistributionTypeImport DrgRouteDistributionDistributionTypeEnum = "IMPORT"
DrgRouteDistributionDistributionTypeExport DrgRouteDistributionDistributionTypeEnum = "EXPORT"
)
func GetDrgRouteDistributionDistributionTypeEnumValues() []DrgRouteDistributionDistributionTypeEnum
GetDrgRouteDistributionDistributionTypeEnumValues Enumerates the set of values for DrgRouteDistributionDistributionTypeEnum
func GetMappingDrgRouteDistributionDistributionTypeEnum(val string) (DrgRouteDistributionDistributionTypeEnum, bool)
GetMappingDrgRouteDistributionDistributionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DrgRouteDistributionLifecycleStateEnum Enum with underlying type: string
type DrgRouteDistributionLifecycleStateEnum string
Set of constants representing the allowable values for DrgRouteDistributionLifecycleStateEnum
const (
DrgRouteDistributionLifecycleStateProvisioning DrgRouteDistributionLifecycleStateEnum = "PROVISIONING"
DrgRouteDistributionLifecycleStateAvailable DrgRouteDistributionLifecycleStateEnum = "AVAILABLE"
DrgRouteDistributionLifecycleStateTerminating DrgRouteDistributionLifecycleStateEnum = "TERMINATING"
DrgRouteDistributionLifecycleStateTerminated DrgRouteDistributionLifecycleStateEnum = "TERMINATED"
)
func GetDrgRouteDistributionLifecycleStateEnumValues() []DrgRouteDistributionLifecycleStateEnum
GetDrgRouteDistributionLifecycleStateEnumValues Enumerates the set of values for DrgRouteDistributionLifecycleStateEnum
func GetMappingDrgRouteDistributionLifecycleStateEnum(val string) (DrgRouteDistributionLifecycleStateEnum, bool)
GetMappingDrgRouteDistributionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DrgRouteDistributionMatchCriteria The match criteria in a route distribution statement. The match criteria outlines which routes should be imported or exported.
type DrgRouteDistributionMatchCriteria interface {
}
DrgRouteDistributionMatchCriteriaMatchTypeEnum Enum with underlying type: string
type DrgRouteDistributionMatchCriteriaMatchTypeEnum string
Set of constants representing the allowable values for DrgRouteDistributionMatchCriteriaMatchTypeEnum
const (
DrgRouteDistributionMatchCriteriaMatchTypeDrgAttachmentType DrgRouteDistributionMatchCriteriaMatchTypeEnum = "DRG_ATTACHMENT_TYPE"
DrgRouteDistributionMatchCriteriaMatchTypeDrgAttachmentId DrgRouteDistributionMatchCriteriaMatchTypeEnum = "DRG_ATTACHMENT_ID"
DrgRouteDistributionMatchCriteriaMatchTypeMatchAll DrgRouteDistributionMatchCriteriaMatchTypeEnum = "MATCH_ALL"
)
func GetDrgRouteDistributionMatchCriteriaMatchTypeEnumValues() []DrgRouteDistributionMatchCriteriaMatchTypeEnum
GetDrgRouteDistributionMatchCriteriaMatchTypeEnumValues Enumerates the set of values for DrgRouteDistributionMatchCriteriaMatchTypeEnum
func GetMappingDrgRouteDistributionMatchCriteriaMatchTypeEnum(val string) (DrgRouteDistributionMatchCriteriaMatchTypeEnum, bool)
GetMappingDrgRouteDistributionMatchCriteriaMatchTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DrgRouteDistributionStatement A single statement within a route distribution. All match criteria in a statement must be met for the action to take place.
type DrgRouteDistributionStatement struct {
// The action is applied only if all of the match criteria is met.
// If there are no match criteria in a statement, any input is considered a match and the action is applied.
MatchCriteria []DrgRouteDistributionMatchCriteria `mandatory:"true" json:"matchCriteria"`
// `ACCEPT` indicates the route should be imported or exported as-is.
Action DrgRouteDistributionStatementActionEnum `mandatory:"true" json:"action"`
// This field specifies the priority of each statement in a route distribution.
// Priorities must be unique within a particular route distribution.
// The priority will be represented as a number between 0 and 65535 where a lower number
// indicates a higher priority. When a route is processed, statements are applied in the order
// defined by their priority. The first matching rule dictates the action that will be taken
// on the route.
Priority *int `mandatory:"true" json:"priority"`
// The Oracle-assigned ID of the route distribution statement.
Id *string `mandatory:"true" json:"id"`
}
func (m DrgRouteDistributionStatement) String() string
func (m *DrgRouteDistributionStatement) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m DrgRouteDistributionStatement) 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
DrgRouteDistributionStatementActionEnum Enum with underlying type: string
type DrgRouteDistributionStatementActionEnum string
Set of constants representing the allowable values for DrgRouteDistributionStatementActionEnum
const (
DrgRouteDistributionStatementActionAccept DrgRouteDistributionStatementActionEnum = "ACCEPT"
)
func GetDrgRouteDistributionStatementActionEnumValues() []DrgRouteDistributionStatementActionEnum
GetDrgRouteDistributionStatementActionEnumValues Enumerates the set of values for DrgRouteDistributionStatementActionEnum
func GetMappingDrgRouteDistributionStatementActionEnum(val string) (DrgRouteDistributionStatementActionEnum, bool)
GetMappingDrgRouteDistributionStatementActionEnum performs case Insensitive comparison on enum value and return the desired enum
DrgRouteRule A DRG route rule is a mapping between a destination IP address range and a DRG attachment. The map is used to route matching packets. Traffic will be routed across the attachments using Equal-cost multi-path routing (ECMP) if there are multiple rules with identical destinations and none of the rules conflict.
type DrgRouteRule struct {
// Represents the range of IP addresses to match against when routing traffic.
// Potential values:
// * An IP address range (IPv4 or IPv6) in CIDR notation. For example: `192.168.1.0/24`
// or `2001:0db8:0123:45::/56`.
// * When you're setting up a security rule for traffic destined for a particular `Service` through
// a service gateway, this is the `cidrBlock` value associated with that Service. For example: `oci-phx-objectstorage`.
Destination *string `mandatory:"true" json:"destination"`
// The type of destination for the rule.
// Allowed values:
// * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.
// * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a
// Service (the rule is for traffic destined for a
// particular `Service` through a service gateway).
DestinationType DrgRouteRuleDestinationTypeEnum `mandatory:"true" json:"destinationType"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the next hop DRG attachment responsible
// for reaching the network destination.
// A value of `BLACKHOLE` means traffic for this route is discarded without notification.
NextHopDrgAttachmentId *string `mandatory:"true" json:"nextHopDrgAttachmentId"`
// The Oracle-assigned ID of the DRG route rule.
Id *string `mandatory:"true" json:"id"`
// The earliest origin of a route. If a route is advertised to a DRG through an IPsec tunnel attachment,
// and is propagated to peered DRGs via RPC attachments, the route's provenance in the peered DRGs remains `IPSEC_TUNNEL`,
// because that is the earliest origin.
// No routes with a provenance `IPSEC_TUNNEL` or `VIRTUAL_CIRCUIT` will be exported to IPsec tunnel or virtual circuit attachments,
// regardless of the attachment's export distribution.
RouteProvenance DrgRouteRuleRouteProvenanceEnum `mandatory:"true" json:"routeProvenance"`
// You can specify static routes for the DRG route table using the API.
// The DRG learns dynamic routes from the DRG attachments using various routing protocols.
RouteType DrgRouteRuleRouteTypeEnum `mandatory:"false" json:"routeType,omitempty"`
// Indicates that the route was not imported due to a conflict between route rules.
IsConflict *bool `mandatory:"false" json:"isConflict"`
// Indicates that if the next hop attachment does not exist, so traffic for this route is discarded without notification.
IsBlackhole *bool `mandatory:"false" json:"isBlackhole"`
// Additional properties for the route, computed by the service.
Attributes *interface{} `mandatory:"false" json:"attributes"`
}
func (m DrgRouteRule) String() string
func (m DrgRouteRule) 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
DrgRouteRuleDestinationTypeEnum Enum with underlying type: string
type DrgRouteRuleDestinationTypeEnum string
Set of constants representing the allowable values for DrgRouteRuleDestinationTypeEnum
const (
DrgRouteRuleDestinationTypeCidrBlock DrgRouteRuleDestinationTypeEnum = "CIDR_BLOCK"
DrgRouteRuleDestinationTypeServiceCidrBlock DrgRouteRuleDestinationTypeEnum = "SERVICE_CIDR_BLOCK"
)
func GetDrgRouteRuleDestinationTypeEnumValues() []DrgRouteRuleDestinationTypeEnum
GetDrgRouteRuleDestinationTypeEnumValues Enumerates the set of values for DrgRouteRuleDestinationTypeEnum
func GetMappingDrgRouteRuleDestinationTypeEnum(val string) (DrgRouteRuleDestinationTypeEnum, bool)
GetMappingDrgRouteRuleDestinationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DrgRouteRuleRouteProvenanceEnum Enum with underlying type: string
type DrgRouteRuleRouteProvenanceEnum string
Set of constants representing the allowable values for DrgRouteRuleRouteProvenanceEnum
const (
DrgRouteRuleRouteProvenanceStatic DrgRouteRuleRouteProvenanceEnum = "STATIC"
DrgRouteRuleRouteProvenanceVcn DrgRouteRuleRouteProvenanceEnum = "VCN"
DrgRouteRuleRouteProvenanceVirtualCircuit DrgRouteRuleRouteProvenanceEnum = "VIRTUAL_CIRCUIT"
DrgRouteRuleRouteProvenanceIpsecTunnel DrgRouteRuleRouteProvenanceEnum = "IPSEC_TUNNEL"
)
func GetDrgRouteRuleRouteProvenanceEnumValues() []DrgRouteRuleRouteProvenanceEnum
GetDrgRouteRuleRouteProvenanceEnumValues Enumerates the set of values for DrgRouteRuleRouteProvenanceEnum
func GetMappingDrgRouteRuleRouteProvenanceEnum(val string) (DrgRouteRuleRouteProvenanceEnum, bool)
GetMappingDrgRouteRuleRouteProvenanceEnum performs case Insensitive comparison on enum value and return the desired enum
DrgRouteRuleRouteTypeEnum Enum with underlying type: string
type DrgRouteRuleRouteTypeEnum string
Set of constants representing the allowable values for DrgRouteRuleRouteTypeEnum
const (
DrgRouteRuleRouteTypeStatic DrgRouteRuleRouteTypeEnum = "STATIC"
DrgRouteRuleRouteTypeDynamic DrgRouteRuleRouteTypeEnum = "DYNAMIC"
)
func GetDrgRouteRuleRouteTypeEnumValues() []DrgRouteRuleRouteTypeEnum
GetDrgRouteRuleRouteTypeEnumValues Enumerates the set of values for DrgRouteRuleRouteTypeEnum
func GetMappingDrgRouteRuleRouteTypeEnum(val string) (DrgRouteRuleRouteTypeEnum, bool)
GetMappingDrgRouteRuleRouteTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DrgRouteTable All routing inside the DRG is driven by the contents of DRG route tables. DRG route tables contain rules which route packets to a particular network destination, represented as a DRG attachment. The routing decision for a packet entering a DRG is determined by the rules in the DRG route table assigned to the attachment-of-entry. Each DRG attachment can inject routes in any DRG route table, provided there is a statement corresponding to the attachment in the route table's `importDrgRouteDistribution`. You can also insert static routes into the DRG route tables. The DRG route table is always in the same compartment as the DRG. There must always be a default DRG route table for each attachment type.
type DrgRouteTable struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the
// DRG route table.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment the DRG is in. The DRG route table
// is always in the same compartment as the DRG.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG the DRG that contains this route table.
DrgId *string `mandatory:"true" json:"drgId"`
// The date and time the DRG route table was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The DRG route table's current state.
LifecycleState DrgRouteTableLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// If you want traffic to be routed using ECMP across your virtual circuits or IPSec tunnels to
// your on-premises network, enable ECMP on the DRG route table to which these attachments
// import routes.
IsEcmpEnabled *bool `mandatory:"true" json:"isEcmpEnabled"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution used to specify how incoming route advertisements from
// referenced attachments are inserted into the DRG route table.
ImportDrgRouteDistributionId *string `mandatory:"false" json:"importDrgRouteDistributionId"`
}
func (m DrgRouteTable) String() string
func (m DrgRouteTable) 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
DrgRouteTableLifecycleStateEnum Enum with underlying type: string
type DrgRouteTableLifecycleStateEnum string
Set of constants representing the allowable values for DrgRouteTableLifecycleStateEnum
const (
DrgRouteTableLifecycleStateProvisioning DrgRouteTableLifecycleStateEnum = "PROVISIONING"
DrgRouteTableLifecycleStateAvailable DrgRouteTableLifecycleStateEnum = "AVAILABLE"
DrgRouteTableLifecycleStateTerminating DrgRouteTableLifecycleStateEnum = "TERMINATING"
DrgRouteTableLifecycleStateTerminated DrgRouteTableLifecycleStateEnum = "TERMINATED"
)
func GetDrgRouteTableLifecycleStateEnumValues() []DrgRouteTableLifecycleStateEnum
GetDrgRouteTableLifecycleStateEnumValues Enumerates the set of values for DrgRouteTableLifecycleStateEnum
func GetMappingDrgRouteTableLifecycleStateEnum(val string) (DrgRouteTableLifecycleStateEnum, bool)
GetMappingDrgRouteTableLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DrgRoutingConfiguration Identifies the DRG route table and rule that allowed the traffic to be forwarded.
type DrgRoutingConfiguration struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG route
// table that allowed the traffic.
DrgRouteTableId *string `mandatory:"true" json:"drgRouteTableId"`
RouteRule *DrgRouteRule `mandatory:"true" json:"routeRule"`
}
func (m DrgRoutingConfiguration) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DrgRoutingConfiguration) String() string
func (m DrgRoutingConfiguration) 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
EgressSecurityListConfiguration Defines the subnet egress security list configuration that allowed the traffic.
type EgressSecurityListConfiguration struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the security
// list that allowed the traffic.
SecurityListId *string `mandatory:"true" json:"securityListId"`
SecurityRule *EgressSecurityRule `mandatory:"true" json:"securityRule"`
}
func (m EgressSecurityListConfiguration) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m EgressSecurityListConfiguration) String() string
func (m EgressSecurityListConfiguration) 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
EgressSecurityRule A rule for allowing outbound IP packets.
type EgressSecurityRule struct {
// Conceptually, this is the range of IP addresses that a packet originating from the instance
// can go to.
// Allowed values:
// * IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`
// Note that IPv6 addressing is currently supported only in certain regions. See
// IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// * The `cidrBlock` value for a Service, if you're
// setting up a security list rule for traffic destined for a particular `Service` through
// a service gateway. For example: `oci-phx-objectstorage`.
Destination *string `mandatory:"true" json:"destination"`
// The transport protocol. Specify either `all` or an IPv4 protocol number as
// defined in
// Protocol Numbers (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
// Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58").
Protocol *string `mandatory:"true" json:"protocol"`
// Type of destination for the rule. The default is `CIDR_BLOCK`.
// Allowed values:
// * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.
// * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a
// Service (the rule is for traffic destined for a
// particular `Service` through a service gateway).
DestinationType EgressSecurityRuleDestinationTypeEnum `mandatory:"false" json:"destinationType,omitempty"`
IcmpOptions *IcmpOptions `mandatory:"false" json:"icmpOptions"`
// A stateless rule allows traffic in one direction. Remember to add a corresponding
// stateless rule in the other direction if you need to support bidirectional traffic. For
// example, if egress traffic allows TCP destination port 80, there should be an ingress
// rule to allow TCP source port 80. Defaults to false, which means the rule is stateful
// and a corresponding rule is not necessary for bidirectional traffic.
IsStateless *bool `mandatory:"false" json:"isStateless"`
TcpOptions *TcpOptions `mandatory:"false" json:"tcpOptions"`
UdpOptions *UdpOptions `mandatory:"false" json:"udpOptions"`
// An optional description of your choice for the rule.
Description *string `mandatory:"false" json:"description"`
}
func (m EgressSecurityRule) String() string
func (m EgressSecurityRule) 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
EgressSecurityRuleDestinationTypeEnum Enum with underlying type: string
type EgressSecurityRuleDestinationTypeEnum string
Set of constants representing the allowable values for EgressSecurityRuleDestinationTypeEnum
const (
EgressSecurityRuleDestinationTypeCidrBlock EgressSecurityRuleDestinationTypeEnum = "CIDR_BLOCK"
EgressSecurityRuleDestinationTypeServiceCidrBlock EgressSecurityRuleDestinationTypeEnum = "SERVICE_CIDR_BLOCK"
)
func GetEgressSecurityRuleDestinationTypeEnumValues() []EgressSecurityRuleDestinationTypeEnum
GetEgressSecurityRuleDestinationTypeEnumValues Enumerates the set of values for EgressSecurityRuleDestinationTypeEnum
func GetMappingEgressSecurityRuleDestinationTypeEnum(val string) (EgressSecurityRuleDestinationTypeEnum, bool)
GetMappingEgressSecurityRuleDestinationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
EgressTrafficSpec Defines the traffic configuration that leaves the traffic node.
type EgressTrafficSpec struct {
// The IP protocol to use for the traffic path analysis.
Protocol *int `mandatory:"true" json:"protocol"`
// The IPv4 address of the source node.
SourceAddress *string `mandatory:"true" json:"sourceAddress"`
// The IPv4 address of the destination node.
DestinationAddress *string `mandatory:"true" json:"destinationAddress"`
TrafficProtocolParameters TrafficProtocolParameters `mandatory:"false" json:"trafficProtocolParameters"`
}
func (m EgressTrafficSpec) String() string
func (m *EgressTrafficSpec) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m EgressTrafficSpec) 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
EncryptionDomainConfig Configuration information used by the encryption domain policy.
type EncryptionDomainConfig struct {
// Lists IPv4 or IPv6-enabled subnets in your Oracle tenancy.
OracleTrafficSelector []string `mandatory:"false" json:"oracleTrafficSelector"`
// Lists IPv4 or IPv6-enabled subnets in your on-premises network.
CpeTrafficSelector []string `mandatory:"false" json:"cpeTrafficSelector"`
}
func (m EncryptionDomainConfig) String() string
func (m EncryptionDomainConfig) 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
Endpoint Information describing a source or destination in a `PathAnalyzerTest` resource.
type Endpoint interface {
}
EndpointTypeEnum Enum with underlying type: string
type EndpointTypeEnum string
Set of constants representing the allowable values for EndpointTypeEnum
const (
EndpointTypeIpAddress EndpointTypeEnum = "IP_ADDRESS"
EndpointTypeSubnet EndpointTypeEnum = "SUBNET"
EndpointTypeComputeInstance EndpointTypeEnum = "COMPUTE_INSTANCE"
EndpointTypeVnic EndpointTypeEnum = "VNIC"
EndpointTypeLoadBalancer EndpointTypeEnum = "LOAD_BALANCER"
EndpointTypeLoadBalancerListener EndpointTypeEnum = "LOAD_BALANCER_LISTENER"
EndpointTypeNetworkLoadBalancer EndpointTypeEnum = "NETWORK_LOAD_BALANCER"
EndpointTypeNetworkLoadBalancerListener EndpointTypeEnum = "NETWORK_LOAD_BALANCER_LISTENER"
EndpointTypeVlan EndpointTypeEnum = "VLAN"
EndpointTypeOnPrem EndpointTypeEnum = "ON_PREM"
)
func GetEndpointTypeEnumValues() []EndpointTypeEnum
GetEndpointTypeEnumValues Enumerates the set of values for EndpointTypeEnum
func GetMappingEndpointTypeEnum(val string) (EndpointTypeEnum, bool)
GetMappingEndpointTypeEnum performs case Insensitive comparison on enum value and return the desired enum
FastConnectProviderService A service offering from a supported provider. For more information, see FastConnect Overview (https://docs.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm).
type FastConnectProviderService struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the service offered by the provider.
Id *string `mandatory:"true" json:"id"`
// Who is responsible for managing the private peering BGP information.
PrivatePeeringBgpManagement FastConnectProviderServicePrivatePeeringBgpManagementEnum `mandatory:"true" json:"privatePeeringBgpManagement"`
// The name of the provider.
ProviderName *string `mandatory:"true" json:"providerName"`
// The name of the service offered by the provider.
ProviderServiceName *string `mandatory:"true" json:"providerServiceName"`
// Who is responsible for managing the public peering BGP information.
PublicPeeringBgpManagement FastConnectProviderServicePublicPeeringBgpManagementEnum `mandatory:"true" json:"publicPeeringBgpManagement"`
// Who is responsible for managing the ASN information for the network at the other end
// of the connection from Oracle.
CustomerAsnManagement FastConnectProviderServiceCustomerAsnManagementEnum `mandatory:"true" json:"customerAsnManagement"`
// Who is responsible for managing the provider service key.
ProviderServiceKeyManagement FastConnectProviderServiceProviderServiceKeyManagementEnum `mandatory:"true" json:"providerServiceKeyManagement"`
// Who is responsible for managing the virtual circuit bandwidth.
BandwithShapeManagement FastConnectProviderServiceBandwithShapeManagementEnum `mandatory:"true" json:"bandwithShapeManagement"`
// Total number of cross-connect or cross-connect groups required for the virtual circuit.
RequiredTotalCrossConnects *int `mandatory:"true" json:"requiredTotalCrossConnects"`
// Provider service type.
Type FastConnectProviderServiceTypeEnum `mandatory:"true" json:"type"`
// The location of the provider's website or portal. This portal is where you can get information
// about the provider service, create a virtual circuit connection from the provider to Oracle
// Cloud Infrastructure, and retrieve your provider service key for that virtual circuit connection.
// Example: `https://example.com`
Description *string `mandatory:"false" json:"description"`
// An array of virtual circuit types supported by this service.
SupportedVirtualCircuitTypes []FastConnectProviderServiceSupportedVirtualCircuitTypesEnum `mandatory:"false" json:"supportedVirtualCircuitTypes,omitempty"`
}
func (m FastConnectProviderService) String() string
func (m FastConnectProviderService) 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
FastConnectProviderServiceBandwithShapeManagementEnum Enum with underlying type: string
type FastConnectProviderServiceBandwithShapeManagementEnum string
Set of constants representing the allowable values for FastConnectProviderServiceBandwithShapeManagementEnum
const (
FastConnectProviderServiceBandwithShapeManagementCustomerManaged FastConnectProviderServiceBandwithShapeManagementEnum = "CUSTOMER_MANAGED"
FastConnectProviderServiceBandwithShapeManagementProviderManaged FastConnectProviderServiceBandwithShapeManagementEnum = "PROVIDER_MANAGED"
FastConnectProviderServiceBandwithShapeManagementOracleManaged FastConnectProviderServiceBandwithShapeManagementEnum = "ORACLE_MANAGED"
)
func GetFastConnectProviderServiceBandwithShapeManagementEnumValues() []FastConnectProviderServiceBandwithShapeManagementEnum
GetFastConnectProviderServiceBandwithShapeManagementEnumValues Enumerates the set of values for FastConnectProviderServiceBandwithShapeManagementEnum
func GetMappingFastConnectProviderServiceBandwithShapeManagementEnum(val string) (FastConnectProviderServiceBandwithShapeManagementEnum, bool)
GetMappingFastConnectProviderServiceBandwithShapeManagementEnum performs case Insensitive comparison on enum value and return the desired enum
FastConnectProviderServiceCustomerAsnManagementEnum Enum with underlying type: string
type FastConnectProviderServiceCustomerAsnManagementEnum string
Set of constants representing the allowable values for FastConnectProviderServiceCustomerAsnManagementEnum
const (
FastConnectProviderServiceCustomerAsnManagementCustomerManaged FastConnectProviderServiceCustomerAsnManagementEnum = "CUSTOMER_MANAGED"
FastConnectProviderServiceCustomerAsnManagementProviderManaged FastConnectProviderServiceCustomerAsnManagementEnum = "PROVIDER_MANAGED"
FastConnectProviderServiceCustomerAsnManagementOracleManaged FastConnectProviderServiceCustomerAsnManagementEnum = "ORACLE_MANAGED"
)
func GetFastConnectProviderServiceCustomerAsnManagementEnumValues() []FastConnectProviderServiceCustomerAsnManagementEnum
GetFastConnectProviderServiceCustomerAsnManagementEnumValues Enumerates the set of values for FastConnectProviderServiceCustomerAsnManagementEnum
func GetMappingFastConnectProviderServiceCustomerAsnManagementEnum(val string) (FastConnectProviderServiceCustomerAsnManagementEnum, bool)
GetMappingFastConnectProviderServiceCustomerAsnManagementEnum performs case Insensitive comparison on enum value and return the desired enum
FastConnectProviderServiceKey A provider service key and its details. A provider service key is an identifier for a provider's virtual circuit.
type FastConnectProviderServiceKey struct {
// The service key that the provider gives you when you set up a virtual circuit connection
// from the provider to Oracle Cloud Infrastructure. Use this value as the `providerServiceKeyName`
// query parameter for
// GetFastConnectProviderServiceKey.
Name *string `mandatory:"true" json:"name"`
// The provisioned data rate of the connection. To get a list of the
// available bandwidth levels (that is, shapes), see
// ListFastConnectProviderVirtualCircuitBandwidthShapes.
// Example: `10 Gbps`
BandwidthShapeName *string `mandatory:"false" json:"bandwidthShapeName"`
// The provider's peering location.
PeeringLocation *string `mandatory:"false" json:"peeringLocation"`
}
func (m FastConnectProviderServiceKey) String() string
func (m FastConnectProviderServiceKey) 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
FastConnectProviderServicePrivatePeeringBgpManagementEnum Enum with underlying type: string
type FastConnectProviderServicePrivatePeeringBgpManagementEnum string
Set of constants representing the allowable values for FastConnectProviderServicePrivatePeeringBgpManagementEnum
const (
FastConnectProviderServicePrivatePeeringBgpManagementCustomerManaged FastConnectProviderServicePrivatePeeringBgpManagementEnum = "CUSTOMER_MANAGED"
FastConnectProviderServicePrivatePeeringBgpManagementProviderManaged FastConnectProviderServicePrivatePeeringBgpManagementEnum = "PROVIDER_MANAGED"
FastConnectProviderServicePrivatePeeringBgpManagementOracleManaged FastConnectProviderServicePrivatePeeringBgpManagementEnum = "ORACLE_MANAGED"
)
func GetFastConnectProviderServicePrivatePeeringBgpManagementEnumValues() []FastConnectProviderServicePrivatePeeringBgpManagementEnum
GetFastConnectProviderServicePrivatePeeringBgpManagementEnumValues Enumerates the set of values for FastConnectProviderServicePrivatePeeringBgpManagementEnum
func GetMappingFastConnectProviderServicePrivatePeeringBgpManagementEnum(val string) (FastConnectProviderServicePrivatePeeringBgpManagementEnum, bool)
GetMappingFastConnectProviderServicePrivatePeeringBgpManagementEnum performs case Insensitive comparison on enum value and return the desired enum
FastConnectProviderServiceProviderServiceKeyManagementEnum Enum with underlying type: string
type FastConnectProviderServiceProviderServiceKeyManagementEnum string
Set of constants representing the allowable values for FastConnectProviderServiceProviderServiceKeyManagementEnum
const (
FastConnectProviderServiceProviderServiceKeyManagementCustomerManaged FastConnectProviderServiceProviderServiceKeyManagementEnum = "CUSTOMER_MANAGED"
FastConnectProviderServiceProviderServiceKeyManagementProviderManaged FastConnectProviderServiceProviderServiceKeyManagementEnum = "PROVIDER_MANAGED"
FastConnectProviderServiceProviderServiceKeyManagementOracleManaged FastConnectProviderServiceProviderServiceKeyManagementEnum = "ORACLE_MANAGED"
)
func GetFastConnectProviderServiceProviderServiceKeyManagementEnumValues() []FastConnectProviderServiceProviderServiceKeyManagementEnum
GetFastConnectProviderServiceProviderServiceKeyManagementEnumValues Enumerates the set of values for FastConnectProviderServiceProviderServiceKeyManagementEnum
func GetMappingFastConnectProviderServiceProviderServiceKeyManagementEnum(val string) (FastConnectProviderServiceProviderServiceKeyManagementEnum, bool)
GetMappingFastConnectProviderServiceProviderServiceKeyManagementEnum performs case Insensitive comparison on enum value and return the desired enum
FastConnectProviderServicePublicPeeringBgpManagementEnum Enum with underlying type: string
type FastConnectProviderServicePublicPeeringBgpManagementEnum string
Set of constants representing the allowable values for FastConnectProviderServicePublicPeeringBgpManagementEnum
const (
FastConnectProviderServicePublicPeeringBgpManagementCustomerManaged FastConnectProviderServicePublicPeeringBgpManagementEnum = "CUSTOMER_MANAGED"
FastConnectProviderServicePublicPeeringBgpManagementProviderManaged FastConnectProviderServicePublicPeeringBgpManagementEnum = "PROVIDER_MANAGED"
FastConnectProviderServicePublicPeeringBgpManagementOracleManaged FastConnectProviderServicePublicPeeringBgpManagementEnum = "ORACLE_MANAGED"
)
func GetFastConnectProviderServicePublicPeeringBgpManagementEnumValues() []FastConnectProviderServicePublicPeeringBgpManagementEnum
GetFastConnectProviderServicePublicPeeringBgpManagementEnumValues Enumerates the set of values for FastConnectProviderServicePublicPeeringBgpManagementEnum
func GetMappingFastConnectProviderServicePublicPeeringBgpManagementEnum(val string) (FastConnectProviderServicePublicPeeringBgpManagementEnum, bool)
GetMappingFastConnectProviderServicePublicPeeringBgpManagementEnum performs case Insensitive comparison on enum value and return the desired enum
FastConnectProviderServiceSupportedVirtualCircuitTypesEnum Enum with underlying type: string
type FastConnectProviderServiceSupportedVirtualCircuitTypesEnum string
Set of constants representing the allowable values for FastConnectProviderServiceSupportedVirtualCircuitTypesEnum
const (
FastConnectProviderServiceSupportedVirtualCircuitTypesPublic FastConnectProviderServiceSupportedVirtualCircuitTypesEnum = "PUBLIC"
FastConnectProviderServiceSupportedVirtualCircuitTypesPrivate FastConnectProviderServiceSupportedVirtualCircuitTypesEnum = "PRIVATE"
)
func GetFastConnectProviderServiceSupportedVirtualCircuitTypesEnumValues() []FastConnectProviderServiceSupportedVirtualCircuitTypesEnum
GetFastConnectProviderServiceSupportedVirtualCircuitTypesEnumValues Enumerates the set of values for FastConnectProviderServiceSupportedVirtualCircuitTypesEnum
func GetMappingFastConnectProviderServiceSupportedVirtualCircuitTypesEnum(val string) (FastConnectProviderServiceSupportedVirtualCircuitTypesEnum, bool)
GetMappingFastConnectProviderServiceSupportedVirtualCircuitTypesEnum performs case Insensitive comparison on enum value and return the desired enum
FastConnectProviderServiceTypeEnum Enum with underlying type: string
type FastConnectProviderServiceTypeEnum string
Set of constants representing the allowable values for FastConnectProviderServiceTypeEnum
const (
FastConnectProviderServiceTypeLayer2 FastConnectProviderServiceTypeEnum = "LAYER2"
FastConnectProviderServiceTypeLayer3 FastConnectProviderServiceTypeEnum = "LAYER3"
)
func GetFastConnectProviderServiceTypeEnumValues() []FastConnectProviderServiceTypeEnum
GetFastConnectProviderServiceTypeEnumValues Enumerates the set of values for FastConnectProviderServiceTypeEnum
func GetMappingFastConnectProviderServiceTypeEnum(val string) (FastConnectProviderServiceTypeEnum, bool)
GetMappingFastConnectProviderServiceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
FlowLogCaptureFilterRuleDetails The set of rules governing what traffic the flow log collects when creating a flow log capture filter.
type FlowLogCaptureFilterRuleDetails struct {
// Indicates whether a flow log capture filter rule is enabled.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// A lower number indicates a higher priority, range 0-9. Each rule must have a distinct priority.
Priority *int `mandatory:"false" json:"priority"`
// Sampling interval as 1 of X, where X is an integer not greater than 100000.
SamplingRate *int `mandatory:"false" json:"samplingRate"`
// Traffic from this CIDR will be captured in the flow log.
SourceCidr *string `mandatory:"false" json:"sourceCidr"`
// Traffic to this CIDR will be captured in the flow log.
DestinationCidr *string `mandatory:"false" json:"destinationCidr"`
// The transport protocol the filter uses.
Protocol *string `mandatory:"false" json:"protocol"`
IcmpOptions *IcmpOptions `mandatory:"false" json:"icmpOptions"`
TcpOptions *TcpOptions `mandatory:"false" json:"tcpOptions"`
UdpOptions *UdpOptions `mandatory:"false" json:"udpOptions"`
// Type or types of flow logs to store. `ALL` includes records for both accepted traffic and
// rejected traffic.
FlowLogType FlowLogCaptureFilterRuleDetailsFlowLogTypeEnum `mandatory:"false" json:"flowLogType,omitempty"`
// Include or exclude a ruleAction object.
RuleAction FlowLogCaptureFilterRuleDetailsRuleActionEnum `mandatory:"false" json:"ruleAction,omitempty"`
}
func (m FlowLogCaptureFilterRuleDetails) String() string
func (m FlowLogCaptureFilterRuleDetails) 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
FlowLogCaptureFilterRuleDetailsFlowLogTypeEnum Enum with underlying type: string
type FlowLogCaptureFilterRuleDetailsFlowLogTypeEnum string
Set of constants representing the allowable values for FlowLogCaptureFilterRuleDetailsFlowLogTypeEnum
const (
FlowLogCaptureFilterRuleDetailsFlowLogTypeAll FlowLogCaptureFilterRuleDetailsFlowLogTypeEnum = "ALL"
FlowLogCaptureFilterRuleDetailsFlowLogTypeReject FlowLogCaptureFilterRuleDetailsFlowLogTypeEnum = "REJECT"
FlowLogCaptureFilterRuleDetailsFlowLogTypeAccept FlowLogCaptureFilterRuleDetailsFlowLogTypeEnum = "ACCEPT"
)
func GetFlowLogCaptureFilterRuleDetailsFlowLogTypeEnumValues() []FlowLogCaptureFilterRuleDetailsFlowLogTypeEnum
GetFlowLogCaptureFilterRuleDetailsFlowLogTypeEnumValues Enumerates the set of values for FlowLogCaptureFilterRuleDetailsFlowLogTypeEnum
func GetMappingFlowLogCaptureFilterRuleDetailsFlowLogTypeEnum(val string) (FlowLogCaptureFilterRuleDetailsFlowLogTypeEnum, bool)
GetMappingFlowLogCaptureFilterRuleDetailsFlowLogTypeEnum performs case Insensitive comparison on enum value and return the desired enum
FlowLogCaptureFilterRuleDetailsRuleActionEnum Enum with underlying type: string
type FlowLogCaptureFilterRuleDetailsRuleActionEnum string
Set of constants representing the allowable values for FlowLogCaptureFilterRuleDetailsRuleActionEnum
const (
FlowLogCaptureFilterRuleDetailsRuleActionInclude FlowLogCaptureFilterRuleDetailsRuleActionEnum = "INCLUDE"
FlowLogCaptureFilterRuleDetailsRuleActionExclude FlowLogCaptureFilterRuleDetailsRuleActionEnum = "EXCLUDE"
)
func GetFlowLogCaptureFilterRuleDetailsRuleActionEnumValues() []FlowLogCaptureFilterRuleDetailsRuleActionEnum
GetFlowLogCaptureFilterRuleDetailsRuleActionEnumValues Enumerates the set of values for FlowLogCaptureFilterRuleDetailsRuleActionEnum
func GetMappingFlowLogCaptureFilterRuleDetailsRuleActionEnum(val string) (FlowLogCaptureFilterRuleDetailsRuleActionEnum, bool)
GetMappingFlowLogCaptureFilterRuleDetailsRuleActionEnum performs case Insensitive comparison on enum value and return the desired enum
ForwardedRoutingAction Defines the routing actions taken for traffic that is forwarded.
type ForwardedRoutingAction struct {
ForwardedRoutingActionDetails *ForwardedRoutingActionDetails `mandatory:"false" json:"forwardedRoutingActionDetails"`
// The type of the routing support for the traffic flow.
ActionType RoutingActionActionTypeEnum `mandatory:"true" json:"actionType"`
}
func (m ForwardedRoutingAction) GetActionType() RoutingActionActionTypeEnum
GetActionType returns ActionType
func (m ForwardedRoutingAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ForwardedRoutingAction) String() string
func (m ForwardedRoutingAction) 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
ForwardedRoutingActionDetails Defines details for the forwarded routing action.
type ForwardedRoutingActionDetails struct {
// If true, the forwarded routing configuration details are incomplete.
IsRestrictedOrPartial *bool `mandatory:"true" json:"isRestrictedOrPartial"`
ForwardedRoutingConfiguration ForwardedRoutingConfiguration `mandatory:"false" json:"forwardedRoutingConfiguration"`
}
func (m ForwardedRoutingActionDetails) String() string
func (m *ForwardedRoutingActionDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ForwardedRoutingActionDetails) 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
ForwardedRoutingConfiguration Defines the type of the resource that forwarded traffic.
type ForwardedRoutingConfiguration interface {
}
ForwardedRoutingConfigurationTypeEnum Enum with underlying type: string
type ForwardedRoutingConfigurationTypeEnum string
Set of constants representing the allowable values for ForwardedRoutingConfigurationTypeEnum
const (
ForwardedRoutingConfigurationTypeVcn ForwardedRoutingConfigurationTypeEnum = "VCN"
ForwardedRoutingConfigurationTypeDrg ForwardedRoutingConfigurationTypeEnum = "DRG"
)
func GetForwardedRoutingConfigurationTypeEnumValues() []ForwardedRoutingConfigurationTypeEnum
GetForwardedRoutingConfigurationTypeEnumValues Enumerates the set of values for ForwardedRoutingConfigurationTypeEnum
func GetMappingForwardedRoutingConfigurationTypeEnum(val string) (ForwardedRoutingConfigurationTypeEnum, bool)
GetMappingForwardedRoutingConfigurationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
GetPathAnalysisDetails Defines the configuration for getting a path analysis.
type GetPathAnalysisDetails interface {
}
GetPathAnalysisDetailsTypeEnum Enum with underlying type: string
type GetPathAnalysisDetailsTypeEnum string
Set of constants representing the allowable values for GetPathAnalysisDetailsTypeEnum
const (
GetPathAnalysisDetailsTypePersistedQuery GetPathAnalysisDetailsTypeEnum = "PERSISTED_QUERY"
GetPathAnalysisDetailsTypeAdhocQuery GetPathAnalysisDetailsTypeEnum = "ADHOC_QUERY"
)
func GetGetPathAnalysisDetailsTypeEnumValues() []GetPathAnalysisDetailsTypeEnum
GetGetPathAnalysisDetailsTypeEnumValues Enumerates the set of values for GetPathAnalysisDetailsTypeEnum
func GetMappingGetPathAnalysisDetailsTypeEnum(val string) (GetPathAnalysisDetailsTypeEnum, bool)
GetMappingGetPathAnalysisDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
GetPathAnalysisRequest wrapper for the GetPathAnalysis operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/GetPathAnalysis.go.html to see an example of how to use GetPathAnalysisRequest.
type GetPathAnalysisRequest struct {
// Details for the path analysis query.
GetPathAnalysisDetails `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
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The Cache-Control HTTP header holds directives (instructions)
// for caching in both requests and responses.
CacheControl *string `mandatory:"false" contributesTo:"header" name:"cache-control"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetPathAnalysisRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPathAnalysisRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPathAnalysisRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPathAnalysisRequest) String() string
func (request GetPathAnalysisRequest) 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
GetPathAnalysisResponse wrapper for the GetPathAnalysis operation
type GetPathAnalysisResponse 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"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response GetPathAnalysisResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPathAnalysisResponse) String() string
GetPathAnalyzerTestRequest wrapper for the GetPathAnalyzerTest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/GetPathAnalyzerTest.go.html to see an example of how to use GetPathAnalyzerTestRequest.
type GetPathAnalyzerTestRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `PathAnalyzerTest` resource.
PathAnalyzerTestId *string `mandatory:"true" contributesTo:"path" name:"pathAnalyzerTestId"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetPathAnalyzerTestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPathAnalyzerTestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPathAnalyzerTestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPathAnalyzerTestRequest) String() string
func (request GetPathAnalyzerTestRequest) 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
GetPathAnalyzerTestResponse wrapper for the GetPathAnalyzerTest operation
type GetPathAnalyzerTestResponse struct {
// The underlying http response
RawResponse *http.Response
// The PathAnalyzerTest instance
PathAnalyzerTest `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetPathAnalyzerTestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPathAnalyzerTestResponse) String() string
GetPublicIpByIpAddressDetails IP address of the public IP.
type GetPublicIpByIpAddressDetails struct {
// The public IP address.
// Example: 203.0.113.2
IpAddress *string `mandatory:"true" json:"ipAddress"`
}
func (m GetPublicIpByIpAddressDetails) String() string
func (m GetPublicIpByIpAddressDetails) 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
GetPublicIpByPrivateIpIdDetails Details of the private IP that the public IP is assigned to.
type GetPublicIpByPrivateIpIdDetails struct {
// OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private IP.
PrivateIpId *string `mandatory:"true" json:"privateIpId"`
}
func (m GetPublicIpByPrivateIpIdDetails) String() string
func (m GetPublicIpByPrivateIpIdDetails) 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
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
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
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
IcmpOptions Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: - ICMP Parameters (http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) - ICMPv6 Parameters (https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml) If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and codes are allowed. If you do provide this object, the type is required and the code is optional. To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 ("Destination Unreachable") code 4 ("Fragmentation Needed and Don't Fragment was Set"). If you need to specify multiple codes for a single type, create a separate security list rule for each.
type IcmpOptions struct {
// The ICMP type.
Type *int `mandatory:"true" json:"type"`
// The ICMP code (optional).
Code *int `mandatory:"false" json:"code"`
}
func (m IcmpOptions) String() string
func (m IcmpOptions) 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
IcmpProtocolParameters Defines the configuration for the ICMP (https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) protocol parameters.
type IcmpProtocolParameters struct {
// The ICMP (https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) type.
IcmpType *int `mandatory:"true" json:"icmpType"`
// The ICMP (https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) code.
IcmpCode *int `mandatory:"false" json:"icmpCode"`
}
func (m IcmpProtocolParameters) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m IcmpProtocolParameters) String() string
func (m IcmpProtocolParameters) 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
IcmpTrafficProtocolParameters Defines the `ProtocolParameters` configuration for the ICMP (https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) protocol.
type IcmpTrafficProtocolParameters struct {
// The ICMP (https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) type.
IcmpType *int `mandatory:"true" json:"icmpType"`
// The ICMP (https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) code.
IcmpCode *int `mandatory:"false" json:"icmpCode"`
}
func (m IcmpTrafficProtocolParameters) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m IcmpTrafficProtocolParameters) String() string
func (m IcmpTrafficProtocolParameters) 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
IndeterminateRoutingAction Defines the routing action taken on a traffic node where the routing action is INDETERMINATE.
type IndeterminateRoutingAction struct {
// The type of the routing support for the traffic flow.
ActionType RoutingActionActionTypeEnum `mandatory:"true" json:"actionType"`
}
func (m IndeterminateRoutingAction) GetActionType() RoutingActionActionTypeEnum
GetActionType returns ActionType
func (m IndeterminateRoutingAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m IndeterminateRoutingAction) String() string
func (m IndeterminateRoutingAction) 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
IngressSecurityListConfiguration Defines the subnet ingress security list configuration that allowed the traffic.
type IngressSecurityListConfiguration struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the security
// list that allowed the traffic.
SecurityListId *string `mandatory:"true" json:"securityListId"`
SecurityRule *IngressSecurityRule `mandatory:"true" json:"securityRule"`
}
func (m IngressSecurityListConfiguration) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m IngressSecurityListConfiguration) String() string
func (m IngressSecurityListConfiguration) 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
IngressSecurityRule A rule for allowing inbound IP packets.
type IngressSecurityRule struct {
// The transport protocol. Specify either `all` or an IPv4 protocol number as
// defined in
// Protocol Numbers (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
// Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58").
Protocol *string `mandatory:"true" json:"protocol"`
// Conceptually, this is the range of IP addresses that a packet coming into the instance
// can come from.
// Allowed values:
// * IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`.
// IPv6 addressing is supported for all commercial and government regions. See
// IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// * The `cidrBlock` value for a Service, if you're
// setting up a security list rule for traffic coming from a particular `Service` through
// a service gateway. For example: `oci-phx-objectstorage`.
Source *string `mandatory:"true" json:"source"`
IcmpOptions *IcmpOptions `mandatory:"false" json:"icmpOptions"`
// A stateless rule allows traffic in one direction. Remember to add a corresponding
// stateless rule in the other direction if you need to support bidirectional traffic. For
// example, if ingress traffic allows TCP destination port 80, there should be an egress
// rule to allow TCP source port 80. Defaults to false, which means the rule is stateful
// and a corresponding rule is not necessary for bidirectional traffic.
IsStateless *bool `mandatory:"false" json:"isStateless"`
// Type of source for the rule. The default is `CIDR_BLOCK`.
// * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation.
// * `SERVICE_CIDR_BLOCK`: If the rule's `source` is the `cidrBlock` value for a
// Service (the rule is for traffic coming from a
// particular `Service` through a service gateway).
SourceType IngressSecurityRuleSourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`
TcpOptions *TcpOptions `mandatory:"false" json:"tcpOptions"`
UdpOptions *UdpOptions `mandatory:"false" json:"udpOptions"`
// An optional description of your choice for the rule.
Description *string `mandatory:"false" json:"description"`
}
func (m IngressSecurityRule) String() string
func (m IngressSecurityRule) 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
IngressSecurityRuleSourceTypeEnum Enum with underlying type: string
type IngressSecurityRuleSourceTypeEnum string
Set of constants representing the allowable values for IngressSecurityRuleSourceTypeEnum
const (
IngressSecurityRuleSourceTypeCidrBlock IngressSecurityRuleSourceTypeEnum = "CIDR_BLOCK"
IngressSecurityRuleSourceTypeServiceCidrBlock IngressSecurityRuleSourceTypeEnum = "SERVICE_CIDR_BLOCK"
)
func GetIngressSecurityRuleSourceTypeEnumValues() []IngressSecurityRuleSourceTypeEnum
GetIngressSecurityRuleSourceTypeEnumValues Enumerates the set of values for IngressSecurityRuleSourceTypeEnum
func GetMappingIngressSecurityRuleSourceTypeEnum(val string) (IngressSecurityRuleSourceTypeEnum, bool)
GetMappingIngressSecurityRuleSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
InternetGateway Represents a router that connects the edge of a VCN with the Internet. For an example scenario that uses an internet gateway, see Typical Networking Service Scenarios (https://docs.oracle.com/iaas/Content/Network/Concepts/overview.htm#scenarios). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type InternetGateway struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the internet gateway.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The internet gateway's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"true" json:"id"`
// The internet gateway's current state.
LifecycleState InternetGatewayLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN the Internet Gateway belongs to.
VcnId *string `mandatory:"true" json:"vcnId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Whether the gateway is enabled. When the gateway is disabled, traffic is not
// routed to/from the Internet, regardless of route rules.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// The date and time the internet gateway was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the Internet Gateway is using.
RouteTableId *string `mandatory:"false" json:"routeTableId"`
}
func (m InternetGateway) String() string
func (m InternetGateway) 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
InternetGatewayLifecycleStateEnum Enum with underlying type: string
type InternetGatewayLifecycleStateEnum string
Set of constants representing the allowable values for InternetGatewayLifecycleStateEnum
const (
InternetGatewayLifecycleStateProvisioning InternetGatewayLifecycleStateEnum = "PROVISIONING"
InternetGatewayLifecycleStateAvailable InternetGatewayLifecycleStateEnum = "AVAILABLE"
InternetGatewayLifecycleStateTerminating InternetGatewayLifecycleStateEnum = "TERMINATING"
InternetGatewayLifecycleStateTerminated InternetGatewayLifecycleStateEnum = "TERMINATED"
)
func GetInternetGatewayLifecycleStateEnumValues() []InternetGatewayLifecycleStateEnum
GetInternetGatewayLifecycleStateEnumValues Enumerates the set of values for InternetGatewayLifecycleStateEnum
func GetMappingInternetGatewayLifecycleStateEnum(val string) (InternetGatewayLifecycleStateEnum, bool)
GetMappingInternetGatewayLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
IpAddressEndpoint Defines the details required for an IP_ADDRESS-type `Endpoint`.
type IpAddressEndpoint struct {
// The IPv4 address of the `Endpoint`.
Address *string `mandatory:"true" json:"address"`
}
func (m IpAddressEndpoint) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m IpAddressEndpoint) String() string
func (m IpAddressEndpoint) 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
IpSecConnection A connection between a DRG and CPE. This connection consists of multiple IPSec tunnels. Creating this connection is one of the steps required when setting up a Site-to-Site VPN. **Important:** Each tunnel in an IPSec connection can use either static routing or BGP dynamic routing (see the IPSecConnectionTunnel object's `routing` attribute). Originally only static routing was supported and every IPSec connection was required to have at least one static route configured. To maintain backward compatibility in the API when support for BPG dynamic routing was introduced, the API accepts an empty list of static routes if you configure both of the IPSec tunnels to use BGP dynamic routing. If you switch a tunnel's routing from `BGP` to `STATIC`, you must first ensure that the IPSec connection is configured with at least one valid CIDR block static route. Oracle uses the IPSec connection's static routes when routing a tunnel's traffic *only* if that tunnel's `routing` attribute = `STATIC`. Otherwise the static routes are ignored. For more information about the workflow for setting up an IPSec connection, see Site-to-Site VPN Overview (https://docs.oracle.com/iaas/Content/Network/Tasks/overviewIPsec.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type IpSecConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the IPSec connection.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Cpe object.
CpeId *string `mandatory:"true" json:"cpeId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG.
DrgId *string `mandatory:"true" json:"drgId"`
// The IPSec connection's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"true" json:"id"`
// The IPSec connection's current state.
LifecycleState IpSecConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Static routes to the CPE. The CIDR must not be a
// multicast address or class E address.
// Used for routing a given IPSec tunnel's traffic only if the tunnel
// is using static routing. If you configure at least one tunnel to use static routing, then
// you must provide at least one valid static route. If you configure both
// tunnels to use BGP dynamic routing, you can provide an empty list for the static routes.
// The CIDR can be either IPv4 or IPv6. IPv6 addressing is supported for all commercial and government regions.
// See IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// Example: `10.0.1.0/24`
// Example: `2001:db8::/32`
StaticRoutes []string `mandatory:"true" json:"staticRoutes"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Your identifier for your CPE device. Can be either an IP address or a hostname (specifically,
// the fully qualified domain name (FQDN)). The type of identifier here must correspond
// to the value for `cpeLocalIdentifierType`.
// If you don't provide a value when creating the IPSec connection, the `ipAddress` attribute
// for the Cpe object specified by `cpeId` is used as the `cpeLocalIdentifier`.
// For information about why you'd provide this value, see
// If Your CPE Is Behind a NAT Device (https://docs.oracle.com/iaas/Content/Network/Tasks/overviewIPsec.htm#nat).
// Example IP address: `10.0.3.3`
// Example hostname: `cpe.example.com`
CpeLocalIdentifier *string `mandatory:"false" json:"cpeLocalIdentifier"`
// The type of identifier for your CPE device. The value here must correspond to the value
// for `cpeLocalIdentifier`.
CpeLocalIdentifierType IpSecConnectionCpeLocalIdentifierTypeEnum `mandatory:"false" json:"cpeLocalIdentifierType,omitempty"`
// The date and time the IPSec connection was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The transport type used for the IPSec connection.
TransportType IpSecConnectionTransportTypeEnum `mandatory:"false" json:"transportType,omitempty"`
}
func (m IpSecConnection) String() string
func (m IpSecConnection) 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
IpSecConnectionCpeLocalIdentifierTypeEnum Enum with underlying type: string
type IpSecConnectionCpeLocalIdentifierTypeEnum string
Set of constants representing the allowable values for IpSecConnectionCpeLocalIdentifierTypeEnum
const (
IpSecConnectionCpeLocalIdentifierTypeIpAddress IpSecConnectionCpeLocalIdentifierTypeEnum = "IP_ADDRESS"
IpSecConnectionCpeLocalIdentifierTypeHostname IpSecConnectionCpeLocalIdentifierTypeEnum = "HOSTNAME"
)
func GetIpSecConnectionCpeLocalIdentifierTypeEnumValues() []IpSecConnectionCpeLocalIdentifierTypeEnum
GetIpSecConnectionCpeLocalIdentifierTypeEnumValues Enumerates the set of values for IpSecConnectionCpeLocalIdentifierTypeEnum
func GetMappingIpSecConnectionCpeLocalIdentifierTypeEnum(val string) (IpSecConnectionCpeLocalIdentifierTypeEnum, bool)
GetMappingIpSecConnectionCpeLocalIdentifierTypeEnum performs case Insensitive comparison on enum value and return the desired enum
IpSecConnectionDeviceConfig Deprecated. For tunnel information, instead see:
type IpSecConnectionDeviceConfig struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the IPSec connection.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The IPSec connection's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"true" json:"id"`
// The date and time the IPSec connection was created.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Two TunnelConfig objects.
Tunnels []TunnelConfig `mandatory:"false" json:"tunnels"`
}
func (m IpSecConnectionDeviceConfig) String() string
func (m IpSecConnectionDeviceConfig) 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
IpSecConnectionDeviceStatus Deprecated. For tunnel information, instead see IPSecConnectionTunnel.
type IpSecConnectionDeviceStatus struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the IPSec connection.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The IPSec connection's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"true" json:"id"`
// The date and time the IPSec connection was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Two TunnelStatus objects.
Tunnels []TunnelStatus `mandatory:"false" json:"tunnels"`
}
func (m IpSecConnectionDeviceStatus) String() string
func (m IpSecConnectionDeviceStatus) 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
IpSecConnectionLifecycleStateEnum Enum with underlying type: string
type IpSecConnectionLifecycleStateEnum string
Set of constants representing the allowable values for IpSecConnectionLifecycleStateEnum
const (
IpSecConnectionLifecycleStateProvisioning IpSecConnectionLifecycleStateEnum = "PROVISIONING"
IpSecConnectionLifecycleStateAvailable IpSecConnectionLifecycleStateEnum = "AVAILABLE"
IpSecConnectionLifecycleStateTerminating IpSecConnectionLifecycleStateEnum = "TERMINATING"
IpSecConnectionLifecycleStateTerminated IpSecConnectionLifecycleStateEnum = "TERMINATED"
)
func GetIpSecConnectionLifecycleStateEnumValues() []IpSecConnectionLifecycleStateEnum
GetIpSecConnectionLifecycleStateEnumValues Enumerates the set of values for IpSecConnectionLifecycleStateEnum
func GetMappingIpSecConnectionLifecycleStateEnum(val string) (IpSecConnectionLifecycleStateEnum, bool)
GetMappingIpSecConnectionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
IpSecConnectionTransportTypeEnum Enum with underlying type: string
type IpSecConnectionTransportTypeEnum string
Set of constants representing the allowable values for IpSecConnectionTransportTypeEnum
const (
IpSecConnectionTransportTypeInternet IpSecConnectionTransportTypeEnum = "INTERNET"
IpSecConnectionTransportTypeFastconnect IpSecConnectionTransportTypeEnum = "FASTCONNECT"
)
func GetIpSecConnectionTransportTypeEnumValues() []IpSecConnectionTransportTypeEnum
GetIpSecConnectionTransportTypeEnumValues Enumerates the set of values for IpSecConnectionTransportTypeEnum
func GetMappingIpSecConnectionTransportTypeEnum(val string) (IpSecConnectionTransportTypeEnum, bool)
GetMappingIpSecConnectionTransportTypeEnum performs case Insensitive comparison on enum value and return the desired enum
IpSecConnectionTunnel Information about a single IPSec tunnel in an IPSec connection. This object does not include the tunnel's shared secret (pre-shared key), which is found in the IPSecConnectionTunnelSharedSecret object.
type IpSecConnectionTunnel struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the tunnel.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the tunnel.
Id *string `mandatory:"true" json:"id"`
// The tunnel's lifecycle state.
LifecycleState IpSecConnectionTunnelLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The IP address of the Oracle VPN headend for the connection.
// Example: `203.0.113.21`
VpnIp *string `mandatory:"false" json:"vpnIp"`
// The IP address of the CPE device's VPN headend.
// Example: `203.0.113.22`
CpeIp *string `mandatory:"false" json:"cpeIp"`
// The status of the tunnel based on IPSec protocol characteristics.
Status IpSecConnectionTunnelStatusEnum `mandatory:"false" json:"status,omitempty"`
// Internet Key Exchange protocol version.
IkeVersion IpSecConnectionTunnelIkeVersionEnum `mandatory:"false" json:"ikeVersion,omitempty"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
BgpSessionInfo *BgpSessionInfo `mandatory:"false" json:"bgpSessionInfo"`
EncryptionDomainConfig *EncryptionDomainConfig `mandatory:"false" json:"encryptionDomainConfig"`
// The type of routing used for this tunnel (BGP dynamic routing, static routing, or policy-based routing).
Routing IpSecConnectionTunnelRoutingEnum `mandatory:"false" json:"routing,omitempty"`
// The date and time the IPSec tunnel was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// When the status of the IPSec tunnel last changed, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeStatusUpdated *common.SDKTime `mandatory:"false" json:"timeStatusUpdated"`
// Indicates whether Oracle can only respond to a request to start an IPSec tunnel from the CPE device, or both respond to and initiate requests.
OracleCanInitiate IpSecConnectionTunnelOracleCanInitiateEnum `mandatory:"false" json:"oracleCanInitiate,omitempty"`
// By default (the `AUTO` setting), IKE sends packets with a source and destination port set to 500,
// and when it detects that the port used to forward packets has changed (most likely because a NAT device
// is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T.
// The `ENABLED` option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets.
// The `DISABLED` option directs IKE to completely refuse to negotiate NAT-T
// even if it senses there may be a NAT device in use.
//
// .
NatTranslationEnabled IpSecConnectionTunnelNatTranslationEnabledEnum `mandatory:"false" json:"natTranslationEnabled,omitempty"`
// Dead peer detection (DPD) mode set on the Oracle side of the connection.
// This mode sets whether Oracle can only respond to a request from the CPE device to start DPD,
// or both respond to and initiate requests.
DpdMode IpSecConnectionTunnelDpdModeEnum `mandatory:"false" json:"dpdMode,omitempty"`
// DPD timeout in seconds.
DpdTimeoutInSec *int `mandatory:"false" json:"dpdTimeoutInSec"`
PhaseOneDetails *TunnelPhaseOneDetails `mandatory:"false" json:"phaseOneDetails"`
PhaseTwoDetails *TunnelPhaseTwoDetails `mandatory:"false" json:"phaseTwoDetails"`
// The list of virtual circuit OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s over which your network can reach this tunnel.
AssociatedVirtualCircuits []string `mandatory:"false" json:"associatedVirtualCircuits"`
}
func (m IpSecConnectionTunnel) String() string
func (m IpSecConnectionTunnel) 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
IpSecConnectionTunnelDpdModeEnum Enum with underlying type: string
type IpSecConnectionTunnelDpdModeEnum string
Set of constants representing the allowable values for IpSecConnectionTunnelDpdModeEnum
const (
IpSecConnectionTunnelDpdModeInitiateAndRespond IpSecConnectionTunnelDpdModeEnum = "INITIATE_AND_RESPOND"
IpSecConnectionTunnelDpdModeRespondOnly IpSecConnectionTunnelDpdModeEnum = "RESPOND_ONLY"
)
func GetIpSecConnectionTunnelDpdModeEnumValues() []IpSecConnectionTunnelDpdModeEnum
GetIpSecConnectionTunnelDpdModeEnumValues Enumerates the set of values for IpSecConnectionTunnelDpdModeEnum
func GetMappingIpSecConnectionTunnelDpdModeEnum(val string) (IpSecConnectionTunnelDpdModeEnum, bool)
GetMappingIpSecConnectionTunnelDpdModeEnum performs case Insensitive comparison on enum value and return the desired enum
IpSecConnectionTunnelErrorDetails Details for an error on an IPSec tunnel.
type IpSecConnectionTunnelErrorDetails struct {
// Unique ID generated for each error report.
Id *string `mandatory:"true" json:"id"`
// Unique code describes the error type.
ErrorCode *string `mandatory:"true" json:"errorCode"`
// A detailed description of the error.
ErrorDescription *string `mandatory:"true" json:"errorDescription"`
// Resolution for the error.
Solution *string `mandatory:"true" json:"solution"`
// Link to more Oracle resources or relevant documentation.
OciResourcesLink *string `mandatory:"true" json:"ociResourcesLink"`
// Timestamp when the error occurred.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m IpSecConnectionTunnelErrorDetails) String() string
func (m IpSecConnectionTunnelErrorDetails) 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
IpSecConnectionTunnelIkeVersionEnum Enum with underlying type: string
type IpSecConnectionTunnelIkeVersionEnum string
Set of constants representing the allowable values for IpSecConnectionTunnelIkeVersionEnum
const (
IpSecConnectionTunnelIkeVersionV1 IpSecConnectionTunnelIkeVersionEnum = "V1"
IpSecConnectionTunnelIkeVersionV2 IpSecConnectionTunnelIkeVersionEnum = "V2"
)
func GetIpSecConnectionTunnelIkeVersionEnumValues() []IpSecConnectionTunnelIkeVersionEnum
GetIpSecConnectionTunnelIkeVersionEnumValues Enumerates the set of values for IpSecConnectionTunnelIkeVersionEnum
func GetMappingIpSecConnectionTunnelIkeVersionEnum(val string) (IpSecConnectionTunnelIkeVersionEnum, bool)
GetMappingIpSecConnectionTunnelIkeVersionEnum performs case Insensitive comparison on enum value and return the desired enum
IpSecConnectionTunnelLifecycleStateEnum Enum with underlying type: string
type IpSecConnectionTunnelLifecycleStateEnum string
Set of constants representing the allowable values for IpSecConnectionTunnelLifecycleStateEnum
const (
IpSecConnectionTunnelLifecycleStateProvisioning IpSecConnectionTunnelLifecycleStateEnum = "PROVISIONING"
IpSecConnectionTunnelLifecycleStateAvailable IpSecConnectionTunnelLifecycleStateEnum = "AVAILABLE"
IpSecConnectionTunnelLifecycleStateTerminating IpSecConnectionTunnelLifecycleStateEnum = "TERMINATING"
IpSecConnectionTunnelLifecycleStateTerminated IpSecConnectionTunnelLifecycleStateEnum = "TERMINATED"
)
func GetIpSecConnectionTunnelLifecycleStateEnumValues() []IpSecConnectionTunnelLifecycleStateEnum
GetIpSecConnectionTunnelLifecycleStateEnumValues Enumerates the set of values for IpSecConnectionTunnelLifecycleStateEnum
func GetMappingIpSecConnectionTunnelLifecycleStateEnum(val string) (IpSecConnectionTunnelLifecycleStateEnum, bool)
GetMappingIpSecConnectionTunnelLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
IpSecConnectionTunnelNatTranslationEnabledEnum Enum with underlying type: string
type IpSecConnectionTunnelNatTranslationEnabledEnum string
Set of constants representing the allowable values for IpSecConnectionTunnelNatTranslationEnabledEnum
const (
IpSecConnectionTunnelNatTranslationEnabledEnabled IpSecConnectionTunnelNatTranslationEnabledEnum = "ENABLED"
IpSecConnectionTunnelNatTranslationEnabledDisabled IpSecConnectionTunnelNatTranslationEnabledEnum = "DISABLED"
IpSecConnectionTunnelNatTranslationEnabledAuto IpSecConnectionTunnelNatTranslationEnabledEnum = "AUTO"
)
func GetIpSecConnectionTunnelNatTranslationEnabledEnumValues() []IpSecConnectionTunnelNatTranslationEnabledEnum
GetIpSecConnectionTunnelNatTranslationEnabledEnumValues Enumerates the set of values for IpSecConnectionTunnelNatTranslationEnabledEnum
func GetMappingIpSecConnectionTunnelNatTranslationEnabledEnum(val string) (IpSecConnectionTunnelNatTranslationEnabledEnum, bool)
GetMappingIpSecConnectionTunnelNatTranslationEnabledEnum performs case Insensitive comparison on enum value and return the desired enum
IpSecConnectionTunnelOracleCanInitiateEnum Enum with underlying type: string
type IpSecConnectionTunnelOracleCanInitiateEnum string
Set of constants representing the allowable values for IpSecConnectionTunnelOracleCanInitiateEnum
const (
IpSecConnectionTunnelOracleCanInitiateInitiatorOrResponder IpSecConnectionTunnelOracleCanInitiateEnum = "INITIATOR_OR_RESPONDER"
IpSecConnectionTunnelOracleCanInitiateResponderOnly IpSecConnectionTunnelOracleCanInitiateEnum = "RESPONDER_ONLY"
)
func GetIpSecConnectionTunnelOracleCanInitiateEnumValues() []IpSecConnectionTunnelOracleCanInitiateEnum
GetIpSecConnectionTunnelOracleCanInitiateEnumValues Enumerates the set of values for IpSecConnectionTunnelOracleCanInitiateEnum
func GetMappingIpSecConnectionTunnelOracleCanInitiateEnum(val string) (IpSecConnectionTunnelOracleCanInitiateEnum, bool)
GetMappingIpSecConnectionTunnelOracleCanInitiateEnum performs case Insensitive comparison on enum value and return the desired enum
IpSecConnectionTunnelRoutingEnum Enum with underlying type: string
type IpSecConnectionTunnelRoutingEnum string
Set of constants representing the allowable values for IpSecConnectionTunnelRoutingEnum
const (
IpSecConnectionTunnelRoutingBgp IpSecConnectionTunnelRoutingEnum = "BGP"
IpSecConnectionTunnelRoutingStatic IpSecConnectionTunnelRoutingEnum = "STATIC"
IpSecConnectionTunnelRoutingPolicy IpSecConnectionTunnelRoutingEnum = "POLICY"
)
func GetIpSecConnectionTunnelRoutingEnumValues() []IpSecConnectionTunnelRoutingEnum
GetIpSecConnectionTunnelRoutingEnumValues Enumerates the set of values for IpSecConnectionTunnelRoutingEnum
func GetMappingIpSecConnectionTunnelRoutingEnum(val string) (IpSecConnectionTunnelRoutingEnum, bool)
GetMappingIpSecConnectionTunnelRoutingEnum performs case Insensitive comparison on enum value and return the desired enum
IpSecConnectionTunnelSharedSecret The tunnel's shared secret (pre-shared key).
type IpSecConnectionTunnelSharedSecret struct {
// The tunnel's shared secret (pre-shared key).
SharedSecret *string `mandatory:"true" json:"sharedSecret"`
}
func (m IpSecConnectionTunnelSharedSecret) String() string
func (m IpSecConnectionTunnelSharedSecret) 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
IpSecConnectionTunnelStatusEnum Enum with underlying type: string
type IpSecConnectionTunnelStatusEnum string
Set of constants representing the allowable values for IpSecConnectionTunnelStatusEnum
const (
IpSecConnectionTunnelStatusUp IpSecConnectionTunnelStatusEnum = "UP"
IpSecConnectionTunnelStatusDown IpSecConnectionTunnelStatusEnum = "DOWN"
IpSecConnectionTunnelStatusDownForMaintenance IpSecConnectionTunnelStatusEnum = "DOWN_FOR_MAINTENANCE"
IpSecConnectionTunnelStatusPartialUp IpSecConnectionTunnelStatusEnum = "PARTIAL_UP"
)
func GetIpSecConnectionTunnelStatusEnumValues() []IpSecConnectionTunnelStatusEnum
GetIpSecConnectionTunnelStatusEnumValues Enumerates the set of values for IpSecConnectionTunnelStatusEnum
func GetMappingIpSecConnectionTunnelStatusEnum(val string) (IpSecConnectionTunnelStatusEnum, bool)
GetMappingIpSecConnectionTunnelStatusEnum performs case Insensitive comparison on enum value and return the desired enum
IpsecTunnelDrgAttachmentNetworkDetails Specifies the IPSec tunnel attached to the DRG.
type IpsecTunnelDrgAttachmentNetworkDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG.
Id *string `mandatory:"false" json:"id"`
// The IPSec connection that contains the attached IPSec tunnel.
IpsecConnectionId *string `mandatory:"false" json:"ipsecConnectionId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the virtual circuit's DRG attachment.
TransportAttachmentId *string `mandatory:"false" json:"transportAttachmentId"`
}
func (m IpsecTunnelDrgAttachmentNetworkDetails) GetId() *string
GetId returns Id
func (m IpsecTunnelDrgAttachmentNetworkDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m IpsecTunnelDrgAttachmentNetworkDetails) String() string
func (m IpsecTunnelDrgAttachmentNetworkDetails) 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
Ipv6 An *IPv6* is a conceptual term that refers to an IPv6 address and related properties. The `IPv6` object is the API representation of an IPv6. You can create and assign an IPv6 to any VNIC that is in an IPv6-enabled subnet in an IPv6-enabled VCN. **Note:** IPv6 addressing is supported for all commercial and government regions. For important details about IPv6 addressing in a VCN, see IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
type Ipv6 struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the IPv6.
// This is the same as the VNIC's compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IPv6.
Id *string `mandatory:"true" json:"id"`
// The IPv6 address of the `IPv6` object. The address is within the IPv6 CIDR block of the VNIC's subnet
// (see the `ipv6CidrBlock` attribute for the Subnet object.
// Example: `2001:0db8:0123:1111:abcd:ef01:2345:6789`
IpAddress *string `mandatory:"true" json:"ipAddress"`
// The IPv6's current state.
LifecycleState Ipv6LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet the VNIC is in.
SubnetId *string `mandatory:"true" json:"subnetId"`
// The date and time the IPv6 was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC the IPv6 is assigned to.
// The VNIC and IPv6 must be in the same subnet.
VnicId *string `mandatory:"true" json:"vnicId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m Ipv6) String() string
func (m Ipv6) 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
Ipv6LifecycleStateEnum Enum with underlying type: string
type Ipv6LifecycleStateEnum string
Set of constants representing the allowable values for Ipv6LifecycleStateEnum
const (
Ipv6LifecycleStateProvisioning Ipv6LifecycleStateEnum = "PROVISIONING"
Ipv6LifecycleStateAvailable Ipv6LifecycleStateEnum = "AVAILABLE"
Ipv6LifecycleStateTerminating Ipv6LifecycleStateEnum = "TERMINATING"
Ipv6LifecycleStateTerminated Ipv6LifecycleStateEnum = "TERMINATED"
)
func GetIpv6LifecycleStateEnumValues() []Ipv6LifecycleStateEnum
GetIpv6LifecycleStateEnumValues Enumerates the set of values for Ipv6LifecycleStateEnum
func GetMappingIpv6LifecycleStateEnum(val string) (Ipv6LifecycleStateEnum, bool)
GetMappingIpv6LifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
LetterOfAuthority The Letter of Authority for the cross-connect. You must submit this letter when requesting cabling for the cross-connect at the FastConnect location.
type LetterOfAuthority struct {
// The name of the entity authorized by this Letter of Authority.
AuthorizedEntityName *string `mandatory:"false" json:"authorizedEntityName"`
// The type of cross-connect fiber, termination, and optical specification.
CircuitType LetterOfAuthorityCircuitTypeEnum `mandatory:"false" json:"circuitType,omitempty"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect.
CrossConnectId *string `mandatory:"false" json:"crossConnectId"`
// The address of the FastConnect location.
FacilityLocation *string `mandatory:"false" json:"facilityLocation"`
// The meet-me room port for this cross-connect.
PortName *string `mandatory:"false" json:"portName"`
// The date and time when the Letter of Authority expires, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`
// The date and time the Letter of Authority was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeIssued *common.SDKTime `mandatory:"false" json:"timeIssued"`
}
func (m LetterOfAuthority) String() string
func (m LetterOfAuthority) 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
LetterOfAuthorityCircuitTypeEnum Enum with underlying type: string
type LetterOfAuthorityCircuitTypeEnum string
Set of constants representing the allowable values for LetterOfAuthorityCircuitTypeEnum
const (
LetterOfAuthorityCircuitTypeLc LetterOfAuthorityCircuitTypeEnum = "Single_mode_LC"
LetterOfAuthorityCircuitTypeSc LetterOfAuthorityCircuitTypeEnum = "Single_mode_SC"
)
func GetLetterOfAuthorityCircuitTypeEnumValues() []LetterOfAuthorityCircuitTypeEnum
GetLetterOfAuthorityCircuitTypeEnumValues Enumerates the set of values for LetterOfAuthorityCircuitTypeEnum
func GetMappingLetterOfAuthorityCircuitTypeEnum(val string) (LetterOfAuthorityCircuitTypeEnum, bool)
GetMappingLetterOfAuthorityCircuitTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListPathAnalyzerTestsRequest wrapper for the ListPathAnalyzerTests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/ListPathAnalyzerTests.go.html to see an example of how to use ListPathAnalyzerTestsRequest.
type ListPathAnalyzerTestsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter that returns only resources whose `lifecycleState` matches the given `lifecycleState`.
LifecycleState PathAnalyzerTestLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter that returns only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `50`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List"
// call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order
// is case sensitive.
SortOrder ListPathAnalyzerTestsSortOrderEnum `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.
// **Note:** In general, some "List" operations (for example, `ListInstances`) let you
// optionally filter by availability domain if the scope of the resource type is within a
// single availability domain. If you call one of these "List" operations without specifying
// an availability domain, the resources are grouped by availability domain, then sorted.
SortBy ListPathAnalyzerTestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListPathAnalyzerTestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPathAnalyzerTestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPathAnalyzerTestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPathAnalyzerTestsRequest) String() string
func (request ListPathAnalyzerTestsRequest) 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
ListPathAnalyzerTestsResponse wrapper for the ListPathAnalyzerTests operation
type ListPathAnalyzerTestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of PathAnalyzerTestCollection instances
PathAnalyzerTestCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListPathAnalyzerTestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPathAnalyzerTestsResponse) String() string
ListPathAnalyzerTestsSortByEnum Enum with underlying type: string
type ListPathAnalyzerTestsSortByEnum string
Set of constants representing the allowable values for ListPathAnalyzerTestsSortByEnum
const (
ListPathAnalyzerTestsSortByTimecreated ListPathAnalyzerTestsSortByEnum = "TIMECREATED"
ListPathAnalyzerTestsSortByDisplayname ListPathAnalyzerTestsSortByEnum = "DISPLAYNAME"
)
func GetListPathAnalyzerTestsSortByEnumValues() []ListPathAnalyzerTestsSortByEnum
GetListPathAnalyzerTestsSortByEnumValues Enumerates the set of values for ListPathAnalyzerTestsSortByEnum
func GetMappingListPathAnalyzerTestsSortByEnum(val string) (ListPathAnalyzerTestsSortByEnum, bool)
GetMappingListPathAnalyzerTestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListPathAnalyzerTestsSortOrderEnum Enum with underlying type: string
type ListPathAnalyzerTestsSortOrderEnum string
Set of constants representing the allowable values for ListPathAnalyzerTestsSortOrderEnum
const (
ListPathAnalyzerTestsSortOrderAsc ListPathAnalyzerTestsSortOrderEnum = "ASC"
ListPathAnalyzerTestsSortOrderDesc ListPathAnalyzerTestsSortOrderEnum = "DESC"
)
func GetListPathAnalyzerTestsSortOrderEnumValues() []ListPathAnalyzerTestsSortOrderEnum
GetListPathAnalyzerTestsSortOrderEnumValues Enumerates the set of values for ListPathAnalyzerTestsSortOrderEnum
func GetMappingListPathAnalyzerTestsSortOrderEnum(val string) (ListPathAnalyzerTestsSortOrderEnum, bool)
GetMappingListPathAnalyzerTestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `50`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List"
// call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order
// is case sensitive.
SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. The default order for `timeCreated` is descending.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
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
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimecreated ListWorkRequestErrorsSortByEnum = "timeCreated"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `50`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List"
// call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order
// is case sensitive.
SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. The default order for `timeCreated` is descending.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
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
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimecreated ListWorkRequestLogsSortByEnum = "timeCreated"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestResultsRequest wrapper for the ListWorkRequestResults operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/ListWorkRequestResults.go.html to see an example of how to use ListWorkRequestResultsRequest.
type ListWorkRequestResultsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `50`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List"
// call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The type of results to return.
ResultType WorkRequestResultResultTypeEnum `mandatory:"false" contributesTo:"query" name:"resultType" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestResultsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestResultsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestResultsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestResultsRequest) String() string
func (request ListWorkRequestResultsRequest) 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
ListWorkRequestResultsResponse wrapper for the ListWorkRequestResults operation
type ListWorkRequestResultsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestResultCollection instances
WorkRequestResultCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestResultsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestResultsResponse) String() string
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The ID of the asynchronous work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// For list pagination. The maximum number of results per page, or items to return in a paginated
// "List" call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
// Example: `50`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the `opc-next-page` response header from the previous "List"
// call. For important details about how pagination works, see
// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order
// is case sensitive.
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. The default order for `timeAccepted` is descending.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// A filter to return only resources whose `lifecycleState` matches the given `OperationStatus`.
Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// The ID of the resource affected by the work request.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
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
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestSummaryCollection instances
WorkRequestSummaryCollection `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 pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const (
ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING"
ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
LoadBalancerEndpoint Defines the details required for a LOAD_BALANCER-type `Endpoint`.
type LoadBalancerEndpoint struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer.
LoadBalancerId *string `mandatory:"true" json:"loadBalancerId"`
}
func (m LoadBalancerEndpoint) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m LoadBalancerEndpoint) String() string
func (m LoadBalancerEndpoint) 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
LoadBalancerListenerEndpoint Defines the details required for a LOAD_BALANCER_LISTENER-type `Endpoint`.
type LoadBalancerListenerEndpoint struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer listener.
ListenerId *string `mandatory:"true" json:"listenerId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's load balancer.
LoadBalancerId *string `mandatory:"true" json:"loadBalancerId"`
}
func (m LoadBalancerListenerEndpoint) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m LoadBalancerListenerEndpoint) String() string
func (m LoadBalancerListenerEndpoint) 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
LocalPeeringGateway A local peering gateway (LPG) is an object on a VCN that lets that VCN peer with another VCN in the same region. *Peering* means that the two VCNs can communicate using private IP addresses, but without the traffic traversing the internet or routing through your on-premises network. For more information, see VCN Peering (https://docs.oracle.com/iaas/Content/Network/Tasks/VCNpeering.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type LocalPeeringGateway struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the LPG.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The LPG's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"true" json:"id"`
// Whether the VCN at the other end of the peering is in a different tenancy.
// Example: `false`
IsCrossTenancyPeering *bool `mandatory:"true" json:"isCrossTenancyPeering"`
// The LPG's current lifecycle state.
LifecycleState LocalPeeringGatewayLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Whether the LPG is peered with another LPG. `NEW` means the LPG has not yet been
// peered. `PENDING` means the peering is being established. `REVOKED` means the
// LPG at the other end of the peering has been deleted.
PeeringStatus LocalPeeringGatewayPeeringStatusEnum `mandatory:"true" json:"peeringStatus"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the peered LPG.
PeerId *string `mandatory:"true" json:"peerId"`
// The date and time the LPG was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN that uses the LPG.
VcnId *string `mandatory:"true" json:"vcnId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN
// at the other end of the peering from this LPG. See `peerAdvertisedCidrDetails` for
// the individual CIDRs. The value is `null` if the LPG is not peered.
// Example: `192.168.0.0/16`, or if aggregated with `172.16.0.0/24` then `128.0.0.0/1`
PeerAdvertisedCidr *string `mandatory:"false" json:"peerAdvertisedCidr"`
// The specific ranges of IP addresses available on or via the VCN at the other
// end of the peering from this LPG. The value is `null` if the LPG is not peered.
// You can use these as destination CIDRs for route rules to route a subnet's
// traffic to this LPG.
// Example: [`192.168.0.0/16`, `172.16.0.0/24`]
PeerAdvertisedCidrDetails []string `mandatory:"false" json:"peerAdvertisedCidrDetails"`
// Additional information regarding the peering status, if applicable.
PeeringStatusDetails *string `mandatory:"false" json:"peeringStatusDetails"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the LPG is using.
// For information about why you would associate a route table with an LPG, see
// Transit Routing: Access to Multiple VCNs in Same Region (https://docs.oracle.com/iaas/Content/Network/Tasks/transitrouting.htm).
RouteTableId *string `mandatory:"false" json:"routeTableId"`
}
func (m LocalPeeringGateway) String() string
func (m LocalPeeringGateway) 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
LocalPeeringGatewayLifecycleStateEnum Enum with underlying type: string
type LocalPeeringGatewayLifecycleStateEnum string
Set of constants representing the allowable values for LocalPeeringGatewayLifecycleStateEnum
const (
LocalPeeringGatewayLifecycleStateProvisioning LocalPeeringGatewayLifecycleStateEnum = "PROVISIONING"
LocalPeeringGatewayLifecycleStateAvailable LocalPeeringGatewayLifecycleStateEnum = "AVAILABLE"
LocalPeeringGatewayLifecycleStateTerminating LocalPeeringGatewayLifecycleStateEnum = "TERMINATING"
LocalPeeringGatewayLifecycleStateTerminated LocalPeeringGatewayLifecycleStateEnum = "TERMINATED"
)
func GetLocalPeeringGatewayLifecycleStateEnumValues() []LocalPeeringGatewayLifecycleStateEnum
GetLocalPeeringGatewayLifecycleStateEnumValues Enumerates the set of values for LocalPeeringGatewayLifecycleStateEnum
func GetMappingLocalPeeringGatewayLifecycleStateEnum(val string) (LocalPeeringGatewayLifecycleStateEnum, bool)
GetMappingLocalPeeringGatewayLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
LocalPeeringGatewayPeeringStatusEnum Enum with underlying type: string
type LocalPeeringGatewayPeeringStatusEnum string
Set of constants representing the allowable values for LocalPeeringGatewayPeeringStatusEnum
const (
LocalPeeringGatewayPeeringStatusInvalid LocalPeeringGatewayPeeringStatusEnum = "INVALID"
LocalPeeringGatewayPeeringStatusNew LocalPeeringGatewayPeeringStatusEnum = "NEW"
LocalPeeringGatewayPeeringStatusPeered LocalPeeringGatewayPeeringStatusEnum = "PEERED"
LocalPeeringGatewayPeeringStatusPending LocalPeeringGatewayPeeringStatusEnum = "PENDING"
LocalPeeringGatewayPeeringStatusRevoked LocalPeeringGatewayPeeringStatusEnum = "REVOKED"
)
func GetLocalPeeringGatewayPeeringStatusEnumValues() []LocalPeeringGatewayPeeringStatusEnum
GetLocalPeeringGatewayPeeringStatusEnumValues Enumerates the set of values for LocalPeeringGatewayPeeringStatusEnum
func GetMappingLocalPeeringGatewayPeeringStatusEnum(val string) (LocalPeeringGatewayPeeringStatusEnum, bool)
GetMappingLocalPeeringGatewayPeeringStatusEnum performs case Insensitive comparison on enum value and return the desired enum
LoopBackDrgAttachmentNetworkDetails Specifies the loopback attachment on the DRG. A loopback attachment can be used to terminate a virtual circuit that is carrying an IPSec tunnel, routing traffic directly to the IPSec tunnel attachment where the tunnel can terminate.
type LoopBackDrgAttachmentNetworkDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG.
Id *string `mandatory:"false" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target IPSec tunnel attachment.
Ids []string `mandatory:"false" json:"ids"`
}
func (m LoopBackDrgAttachmentNetworkDetails) GetId() *string
GetId returns Id
func (m LoopBackDrgAttachmentNetworkDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m LoopBackDrgAttachmentNetworkDetails) String() string
func (m LoopBackDrgAttachmentNetworkDetails) 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
MacsecEncryptionCipherEnum Enum with underlying type: string
type MacsecEncryptionCipherEnum string
Set of constants representing the allowable values for MacsecEncryptionCipherEnum
const (
MacsecEncryptionCipherAes128Gcm MacsecEncryptionCipherEnum = "AES128_GCM"
MacsecEncryptionCipherAes128GcmXpn MacsecEncryptionCipherEnum = "AES128_GCM_XPN"
MacsecEncryptionCipherAes256Gcm MacsecEncryptionCipherEnum = "AES256_GCM"
MacsecEncryptionCipherAes256GcmXpn MacsecEncryptionCipherEnum = "AES256_GCM_XPN"
)
func GetMacsecEncryptionCipherEnumValues() []MacsecEncryptionCipherEnum
GetMacsecEncryptionCipherEnumValues Enumerates the set of values for MacsecEncryptionCipherEnum
func GetMappingMacsecEncryptionCipherEnum(val string) (MacsecEncryptionCipherEnum, bool)
GetMappingMacsecEncryptionCipherEnum performs case Insensitive comparison on enum value and return the desired enum
MacsecKey An object defining the Secrets-in-Vault OCIDs representing the MACsec key.
type MacsecKey struct {
// Secret OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key.
ConnectivityAssociationNameSecretId *string `mandatory:"true" json:"connectivityAssociationNameSecretId"`
// Secret OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key.
ConnectivityAssociationKeySecretId *string `mandatory:"true" json:"connectivityAssociationKeySecretId"`
// The secret version of the connectivity association name secret in Vault.
ConnectivityAssociationNameSecretVersion *int64 `mandatory:"false" json:"connectivityAssociationNameSecretVersion"`
// The secret version of the `connectivityAssociationKey` secret in Vault.
ConnectivityAssociationKeySecretVersion *int64 `mandatory:"false" json:"connectivityAssociationKeySecretVersion"`
}
func (m MacsecKey) String() string
func (m MacsecKey) 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
MacsecProperties Properties used for MACsec (if capable).
type MacsecProperties struct {
// Indicates whether or not MACsec is enabled.
State MacsecStateEnum `mandatory:"true" json:"state"`
PrimaryKey *MacsecKey `mandatory:"false" json:"primaryKey"`
// Type of encryption cipher suite to use for the MACsec connection.
EncryptionCipher MacsecEncryptionCipherEnum `mandatory:"false" json:"encryptionCipher,omitempty"`
}
func (m MacsecProperties) String() string
func (m MacsecProperties) 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
MacsecStateEnum Enum with underlying type: string
type MacsecStateEnum string
Set of constants representing the allowable values for MacsecStateEnum
const (
MacsecStateEnabled MacsecStateEnum = "ENABLED"
MacsecStateDisabled MacsecStateEnum = "DISABLED"
)
func GetMacsecStateEnumValues() []MacsecStateEnum
GetMacsecStateEnumValues Enumerates the set of values for MacsecStateEnum
func GetMappingMacsecStateEnum(val string) (MacsecStateEnum, bool)
GetMappingMacsecStateEnum performs case Insensitive comparison on enum value and return the desired enum
ModifyVcnCidrDetails Details for updating a CIDR block.
type ModifyVcnCidrDetails struct {
// The CIDR IP address to update.
OriginalCidrBlock *string `mandatory:"true" json:"originalCidrBlock"`
// The new CIDR IP address.
NewCidrBlock *string `mandatory:"true" json:"newCidrBlock"`
}
func (m ModifyVcnCidrDetails) String() string
func (m ModifyVcnCidrDetails) 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
NatGateway A NAT (Network Address Translation) gateway, which represents a router that lets instances without public IPs contact the public internet without exposing the instance to inbound internet traffic. For more information, see NAT Gateway (https://docs.oracle.com/iaas/Content/Network/Tasks/NATgateway.htm). To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type NatGateway struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains
// the NAT gateway.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the
// NAT gateway.
Id *string `mandatory:"true" json:"id"`
// Whether the NAT gateway blocks traffic through it. The default is `false`.
// Example: `true`
BlockTraffic *bool `mandatory:"true" json:"blockTraffic"`
// The NAT gateway's current state.
LifecycleState NatGatewayLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The IP address associated with the NAT gateway.
NatIp *string `mandatory:"true" json:"natIp"`
// The date and time the NAT gateway was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN the NAT gateway
// belongs to.
VcnId *string `mandatory:"true" json:"vcnId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the public IP address associated with the NAT gateway.
PublicIpId *string `mandatory:"false" json:"publicIpId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the NAT gateway.
// If you don't specify a route table here, the NAT gateway is created without an associated route
// table. The Networking service does NOT automatically associate the attached VCN's default route table
// with the NAT gateway.
RouteTableId *string `mandatory:"false" json:"routeTableId"`
}
func (m NatGateway) String() string
func (m NatGateway) 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
NatGatewayLifecycleStateEnum Enum with underlying type: string
type NatGatewayLifecycleStateEnum string
Set of constants representing the allowable values for NatGatewayLifecycleStateEnum
const (
NatGatewayLifecycleStateProvisioning NatGatewayLifecycleStateEnum = "PROVISIONING"
NatGatewayLifecycleStateAvailable NatGatewayLifecycleStateEnum = "AVAILABLE"
NatGatewayLifecycleStateTerminating NatGatewayLifecycleStateEnum = "TERMINATING"
NatGatewayLifecycleStateTerminated NatGatewayLifecycleStateEnum = "TERMINATED"
)
func GetMappingNatGatewayLifecycleStateEnum(val string) (NatGatewayLifecycleStateEnum, bool)
GetMappingNatGatewayLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNatGatewayLifecycleStateEnumValues() []NatGatewayLifecycleStateEnum
GetNatGatewayLifecycleStateEnumValues Enumerates the set of values for NatGatewayLifecycleStateEnum
NetworkLoadBalancerEndpoint Defines the details required for a NETWORK_LOAD_BALANCER-type `Endpoint`.
type NetworkLoadBalancerEndpoint struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network load balancer.
NetworkLoadBalancerId *string `mandatory:"true" json:"networkLoadBalancerId"`
}
func (m NetworkLoadBalancerEndpoint) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NetworkLoadBalancerEndpoint) String() string
func (m NetworkLoadBalancerEndpoint) 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
NetworkLoadBalancerListenerEndpoint Defines the details required for a NETWORK_LOAD_BALANCER_LISTENER-type `Endpoint`.
type NetworkLoadBalancerListenerEndpoint struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network load balancer listener.
ListenerId *string `mandatory:"true" json:"listenerId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the listener's network load balancer.
NetworkLoadBalancerId *string `mandatory:"true" json:"networkLoadBalancerId"`
}
func (m NetworkLoadBalancerListenerEndpoint) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NetworkLoadBalancerListenerEndpoint) String() string
func (m NetworkLoadBalancerListenerEndpoint) 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
NetworkSecurityGroup A *network security group* (NSG) provides virtual firewall rules for a specific set of Vnic in a VCN. Compare NSGs with SecurityList, which provide virtual firewall rules to all the VNICs in a *subnet*. A network security group consists of two items:
After creating an NSG, you can add VNICs and security rules to it. For example, when you create an instance, you can specify one or more NSGs to add the instance to (see CreateVnicDetails). Or you can add an existing instance to an NSG with UpdateVnic. To add security rules to an NSG, see AddNetworkSecurityGroupSecurityRules. To list the VNICs in an NSG, see ListNetworkSecurityGroupVnics. To list the security rules in an NSG, see ListNetworkSecurityGroupSecurityRules. For more information about network security groups, see Network Security Groups (https://docs.oracle.com/iaas/Content/Network/Concepts/networksecuritygroups.htm). **Important:** Oracle Cloud Infrastructure Compute service images automatically include firewall rules (for example, Linux iptables, Windows firewall). If there are issues with some type of access to an instance, make sure all of the following are set correctly:
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type NetworkSecurityGroup struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment the network security group is in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security group.
Id *string `mandatory:"true" json:"id"`
// The network security group's current state.
LifecycleState NetworkSecurityGroupLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the network security group was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security group's VCN.
VcnId *string `mandatory:"true" json:"vcnId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m NetworkSecurityGroup) String() string
func (m NetworkSecurityGroup) 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
NetworkSecurityGroupLifecycleStateEnum Enum with underlying type: string
type NetworkSecurityGroupLifecycleStateEnum string
Set of constants representing the allowable values for NetworkSecurityGroupLifecycleStateEnum
const (
NetworkSecurityGroupLifecycleStateProvisioning NetworkSecurityGroupLifecycleStateEnum = "PROVISIONING"
NetworkSecurityGroupLifecycleStateAvailable NetworkSecurityGroupLifecycleStateEnum = "AVAILABLE"
NetworkSecurityGroupLifecycleStateTerminating NetworkSecurityGroupLifecycleStateEnum = "TERMINATING"
NetworkSecurityGroupLifecycleStateTerminated NetworkSecurityGroupLifecycleStateEnum = "TERMINATED"
)
func GetMappingNetworkSecurityGroupLifecycleStateEnum(val string) (NetworkSecurityGroupLifecycleStateEnum, bool)
GetMappingNetworkSecurityGroupLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetNetworkSecurityGroupLifecycleStateEnumValues() []NetworkSecurityGroupLifecycleStateEnum
GetNetworkSecurityGroupLifecycleStateEnumValues Enumerates the set of values for NetworkSecurityGroupLifecycleStateEnum
NetworkSecurityGroupVnic Information about a VNIC that belongs to a network security group.
type NetworkSecurityGroupVnic struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC.
VnicId *string `mandatory:"true" json:"vnicId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent resource that the VNIC
// is attached to (for example, a Compute instance).
ResourceId *string `mandatory:"false" json:"resourceId"`
// The date and time the VNIC was added to the network security group, in the format
// defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeAssociated *common.SDKTime `mandatory:"false" json:"timeAssociated"`
}
func (m NetworkSecurityGroupVnic) String() string
func (m NetworkSecurityGroupVnic) 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
NetworkingTopology Defines the representation of a virtual network topology for a region.
type NetworkingTopology struct {
// Lists entities comprising the virtual network topology.
Entities []interface{} `mandatory:"true" json:"entities"`
// Lists relationships between entities in the virtual network topology.
Relationships []TopologyEntityRelationship `mandatory:"true" json:"relationships"`
// Lists entities that are limited during ingestion.
// The values for the items in the list are the entity type names of the limitedEntities.
// Example: `vcn`
LimitedEntities []string `mandatory:"true" json:"limitedEntities"`
// Records when the virtual network topology was created, in RFC3339 (https://tools.ietf.org/html/rfc3339) format for date and time.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
}
func (m NetworkingTopology) GetEntities() []interface{}
GetEntities returns Entities
func (m NetworkingTopology) GetLimitedEntities() []string
GetLimitedEntities returns LimitedEntities
func (m NetworkingTopology) GetRelationships() []TopologyEntityRelationship
GetRelationships returns Relationships
func (m NetworkingTopology) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m NetworkingTopology) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NetworkingTopology) String() string
func (m *NetworkingTopology) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m NetworkingTopology) 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
NoRouteRoutingAction Defines the routing actions taken on traffic when no route is found.
type NoRouteRoutingAction struct {
NoRouteRoutingActionDetails *NoRouteRoutingActionDetails `mandatory:"false" json:"noRouteRoutingActionDetails"`
// The type of the routing support for the traffic flow.
ActionType RoutingActionActionTypeEnum `mandatory:"true" json:"actionType"`
}
func (m NoRouteRoutingAction) GetActionType() RoutingActionActionTypeEnum
GetActionType returns ActionType
func (m NoRouteRoutingAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NoRouteRoutingAction) String() string
func (m NoRouteRoutingAction) 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
NoRouteRoutingActionDetails Defines the routing action taken on traffic flow with no route found.
type NoRouteRoutingActionDetails struct {
// If true, the evaluated route table details are incomplete.
IsRestrictedOrPartial *bool `mandatory:"true" json:"isRestrictedOrPartial"`
// OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the evaluated VCN route table.
EvaluatedVcnRouteTableId *string `mandatory:"false" json:"evaluatedVcnRouteTableId"`
// OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of evaluated DRG route table.
EvaluatedDrgRouteTableId *string `mandatory:"false" json:"evaluatedDrgRouteTableId"`
}
func (m NoRouteRoutingActionDetails) String() string
func (m NoRouteRoutingActionDetails) 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
NsgConfiguration Defines the network security group configuration that allowed the traffic.
type NsgConfiguration struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network
// security group that allowed the traffic.
NsgId *string `mandatory:"true" json:"nsgId"`
SecurityRule *SecurityRule `mandatory:"true" json:"securityRule"`
}
func (m NsgConfiguration) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NsgConfiguration) String() string
func (m NsgConfiguration) 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
OnPremEndpoint Defines the details required for an ON_PREM-type `Endpoint`.
type OnPremEndpoint struct {
// The IPv4 address of the `Endpoint`.
Address *string `mandatory:"true" json:"address"`
}
func (m OnPremEndpoint) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OnPremEndpoint) String() string
func (m OnPremEndpoint) 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
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreatePathAnalysisResult OperationTypeEnum = "CREATE_PATH_ANALYSIS_RESULT"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
Path Defines the configuration of the traffic path in `PathAnalysisResult`.
type Path struct {
ForwardRoute *TrafficRoute `mandatory:"true" json:"forwardRoute"`
Topology *PathTopology `mandatory:"true" json:"topology"`
ReturnRoute *TrafficRoute `mandatory:"false" json:"returnRoute"`
}
func (m Path) String() string
func (m Path) 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
PathAnalysisWorkRequestResult Defines the configuration of the path analysis result.
type PathAnalysisWorkRequestResult struct {
// List of various paths from source node to destination node
// for a given `PathAnalysisQuery`.
Paths []Path `mandatory:"true" json:"paths"`
// Time the `PathAnalysisResult` was generated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
}
func (m PathAnalysisWorkRequestResult) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PathAnalysisWorkRequestResult) String() string
func (m PathAnalysisWorkRequestResult) 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
PathAnalyzerTest Defines the details saved in a `PathAnalyzerTest` resource. These configuration details are used to run a Network Path Analyzer (https://docs.oracle.com/iaas/Content/Network/Concepts/path_analyzer.htm) analysis.
type PathAnalyzerTest struct {
// A unique identifier established when the resource is created. The identifier can't be changed later.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `PathAnalyzerTest` resource's compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The IP protocol to use for the `PathAnalyzerTest` resource.
Protocol *int `mandatory:"true" json:"protocol"`
SourceEndpoint Endpoint `mandatory:"true" json:"sourceEndpoint"`
DestinationEndpoint Endpoint `mandatory:"true" json:"destinationEndpoint"`
QueryOptions *QueryOptions `mandatory:"true" json:"queryOptions"`
// The date and time the `PathAnalyzerTest` resource was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the `PathAnalyzerTest` resource was last updated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the `PathAnalyzerTest` resource.
LifecycleState PathAnalyzerTestLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
ProtocolParameters ProtocolParameters `mandatory:"false" json:"protocolParameters"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m PathAnalyzerTest) String() string
func (m *PathAnalyzerTest) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m PathAnalyzerTest) 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
PathAnalyzerTestCollection The results of a `ListPathAnalyzerTests` call in the current compartment.
type PathAnalyzerTestCollection struct {
// A list of `PathAnalyzerTestSummary` items.
Items []PathAnalyzerTestSummary `mandatory:"true" json:"items"`
}
func (m PathAnalyzerTestCollection) String() string
func (m PathAnalyzerTestCollection) 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
PathAnalyzerTestLifecycleStateEnum Enum with underlying type: string
type PathAnalyzerTestLifecycleStateEnum string
Set of constants representing the allowable values for PathAnalyzerTestLifecycleStateEnum
const (
PathAnalyzerTestLifecycleStateActive PathAnalyzerTestLifecycleStateEnum = "ACTIVE"
PathAnalyzerTestLifecycleStateDeleted PathAnalyzerTestLifecycleStateEnum = "DELETED"
)
func GetMappingPathAnalyzerTestLifecycleStateEnum(val string) (PathAnalyzerTestLifecycleStateEnum, bool)
GetMappingPathAnalyzerTestLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPathAnalyzerTestLifecycleStateEnumValues() []PathAnalyzerTestLifecycleStateEnum
GetPathAnalyzerTestLifecycleStateEnumValues Enumerates the set of values for PathAnalyzerTestLifecycleStateEnum
PathAnalyzerTestSummary Defines the summary of a `PathAnalyzerTest` resource.
type PathAnalyzerTestSummary struct {
// A unique identifier established when the resource is created. The identifier can't be changed later.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `PathAnalyzerTest` resource's compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The IP protocol to use for the `PathAnalyzerTest` resource.
Protocol *int `mandatory:"true" json:"protocol"`
SourceEndpoint Endpoint `mandatory:"true" json:"sourceEndpoint"`
DestinationEndpoint Endpoint `mandatory:"true" json:"destinationEndpoint"`
QueryOptions *QueryOptions `mandatory:"true" json:"queryOptions"`
// The date and time the `PathAnalyzerTest` resource was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the `PathAnalyzerTest` resource was last updated, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The current state of the `PathAnalyzerTest` resource.
LifecycleState PathAnalyzerTestLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
ProtocolParameters ProtocolParameters `mandatory:"false" json:"protocolParameters"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m PathAnalyzerTestSummary) String() string
func (m *PathAnalyzerTestSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m PathAnalyzerTestSummary) 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
PathTopology Defines the representation of a virtual network topology for path analysis.
type PathTopology struct {
// Lists entities comprising the virtual network topology.
Entities []interface{} `mandatory:"true" json:"entities"`
// Lists relationships between entities in the virtual network topology.
Relationships []TopologyEntityRelationship `mandatory:"true" json:"relationships"`
// Lists entities that are limited during ingestion.
// The values for the items in the list are the entity type names of the limitedEntities.
// Example: `vcn`
LimitedEntities []string `mandatory:"true" json:"limitedEntities"`
// Records when the virtual network topology was created, in RFC3339 (https://tools.ietf.org/html/rfc3339) format for date and time.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
}
func (m PathTopology) GetEntities() []interface{}
GetEntities returns Entities
func (m PathTopology) GetLimitedEntities() []string
GetLimitedEntities returns LimitedEntities
func (m PathTopology) GetRelationships() []TopologyEntityRelationship
GetRelationships returns Relationships
func (m PathTopology) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m PathTopology) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PathTopology) String() string
func (m *PathTopology) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m PathTopology) 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
PersistedGetPathAnalysisDetails Defines the configuration for getting a path analysis using the persisted `PathAnalyzerTest` resource.
type PersistedGetPathAnalysisDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `PathAnalyzerTest` resource.
PathAnalyzerTestId *string `mandatory:"true" json:"pathAnalyzerTestId"`
}
func (m PersistedGetPathAnalysisDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PersistedGetPathAnalysisDetails) String() string
func (m PersistedGetPathAnalysisDetails) 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
PhaseOneConfigDetails Configuration details for IKE phase one (ISAKMP) configuration parameters.
type PhaseOneConfigDetails struct {
// Indicates whether custom configuration is enabled for phase one options.
IsCustomPhaseOneConfig *bool `mandatory:"false" json:"isCustomPhaseOneConfig"`
// The custom authentication algorithm proposed during phase one tunnel negotiation.
AuthenticationAlgorithm PhaseOneConfigDetailsAuthenticationAlgorithmEnum `mandatory:"false" json:"authenticationAlgorithm,omitempty"`
// The custom encryption algorithm proposed during phase one tunnel negotiation.
EncryptionAlgorithm PhaseOneConfigDetailsEncryptionAlgorithmEnum `mandatory:"false" json:"encryptionAlgorithm,omitempty"`
// The custom Diffie-Hellman group proposed during phase one tunnel negotiation.
DiffieHelmanGroup PhaseOneConfigDetailsDiffieHelmanGroupEnum `mandatory:"false" json:"diffieHelmanGroup,omitempty"`
// Internet key association (IKE) session key lifetime in seconds for IPSec phase one. The default is 28800 which is equivalent to 8 hours.
LifetimeInSeconds *int `mandatory:"false" json:"lifetimeInSeconds"`
}
func (m PhaseOneConfigDetails) String() string
func (m PhaseOneConfigDetails) 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
PhaseOneConfigDetailsAuthenticationAlgorithmEnum Enum with underlying type: string
type PhaseOneConfigDetailsAuthenticationAlgorithmEnum string
Set of constants representing the allowable values for PhaseOneConfigDetailsAuthenticationAlgorithmEnum
const (
PhaseOneConfigDetailsAuthenticationAlgorithmSha2384 PhaseOneConfigDetailsAuthenticationAlgorithmEnum = "SHA2_384"
PhaseOneConfigDetailsAuthenticationAlgorithmSha2256 PhaseOneConfigDetailsAuthenticationAlgorithmEnum = "SHA2_256"
PhaseOneConfigDetailsAuthenticationAlgorithmSha196 PhaseOneConfigDetailsAuthenticationAlgorithmEnum = "SHA1_96"
)
func GetMappingPhaseOneConfigDetailsAuthenticationAlgorithmEnum(val string) (PhaseOneConfigDetailsAuthenticationAlgorithmEnum, bool)
GetMappingPhaseOneConfigDetailsAuthenticationAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPhaseOneConfigDetailsAuthenticationAlgorithmEnumValues() []PhaseOneConfigDetailsAuthenticationAlgorithmEnum
GetPhaseOneConfigDetailsAuthenticationAlgorithmEnumValues Enumerates the set of values for PhaseOneConfigDetailsAuthenticationAlgorithmEnum
PhaseOneConfigDetailsDiffieHelmanGroupEnum Enum with underlying type: string
type PhaseOneConfigDetailsDiffieHelmanGroupEnum string
Set of constants representing the allowable values for PhaseOneConfigDetailsDiffieHelmanGroupEnum
const (
PhaseOneConfigDetailsDiffieHelmanGroupGroup2 PhaseOneConfigDetailsDiffieHelmanGroupEnum = "GROUP2"
PhaseOneConfigDetailsDiffieHelmanGroupGroup5 PhaseOneConfigDetailsDiffieHelmanGroupEnum = "GROUP5"
PhaseOneConfigDetailsDiffieHelmanGroupGroup14 PhaseOneConfigDetailsDiffieHelmanGroupEnum = "GROUP14"
PhaseOneConfigDetailsDiffieHelmanGroupGroup19 PhaseOneConfigDetailsDiffieHelmanGroupEnum = "GROUP19"
PhaseOneConfigDetailsDiffieHelmanGroupGroup20 PhaseOneConfigDetailsDiffieHelmanGroupEnum = "GROUP20"
PhaseOneConfigDetailsDiffieHelmanGroupGroup24 PhaseOneConfigDetailsDiffieHelmanGroupEnum = "GROUP24"
)
func GetMappingPhaseOneConfigDetailsDiffieHelmanGroupEnum(val string) (PhaseOneConfigDetailsDiffieHelmanGroupEnum, bool)
GetMappingPhaseOneConfigDetailsDiffieHelmanGroupEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPhaseOneConfigDetailsDiffieHelmanGroupEnumValues() []PhaseOneConfigDetailsDiffieHelmanGroupEnum
GetPhaseOneConfigDetailsDiffieHelmanGroupEnumValues Enumerates the set of values for PhaseOneConfigDetailsDiffieHelmanGroupEnum
PhaseOneConfigDetailsEncryptionAlgorithmEnum Enum with underlying type: string
type PhaseOneConfigDetailsEncryptionAlgorithmEnum string
Set of constants representing the allowable values for PhaseOneConfigDetailsEncryptionAlgorithmEnum
const (
PhaseOneConfigDetailsEncryptionAlgorithm256Cbc PhaseOneConfigDetailsEncryptionAlgorithmEnum = "AES_256_CBC"
PhaseOneConfigDetailsEncryptionAlgorithm192Cbc PhaseOneConfigDetailsEncryptionAlgorithmEnum = "AES_192_CBC"
PhaseOneConfigDetailsEncryptionAlgorithm128Cbc PhaseOneConfigDetailsEncryptionAlgorithmEnum = "AES_128_CBC"
)
func GetMappingPhaseOneConfigDetailsEncryptionAlgorithmEnum(val string) (PhaseOneConfigDetailsEncryptionAlgorithmEnum, bool)
GetMappingPhaseOneConfigDetailsEncryptionAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPhaseOneConfigDetailsEncryptionAlgorithmEnumValues() []PhaseOneConfigDetailsEncryptionAlgorithmEnum
GetPhaseOneConfigDetailsEncryptionAlgorithmEnumValues Enumerates the set of values for PhaseOneConfigDetailsEncryptionAlgorithmEnum
PhaseTwoConfigDetails Configuration details for IPSec phase two configuration parameters.
type PhaseTwoConfigDetails struct {
// Indicates whether custom configuration is enabled for phase two options.
IsCustomPhaseTwoConfig *bool `mandatory:"false" json:"isCustomPhaseTwoConfig"`
// The authentication algorithm proposed during phase two tunnel negotiation.
AuthenticationAlgorithm PhaseTwoConfigDetailsAuthenticationAlgorithmEnum `mandatory:"false" json:"authenticationAlgorithm,omitempty"`
// The encryption algorithm proposed during phase two tunnel negotiation.
EncryptionAlgorithm PhaseTwoConfigDetailsEncryptionAlgorithmEnum `mandatory:"false" json:"encryptionAlgorithm,omitempty"`
// Lifetime in seconds for the IPSec session key set in phase two. The default is 3600 which is equivalent to 1 hour.
LifetimeInSeconds *int `mandatory:"false" json:"lifetimeInSeconds"`
// Indicates whether perfect forward secrecy (PFS) is enabled.
IsPfsEnabled *bool `mandatory:"false" json:"isPfsEnabled"`
// The Diffie-Hellman group used for PFS, if PFS is enabled.
PfsDhGroup PhaseTwoConfigDetailsPfsDhGroupEnum `mandatory:"false" json:"pfsDhGroup,omitempty"`
}
func (m PhaseTwoConfigDetails) String() string
func (m PhaseTwoConfigDetails) 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
PhaseTwoConfigDetailsAuthenticationAlgorithmEnum Enum with underlying type: string
type PhaseTwoConfigDetailsAuthenticationAlgorithmEnum string
Set of constants representing the allowable values for PhaseTwoConfigDetailsAuthenticationAlgorithmEnum
const (
PhaseTwoConfigDetailsAuthenticationAlgorithmSha2256128 PhaseTwoConfigDetailsAuthenticationAlgorithmEnum = "HMAC_SHA2_256_128"
PhaseTwoConfigDetailsAuthenticationAlgorithmSha1128 PhaseTwoConfigDetailsAuthenticationAlgorithmEnum = "HMAC_SHA1_128"
)
func GetMappingPhaseTwoConfigDetailsAuthenticationAlgorithmEnum(val string) (PhaseTwoConfigDetailsAuthenticationAlgorithmEnum, bool)
GetMappingPhaseTwoConfigDetailsAuthenticationAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPhaseTwoConfigDetailsAuthenticationAlgorithmEnumValues() []PhaseTwoConfigDetailsAuthenticationAlgorithmEnum
GetPhaseTwoConfigDetailsAuthenticationAlgorithmEnumValues Enumerates the set of values for PhaseTwoConfigDetailsAuthenticationAlgorithmEnum
PhaseTwoConfigDetailsEncryptionAlgorithmEnum Enum with underlying type: string
type PhaseTwoConfigDetailsEncryptionAlgorithmEnum string
Set of constants representing the allowable values for PhaseTwoConfigDetailsEncryptionAlgorithmEnum
const (
PhaseTwoConfigDetailsEncryptionAlgorithm256Gcm PhaseTwoConfigDetailsEncryptionAlgorithmEnum = "AES_256_GCM"
PhaseTwoConfigDetailsEncryptionAlgorithm192Gcm PhaseTwoConfigDetailsEncryptionAlgorithmEnum = "AES_192_GCM"
PhaseTwoConfigDetailsEncryptionAlgorithm128Gcm PhaseTwoConfigDetailsEncryptionAlgorithmEnum = "AES_128_GCM"
PhaseTwoConfigDetailsEncryptionAlgorithm256Cbc PhaseTwoConfigDetailsEncryptionAlgorithmEnum = "AES_256_CBC"
PhaseTwoConfigDetailsEncryptionAlgorithm192Cbc PhaseTwoConfigDetailsEncryptionAlgorithmEnum = "AES_192_CBC"
PhaseTwoConfigDetailsEncryptionAlgorithm128Cbc PhaseTwoConfigDetailsEncryptionAlgorithmEnum = "AES_128_CBC"
)
func GetMappingPhaseTwoConfigDetailsEncryptionAlgorithmEnum(val string) (PhaseTwoConfigDetailsEncryptionAlgorithmEnum, bool)
GetMappingPhaseTwoConfigDetailsEncryptionAlgorithmEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPhaseTwoConfigDetailsEncryptionAlgorithmEnumValues() []PhaseTwoConfigDetailsEncryptionAlgorithmEnum
GetPhaseTwoConfigDetailsEncryptionAlgorithmEnumValues Enumerates the set of values for PhaseTwoConfigDetailsEncryptionAlgorithmEnum
PhaseTwoConfigDetailsPfsDhGroupEnum Enum with underlying type: string
type PhaseTwoConfigDetailsPfsDhGroupEnum string
Set of constants representing the allowable values for PhaseTwoConfigDetailsPfsDhGroupEnum
const (
PhaseTwoConfigDetailsPfsDhGroupGroup2 PhaseTwoConfigDetailsPfsDhGroupEnum = "GROUP2"
PhaseTwoConfigDetailsPfsDhGroupGroup5 PhaseTwoConfigDetailsPfsDhGroupEnum = "GROUP5"
PhaseTwoConfigDetailsPfsDhGroupGroup14 PhaseTwoConfigDetailsPfsDhGroupEnum = "GROUP14"
PhaseTwoConfigDetailsPfsDhGroupGroup19 PhaseTwoConfigDetailsPfsDhGroupEnum = "GROUP19"
PhaseTwoConfigDetailsPfsDhGroupGroup20 PhaseTwoConfigDetailsPfsDhGroupEnum = "GROUP20"
PhaseTwoConfigDetailsPfsDhGroupGroup24 PhaseTwoConfigDetailsPfsDhGroupEnum = "GROUP24"
)
func GetMappingPhaseTwoConfigDetailsPfsDhGroupEnum(val string) (PhaseTwoConfigDetailsPfsDhGroupEnum, bool)
GetMappingPhaseTwoConfigDetailsPfsDhGroupEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPhaseTwoConfigDetailsPfsDhGroupEnumValues() []PhaseTwoConfigDetailsPfsDhGroupEnum
GetPhaseTwoConfigDetailsPfsDhGroupEnumValues Enumerates the set of values for PhaseTwoConfigDetailsPfsDhGroupEnum
PortRange The representation of PortRange
type PortRange struct {
// The maximum port number, which must not be less than the minimum port number. To specify
// a single port number, set both the min and max to the same value.
Max *int `mandatory:"true" json:"max"`
// The minimum port number, which must not be greater than the maximum port number.
Min *int `mandatory:"true" json:"min"`
}
func (m PortRange) String() string
func (m PortRange) 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
PrivateIp A *private IP* is a conceptual term that refers to an IPv4 private IP address and related properties. The `privateIp` object is the API representation of a private IP. **Note:** For information about IPv6 addresses, see Ipv6. Each instance has a *primary private IP* that is automatically created and assigned to the primary VNIC during instance launch. If you add a secondary VNIC to the instance, it also automatically gets a primary private IP. You can't remove a primary private IP from its VNIC. The primary private IP is automatically deleted when the VNIC is terminated. You can add *secondary private IPs* to a VNIC after it's created. For more information, see the `privateIp` operations and also IP Addresses (https://docs.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm). **Note:** Only ListPrivateIps and GetPrivateIp work with *primary* private IPs. To create and update primary private IPs, you instead work with instance and VNIC operations. For example, a primary private IP's properties come from the values you specify in CreateVnicDetails when calling either LaunchInstance or AttachVnic. To update the hostname for a primary private IP, you use UpdateVnic. `PrivateIp` objects that are created for use with the Oracle Cloud VMware Solution are assigned to a VLAN and not a VNIC in a subnet. See the descriptions of the relevant attributes in the `PrivateIp` object. Also see Vlan. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type PrivateIp struct {
// The private IP's availability domain. This attribute will be null if this is a *secondary*
// private IP assigned to a VNIC that is in a *regional* subnet.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the private IP.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The hostname for the private IP. Used for DNS. The value is the hostname
// portion of the private IP's fully qualified domain name (FQDN)
// (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`).
// Must be unique across all VNICs in the subnet and comply with
// RFC 952 (https://tools.ietf.org/html/rfc952) and
// RFC 1123 (https://tools.ietf.org/html/rfc1123).
// For more information, see
// DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm).
// Example: `bminstance1`
HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`
// The private IP's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"false" json:"id"`
// The private IP address of the `privateIp` object. The address is within the CIDR
// of the VNIC's subnet.
// However, if the `PrivateIp` object is being used with a VLAN as part of
// the Oracle Cloud VMware Solution, the address is from the range specified by the
// `cidrBlock` attribute for the VLAN. See Vlan.
// Example: `10.0.3.3`
IpAddress *string `mandatory:"false" json:"ipAddress"`
// Whether this private IP is the primary one on the VNIC. Primary private IPs
// are unassigned and deleted automatically when the VNIC is terminated.
// Example: `true`
IsPrimary *bool `mandatory:"false" json:"isPrimary"`
// Applicable only if the `PrivateIp` object is being used with a VLAN as part of
// the Oracle Cloud VMware Solution. The `vlanId` is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See
// Vlan.
VlanId *string `mandatory:"false" json:"vlanId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet the VNIC is in.
// However, if the `PrivateIp` object is being used with a VLAN as part of
// the Oracle Cloud VMware Solution, the `subnetId` is null.
SubnetId *string `mandatory:"false" json:"subnetId"`
// The date and time the private IP was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC the private IP is assigned to. The VNIC and private IP
// must be in the same subnet.
// However, if the `PrivateIp` object is being used with a VLAN as part of
// the Oracle Cloud VMware Solution, the `vnicId` is null.
VnicId *string `mandatory:"false" json:"vnicId"`
}
func (m PrivateIp) String() string
func (m PrivateIp) 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
ProtocolParameters Defines the IP protocol parameters for a `PathAnalyzerTest` resource.
type ProtocolParameters interface {
}
ProtocolParametersTypeEnum Enum with underlying type: string
type ProtocolParametersTypeEnum string
Set of constants representing the allowable values for ProtocolParametersTypeEnum
const (
ProtocolParametersTypeTcp ProtocolParametersTypeEnum = "TCP"
ProtocolParametersTypeUdp ProtocolParametersTypeEnum = "UDP"
ProtocolParametersTypeIcmp ProtocolParametersTypeEnum = "ICMP"
)
func GetMappingProtocolParametersTypeEnum(val string) (ProtocolParametersTypeEnum, bool)
GetMappingProtocolParametersTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetProtocolParametersTypeEnumValues() []ProtocolParametersTypeEnum
GetProtocolParametersTypeEnumValues Enumerates the set of values for ProtocolParametersTypeEnum
PublicIp A *public IP* is a conceptual term that refers to a public IP address and related properties. The `publicIp` object is the API representation of a public IP. There are two types of public IPs: 1. Ephemeral 2. Reserved For more information and comparison of the two types, see Public IP Addresses (https://docs.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm).
type PublicIp struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the entity the public IP is assigned to, or in the process of
// being assigned to.
AssignedEntityId *string `mandatory:"false" json:"assignedEntityId"`
// The type of entity the public IP is assigned to, or in the process of being
// assigned to.
AssignedEntityType PublicIpAssignedEntityTypeEnum `mandatory:"false" json:"assignedEntityType,omitempty"`
// The public IP's availability domain. This property is set only for ephemeral public IPs
// that are assigned to a private IP (that is, when the `scope` of the public IP is set to
// AVAILABILITY_DOMAIN). The value is the availability domain of the assigned private IP.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the public IP. For an ephemeral public IP, this is
// the compartment of its assigned entity (which can be a private IP or a regional entity such
// as a NAT gateway). For a reserved public IP that is currently assigned,
// its compartment can be different from the assigned private IP's.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The public IP's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"false" json:"id"`
// The public IP address of the `publicIp` object.
// Example: `203.0.113.2`
IpAddress *string `mandatory:"false" json:"ipAddress"`
// The public IP's current state.
LifecycleState PublicIpLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// Defines when the public IP is deleted and released back to Oracle's public IP pool.
// * `EPHEMERAL`: The lifetime is tied to the lifetime of its assigned entity. An ephemeral
// public IP must always be assigned to an entity. If the assigned entity is a private IP,
// the ephemeral public IP is automatically deleted when the private IP is deleted, when
// the VNIC is terminated, or when the instance is terminated. If the assigned entity is a
// NatGateway, the ephemeral public IP is automatically
// deleted when the NAT gateway is terminated.
// * `RESERVED`: You control the public IP's lifetime. You can delete a reserved public IP
// whenever you like. It does not need to be assigned to a private IP at all times.
// For more information and comparison of the two types,
// see Public IP Addresses (https://docs.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm).
Lifetime PublicIpLifetimeEnum `mandatory:"false" json:"lifetime,omitempty"`
// Deprecated. Use `assignedEntityId` instead.
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private IP that the public IP is currently assigned to, or in the
// process of being assigned to.
// **Note:** This is `null` if the public IP is not assigned to a private IP, or is
// in the process of being assigned to one.
PrivateIpId *string `mandatory:"false" json:"privateIpId"`
// Whether the public IP is regional or specific to a particular availability domain.
// * `REGION`: The public IP exists within a region and is assigned to a regional entity
// (such as a NatGateway), or can be assigned to a private
// IP in any availability domain in the region. Reserved public IPs and ephemeral public IPs
// assigned to a regional entity have `scope` = `REGION`.
// * `AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the entity
// it's assigned to, which is specified by the `availabilityDomain` property of the public IP object.
// Ephemeral public IPs that are assigned to private IPs have `scope` = `AVAILABILITY_DOMAIN`.
Scope PublicIpScopeEnum `mandatory:"false" json:"scope,omitempty"`
// The date and time the public IP was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the pool object created in the current tenancy.
PublicIpPoolId *string `mandatory:"false" json:"publicIpPoolId"`
}
func (m PublicIp) String() string
func (m PublicIp) 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
PublicIpAssignedEntityTypeEnum Enum with underlying type: string
type PublicIpAssignedEntityTypeEnum string
Set of constants representing the allowable values for PublicIpAssignedEntityTypeEnum
const (
PublicIpAssignedEntityTypePrivateIp PublicIpAssignedEntityTypeEnum = "PRIVATE_IP"
PublicIpAssignedEntityTypeNatGateway PublicIpAssignedEntityTypeEnum = "NAT_GATEWAY"
)
func GetMappingPublicIpAssignedEntityTypeEnum(val string) (PublicIpAssignedEntityTypeEnum, bool)
GetMappingPublicIpAssignedEntityTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPublicIpAssignedEntityTypeEnumValues() []PublicIpAssignedEntityTypeEnum
GetPublicIpAssignedEntityTypeEnumValues Enumerates the set of values for PublicIpAssignedEntityTypeEnum
PublicIpLifecycleStateEnum Enum with underlying type: string
type PublicIpLifecycleStateEnum string
Set of constants representing the allowable values for PublicIpLifecycleStateEnum
const (
PublicIpLifecycleStateProvisioning PublicIpLifecycleStateEnum = "PROVISIONING"
PublicIpLifecycleStateAvailable PublicIpLifecycleStateEnum = "AVAILABLE"
PublicIpLifecycleStateAssigning PublicIpLifecycleStateEnum = "ASSIGNING"
PublicIpLifecycleStateAssigned PublicIpLifecycleStateEnum = "ASSIGNED"
PublicIpLifecycleStateUnassigning PublicIpLifecycleStateEnum = "UNASSIGNING"
PublicIpLifecycleStateUnassigned PublicIpLifecycleStateEnum = "UNASSIGNED"
PublicIpLifecycleStateTerminating PublicIpLifecycleStateEnum = "TERMINATING"
PublicIpLifecycleStateTerminated PublicIpLifecycleStateEnum = "TERMINATED"
)
func GetMappingPublicIpLifecycleStateEnum(val string) (PublicIpLifecycleStateEnum, bool)
GetMappingPublicIpLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPublicIpLifecycleStateEnumValues() []PublicIpLifecycleStateEnum
GetPublicIpLifecycleStateEnumValues Enumerates the set of values for PublicIpLifecycleStateEnum
PublicIpLifetimeEnum Enum with underlying type: string
type PublicIpLifetimeEnum string
Set of constants representing the allowable values for PublicIpLifetimeEnum
const (
PublicIpLifetimeEphemeral PublicIpLifetimeEnum = "EPHEMERAL"
PublicIpLifetimeReserved PublicIpLifetimeEnum = "RESERVED"
)
func GetMappingPublicIpLifetimeEnum(val string) (PublicIpLifetimeEnum, bool)
GetMappingPublicIpLifetimeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPublicIpLifetimeEnumValues() []PublicIpLifetimeEnum
GetPublicIpLifetimeEnumValues Enumerates the set of values for PublicIpLifetimeEnum
PublicIpPool A public IP pool is a set of public IP addresses represented as one or more IPv4 CIDR blocks. Resources like load balancers and compute instances can be allocated public IP addresses from a public IP pool.
type PublicIpPool struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this pool.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool.
Id *string `mandatory:"true" json:"id"`
// The date and time the public IP pool was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The CIDR blocks added to this pool. This could be all or a portion of a BYOIP CIDR block.
CidrBlocks []string `mandatory:"false" json:"cidrBlocks"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The public IP pool's current state.
LifecycleState PublicIpPoolLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}
func (m PublicIpPool) String() string
func (m PublicIpPool) 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
PublicIpPoolCollection Results of a `ListPublicIpPool` operation.
type PublicIpPoolCollection struct {
// A list of public IP pool summaries.
Items []PublicIpPoolSummary `mandatory:"true" json:"items"`
}
func (m PublicIpPoolCollection) String() string
func (m PublicIpPoolCollection) 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
PublicIpPoolLifecycleStateEnum Enum with underlying type: string
type PublicIpPoolLifecycleStateEnum string
Set of constants representing the allowable values for PublicIpPoolLifecycleStateEnum
const (
PublicIpPoolLifecycleStateInactive PublicIpPoolLifecycleStateEnum = "INACTIVE"
PublicIpPoolLifecycleStateUpdating PublicIpPoolLifecycleStateEnum = "UPDATING"
PublicIpPoolLifecycleStateActive PublicIpPoolLifecycleStateEnum = "ACTIVE"
PublicIpPoolLifecycleStateDeleting PublicIpPoolLifecycleStateEnum = "DELETING"
PublicIpPoolLifecycleStateDeleted PublicIpPoolLifecycleStateEnum = "DELETED"
)
func GetMappingPublicIpPoolLifecycleStateEnum(val string) (PublicIpPoolLifecycleStateEnum, bool)
GetMappingPublicIpPoolLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPublicIpPoolLifecycleStateEnumValues() []PublicIpPoolLifecycleStateEnum
GetPublicIpPoolLifecycleStateEnumValues Enumerates the set of values for PublicIpPoolLifecycleStateEnum
PublicIpPoolSummary Summary information about a public IP pool.
type PublicIpPoolSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the public IP pool.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool.
Id *string `mandatory:"false" json:"id"`
// The public IP pool's current state.
LifecycleState PublicIpPoolLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the public IP pool was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}
func (m PublicIpPoolSummary) String() string
func (m PublicIpPoolSummary) 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
PublicIpScopeEnum Enum with underlying type: string
type PublicIpScopeEnum string
Set of constants representing the allowable values for PublicIpScopeEnum
const (
PublicIpScopeRegion PublicIpScopeEnum = "REGION"
PublicIpScopeAvailabilityDomain PublicIpScopeEnum = "AVAILABILITY_DOMAIN"
)
func GetMappingPublicIpScopeEnum(val string) (PublicIpScopeEnum, bool)
GetMappingPublicIpScopeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetPublicIpScopeEnumValues() []PublicIpScopeEnum
GetPublicIpScopeEnumValues Enumerates the set of values for PublicIpScopeEnum
QueryOptions Defines the query options required for a `PathAnalyzerTest` resource.
type QueryOptions struct {
// If true, a path analysis is done for both the forward and reverse routes.
IsBiDirectionalAnalysis *bool `mandatory:"false" json:"isBiDirectionalAnalysis"`
}
func (m QueryOptions) String() string
func (m QueryOptions) 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
RemotePeeringConnection A remote peering connection (RPC) is an object on a DRG that lets the VCN that is attached to the DRG peer with a VCN in a different region. *Peering* means that the two VCNs can communicate using private IP addresses, but without the traffic traversing the internet or routing through your on-premises network. For more information, see VCN Peering (https://docs.oracle.com/iaas/Content/Network/Tasks/VCNpeering.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type RemotePeeringConnection struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the RPC.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG that this RPC belongs to.
DrgId *string `mandatory:"true" json:"drgId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the RPC.
Id *string `mandatory:"true" json:"id"`
// Whether the VCN at the other end of the peering is in a different tenancy.
// Example: `false`
IsCrossTenancyPeering *bool `mandatory:"true" json:"isCrossTenancyPeering"`
// The RPC's current lifecycle state.
LifecycleState RemotePeeringConnectionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Whether the RPC is peered with another RPC. `NEW` means the RPC has not yet been
// peered. `PENDING` means the peering is being established. `REVOKED` means the
// RPC at the other end of the peering has been deleted.
PeeringStatus RemotePeeringConnectionPeeringStatusEnum `mandatory:"true" json:"peeringStatus"`
// The date and time the RPC was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// If this RPC is peered, this value is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the other RPC.
PeerId *string `mandatory:"false" json:"peerId"`
// If this RPC is peered, this value is the region that contains the other RPC.
// Example: `us-ashburn-1`
PeerRegionName *string `mandatory:"false" json:"peerRegionName"`
// If this RPC is peered, this value is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the other RPC's tenancy.
PeerTenancyId *string `mandatory:"false" json:"peerTenancyId"`
}
func (m RemotePeeringConnection) String() string
func (m RemotePeeringConnection) 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
RemotePeeringConnectionDrgAttachmentNetworkDetails Specifies the DRG attachment to another DRG.
type RemotePeeringConnectionDrgAttachmentNetworkDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG.
Id *string `mandatory:"false" json:"id"`
}
func (m RemotePeeringConnectionDrgAttachmentNetworkDetails) GetId() *string
GetId returns Id
func (m RemotePeeringConnectionDrgAttachmentNetworkDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m RemotePeeringConnectionDrgAttachmentNetworkDetails) String() string
func (m RemotePeeringConnectionDrgAttachmentNetworkDetails) 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
RemotePeeringConnectionLifecycleStateEnum Enum with underlying type: string
type RemotePeeringConnectionLifecycleStateEnum string
Set of constants representing the allowable values for RemotePeeringConnectionLifecycleStateEnum
const (
RemotePeeringConnectionLifecycleStateAvailable RemotePeeringConnectionLifecycleStateEnum = "AVAILABLE"
RemotePeeringConnectionLifecycleStateProvisioning RemotePeeringConnectionLifecycleStateEnum = "PROVISIONING"
RemotePeeringConnectionLifecycleStateTerminating RemotePeeringConnectionLifecycleStateEnum = "TERMINATING"
RemotePeeringConnectionLifecycleStateTerminated RemotePeeringConnectionLifecycleStateEnum = "TERMINATED"
)
func GetMappingRemotePeeringConnectionLifecycleStateEnum(val string) (RemotePeeringConnectionLifecycleStateEnum, bool)
GetMappingRemotePeeringConnectionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRemotePeeringConnectionLifecycleStateEnumValues() []RemotePeeringConnectionLifecycleStateEnum
GetRemotePeeringConnectionLifecycleStateEnumValues Enumerates the set of values for RemotePeeringConnectionLifecycleStateEnum
RemotePeeringConnectionPeeringStatusEnum Enum with underlying type: string
type RemotePeeringConnectionPeeringStatusEnum string
Set of constants representing the allowable values for RemotePeeringConnectionPeeringStatusEnum
const (
RemotePeeringConnectionPeeringStatusInvalid RemotePeeringConnectionPeeringStatusEnum = "INVALID"
RemotePeeringConnectionPeeringStatusNew RemotePeeringConnectionPeeringStatusEnum = "NEW"
RemotePeeringConnectionPeeringStatusPending RemotePeeringConnectionPeeringStatusEnum = "PENDING"
RemotePeeringConnectionPeeringStatusPeered RemotePeeringConnectionPeeringStatusEnum = "PEERED"
RemotePeeringConnectionPeeringStatusRevoked RemotePeeringConnectionPeeringStatusEnum = "REVOKED"
)
func GetMappingRemotePeeringConnectionPeeringStatusEnum(val string) (RemotePeeringConnectionPeeringStatusEnum, bool)
GetMappingRemotePeeringConnectionPeeringStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRemotePeeringConnectionPeeringStatusEnumValues() []RemotePeeringConnectionPeeringStatusEnum
GetRemotePeeringConnectionPeeringStatusEnumValues Enumerates the set of values for RemotePeeringConnectionPeeringStatusEnum
RemoveDrgRouteDistributionStatementsDetails Details request to remove statements from a route distribution.
type RemoveDrgRouteDistributionStatementsDetails struct {
// The Oracle-assigned ID of each route distribution to remove.
StatementIds []string `mandatory:"false" json:"statementIds"`
}
func (m RemoveDrgRouteDistributionStatementsDetails) String() string
func (m RemoveDrgRouteDistributionStatementsDetails) 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
RemoveDrgRouteRulesDetails Details used in a request to remove static routes from a DRG route table.
type RemoveDrgRouteRulesDetails struct {
// The Oracle-assigned ID of each DRG route rule to be deleted.
RouteRuleIds []string `mandatory:"false" json:"routeRuleIds"`
}
func (m RemoveDrgRouteRulesDetails) String() string
func (m RemoveDrgRouteRulesDetails) 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
RemoveNetworkSecurityGroupSecurityRulesDetails The representation of RemoveNetworkSecurityGroupSecurityRulesDetails
type RemoveNetworkSecurityGroupSecurityRulesDetails struct {
// The Oracle-assigned ID of each SecurityRule to be deleted.
SecurityRuleIds []string `mandatory:"false" json:"securityRuleIds"`
}
func (m RemoveNetworkSecurityGroupSecurityRulesDetails) String() string
func (m RemoveNetworkSecurityGroupSecurityRulesDetails) 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
RemovePublicIpPoolCapacityDetails The information needed to remove capacity from a public IP pool.
type RemovePublicIpPoolCapacityDetails struct {
// The CIDR block to remove from the public IP pool.
// Example: `10.0.1.0/24`
CidrBlock *string `mandatory:"true" json:"cidrBlock"`
}
func (m RemovePublicIpPoolCapacityDetails) String() string
func (m RemovePublicIpPoolCapacityDetails) 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
RemoveSubnetIpv6CidrDetails Details object for removing an IPv6 CIDR Block from a Subnet.
type RemoveSubnetIpv6CidrDetails struct {
// This field is not required and should only be specified when removing an IPv6 CIDR
// from a subnet's IPv6 address space.
// SeeIPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// Example: `2001:0db8:0123::/64`
Ipv6CidrBlock *string `mandatory:"true" json:"ipv6CidrBlock"`
}
func (m RemoveSubnetIpv6CidrDetails) String() string
func (m RemoveSubnetIpv6CidrDetails) 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
RemoveVcnCidrDetails Details for removing a CIDR block from a VCN.
type RemoveVcnCidrDetails struct {
// The CIDR block to remove.
CidrBlock *string `mandatory:"true" json:"cidrBlock"`
}
func (m RemoveVcnCidrDetails) String() string
func (m RemoveVcnCidrDetails) 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
RemoveVcnIpv6CidrDetails Details used when removing ULA or private IPv6 prefix or an IPv6 GUA assigned by Oracle or BYOIPv6 prefix. You can only remove one of these per request.
type RemoveVcnIpv6CidrDetails struct {
// This field is not required and should only be specified when removing ULA or private IPv6 prefix or an IPv6 GUA assigned by Oracle or BYOIPv6 prefix
// from a VCN's IPv6 address space.
// SeeIPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// Example: `2001:0db8:0123::/56`
Ipv6CidrBlock *string `mandatory:"false" json:"ipv6CidrBlock"`
}
func (m RemoveVcnIpv6CidrDetails) String() string
func (m RemoveVcnIpv6CidrDetails) 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
RouteRule A mapping between a destination IP address range and a virtual device to route matching packets to (a target).
type RouteRule struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the route rule's target. For information about the type of
// targets you can specify, see
// Route Tables (https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm).
NetworkEntityId *string `mandatory:"true" json:"networkEntityId"`
// Deprecated. Instead use `destination` and `destinationType`. Requests that include both
// `cidrBlock` and `destination` will be rejected.
// A destination IP address range in CIDR notation. Matching packets will
// be routed to the indicated network entity (the target).
// Cannot be an IPv6 CIDR.
// Example: `0.0.0.0/0`
CidrBlock *string `mandatory:"false" json:"cidrBlock"`
// Conceptually, this is the range of IP addresses used for matching when routing
// traffic. Required if you provide a `destinationType`.
// Allowed values:
// * IP address range in CIDR notation. Can be an IPv4 or IPv6 CIDR. For example: `192.168.1.0/24`
// or `2001:0db8:0123:45::/56`. If you set this to an IPv6 CIDR, the route rule's target
// can only be a DRG or internet gateway.
// IPv6 addressing is supported for all commercial and government regions.
// See IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// * The `cidrBlock` value for a Service, if you're
// setting up a route rule for traffic destined for a particular `Service` through
// a service gateway. For example: `oci-phx-objectstorage`.
Destination *string `mandatory:"false" json:"destination"`
// Type of destination for the rule. Required if you provide a `destination`.
// * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.
// * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a
// Service (the rule is for traffic destined for a
// particular `Service` through a service gateway).
DestinationType RouteRuleDestinationTypeEnum `mandatory:"false" json:"destinationType,omitempty"`
// An optional description of your choice for the rule.
Description *string `mandatory:"false" json:"description"`
// A route rule can be STATIC if manually added to the route table, LOCAL if added by OCI to the route table.
RouteType RouteRuleRouteTypeEnum `mandatory:"false" json:"routeType,omitempty"`
}
func (m RouteRule) String() string
func (m RouteRule) 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
RouteRuleDestinationTypeEnum Enum with underlying type: string
type RouteRuleDestinationTypeEnum string
Set of constants representing the allowable values for RouteRuleDestinationTypeEnum
const (
RouteRuleDestinationTypeCidrBlock RouteRuleDestinationTypeEnum = "CIDR_BLOCK"
RouteRuleDestinationTypeServiceCidrBlock RouteRuleDestinationTypeEnum = "SERVICE_CIDR_BLOCK"
)
func GetMappingRouteRuleDestinationTypeEnum(val string) (RouteRuleDestinationTypeEnum, bool)
GetMappingRouteRuleDestinationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRouteRuleDestinationTypeEnumValues() []RouteRuleDestinationTypeEnum
GetRouteRuleDestinationTypeEnumValues Enumerates the set of values for RouteRuleDestinationTypeEnum
RouteRuleRouteTypeEnum Enum with underlying type: string
type RouteRuleRouteTypeEnum string
Set of constants representing the allowable values for RouteRuleRouteTypeEnum
const (
RouteRuleRouteTypeStatic RouteRuleRouteTypeEnum = "STATIC"
RouteRuleRouteTypeLocal RouteRuleRouteTypeEnum = "LOCAL"
)
func GetMappingRouteRuleRouteTypeEnum(val string) (RouteRuleRouteTypeEnum, bool)
GetMappingRouteRuleRouteTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRouteRuleRouteTypeEnumValues() []RouteRuleRouteTypeEnum
GetRouteRuleRouteTypeEnumValues Enumerates the set of values for RouteRuleRouteTypeEnum
RouteTable A collection of `RouteRule` objects, which are used to route packets based on destination IP to a particular network entity. For more information, see Overview of the Networking Service (https://docs.oracle.com/iaas/Content/Network/Concepts/overview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type RouteTable struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the route table.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The route table's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"true" json:"id"`
// The route table's current state.
LifecycleState RouteTableLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The collection of rules for routing destination IPs to network devices.
RouteRules []RouteRule `mandatory:"true" json:"routeRules"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN the route table list belongs to.
VcnId *string `mandatory:"true" json:"vcnId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The date and time the route table was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}
func (m RouteTable) String() string
func (m RouteTable) 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
RouteTableLifecycleStateEnum Enum with underlying type: string
type RouteTableLifecycleStateEnum string
Set of constants representing the allowable values for RouteTableLifecycleStateEnum
const (
RouteTableLifecycleStateProvisioning RouteTableLifecycleStateEnum = "PROVISIONING"
RouteTableLifecycleStateAvailable RouteTableLifecycleStateEnum = "AVAILABLE"
RouteTableLifecycleStateTerminating RouteTableLifecycleStateEnum = "TERMINATING"
RouteTableLifecycleStateTerminated RouteTableLifecycleStateEnum = "TERMINATED"
)
func GetMappingRouteTableLifecycleStateEnum(val string) (RouteTableLifecycleStateEnum, bool)
GetMappingRouteTableLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRouteTableLifecycleStateEnumValues() []RouteTableLifecycleStateEnum
GetRouteTableLifecycleStateEnumValues Enumerates the set of values for RouteTableLifecycleStateEnum
RoutingAction Defines the details for routing actions taken on the traffic flow.
type RoutingAction interface {
// The type of the routing support for the traffic flow.
GetActionType() RoutingActionActionTypeEnum
}
RoutingActionActionEnum Enum with underlying type: string
type RoutingActionActionEnum string
Set of constants representing the allowable values for RoutingActionActionEnum
const (
RoutingActionActionForwarded RoutingActionActionEnum = "FORWARDED"
RoutingActionActionNoRoute RoutingActionActionEnum = "NO_ROUTE"
RoutingActionActionIndeterminate RoutingActionActionEnum = "INDETERMINATE"
)
func GetMappingRoutingActionActionEnum(val string) (RoutingActionActionEnum, bool)
GetMappingRoutingActionActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRoutingActionActionEnumValues() []RoutingActionActionEnum
GetRoutingActionActionEnumValues Enumerates the set of values for RoutingActionActionEnum
RoutingActionActionTypeEnum Enum with underlying type: string
type RoutingActionActionTypeEnum string
Set of constants representing the allowable values for RoutingActionActionTypeEnum
const (
RoutingActionActionTypeExplicit RoutingActionActionTypeEnum = "EXPLICIT"
RoutingActionActionTypeImplicit RoutingActionActionTypeEnum = "IMPLICIT"
RoutingActionActionTypeNotSupported RoutingActionActionTypeEnum = "NOT_SUPPORTED"
)
func GetMappingRoutingActionActionTypeEnum(val string) (RoutingActionActionTypeEnum, bool)
GetMappingRoutingActionActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRoutingActionActionTypeEnumValues() []RoutingActionActionTypeEnum
GetRoutingActionActionTypeEnumValues Enumerates the set of values for RoutingActionActionTypeEnum
SecurityAction Defines the security action details taken on the traffic.
type SecurityAction interface {
// Type of the `SecurityAction`.
GetActionType() SecurityActionActionTypeEnum
}
SecurityActionActionEnum Enum with underlying type: string
type SecurityActionActionEnum string
Set of constants representing the allowable values for SecurityActionActionEnum
const (
SecurityActionActionAllowed SecurityActionActionEnum = "ALLOWED"
SecurityActionActionDenied SecurityActionActionEnum = "DENIED"
)
func GetMappingSecurityActionActionEnum(val string) (SecurityActionActionEnum, bool)
GetMappingSecurityActionActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSecurityActionActionEnumValues() []SecurityActionActionEnum
GetSecurityActionActionEnumValues Enumerates the set of values for SecurityActionActionEnum
SecurityActionActionTypeEnum Enum with underlying type: string
type SecurityActionActionTypeEnum string
Set of constants representing the allowable values for SecurityActionActionTypeEnum
const (
SecurityActionActionTypeExplicit SecurityActionActionTypeEnum = "EXPLICIT"
SecurityActionActionTypeImplicit SecurityActionActionTypeEnum = "IMPLICIT"
)
func GetMappingSecurityActionActionTypeEnum(val string) (SecurityActionActionTypeEnum, bool)
GetMappingSecurityActionActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSecurityActionActionTypeEnumValues() []SecurityActionActionTypeEnum
GetSecurityActionActionTypeEnumValues Enumerates the set of values for SecurityActionActionTypeEnum
SecurityList A set of virtual firewall rules for your VCN. Security lists are configured at the subnet level, but the rules are applied to the ingress and egress traffic for the individual instances in the subnet. The rules can be stateful or stateless. For more information, see Security Lists (https://docs.oracle.com/iaas/Content/Network/Concepts/securitylists.htm). **Note:** Compare security lists to NetworkSecurityGroups, which let you apply a set of security rules to a *specific set of VNICs* instead of an entire subnet. Oracle recommends using network security groups instead of security lists, although you can use either or both together. **Important:** Oracle Cloud Infrastructure Compute service images automatically include firewall rules (for example, Linux iptables, Windows firewall). If there are issues with some type of access to an instance, make sure both the security lists associated with the instance's subnet and the instance's firewall rules are set correctly. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type SecurityList struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the security list.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// Rules for allowing egress IP packets.
EgressSecurityRules []EgressSecurityRule `mandatory:"true" json:"egressSecurityRules"`
// The security list's Oracle Cloud ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"true" json:"id"`
// Rules for allowing ingress IP packets.
IngressSecurityRules []IngressSecurityRule `mandatory:"true" json:"ingressSecurityRules"`
// The security list's current state.
LifecycleState SecurityListLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the security list was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN the security list belongs to.
VcnId *string `mandatory:"true" json:"vcnId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m SecurityList) String() string
func (m SecurityList) 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
SecurityListLifecycleStateEnum Enum with underlying type: string
type SecurityListLifecycleStateEnum string
Set of constants representing the allowable values for SecurityListLifecycleStateEnum
const (
SecurityListLifecycleStateProvisioning SecurityListLifecycleStateEnum = "PROVISIONING"
SecurityListLifecycleStateAvailable SecurityListLifecycleStateEnum = "AVAILABLE"
SecurityListLifecycleStateTerminating SecurityListLifecycleStateEnum = "TERMINATING"
SecurityListLifecycleStateTerminated SecurityListLifecycleStateEnum = "TERMINATED"
)
func GetMappingSecurityListLifecycleStateEnum(val string) (SecurityListLifecycleStateEnum, bool)
GetMappingSecurityListLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSecurityListLifecycleStateEnumValues() []SecurityListLifecycleStateEnum
GetSecurityListLifecycleStateEnumValues Enumerates the set of values for SecurityListLifecycleStateEnum
SecurityRule A security rule is one of the items in a NetworkSecurityGroup. It is a virtual firewall rule for the VNICs in the network security group. A rule can be for either inbound (`direction`= INGRESS) or outbound (`direction`= EGRESS) IP packets.
type SecurityRule struct {
// Direction of the security rule. Set to `EGRESS` for rules to allow outbound IP packets,
// or `INGRESS` for rules to allow inbound IP packets.
Direction SecurityRuleDirectionEnum `mandatory:"true" json:"direction"`
// The transport protocol. Specify either `all` or an IPv4 protocol number as
// defined in
// Protocol Numbers (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
// Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58").
Protocol *string `mandatory:"true" json:"protocol"`
// An optional description of your choice for the rule.
Description *string `mandatory:"false" json:"description"`
// Conceptually, this is the range of IP addresses that a packet originating from the instance
// can go to.
// Allowed values:
// * An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`
// IPv6 addressing is supported for all commercial and government regions.
// See IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// * The `cidrBlock` value for a Service, if you're
// setting up a security rule for traffic destined for a particular `Service` through
// a service gateway. For example: `oci-phx-objectstorage`.
// * The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a NetworkSecurityGroup in the same
// VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control
// traffic between VNICs in the same NSG.
Destination *string `mandatory:"false" json:"destination"`
// Type of destination for the rule. Required if `direction` = `EGRESS`.
// Allowed values:
// * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.
// * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a
// Service (the rule is for traffic destined for a
// particular `Service` through a service gateway).
// * `NETWORK_SECURITY_GROUP`: If the rule's `destination` is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a
// NetworkSecurityGroup.
DestinationType SecurityRuleDestinationTypeEnum `mandatory:"false" json:"destinationType,omitempty"`
IcmpOptions *IcmpOptions `mandatory:"false" json:"icmpOptions"`
// An Oracle-assigned identifier for the security rule. You specify this ID when you want to
// update or delete the rule.
// Example: `04ABEC`
Id *string `mandatory:"false" json:"id"`
// A stateless rule allows traffic in one direction. Remember to add a corresponding
// stateless rule in the other direction if you need to support bidirectional traffic. For
// example, if egress traffic allows TCP destination port 80, there should be an ingress
// rule to allow TCP source port 80. Defaults to false, which means the rule is stateful
// and a corresponding rule is not necessary for bidirectional traffic.
IsStateless *bool `mandatory:"false" json:"isStateless"`
// Whether the rule is valid. The value is `True` when the rule is first created. If
// the rule's `source` or `destination` is a network security group, the value changes to
// `False` if that network security group is deleted.
IsValid *bool `mandatory:"false" json:"isValid"`
// Conceptually, this is the range of IP addresses that a packet coming into the instance
// can come from.
// Allowed values:
// * An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`
// IPv6 addressing is supported for all commercial and government regions.
// See IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// * The `cidrBlock` value for a Service, if you're
// setting up a security rule for traffic coming from a particular `Service` through
// a service gateway. For example: `oci-phx-objectstorage`.
// * The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a NetworkSecurityGroup in the same
// VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control
// traffic between VNICs in the same NSG.
Source *string `mandatory:"false" json:"source"`
// Type of source for the rule. Required if `direction` = `INGRESS`.
// * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation.
// * `SERVICE_CIDR_BLOCK`: If the rule's `source` is the `cidrBlock` value for a
// Service (the rule is for traffic coming from a
// particular `Service` through a service gateway).
// * `NETWORK_SECURITY_GROUP`: If the rule's `source` is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a
// NetworkSecurityGroup.
SourceType SecurityRuleSourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`
TcpOptions *TcpOptions `mandatory:"false" json:"tcpOptions"`
// The date and time the security rule was created. Format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
UdpOptions *UdpOptions `mandatory:"false" json:"udpOptions"`
}
func (m SecurityRule) String() string
func (m SecurityRule) 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
SecurityRuleDestinationTypeEnum Enum with underlying type: string
type SecurityRuleDestinationTypeEnum string
Set of constants representing the allowable values for SecurityRuleDestinationTypeEnum
const (
SecurityRuleDestinationTypeCidrBlock SecurityRuleDestinationTypeEnum = "CIDR_BLOCK"
SecurityRuleDestinationTypeServiceCidrBlock SecurityRuleDestinationTypeEnum = "SERVICE_CIDR_BLOCK"
SecurityRuleDestinationTypeNetworkSecurityGroup SecurityRuleDestinationTypeEnum = "NETWORK_SECURITY_GROUP"
)
func GetMappingSecurityRuleDestinationTypeEnum(val string) (SecurityRuleDestinationTypeEnum, bool)
GetMappingSecurityRuleDestinationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSecurityRuleDestinationTypeEnumValues() []SecurityRuleDestinationTypeEnum
GetSecurityRuleDestinationTypeEnumValues Enumerates the set of values for SecurityRuleDestinationTypeEnum
SecurityRuleDirectionEnum Enum with underlying type: string
type SecurityRuleDirectionEnum string
Set of constants representing the allowable values for SecurityRuleDirectionEnum
const (
SecurityRuleDirectionEgress SecurityRuleDirectionEnum = "EGRESS"
SecurityRuleDirectionIngress SecurityRuleDirectionEnum = "INGRESS"
)
func GetMappingSecurityRuleDirectionEnum(val string) (SecurityRuleDirectionEnum, bool)
GetMappingSecurityRuleDirectionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSecurityRuleDirectionEnumValues() []SecurityRuleDirectionEnum
GetSecurityRuleDirectionEnumValues Enumerates the set of values for SecurityRuleDirectionEnum
SecurityRuleSourceTypeEnum Enum with underlying type: string
type SecurityRuleSourceTypeEnum string
Set of constants representing the allowable values for SecurityRuleSourceTypeEnum
const (
SecurityRuleSourceTypeCidrBlock SecurityRuleSourceTypeEnum = "CIDR_BLOCK"
SecurityRuleSourceTypeServiceCidrBlock SecurityRuleSourceTypeEnum = "SERVICE_CIDR_BLOCK"
SecurityRuleSourceTypeNetworkSecurityGroup SecurityRuleSourceTypeEnum = "NETWORK_SECURITY_GROUP"
)
func GetMappingSecurityRuleSourceTypeEnum(val string) (SecurityRuleSourceTypeEnum, bool)
GetMappingSecurityRuleSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSecurityRuleSourceTypeEnumValues() []SecurityRuleSourceTypeEnum
GetSecurityRuleSourceTypeEnumValues Enumerates the set of values for SecurityRuleSourceTypeEnum
Service An object that represents one or multiple Oracle services that you can enable for a ServiceGateway. In the User Guide topic Access to Oracle Services: Service Gateway (https://docs.oracle.com/iaas/Content/Network/Tasks/servicegateway.htm), the term *service CIDR label* is used to refer to the string that represents the regional public IP address ranges of the Oracle service or services covered by a given `Service` object. That unique string is the value of the `Service` object's `cidrBlock` attribute.
type Service struct {
// A string that represents the regional public IP address ranges for the Oracle service or
// services covered by this `Service` object. Also known as the `Service` object's *service
// CIDR label*.
// When you set up a route rule to route traffic to the service gateway, use this value as the
// rule's destination. See RouteTable. Also, when you set up
// a security list rule to cover traffic with the service gateway, use the `cidrBlock` value
// as the rule's destination (for an egress rule) or the source (for an ingress rule).
// See SecurityList.
// Example: `oci-phx-objectstorage`
CidrBlock *string `mandatory:"true" json:"cidrBlock"`
// Description of the Oracle service or services covered by this `Service` object.
// Example: `OCI PHX Object Storage`
Description *string `mandatory:"true" json:"description"`
// The `Service` object's OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
Id *string `mandatory:"true" json:"id"`
// Name of the `Service` object. This name can change and is not guaranteed to be unique.
// Example: `OCI PHX Object Storage`
Name *string `mandatory:"true" json:"name"`
}
func (m Service) String() string
func (m Service) 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
ServiceGateway Represents a router that lets your VCN privately access specific Oracle services such as Object Storage without exposing the VCN to the public internet. Traffic leaving the VCN and destined for a supported Oracle service (see ListServices) is routed through the service gateway and does not traverse the internet. The instances in the VCN do not need to have public IP addresses nor be in a public subnet. The VCN does not need an internet gateway for this traffic. For more information, see Access to Oracle Services: Service Gateway (https://docs.oracle.com/iaas/Content/Network/Tasks/servicegateway.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type ServiceGateway struct {
// Whether the service gateway blocks all traffic through it. The default is `false`. When
// this is `true`, traffic is not routed to any services, regardless of route rules.
// Example: `true`
BlockTraffic *bool `mandatory:"true" json:"blockTraffic"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the
// service gateway.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the service gateway.
Id *string `mandatory:"true" json:"id"`
// The service gateway's current state.
LifecycleState ServiceGatewayLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// List of the Service objects enabled for this service gateway.
// The list can be empty. You can enable a particular `Service` by using
// AttachServiceId or
// UpdateServiceGateway.
Services []ServiceIdResponseDetails `mandatory:"true" json:"services"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN the service gateway
// belongs to.
VcnId *string `mandatory:"true" json:"vcnId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the service gateway is using.
// For information about why you would associate a route table with a service gateway, see
// Transit Routing: Private Access to Oracle Services (https://docs.oracle.com/iaas/Content/Network/Tasks/transitroutingoracleservices.htm).
RouteTableId *string `mandatory:"false" json:"routeTableId"`
// The date and time the service gateway was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}
func (m ServiceGateway) String() string
func (m ServiceGateway) 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
ServiceGatewayLifecycleStateEnum Enum with underlying type: string
type ServiceGatewayLifecycleStateEnum string
Set of constants representing the allowable values for ServiceGatewayLifecycleStateEnum
const (
ServiceGatewayLifecycleStateProvisioning ServiceGatewayLifecycleStateEnum = "PROVISIONING"
ServiceGatewayLifecycleStateAvailable ServiceGatewayLifecycleStateEnum = "AVAILABLE"
ServiceGatewayLifecycleStateTerminating ServiceGatewayLifecycleStateEnum = "TERMINATING"
ServiceGatewayLifecycleStateTerminated ServiceGatewayLifecycleStateEnum = "TERMINATED"
)
func GetMappingServiceGatewayLifecycleStateEnum(val string) (ServiceGatewayLifecycleStateEnum, bool)
GetMappingServiceGatewayLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetServiceGatewayLifecycleStateEnumValues() []ServiceGatewayLifecycleStateEnum
GetServiceGatewayLifecycleStateEnumValues Enumerates the set of values for ServiceGatewayLifecycleStateEnum
ServiceIdRequestDetails The representation of ServiceIdRequestDetails
type ServiceIdRequestDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Service.
ServiceId *string `mandatory:"true" json:"serviceId"`
}
func (m ServiceIdRequestDetails) String() string
func (m ServiceIdRequestDetails) 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
ServiceIdResponseDetails The representation of ServiceIdResponseDetails
type ServiceIdResponseDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the service.
ServiceId *string `mandatory:"true" json:"serviceId"`
// The name of the service.
ServiceName *string `mandatory:"true" json:"serviceName"`
}
func (m ServiceIdResponseDetails) String() string
func (m ServiceIdResponseDetails) 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
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
StatefulEgressSecurityListConfiguration Defines the stateful subnet egress security list configuration that allowed the ingress traffic.
type StatefulEgressSecurityListConfiguration struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the security
// list that allowed the traffic.
SecurityListId *string `mandatory:"true" json:"securityListId"`
SecurityRule *IngressSecurityRule `mandatory:"true" json:"securityRule"`
}
func (m StatefulEgressSecurityListConfiguration) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StatefulEgressSecurityListConfiguration) String() string
func (m StatefulEgressSecurityListConfiguration) 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
StatefulIngressSecurityListConfiguration Defines the stateful subnet ingress security list configuration that allowed the egress traffic.
type StatefulIngressSecurityListConfiguration struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the security
// list that allowed the traffic.
SecurityListId *string `mandatory:"true" json:"securityListId"`
SecurityRule *EgressSecurityRule `mandatory:"true" json:"securityRule"`
}
func (m StatefulIngressSecurityListConfiguration) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StatefulIngressSecurityListConfiguration) String() string
func (m StatefulIngressSecurityListConfiguration) 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
StatefulNsgConfiguration Defines the stateful network security group configuration that allowed the traffic.
type StatefulNsgConfiguration struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network
// security group that allowed the traffic.
NsgId *string `mandatory:"true" json:"nsgId"`
SecurityRule *SecurityRule `mandatory:"true" json:"securityRule"`
}
func (m StatefulNsgConfiguration) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StatefulNsgConfiguration) String() string
func (m StatefulNsgConfiguration) 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
Subnet A logical subdivision of a VCN. Each subnet consists of a contiguous range of IP addresses that do not overlap with other subnets in the VCN. Example: 172.16.1.0/24. For more information, see Overview of the Networking Service (https://docs.oracle.com/iaas/Content/Network/Concepts/overview.htm) and VCNs and Subnets (https://docs.oracle.com/iaas/Content/Network/Tasks/managingVCNs.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type Subnet struct {
// The subnet's CIDR block.
// Example: `10.0.1.0/24`
CidrBlock *string `mandatory:"true" json:"cidrBlock"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the subnet.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The subnet's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"true" json:"id"`
// The subnet's current state.
LifecycleState SubnetLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table that the subnet uses.
RouteTableId *string `mandatory:"true" json:"routeTableId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN the subnet is in.
VcnId *string `mandatory:"true" json:"vcnId"`
// The IP address of the virtual router.
// Example: `10.0.14.1`
VirtualRouterIp *string `mandatory:"true" json:"virtualRouterIp"`
// The MAC address of the virtual router.
// Example: `00:00:00:00:00:01`
VirtualRouterMac *string `mandatory:"true" json:"virtualRouterMac"`
// The subnet's availability domain. This attribute will be null if this is a regional subnet
// instead of an AD-specific subnet. Oracle recommends creating regional subnets.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the set of DHCP options that the subnet uses.
DhcpOptionsId *string `mandatory:"false" json:"dhcpOptionsId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A DNS label for the subnet, used in conjunction with the VNIC's hostname and
// VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC
// within this subnet (for example, `bminstance1.subnet123.vcn1.oraclevcn.com`).
// Must be an alphanumeric string that begins with a letter and is unique within the VCN.
// The value cannot be changed.
// The absence of this parameter means the Internet and VCN Resolver
// will not resolve hostnames of instances in this subnet.
// For more information, see
// DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm).
// Example: `subnet123`
DnsLabel *string `mandatory:"false" json:"dnsLabel"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// For an IPv6-enabled subnet, this is the IPv6 CIDR block for the subnet's IP address space.
// The subnet size is always /64. See IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// Example: `2001:0db8:0123:1111::/64`
Ipv6CidrBlock *string `mandatory:"false" json:"ipv6CidrBlock"`
// The list of all IPv6 CIDR blocks (Oracle allocated IPv6 GUA, ULA or private IPv6 CIDR blocks, BYOIPv6 CIDR blocks) for the subnet.
Ipv6CidrBlocks []string `mandatory:"false" json:"ipv6CidrBlocks"`
// For an IPv6-enabled subnet, this is the IPv6 address of the virtual router.
// Example: `2001:0db8:0123:1111:89ab:cdef:1234:5678`
Ipv6VirtualRouterIp *string `mandatory:"false" json:"ipv6VirtualRouterIp"`
// Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false.
// For IPV4, `prohibitInternetIngress` behaves similarly to `prohibitPublicIpOnVnic`.
// If it is set to false, VNICs created in this subnet will automatically be assigned public IP
// addresses unless specified otherwise during instance launch or VNIC creation (with the `assignPublicIp`
// flag in CreateVnicDetails).
// If `prohibitInternetIngress` is set to true, VNICs created in this subnet cannot have public IP addresses
// (that is, it's a privatesubnet).
// For IPv6, if `prohibitInternetIngress` is set to `true`, internet access is not allowed for any
// IPv6s assigned to VNICs in the subnet. Otherwise, ingress internet traffic is allowed by default.
// Example: `true`
ProhibitInternetIngress *bool `mandatory:"false" json:"prohibitInternetIngress"`
// Whether VNICs within this subnet can have public IP addresses.
// Defaults to false, which means VNICs created in this subnet will
// automatically be assigned public IP addresses unless specified
// otherwise during instance launch or VNIC creation (with the
// `assignPublicIp` flag in
// CreateVnicDetails).
// If `prohibitPublicIpOnVnic` is set to true, VNICs created in this
// subnet cannot have public IP addresses (that is, it's a private
// subnet).
// Example: `true`
ProhibitPublicIpOnVnic *bool `mandatory:"false" json:"prohibitPublicIpOnVnic"`
// The OCIDs of the security list or lists that the subnet uses. Remember
// that security lists are associated *with the subnet*, but the
// rules are applied to the individual VNICs in the subnet.
SecurityListIds []string `mandatory:"false" json:"securityListIds"`
// The subnet's domain name, which consists of the subnet's DNS label,
// the VCN's DNS label, and the `oraclevcn.com` domain.
// For more information, see
// DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm).
// Example: `subnet123.vcn1.oraclevcn.com`
SubnetDomainName *string `mandatory:"false" json:"subnetDomainName"`
// The date and time the subnet was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}
func (m Subnet) String() string
func (m Subnet) 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
SubnetEndpoint Defines the details required for a SUBNET-type `Endpoint`.
type SubnetEndpoint struct {
// The IPv4 address of the `Endpoint`.
Address *string `mandatory:"true" json:"address"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet containing the IP address.
// This can be used to disambiguate which subnet is intended, in case the IP address
// is used in more than one subnet (when there are subnets with overlapping IP ranges).
SubnetId *string `mandatory:"true" json:"subnetId"`
}
func (m SubnetEndpoint) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SubnetEndpoint) String() string
func (m SubnetEndpoint) 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
SubnetLifecycleStateEnum Enum with underlying type: string
type SubnetLifecycleStateEnum string
Set of constants representing the allowable values for SubnetLifecycleStateEnum
const (
SubnetLifecycleStateProvisioning SubnetLifecycleStateEnum = "PROVISIONING"
SubnetLifecycleStateAvailable SubnetLifecycleStateEnum = "AVAILABLE"
SubnetLifecycleStateTerminating SubnetLifecycleStateEnum = "TERMINATING"
SubnetLifecycleStateTerminated SubnetLifecycleStateEnum = "TERMINATED"
SubnetLifecycleStateUpdating SubnetLifecycleStateEnum = "UPDATING"
)
func GetMappingSubnetLifecycleStateEnum(val string) (SubnetLifecycleStateEnum, bool)
GetMappingSubnetLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSubnetLifecycleStateEnumValues() []SubnetLifecycleStateEnum
GetSubnetLifecycleStateEnumValues Enumerates the set of values for SubnetLifecycleStateEnum
SubnetTopology Defines the visualization of a subnet in a VCN.
type SubnetTopology struct {
// Lists entities comprising the virtual network topology.
Entities []interface{} `mandatory:"true" json:"entities"`
// Lists relationships between entities in the virtual network topology.
Relationships []TopologyEntityRelationship `mandatory:"true" json:"relationships"`
// Lists entities that are limited during ingestion.
// The values for the items in the list are the entity type names of the limitedEntities.
// Example: `vcn`
LimitedEntities []string `mandatory:"true" json:"limitedEntities"`
// Records when the virtual network topology was created, in RFC3339 (https://tools.ietf.org/html/rfc3339) format for date and time.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet for which the visualization is generated.
SubnetId *string `mandatory:"false" json:"subnetId"`
}
func (m SubnetTopology) GetEntities() []interface{}
GetEntities returns Entities
func (m SubnetTopology) GetLimitedEntities() []string
GetLimitedEntities returns LimitedEntities
func (m SubnetTopology) GetRelationships() []TopologyEntityRelationship
GetRelationships returns Relationships
func (m SubnetTopology) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m SubnetTopology) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SubnetTopology) String() string
func (m *SubnetTopology) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m SubnetTopology) 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
TcpOptions Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.
type TcpOptions struct {
DestinationPortRange *PortRange `mandatory:"false" json:"destinationPortRange"`
SourcePortRange *PortRange `mandatory:"false" json:"sourcePortRange"`
}
func (m TcpOptions) String() string
func (m TcpOptions) 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
TcpProtocolParameters Defines the configuration for TCP protocol parameters.
type TcpProtocolParameters struct {
// The destination port to use in a `PathAnalyzerTest` resource.
DestinationPort *int `mandatory:"true" json:"destinationPort"`
// The source port to use in a `PathAnalyzerTest` resource.
SourcePort *int `mandatory:"false" json:"sourcePort"`
}
func (m TcpProtocolParameters) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TcpProtocolParameters) String() string
func (m TcpProtocolParameters) 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
TcpTrafficProtocolParameters Defines the `TrafficProtocolParameters` configuration for the TCP protocol.
type TcpTrafficProtocolParameters struct {
// The destination port to use in a `PathAnalyzerTest`.
DestinationPort *int `mandatory:"true" json:"destinationPort"`
// The source port to use in a `PathAnalyzerTest`.
SourcePort *int `mandatory:"false" json:"sourcePort"`
}
func (m TcpTrafficProtocolParameters) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TcpTrafficProtocolParameters) String() string
func (m TcpTrafficProtocolParameters) 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
Topology Defines the representation of a virtual network topology.
type Topology interface {
// Lists entities comprising the virtual network topology.
GetEntities() []interface{}
// Lists relationships between entities in the virtual network topology.
GetRelationships() []TopologyEntityRelationship
// Lists entities that are limited during ingestion.
// The values for the items in the list are the entity type names of the limitedEntities.
// Example: `vcn`
GetLimitedEntities() []string
// Records when the virtual network topology was created, in RFC3339 (https://tools.ietf.org/html/rfc3339) format for date and time.
GetTimeCreated() *common.SDKTime
}
TopologyAssociatedWithEntityRelationship Defines the `AssociatedWith` relationship between virtual network topology entities. An `AssociatedWith` relationship is defined when there is no obvious `contains` relationship but entities are still related. For example, a DRG is associated with a VCN because a DRG is not managed by VCN but can be attached to a VCN.
type TopologyAssociatedWithEntityRelationship struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the first entity in the relationship.
Id1 *string `mandatory:"true" json:"id1"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the second entity in the relationship.
Id2 *string `mandatory:"true" json:"id2"`
AssociatedWithDetails *TopologyAssociatedWithRelationshipDetails `mandatory:"false" json:"associatedWithDetails"`
}
func (m TopologyAssociatedWithEntityRelationship) GetId1() *string
GetId1 returns Id1
func (m TopologyAssociatedWithEntityRelationship) GetId2() *string
GetId2 returns Id2
func (m TopologyAssociatedWithEntityRelationship) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TopologyAssociatedWithEntityRelationship) String() string
func (m TopologyAssociatedWithEntityRelationship) 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
TopologyAssociatedWithRelationshipDetails Defines association details for an `associatedWith` relationship.
type TopologyAssociatedWithRelationshipDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the entities via which the relationship is created. For example an instance is associated with a network security group via the VNIC attachment and the VNIC.
Via []string `mandatory:"false" json:"via"`
}
func (m TopologyAssociatedWithRelationshipDetails) String() string
func (m TopologyAssociatedWithRelationshipDetails) 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
TopologyContainsEntityRelationship Defines the `contains` relationship between virtual network topology entities. A `Contains` relationship is defined when an entity fully owns, contains or manages another entity. For example, a subnet is contained and managed in the scope of a VCN, therefore a VCN has a `contains` relationship to a subnet.
type TopologyContainsEntityRelationship struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the first entity in the relationship.
Id1 *string `mandatory:"true" json:"id1"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the second entity in the relationship.
Id2 *string `mandatory:"true" json:"id2"`
}
func (m TopologyContainsEntityRelationship) GetId1() *string
GetId1 returns Id1
func (m TopologyContainsEntityRelationship) GetId2() *string
GetId2 returns Id2
func (m TopologyContainsEntityRelationship) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TopologyContainsEntityRelationship) String() string
func (m TopologyContainsEntityRelationship) 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
TopologyEntityRelationship Defines the relationship between Virtual Network topology entities.
type TopologyEntityRelationship interface {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the first entity in the relationship.
GetId1() *string
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the second entity in the relationship.
GetId2() *string
}
TopologyEntityRelationshipTypeEnum Enum with underlying type: string
type TopologyEntityRelationshipTypeEnum string
Set of constants representing the allowable values for TopologyEntityRelationshipTypeEnum
const (
TopologyEntityRelationshipTypeContains TopologyEntityRelationshipTypeEnum = "CONTAINS"
TopologyEntityRelationshipTypeAssociatedWith TopologyEntityRelationshipTypeEnum = "ASSOCIATED_WITH"
TopologyEntityRelationshipTypeRoutesTo TopologyEntityRelationshipTypeEnum = "ROUTES_TO"
)
func GetMappingTopologyEntityRelationshipTypeEnum(val string) (TopologyEntityRelationshipTypeEnum, bool)
GetMappingTopologyEntityRelationshipTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTopologyEntityRelationshipTypeEnumValues() []TopologyEntityRelationshipTypeEnum
GetTopologyEntityRelationshipTypeEnumValues Enumerates the set of values for TopologyEntityRelationshipTypeEnum
TopologyRoutesToEntityRelationship Defines the `routesTo` relationship between virtual network topology entities. A `RoutesTo` relationship is defined when a routing table and a routing rule are used to govern how to route traffic from one entity to another. For example, a DRG might have a routing rule to send certain traffic to an LPG.
type TopologyRoutesToEntityRelationship struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the first entity in the relationship.
Id1 *string `mandatory:"true" json:"id1"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the second entity in the relationship.
Id2 *string `mandatory:"true" json:"id2"`
RouteRuleDetails *TopologyRoutesToRelationshipDetails `mandatory:"true" json:"routeRuleDetails"`
}
func (m TopologyRoutesToEntityRelationship) GetId1() *string
GetId1 returns Id1
func (m TopologyRoutesToEntityRelationship) GetId2() *string
GetId2 returns Id2
func (m TopologyRoutesToEntityRelationship) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TopologyRoutesToEntityRelationship) String() string
func (m TopologyRoutesToEntityRelationship) 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
TopologyRoutesToRelationshipDetails Defines route rule details for a `routesTo` relationship.
type TopologyRoutesToRelationshipDetails struct {
// The destinationType can be set to one of two values:
// * Use `CIDR_BLOCK` if the rule's `destination` is an IP address range in CIDR notation.
// * Use `SERVICE_CIDR_BLOCK` if the rule's `destination` is the `cidrBlock` value for a Service.
DestinationType *string `mandatory:"true" json:"destinationType"`
// An IP address range in CIDR notation or the `cidrBlock` value for a Service.
Destination *string `mandatory:"true" json:"destination"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the routing table that contains the route rule.
RouteTableId *string `mandatory:"true" json:"routeTableId"`
// A route rule can be `STATIC` if manually added to the route table or `DYNAMIC` if imported from another route table.
RouteType TopologyRoutesToRelationshipDetailsRouteTypeEnum `mandatory:"false" json:"routeType,omitempty"`
}
func (m TopologyRoutesToRelationshipDetails) String() string
func (m TopologyRoutesToRelationshipDetails) 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
TopologyRoutesToRelationshipDetailsRouteTypeEnum Enum with underlying type: string
type TopologyRoutesToRelationshipDetailsRouteTypeEnum string
Set of constants representing the allowable values for TopologyRoutesToRelationshipDetailsRouteTypeEnum
const (
TopologyRoutesToRelationshipDetailsRouteTypeStatic TopologyRoutesToRelationshipDetailsRouteTypeEnum = "STATIC"
TopologyRoutesToRelationshipDetailsRouteTypeDynamic TopologyRoutesToRelationshipDetailsRouteTypeEnum = "DYNAMIC"
)
func GetMappingTopologyRoutesToRelationshipDetailsRouteTypeEnum(val string) (TopologyRoutesToRelationshipDetailsRouteTypeEnum, bool)
GetMappingTopologyRoutesToRelationshipDetailsRouteTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTopologyRoutesToRelationshipDetailsRouteTypeEnumValues() []TopologyRoutesToRelationshipDetailsRouteTypeEnum
GetTopologyRoutesToRelationshipDetailsRouteTypeEnumValues Enumerates the set of values for TopologyRoutesToRelationshipDetailsRouteTypeEnum
TopologyTypeEnum Enum with underlying type: string
type TopologyTypeEnum string
Set of constants representing the allowable values for TopologyTypeEnum
const (
TopologyTypeNetworking TopologyTypeEnum = "NETWORKING"
TopologyTypeVcn TopologyTypeEnum = "VCN"
TopologyTypeSubnet TopologyTypeEnum = "SUBNET"
TopologyTypePath TopologyTypeEnum = "PATH"
)
func GetMappingTopologyTypeEnum(val string) (TopologyTypeEnum, bool)
GetMappingTopologyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTopologyTypeEnumValues() []TopologyTypeEnum
GetTopologyTypeEnumValues Enumerates the set of values for TopologyTypeEnum
TrafficNode Defines the configuration of the OCI entity that represents a traffic node in `PathAnalysisResult`.
type TrafficNode interface {
GetEgressTraffic() *EgressTrafficSpec
GetNextHopRoutingAction() RoutingAction
GetEgressSecurityAction() SecurityAction
GetIngressSecurityAction() SecurityAction
}
TrafficNodeTypeEnum Enum with underlying type: string
type TrafficNodeTypeEnum string
Set of constants representing the allowable values for TrafficNodeTypeEnum
const (
TrafficNodeTypeVisible TrafficNodeTypeEnum = "VISIBLE"
TrafficNodeTypeAccessDenied TrafficNodeTypeEnum = "ACCESS_DENIED"
)
func GetMappingTrafficNodeTypeEnum(val string) (TrafficNodeTypeEnum, bool)
GetMappingTrafficNodeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTrafficNodeTypeEnumValues() []TrafficNodeTypeEnum
GetTrafficNodeTypeEnumValues Enumerates the set of values for TrafficNodeTypeEnum
TrafficProtocolParameters Defines the traffic protocol parameters for the traffic in a `PathAnalysisResult`.
type TrafficProtocolParameters interface {
}
TrafficProtocolParametersTypeEnum Enum with underlying type: string
type TrafficProtocolParametersTypeEnum string
Set of constants representing the allowable values for TrafficProtocolParametersTypeEnum
const (
TrafficProtocolParametersTypeTcp TrafficProtocolParametersTypeEnum = "TCP"
TrafficProtocolParametersTypeUdp TrafficProtocolParametersTypeEnum = "UDP"
TrafficProtocolParametersTypeIcmp TrafficProtocolParametersTypeEnum = "ICMP"
)
func GetMappingTrafficProtocolParametersTypeEnum(val string) (TrafficProtocolParametersTypeEnum, bool)
GetMappingTrafficProtocolParametersTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTrafficProtocolParametersTypeEnumValues() []TrafficProtocolParametersTypeEnum
GetTrafficProtocolParametersTypeEnumValues Enumerates the set of values for TrafficProtocolParametersTypeEnum
TrafficRoute Defines the traffic route taken in the path in `PathAnalysisResult`.
type TrafficRoute struct {
// Reachability status for the given traffic route.
ReachabilityStatus TrafficRouteReachabilityStatusEnum `mandatory:"true" json:"reachabilityStatus"`
// The ordered sequence of nodes in the given the traffic route forming a path.
Nodes []TrafficNode `mandatory:"true" json:"nodes"`
// A description of the traffic route analysis. For example: "Traffic might not reach a destination
// due to the LB backend being unhealthy".
RouteAnalysisDescription *string `mandatory:"false" json:"routeAnalysisDescription"`
}
func (m TrafficRoute) String() string
func (m *TrafficRoute) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m TrafficRoute) 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
TrafficRouteReachabilityStatusEnum Enum with underlying type: string
type TrafficRouteReachabilityStatusEnum string
Set of constants representing the allowable values for TrafficRouteReachabilityStatusEnum
const (
TrafficRouteReachabilityStatusReachable TrafficRouteReachabilityStatusEnum = "REACHABLE"
TrafficRouteReachabilityStatusUnreachable TrafficRouteReachabilityStatusEnum = "UNREACHABLE"
TrafficRouteReachabilityStatusIndeterminate TrafficRouteReachabilityStatusEnum = "INDETERMINATE"
)
func GetMappingTrafficRouteReachabilityStatusEnum(val string) (TrafficRouteReachabilityStatusEnum, bool)
GetMappingTrafficRouteReachabilityStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTrafficRouteReachabilityStatusEnumValues() []TrafficRouteReachabilityStatusEnum
GetTrafficRouteReachabilityStatusEnumValues Enumerates the set of values for TrafficRouteReachabilityStatusEnum
TunnelConfig Deprecated. For tunnel information, instead see:
type TunnelConfig struct {
// The IP address of Oracle's VPN headend.
// Example: `203.0.113.50 `
IpAddress *string `mandatory:"true" json:"ipAddress"`
// The shared secret of the IPSec tunnel.
SharedSecret *string `mandatory:"true" json:"sharedSecret"`
// The date and time the IPSec connection was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}
func (m TunnelConfig) String() string
func (m TunnelConfig) 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
TunnelCpeDeviceConfig The set of CPE configuration answers for the tunnel, which the customer provides in UpdateTunnelCpeDeviceConfig. The answers correlate to the questions that are specific to the CPE device type (see the `parameters` attribute of CpeDeviceShapeDetail). See these related operations:
type TunnelCpeDeviceConfig struct {
TunnelCpeDeviceConfigParameter []CpeDeviceConfigAnswer `mandatory:"false" json:"tunnelCpeDeviceConfigParameter"`
}
func (m TunnelCpeDeviceConfig) String() string
func (m TunnelCpeDeviceConfig) 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
TunnelPhaseOneDetails IPSec tunnel details specific to ISAKMP phase one.
type TunnelPhaseOneDetails struct {
// Indicates whether custom phase one configuration is enabled.
// If this option is not enabled, default settings are proposed.
IsCustomPhaseOneConfig *bool `mandatory:"false" json:"isCustomPhaseOneConfig"`
// The total configured lifetime of the IKE security association.
Lifetime *int64 `mandatory:"false" json:"lifetime"`
// The remaining lifetime before the key is refreshed.
RemainingLifetime *int64 `mandatory:"false" json:"remainingLifetime"`
// The proposed custom authentication algorithm.
CustomAuthenticationAlgorithm *string `mandatory:"false" json:"customAuthenticationAlgorithm"`
// The negotiated authentication algorithm.
NegotiatedAuthenticationAlgorithm *string `mandatory:"false" json:"negotiatedAuthenticationAlgorithm"`
// The proposed custom encryption algorithm.
CustomEncryptionAlgorithm *string `mandatory:"false" json:"customEncryptionAlgorithm"`
// The negotiated encryption algorithm.
NegotiatedEncryptionAlgorithm *string `mandatory:"false" json:"negotiatedEncryptionAlgorithm"`
// The proposed custom Diffie-Hellman group.
CustomDhGroup *string `mandatory:"false" json:"customDhGroup"`
// The negotiated Diffie-Hellman group.
NegotiatedDhGroup *string `mandatory:"false" json:"negotiatedDhGroup"`
// Indicates whether IKE phase one is established.
IsIkeEstablished *bool `mandatory:"false" json:"isIkeEstablished"`
// The date and time we retrieved the remaining lifetime, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
RemainingLifetimeLastRetrieved *common.SDKTime `mandatory:"false" json:"remainingLifetimeLastRetrieved"`
}
func (m TunnelPhaseOneDetails) String() string
func (m TunnelPhaseOneDetails) 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
TunnelPhaseTwoDetails IPsec tunnel detail information specific to phase two.
type TunnelPhaseTwoDetails struct {
// Indicates whether custom phase two configuration is enabled.
// If this option is not enabled, default settings are proposed.
IsCustomPhaseTwoConfig *bool `mandatory:"false" json:"isCustomPhaseTwoConfig"`
// The total configured lifetime of the IKE security association.
Lifetime *int64 `mandatory:"false" json:"lifetime"`
// The remaining lifetime before the key is refreshed.
RemainingLifetime *int64 `mandatory:"false" json:"remainingLifetime"`
// Phase two authentication algorithm proposed during tunnel negotiation.
CustomAuthenticationAlgorithm *string `mandatory:"false" json:"customAuthenticationAlgorithm"`
// The negotiated phase two authentication algorithm.
NegotiatedAuthenticationAlgorithm *string `mandatory:"false" json:"negotiatedAuthenticationAlgorithm"`
// The proposed custom phase two encryption algorithm.
CustomEncryptionAlgorithm *string `mandatory:"false" json:"customEncryptionAlgorithm"`
// The negotiated encryption algorithm.
NegotiatedEncryptionAlgorithm *string `mandatory:"false" json:"negotiatedEncryptionAlgorithm"`
// The proposed Diffie-Hellman group.
DhGroup *string `mandatory:"false" json:"dhGroup"`
// The negotiated Diffie-Hellman group.
NegotiatedDhGroup *string `mandatory:"false" json:"negotiatedDhGroup"`
// Indicates that ESP phase two is established.
IsEspEstablished *bool `mandatory:"false" json:"isEspEstablished"`
// Indicates that PFS (perfect forward secrecy) is enabled.
IsPfsEnabled *bool `mandatory:"false" json:"isPfsEnabled"`
// The date and time the remaining lifetime was last retrieved, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
RemainingLifetimeLastRetrieved *common.SDKTime `mandatory:"false" json:"remainingLifetimeLastRetrieved"`
}
func (m TunnelPhaseTwoDetails) String() string
func (m TunnelPhaseTwoDetails) 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
TunnelRouteSummary A summary of the routes advertised to and received from the on-premises network.
type TunnelRouteSummary struct {
// The BGP network layer reachability information.
Prefix *string `mandatory:"false" json:"prefix"`
// The age of the route.
Age *int64 `mandatory:"false" json:"age"`
// Indicates this is the best route.
IsBestPath *bool `mandatory:"false" json:"isBestPath"`
// A list of ASNs in AS_Path.
AsPath []int `mandatory:"false" json:"asPath"`
// The source of the route advertisement.
Advertiser TunnelRouteSummaryAdvertiserEnum `mandatory:"false" json:"advertiser,omitempty"`
}
func (m TunnelRouteSummary) String() string
func (m TunnelRouteSummary) 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
TunnelRouteSummaryAdvertiserEnum Enum with underlying type: string
type TunnelRouteSummaryAdvertiserEnum string
Set of constants representing the allowable values for TunnelRouteSummaryAdvertiserEnum
const (
TunnelRouteSummaryAdvertiserCustomer TunnelRouteSummaryAdvertiserEnum = "CUSTOMER"
TunnelRouteSummaryAdvertiserOracle TunnelRouteSummaryAdvertiserEnum = "ORACLE"
)
func GetMappingTunnelRouteSummaryAdvertiserEnum(val string) (TunnelRouteSummaryAdvertiserEnum, bool)
GetMappingTunnelRouteSummaryAdvertiserEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTunnelRouteSummaryAdvertiserEnumValues() []TunnelRouteSummaryAdvertiserEnum
GetTunnelRouteSummaryAdvertiserEnumValues Enumerates the set of values for TunnelRouteSummaryAdvertiserEnum
TunnelSecurityAssociationSummary A summary of the IPSec tunnel security association details.
type TunnelSecurityAssociationSummary struct {
// The IP address and mask of the partner subnet used in policy based VPNs or static routes.
CpeSubnet *string `mandatory:"false" json:"cpeSubnet"`
// The IP address and mask of the local subnet used in policy based VPNs or static routes.
OracleSubnet *string `mandatory:"false" json:"oracleSubnet"`
// The IPSec tunnel's phase one status.
TunnelSaStatus TunnelSecurityAssociationSummaryTunnelSaStatusEnum `mandatory:"false" json:"tunnelSaStatus,omitempty"`
// Current state if the IPSec tunnel status is not `UP`, including phase one and phase two details and a possible reason the tunnel is not `UP`.
TunnelSaErrorInfo *string `mandatory:"false" json:"tunnelSaErrorInfo"`
// Time in the current state, in seconds.
Time *string `mandatory:"false" json:"time"`
}
func (m TunnelSecurityAssociationSummary) String() string
func (m TunnelSecurityAssociationSummary) 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
TunnelSecurityAssociationSummaryTunnelSaStatusEnum Enum with underlying type: string
type TunnelSecurityAssociationSummaryTunnelSaStatusEnum string
Set of constants representing the allowable values for TunnelSecurityAssociationSummaryTunnelSaStatusEnum
const (
TunnelSecurityAssociationSummaryTunnelSaStatusInitiating TunnelSecurityAssociationSummaryTunnelSaStatusEnum = "INITIATING"
TunnelSecurityAssociationSummaryTunnelSaStatusListening TunnelSecurityAssociationSummaryTunnelSaStatusEnum = "LISTENING"
TunnelSecurityAssociationSummaryTunnelSaStatusUp TunnelSecurityAssociationSummaryTunnelSaStatusEnum = "UP"
TunnelSecurityAssociationSummaryTunnelSaStatusDown TunnelSecurityAssociationSummaryTunnelSaStatusEnum = "DOWN"
TunnelSecurityAssociationSummaryTunnelSaStatusError TunnelSecurityAssociationSummaryTunnelSaStatusEnum = "ERROR"
TunnelSecurityAssociationSummaryTunnelSaStatusUnknown TunnelSecurityAssociationSummaryTunnelSaStatusEnum = "UNKNOWN"
)
func GetMappingTunnelSecurityAssociationSummaryTunnelSaStatusEnum(val string) (TunnelSecurityAssociationSummaryTunnelSaStatusEnum, bool)
GetMappingTunnelSecurityAssociationSummaryTunnelSaStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTunnelSecurityAssociationSummaryTunnelSaStatusEnumValues() []TunnelSecurityAssociationSummaryTunnelSaStatusEnum
GetTunnelSecurityAssociationSummaryTunnelSaStatusEnumValues Enumerates the set of values for TunnelSecurityAssociationSummaryTunnelSaStatusEnum
TunnelStatus Deprecated. For tunnel information, instead see IPSecConnectionTunnel.
type TunnelStatus struct {
// The IP address of Oracle's VPN headend.
// Example: `203.0.113.50`
IpAddress *string `mandatory:"true" json:"ipAddress"`
// The tunnel's current state.
LifecycleState TunnelStatusLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The date and time the IPSec connection was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// When the state of the tunnel last changed, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeStateModified *common.SDKTime `mandatory:"false" json:"timeStateModified"`
}
func (m TunnelStatus) String() string
func (m TunnelStatus) 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
TunnelStatusLifecycleStateEnum Enum with underlying type: string
type TunnelStatusLifecycleStateEnum string
Set of constants representing the allowable values for TunnelStatusLifecycleStateEnum
const (
TunnelStatusLifecycleStateUp TunnelStatusLifecycleStateEnum = "UP"
TunnelStatusLifecycleStateDown TunnelStatusLifecycleStateEnum = "DOWN"
TunnelStatusLifecycleStateDownForMaintenance TunnelStatusLifecycleStateEnum = "DOWN_FOR_MAINTENANCE"
TunnelStatusLifecycleStatePartialUp TunnelStatusLifecycleStateEnum = "PARTIAL_UP"
)
func GetMappingTunnelStatusLifecycleStateEnum(val string) (TunnelStatusLifecycleStateEnum, bool)
GetMappingTunnelStatusLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTunnelStatusLifecycleStateEnumValues() []TunnelStatusLifecycleStateEnum
GetTunnelStatusLifecycleStateEnumValues Enumerates the set of values for TunnelStatusLifecycleStateEnum
UdpOptions Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.
type UdpOptions struct {
DestinationPortRange *PortRange `mandatory:"false" json:"destinationPortRange"`
SourcePortRange *PortRange `mandatory:"false" json:"sourcePortRange"`
}
func (m UdpOptions) String() string
func (m UdpOptions) 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
UdpProtocolParameters Defines the configuration for UDP protocol parameters.
type UdpProtocolParameters struct {
// The destination port to use in a `PathAnalyzerTest` resource.
DestinationPort *int `mandatory:"true" json:"destinationPort"`
// The source port to use in a `PathAnalyzerTest` resource.
SourcePort *int `mandatory:"false" json:"sourcePort"`
}
func (m UdpProtocolParameters) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UdpProtocolParameters) String() string
func (m UdpProtocolParameters) 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
UdpTrafficProtocolParameters Defines the `TrafficProtocolParameters` configuration for the UDP protocol.
type UdpTrafficProtocolParameters struct {
// The destination port to use in a `PathAnalyzerTest`.
DestinationPort *int `mandatory:"true" json:"destinationPort"`
// The source port to use in a `PathAnalyzerTest`.
SourcePort *int `mandatory:"false" json:"sourcePort"`
}
func (m UdpTrafficProtocolParameters) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UdpTrafficProtocolParameters) String() string
func (m UdpTrafficProtocolParameters) 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
UpdateByoipRangeDetails The information used to update a `ByoipRange` resource.
type UpdateByoipRangeDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m UpdateByoipRangeDetails) String() string
func (m UpdateByoipRangeDetails) 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
UpdateCaptureFilterDetails These details can be included in a request to update a capture filter. A capture filter contains a set of rules governing what traffic a VTAP mirrors.
type UpdateCaptureFilterDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The set of rules governing what traffic a VTAP mirrors.
VtapCaptureFilterRules []VtapCaptureFilterRuleDetails `mandatory:"false" json:"vtapCaptureFilterRules"`
// The set of rules governing what traffic the Flow Log collects when creating a flow log capture filter.
FlowLogCaptureFilterRules []FlowLogCaptureFilterRuleDetails `mandatory:"false" json:"flowLogCaptureFilterRules"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m UpdateCaptureFilterDetails) String() string
func (m UpdateCaptureFilterDetails) 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
UpdateCpeDetails The representation of UpdateCpeDetails
type UpdateCpeDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the CPE device type. You can provide
// a value if you want to generate CPE device configuration content for IPSec connections
// that use this CPE. For a list of possible values, see
// ListCpeDeviceShapes.
// For more information about generating CPE device configuration content, see:
// * GetCpeDeviceConfigContent
// * GetIpsecCpeDeviceConfigContent
// * GetTunnelCpeDeviceConfigContent
// * GetTunnelCpeDeviceConfig
CpeDeviceShapeId *string `mandatory:"false" json:"cpeDeviceShapeId"`
}
func (m UpdateCpeDetails) String() string
func (m UpdateCpeDetails) 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
UpdateCrossConnectDetails Update a CrossConnect
type UpdateCrossConnectDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Set to true to activate the cross-connect. You activate it after the physical cabling
// is complete, and you've confirmed the cross-connect's light levels are good and your side
// of the interface is up. Activation indicates to Oracle that the physical connection is ready.
// Example: `true`
IsActive *bool `mandatory:"false" json:"isActive"`
// A reference name or identifier for the physical fiber connection this cross-connect uses.
CustomerReferenceName *string `mandatory:"false" json:"customerReferenceName"`
MacsecProperties *UpdateMacsecProperties `mandatory:"false" json:"macsecProperties"`
}
func (m UpdateCrossConnectDetails) String() string
func (m UpdateCrossConnectDetails) 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
UpdateCrossConnectGroupDetails The representation of UpdateCrossConnectGroupDetails
type UpdateCrossConnectGroupDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A reference name or identifier for the physical fiber connection this cross-connect group uses.
CustomerReferenceName *string `mandatory:"false" json:"customerReferenceName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
MacsecProperties *UpdateMacsecProperties `mandatory:"false" json:"macsecProperties"`
}
func (m UpdateCrossConnectGroupDetails) String() string
func (m UpdateCrossConnectGroupDetails) 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
UpdateDhcpDetails The representation of UpdateDhcpDetails
type UpdateDhcpDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
Options []DhcpOption `mandatory:"false" json:"options"`
// The search domain name type of DHCP options
DomainNameType UpdateDhcpDetailsDomainNameTypeEnum `mandatory:"false" json:"domainNameType,omitempty"`
}
func (m UpdateDhcpDetails) String() string
func (m *UpdateDhcpDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateDhcpDetails) 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
UpdateDhcpDetailsDomainNameTypeEnum Enum with underlying type: string
type UpdateDhcpDetailsDomainNameTypeEnum string
Set of constants representing the allowable values for UpdateDhcpDetailsDomainNameTypeEnum
const (
UpdateDhcpDetailsDomainNameTypeSubnetDomain UpdateDhcpDetailsDomainNameTypeEnum = "SUBNET_DOMAIN"
UpdateDhcpDetailsDomainNameTypeVcnDomain UpdateDhcpDetailsDomainNameTypeEnum = "VCN_DOMAIN"
UpdateDhcpDetailsDomainNameTypeCustomDomain UpdateDhcpDetailsDomainNameTypeEnum = "CUSTOM_DOMAIN"
)
func GetMappingUpdateDhcpDetailsDomainNameTypeEnum(val string) (UpdateDhcpDetailsDomainNameTypeEnum, bool)
GetMappingUpdateDhcpDetailsDomainNameTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateDhcpDetailsDomainNameTypeEnumValues() []UpdateDhcpDetailsDomainNameTypeEnum
GetUpdateDhcpDetailsDomainNameTypeEnumValues Enumerates the set of values for UpdateDhcpDetailsDomainNameTypeEnum
UpdateDrgAttachmentDetails The representation of UpdateDrgAttachmentDetails
type UpdateDrgAttachmentDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table that is assigned to this attachment.
// The DRG route table manages traffic inside the DRG.
// You can't remove a DRG route table from a DRG attachment, but you can reassign which
// DRG route table it uses.
DrgRouteTableId *string `mandatory:"false" json:"drgRouteTableId"`
NetworkDetails DrgAttachmentNetworkUpdateDetails `mandatory:"false" json:"networkDetails"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the export route distribution used to specify how routes in the assigned DRG route table
// are advertised out through the attachment.
// If this value is null, no routes are advertised through this attachment.
ExportDrgRouteDistributionId *string `mandatory:"false" json:"exportDrgRouteDistributionId"`
// This is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table that is used to route the traffic as it enters a VCN through this attachment.
// For information about why you would associate a route table with a DRG attachment, see:
// * Transit Routing: Access to Multiple VCNs in Same Region (https://docs.oracle.com/iaas/Content/Network/Tasks/transitrouting.htm)
// * Transit Routing: Private Access to Oracle Services (https://docs.oracle.com/iaas/Content/Network/Tasks/transitroutingoracleservices.htm)
RouteTableId *string `mandatory:"false" json:"routeTableId"`
}
func (m UpdateDrgAttachmentDetails) String() string
func (m *UpdateDrgAttachmentDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateDrgAttachmentDetails) 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
UpdateDrgDetails The representation of UpdateDrgDetails
type UpdateDrgDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
DefaultDrgRouteTables *DefaultDrgRouteTables `mandatory:"false" json:"defaultDrgRouteTables"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m UpdateDrgDetails) String() string
func (m UpdateDrgDetails) 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
UpdateDrgRouteDistributionDetails Details used in a request to update a route distribution. You cannot assign a table to a virtual circuit or IPSec tunnel attachment if there is a static route rule for an RPC attachment.
type UpdateDrgRouteDistributionDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m UpdateDrgRouteDistributionDetails) String() string
func (m UpdateDrgRouteDistributionDetails) 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
UpdateDrgRouteDistributionStatementDetails Route distribution statements to update in the route distribution.
type UpdateDrgRouteDistributionStatementDetails struct {
// The Oracle-assigned ID of each route distribution statement to be updated.
Id *string `mandatory:"true" json:"id"`
// The action is applied only if all of the match criteria is met.
MatchCriteria []DrgRouteDistributionMatchCriteria `mandatory:"false" json:"matchCriteria"`
// The priority of the statement you'd like to update.
Priority *int `mandatory:"false" json:"priority"`
}
func (m UpdateDrgRouteDistributionStatementDetails) String() string
func (m *UpdateDrgRouteDistributionStatementDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateDrgRouteDistributionStatementDetails) 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
UpdateDrgRouteDistributionStatementsDetails Details request to update statements in a route distribution.
type UpdateDrgRouteDistributionStatementsDetails struct {
// The route distribution statements to update, and the details to be updated.
Statements []UpdateDrgRouteDistributionStatementDetails `mandatory:"true" json:"statements"`
}
func (m UpdateDrgRouteDistributionStatementsDetails) String() string
func (m UpdateDrgRouteDistributionStatementsDetails) 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
UpdateDrgRouteRuleDetails Details used to update a route rule in the DRG route table.
type UpdateDrgRouteRuleDetails struct {
// The Oracle-assigned ID of each DRG route rule to update.
Id *string `mandatory:"true" json:"id"`
// The range of IP addresses used for matching when routing traffic.
// Potential values:
// * IP address range in CIDR notation. Can be an IPv4 or IPv6 CIDR. For example: `192.168.1.0/24`
// or `2001:0db8:0123:45::/56`.
Destination *string `mandatory:"false" json:"destination"`
// Type of destination for the rule.
// Allowed values:
// * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.
DestinationType UpdateDrgRouteRuleDetailsDestinationTypeEnum `mandatory:"false" json:"destinationType,omitempty"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the next hop DRG attachment. The next hop DRG attachment is responsible
// for reaching the network destination.
NextHopDrgAttachmentId *string `mandatory:"false" json:"nextHopDrgAttachmentId"`
}
func (m UpdateDrgRouteRuleDetails) String() string
func (m UpdateDrgRouteRuleDetails) 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
UpdateDrgRouteRuleDetailsDestinationTypeEnum Enum with underlying type: string
type UpdateDrgRouteRuleDetailsDestinationTypeEnum string
Set of constants representing the allowable values for UpdateDrgRouteRuleDetailsDestinationTypeEnum
const (
UpdateDrgRouteRuleDetailsDestinationTypeCidrBlock UpdateDrgRouteRuleDetailsDestinationTypeEnum = "CIDR_BLOCK"
)
func GetMappingUpdateDrgRouteRuleDetailsDestinationTypeEnum(val string) (UpdateDrgRouteRuleDetailsDestinationTypeEnum, bool)
GetMappingUpdateDrgRouteRuleDetailsDestinationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateDrgRouteRuleDetailsDestinationTypeEnumValues() []UpdateDrgRouteRuleDetailsDestinationTypeEnum
GetUpdateDrgRouteRuleDetailsDestinationTypeEnumValues Enumerates the set of values for UpdateDrgRouteRuleDetailsDestinationTypeEnum
UpdateDrgRouteRulesDetails Details used to update route rules in a DRG route table.
type UpdateDrgRouteRulesDetails struct {
// The DRG rute rules to update.
RouteRules []UpdateDrgRouteRuleDetails `mandatory:"false" json:"routeRules"`
}
func (m UpdateDrgRouteRulesDetails) String() string
func (m UpdateDrgRouteRulesDetails) 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
UpdateDrgRouteTableDetails Details used in a request to update a DRG route table. You can't assign a table to a virtual circuit or IPSec tunnel attachment if there is a static route rule for an RPC attachment.
type UpdateDrgRouteTableDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution used to specify how incoming route advertisements through
// referenced attachements are inserted into the DRG route table.
ImportDrgRouteDistributionId *string `mandatory:"false" json:"importDrgRouteDistributionId"`
// If you want traffic to be routed using ECMP across your virtual circuits or IPSec tunnels to
// your on-prem networks, set this value to true on the route table.
IsEcmpEnabled *bool `mandatory:"false" json:"isEcmpEnabled"`
}
func (m UpdateDrgRouteTableDetails) String() string
func (m UpdateDrgRouteTableDetails) 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
UpdateInternetGatewayDetails The representation of UpdateInternetGatewayDetails
type UpdateInternetGatewayDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Whether the gateway is enabled.
IsEnabled *bool `mandatory:"false" json:"isEnabled"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the Internet Gateway is using.
RouteTableId *string `mandatory:"false" json:"routeTableId"`
}
func (m UpdateInternetGatewayDetails) String() string
func (m UpdateInternetGatewayDetails) 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
UpdateIpSecConnectionDetails The representation of UpdateIpSecConnectionDetails
type UpdateIpSecConnectionDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the
// fully qualified domain name (FQDN)). The type of identifier you provide here must correspond
// to the value for `cpeLocalIdentifierType`.
// For information about why you'd provide this value, see
// If Your CPE Is Behind a NAT Device (https://docs.oracle.com/iaas/Content/Network/Tasks/overviewIPsec.htm#nat).
// Example IP address: `10.0.3.3`
// Example hostname: `cpe.example.com`
CpeLocalIdentifier *string `mandatory:"false" json:"cpeLocalIdentifier"`
// The type of identifier for your CPE device. The value you provide here must correspond to the value
// for `cpeLocalIdentifier`.
CpeLocalIdentifierType UpdateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum `mandatory:"false" json:"cpeLocalIdentifierType,omitempty"`
// Static routes to the CPE. If you provide this attribute, it replaces the entire current set of
// static routes. A static route's CIDR must not be a multicast address or class E address.
// The CIDR can be either IPv4 or IPv6.
// IPv6 addressing is supported for all commercial and government regions.
// See IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// Example: `10.0.1.0/24`
// Example: `2001:db8::/32`
StaticRoutes []string `mandatory:"false" json:"staticRoutes"`
}
func (m UpdateIpSecConnectionDetails) String() string
func (m UpdateIpSecConnectionDetails) 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
UpdateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum Enum with underlying type: string
type UpdateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum string
Set of constants representing the allowable values for UpdateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum
const (
UpdateIpSecConnectionDetailsCpeLocalIdentifierTypeIpAddress UpdateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum = "IP_ADDRESS"
UpdateIpSecConnectionDetailsCpeLocalIdentifierTypeHostname UpdateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum = "HOSTNAME"
)
func GetMappingUpdateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum(val string) (UpdateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum, bool)
GetMappingUpdateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateIpSecConnectionDetailsCpeLocalIdentifierTypeEnumValues() []UpdateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum
GetUpdateIpSecConnectionDetailsCpeLocalIdentifierTypeEnumValues Enumerates the set of values for UpdateIpSecConnectionDetailsCpeLocalIdentifierTypeEnum
UpdateIpSecConnectionTunnelDetails The representation of UpdateIpSecConnectionTunnelDetails
type UpdateIpSecConnectionTunnelDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The type of routing to use for this tunnel (BGP dynamic routing, static routing, or policy-based routing).
Routing UpdateIpSecConnectionTunnelDetailsRoutingEnum `mandatory:"false" json:"routing,omitempty"`
// Internet Key Exchange protocol version.
IkeVersion UpdateIpSecConnectionTunnelDetailsIkeVersionEnum `mandatory:"false" json:"ikeVersion,omitempty"`
BgpSessionConfig *UpdateIpSecTunnelBgpSessionDetails `mandatory:"false" json:"bgpSessionConfig"`
// Indicates whether the Oracle end of the IPSec connection is able to initiate starting up the IPSec tunnel.
OracleInitiation UpdateIpSecConnectionTunnelDetailsOracleInitiationEnum `mandatory:"false" json:"oracleInitiation,omitempty"`
// By default (the `AUTO` setting), IKE sends packets with a source and destination port set to 500,
// and when it detects that the port used to forward packets has changed (most likely because a NAT device
// is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T.
// The `ENABLED` option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets.
// The `DISABLED` option directs IKE to completely refuse to negotiate NAT-T
// even if it senses there may be a NAT device in use.
NatTranslationEnabled UpdateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum `mandatory:"false" json:"natTranslationEnabled,omitempty"`
PhaseOneConfig *PhaseOneConfigDetails `mandatory:"false" json:"phaseOneConfig"`
PhaseTwoConfig *PhaseTwoConfigDetails `mandatory:"false" json:"phaseTwoConfig"`
DpdConfig *DpdConfig `mandatory:"false" json:"dpdConfig"`
EncryptionDomainConfig *UpdateIpSecTunnelEncryptionDomainDetails `mandatory:"false" json:"encryptionDomainConfig"`
}
func (m UpdateIpSecConnectionTunnelDetails) String() string
func (m UpdateIpSecConnectionTunnelDetails) 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
UpdateIpSecConnectionTunnelDetailsIkeVersionEnum Enum with underlying type: string
type UpdateIpSecConnectionTunnelDetailsIkeVersionEnum string
Set of constants representing the allowable values for UpdateIpSecConnectionTunnelDetailsIkeVersionEnum
const (
UpdateIpSecConnectionTunnelDetailsIkeVersionV1 UpdateIpSecConnectionTunnelDetailsIkeVersionEnum = "V1"
UpdateIpSecConnectionTunnelDetailsIkeVersionV2 UpdateIpSecConnectionTunnelDetailsIkeVersionEnum = "V2"
)
func GetMappingUpdateIpSecConnectionTunnelDetailsIkeVersionEnum(val string) (UpdateIpSecConnectionTunnelDetailsIkeVersionEnum, bool)
GetMappingUpdateIpSecConnectionTunnelDetailsIkeVersionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateIpSecConnectionTunnelDetailsIkeVersionEnumValues() []UpdateIpSecConnectionTunnelDetailsIkeVersionEnum
GetUpdateIpSecConnectionTunnelDetailsIkeVersionEnumValues Enumerates the set of values for UpdateIpSecConnectionTunnelDetailsIkeVersionEnum
UpdateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum Enum with underlying type: string
type UpdateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum string
Set of constants representing the allowable values for UpdateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum
const (
UpdateIpSecConnectionTunnelDetailsNatTranslationEnabledEnabled UpdateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum = "ENABLED"
UpdateIpSecConnectionTunnelDetailsNatTranslationEnabledDisabled UpdateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum = "DISABLED"
UpdateIpSecConnectionTunnelDetailsNatTranslationEnabledAuto UpdateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum = "AUTO"
)
func GetMappingUpdateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum(val string) (UpdateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum, bool)
GetMappingUpdateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateIpSecConnectionTunnelDetailsNatTranslationEnabledEnumValues() []UpdateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum
GetUpdateIpSecConnectionTunnelDetailsNatTranslationEnabledEnumValues Enumerates the set of values for UpdateIpSecConnectionTunnelDetailsNatTranslationEnabledEnum
UpdateIpSecConnectionTunnelDetailsOracleInitiationEnum Enum with underlying type: string
type UpdateIpSecConnectionTunnelDetailsOracleInitiationEnum string
Set of constants representing the allowable values for UpdateIpSecConnectionTunnelDetailsOracleInitiationEnum
const (
UpdateIpSecConnectionTunnelDetailsOracleInitiationInitiatorOrResponder UpdateIpSecConnectionTunnelDetailsOracleInitiationEnum = "INITIATOR_OR_RESPONDER"
UpdateIpSecConnectionTunnelDetailsOracleInitiationResponderOnly UpdateIpSecConnectionTunnelDetailsOracleInitiationEnum = "RESPONDER_ONLY"
)
func GetMappingUpdateIpSecConnectionTunnelDetailsOracleInitiationEnum(val string) (UpdateIpSecConnectionTunnelDetailsOracleInitiationEnum, bool)
GetMappingUpdateIpSecConnectionTunnelDetailsOracleInitiationEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateIpSecConnectionTunnelDetailsOracleInitiationEnumValues() []UpdateIpSecConnectionTunnelDetailsOracleInitiationEnum
GetUpdateIpSecConnectionTunnelDetailsOracleInitiationEnumValues Enumerates the set of values for UpdateIpSecConnectionTunnelDetailsOracleInitiationEnum
UpdateIpSecConnectionTunnelDetailsRoutingEnum Enum with underlying type: string
type UpdateIpSecConnectionTunnelDetailsRoutingEnum string
Set of constants representing the allowable values for UpdateIpSecConnectionTunnelDetailsRoutingEnum
const (
UpdateIpSecConnectionTunnelDetailsRoutingBgp UpdateIpSecConnectionTunnelDetailsRoutingEnum = "BGP"
UpdateIpSecConnectionTunnelDetailsRoutingStatic UpdateIpSecConnectionTunnelDetailsRoutingEnum = "STATIC"
UpdateIpSecConnectionTunnelDetailsRoutingPolicy UpdateIpSecConnectionTunnelDetailsRoutingEnum = "POLICY"
)
func GetMappingUpdateIpSecConnectionTunnelDetailsRoutingEnum(val string) (UpdateIpSecConnectionTunnelDetailsRoutingEnum, bool)
GetMappingUpdateIpSecConnectionTunnelDetailsRoutingEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateIpSecConnectionTunnelDetailsRoutingEnumValues() []UpdateIpSecConnectionTunnelDetailsRoutingEnum
GetUpdateIpSecConnectionTunnelDetailsRoutingEnumValues Enumerates the set of values for UpdateIpSecConnectionTunnelDetailsRoutingEnum
UpdateIpSecConnectionTunnelSharedSecretDetails The representation of UpdateIpSecConnectionTunnelSharedSecretDetails
type UpdateIpSecConnectionTunnelSharedSecretDetails struct {
// The shared secret (pre-shared key) to use for the tunnel. Only numbers, letters, and spaces
// are allowed.
SharedSecret *string `mandatory:"false" json:"sharedSecret"`
}
func (m UpdateIpSecConnectionTunnelSharedSecretDetails) String() string
func (m UpdateIpSecConnectionTunnelSharedSecretDetails) 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
UpdateIpSecTunnelBgpSessionDetails The representation of UpdateIpSecTunnelBgpSessionDetails
type UpdateIpSecTunnelBgpSessionDetails struct {
// The IP address for the Oracle end of the inside tunnel interface.
// If the tunnel's `routing` attribute is set to `BGP`
// (see UpdateIPSecConnectionTunnelDetails), this IP address
// is used for the tunnel's BGP session.
// If `routing` is instead set to `STATIC`, you can set this IP address to troubleshoot or
// monitor the tunnel.
// The value must be a /30 or /31.
// If you are switching the tunnel from using BGP dynamic routing to static routing and want
// to remove the value for `oracleInterfaceIp`, you can set the value to an empty string.
// Example: `10.0.0.4/31`
OracleInterfaceIp *string `mandatory:"false" json:"oracleInterfaceIp"`
// The IP address for the CPE end of the inside tunnel interface.
// If the tunnel's `routing` attribute is set to `BGP`
// (see UpdateIPSecConnectionTunnelDetails), this IP address
// is used for the tunnel's BGP session.
// If `routing` is instead set to `STATIC`, you can set this IP address to troubleshoot or
// monitor the tunnel.
// The value must be a /30 or /31.
// If you are switching the tunnel from using BGP dynamic routing to static routing and want
// to remove the value for `customerInterfaceIp`, you can set the value to an empty string.
// Example: `10.0.0.5/31`
CustomerInterfaceIp *string `mandatory:"false" json:"customerInterfaceIp"`
// The IPv6 address for the Oracle end of the inside tunnel interface. This IP address is optional.
// If the tunnel's `routing` attribute is set to `BGP`
// (see IPSecConnectionTunnel), this IP address
// is used for the tunnel's BGP session.
// If `routing` is instead set to `STATIC`, you can set this IP
// address to troubleshoot or monitor the tunnel.
// Only subnet masks from /64 up to /127 are allowed.
// Example: `2001:db8::1/64`
OracleInterfaceIpv6 *string `mandatory:"false" json:"oracleInterfaceIpv6"`
// The IPv6 address for the CPE end of the inside tunnel interface. This IP address is optional.
// If the tunnel's `routing` attribute is set to `BGP`
// (see IPSecConnectionTunnel), this IP address
// is used for the tunnel's BGP session.
// If `routing` is instead set to `STATIC`, you can set this IP
// address to troubleshoot or monitor the tunnel.
// Only subnet masks from /64 up to /127 are allowed.
// Example: `2001:db8::1/64`
CustomerInterfaceIpv6 *string `mandatory:"false" json:"customerInterfaceIpv6"`
// The BGP ASN of the network on the CPE end of the BGP session. Can be a 2-byte or 4-byte ASN.
// Uses "asplain" format.
// If you are switching the tunnel from using BGP dynamic routing to static routing, the
// `customerBgpAsn` must be null.
// Example: `12345` (2-byte) or `1587232876` (4-byte)
CustomerBgpAsn *string `mandatory:"false" json:"customerBgpAsn"`
}
func (m UpdateIpSecTunnelBgpSessionDetails) String() string
func (m UpdateIpSecTunnelBgpSessionDetails) 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
UpdateIpSecTunnelEncryptionDomainDetails Request to update a multi-encryption domain policy on the IPSec tunnel. There can't be more than 50 security associations in use at one time. See Encryption domain for policy-based tunnels (https://docs.oracle.com/iaas/Content/Network/Tasks/ipsecencryptiondomains.htm#spi_policy_based_tunnel) for more.
type UpdateIpSecTunnelEncryptionDomainDetails struct {
// Lists IPv4 or IPv6-enabled subnets in your Oracle tenancy.
OracleTrafficSelector []string `mandatory:"false" json:"oracleTrafficSelector"`
// Lists IPv4 or IPv6-enabled subnets in your on-premises network.
CpeTrafficSelector []string `mandatory:"false" json:"cpeTrafficSelector"`
}
func (m UpdateIpSecTunnelEncryptionDomainDetails) String() string
func (m UpdateIpSecTunnelEncryptionDomainDetails) 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
UpdateIpv6Details The representation of UpdateIpv6Details
type UpdateIpv6Details struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to reassign the IPv6 to.
// The VNIC must be in the same subnet as the current VNIC.
VnicId *string `mandatory:"false" json:"vnicId"`
}
func (m UpdateIpv6Details) String() string
func (m UpdateIpv6Details) 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
UpdateLocalPeeringGatewayDetails The representation of UpdateLocalPeeringGatewayDetails
type UpdateLocalPeeringGatewayDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the LPG will use.
// For information about why you would associate a route table with an LPG, see
// Transit Routing: Access to Multiple VCNs in Same Region (https://docs.oracle.com/iaas/Content/Network/Tasks/transitrouting.htm).
RouteTableId *string `mandatory:"false" json:"routeTableId"`
}
func (m UpdateLocalPeeringGatewayDetails) String() string
func (m UpdateLocalPeeringGatewayDetails) 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
UpdateMacsecKey An object defining the OCID of the Secret held in Vault that represent the MACsec key.
type UpdateMacsecKey struct {
// Secret OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key Name (CKN) of this MACsec key.
ConnectivityAssociationNameSecretId *string `mandatory:"true" json:"connectivityAssociationNameSecretId"`
// The secret version of the connectivity association name secret in Vault.
ConnectivityAssociationNameSecretVersion *int64 `mandatory:"true" json:"connectivityAssociationNameSecretVersion"`
// Secret OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key.
ConnectivityAssociationKeySecretId *string `mandatory:"true" json:"connectivityAssociationKeySecretId"`
// The secret version of the connectivityAssociationKey secret in Vault.
ConnectivityAssociationKeySecretVersion *int64 `mandatory:"true" json:"connectivityAssociationKeySecretVersion"`
}
func (m UpdateMacsecKey) String() string
func (m UpdateMacsecKey) 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
UpdateMacsecProperties Properties used to update MACsec settings.
type UpdateMacsecProperties struct {
// Indicates whether or not MACsec is enabled.
State MacsecStateEnum `mandatory:"true" json:"state"`
PrimaryKey *UpdateMacsecKey `mandatory:"false" json:"primaryKey"`
// Type of encryption cipher suite to use for the MACsec connection.
EncryptionCipher MacsecEncryptionCipherEnum `mandatory:"false" json:"encryptionCipher,omitempty"`
}
func (m UpdateMacsecProperties) String() string
func (m UpdateMacsecProperties) 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
UpdateNatGatewayDetails The representation of UpdateNatGatewayDetails
type UpdateNatGatewayDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Whether the NAT gateway blocks traffic through it. The default is `false`.
// Example: `true`
BlockTraffic *bool `mandatory:"false" json:"blockTraffic"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the NAT gateway.
// If you don't specify a route table here, the NAT gateway is created without an associated route
// table. The Networking service does NOT automatically associate the attached VCN's default route
// table with the NAT gateway.
RouteTableId *string `mandatory:"false" json:"routeTableId"`
}
func (m UpdateNatGatewayDetails) String() string
func (m UpdateNatGatewayDetails) 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
UpdateNetworkSecurityGroupDetails The representation of UpdateNetworkSecurityGroupDetails
type UpdateNetworkSecurityGroupDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m UpdateNetworkSecurityGroupDetails) String() string
func (m UpdateNetworkSecurityGroupDetails) 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
UpdateNetworkSecurityGroupSecurityRulesDetails The representation of UpdateNetworkSecurityGroupSecurityRulesDetails
type UpdateNetworkSecurityGroupSecurityRulesDetails struct {
// The NSG security rules to update.
SecurityRules []UpdateSecurityRuleDetails `mandatory:"false" json:"securityRules"`
}
func (m UpdateNetworkSecurityGroupSecurityRulesDetails) String() string
func (m UpdateNetworkSecurityGroupSecurityRulesDetails) 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
UpdatePathAnalyzerTestDetails Details to update a `PathAnalyzerTest` resource.
type UpdatePathAnalyzerTestDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The IP protocol to use in the `PathAnalyzerTest` resource.
Protocol *int `mandatory:"false" json:"protocol"`
SourceEndpoint Endpoint `mandatory:"false" json:"sourceEndpoint"`
DestinationEndpoint Endpoint `mandatory:"false" json:"destinationEndpoint"`
ProtocolParameters ProtocolParameters `mandatory:"false" json:"protocolParameters"`
QueryOptions *QueryOptions `mandatory:"false" json:"queryOptions"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdatePathAnalyzerTestDetails) String() string
func (m *UpdatePathAnalyzerTestDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdatePathAnalyzerTestDetails) 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
UpdatePathAnalyzerTestRequest wrapper for the UpdatePathAnalyzerTest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/UpdatePathAnalyzerTest.go.html to see an example of how to use UpdatePathAnalyzerTestRequest.
type UpdatePathAnalyzerTestRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `PathAnalyzerTest` resource.
PathAnalyzerTestId *string `mandatory:"true" contributesTo:"path" name:"pathAnalyzerTestId"`
// The information to update.
UpdatePathAnalyzerTestDetails `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"`
// Unique identifier for the request.
// If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A 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
// may be rejected).
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdatePathAnalyzerTestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdatePathAnalyzerTestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdatePathAnalyzerTestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdatePathAnalyzerTestRequest) String() string
func (request UpdatePathAnalyzerTestRequest) 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
UpdatePathAnalyzerTestResponse wrapper for the UpdatePathAnalyzerTest operation
type UpdatePathAnalyzerTestResponse struct {
// The underlying http response
RawResponse *http.Response
// The PathAnalyzerTest instance
PathAnalyzerTest `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdatePathAnalyzerTestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdatePathAnalyzerTestResponse) String() string
UpdatePrivateIpDetails The representation of UpdatePrivateIpDetails
type UpdatePrivateIpDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The hostname for the private IP. Used for DNS. The value
// is the hostname portion of the private IP's fully qualified domain name (FQDN)
// (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`).
// Must be unique across all VNICs in the subnet and comply with
// RFC 952 (https://tools.ietf.org/html/rfc952) and
// RFC 1123 (https://tools.ietf.org/html/rfc1123).
// For more information, see
// DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm).
// Example: `bminstance1`
HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to reassign the private IP to. The VNIC must
// be in the same subnet as the current VNIC.
VnicId *string `mandatory:"false" json:"vnicId"`
}
func (m UpdatePrivateIpDetails) String() string
func (m UpdatePrivateIpDetails) 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
UpdatePublicIpDetails The representation of UpdatePublicIpDetails
type UpdatePublicIpDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private IP to assign the public IP to.
// * If the public IP is already assigned to a different private IP, it will be unassigned
// and then reassigned to the specified private IP.
// * If you set this field to an empty string, the public IP will be unassigned from the
// private IP it is currently assigned to.
PrivateIpId *string `mandatory:"false" json:"privateIpId"`
}
func (m UpdatePublicIpDetails) String() string
func (m UpdatePublicIpDetails) 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
UpdatePublicIpPoolDetails The data to update for a public IP pool.
type UpdatePublicIpPoolDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m UpdatePublicIpPoolDetails) String() string
func (m UpdatePublicIpPoolDetails) 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
UpdateRemotePeeringConnectionDetails The representation of UpdateRemotePeeringConnectionDetails
type UpdateRemotePeeringConnectionDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m UpdateRemotePeeringConnectionDetails) String() string
func (m UpdateRemotePeeringConnectionDetails) 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
UpdateRouteTableDetails The representation of UpdateRouteTableDetails
type UpdateRouteTableDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The collection of rules used for routing destination IPs to network devices.
RouteRules []RouteRule `mandatory:"false" json:"routeRules"`
}
func (m UpdateRouteTableDetails) String() string
func (m UpdateRouteTableDetails) 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
UpdateSecurityListDetails The representation of UpdateSecurityListDetails
type UpdateSecurityListDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Rules for allowing egress IP packets.
EgressSecurityRules []EgressSecurityRule `mandatory:"false" json:"egressSecurityRules"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Rules for allowing ingress IP packets.
IngressSecurityRules []IngressSecurityRule `mandatory:"false" json:"ingressSecurityRules"`
}
func (m UpdateSecurityListDetails) String() string
func (m UpdateSecurityListDetails) 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
UpdateSecurityRuleDetails A rule for allowing inbound (`direction`= INGRESS) or outbound (`direction`= EGRESS) IP packets.
type UpdateSecurityRuleDetails struct {
// Direction of the security rule. Set to `EGRESS` for rules to allow outbound IP packets,
// or `INGRESS` for rules to allow inbound IP packets.
Direction UpdateSecurityRuleDetailsDirectionEnum `mandatory:"true" json:"direction"`
// The Oracle-assigned ID of the security rule that you want to update. You can't change this value.
// Example: `04ABEC`
Id *string `mandatory:"true" json:"id"`
// The transport protocol. Specify either `all` or an IPv4 protocol number as
// defined in
// Protocol Numbers (http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
// Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58").
Protocol *string `mandatory:"true" json:"protocol"`
// An optional description of your choice for the rule. Avoid entering confidential information.
Description *string `mandatory:"false" json:"description"`
// Conceptually, this is the range of IP addresses that a packet originating from the instance
// can go to.
// Allowed values:
// * An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`
// IPv6 addressing is supported for all commercial and government regions. See
// IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// * The `cidrBlock` value for a Service, if you're
// setting up a security rule for traffic destined for a particular `Service` through
// a service gateway. For example: `oci-phx-objectstorage`.
// * The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a NetworkSecurityGroup in the same
// VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control
// traffic between VNICs in the same NSG.
Destination *string `mandatory:"false" json:"destination"`
// Type of destination for the rule. Required if `direction` = `EGRESS`.
// Allowed values:
// * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.
// * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a
// Service (the rule is for traffic destined for a
// particular `Service` through a service gateway).
// * `NETWORK_SECURITY_GROUP`: If the rule's `destination` is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a
// NetworkSecurityGroup.
DestinationType UpdateSecurityRuleDetailsDestinationTypeEnum `mandatory:"false" json:"destinationType,omitempty"`
IcmpOptions *IcmpOptions `mandatory:"false" json:"icmpOptions"`
// A stateless rule allows traffic in one direction. Remember to add a corresponding
// stateless rule in the other direction if you need to support bidirectional traffic. For
// example, if egress traffic allows TCP destination port 80, there should be an ingress
// rule to allow TCP source port 80. Defaults to false, which means the rule is stateful
// and a corresponding rule is not necessary for bidirectional traffic.
IsStateless *bool `mandatory:"false" json:"isStateless"`
// Conceptually, this is the range of IP addresses that a packet coming into the instance
// can come from.
// Allowed values:
// * An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`
// IPv6 addressing is supported for all commercial and government regions. See
// IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// * The `cidrBlock` value for a Service, if you're
// setting up a security rule for traffic coming from a particular `Service` through
// a service gateway. For example: `oci-phx-objectstorage`.
// * The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a NetworkSecurityGroup in the same
// VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control
// traffic between VNICs in the same NSG.
Source *string `mandatory:"false" json:"source"`
// Type of source for the rule. Required if `direction` = `INGRESS`.
// * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation.
// * `SERVICE_CIDR_BLOCK`: If the rule's `source` is the `cidrBlock` value for a
// Service (the rule is for traffic coming from a
// particular `Service` through a service gateway).
// * `NETWORK_SECURITY_GROUP`: If the rule's `source` is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a
// NetworkSecurityGroup.
SourceType UpdateSecurityRuleDetailsSourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`
TcpOptions *TcpOptions `mandatory:"false" json:"tcpOptions"`
UdpOptions *UdpOptions `mandatory:"false" json:"udpOptions"`
}
func (m UpdateSecurityRuleDetails) String() string
func (m UpdateSecurityRuleDetails) 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
UpdateSecurityRuleDetailsDestinationTypeEnum Enum with underlying type: string
type UpdateSecurityRuleDetailsDestinationTypeEnum string
Set of constants representing the allowable values for UpdateSecurityRuleDetailsDestinationTypeEnum
const (
UpdateSecurityRuleDetailsDestinationTypeCidrBlock UpdateSecurityRuleDetailsDestinationTypeEnum = "CIDR_BLOCK"
UpdateSecurityRuleDetailsDestinationTypeServiceCidrBlock UpdateSecurityRuleDetailsDestinationTypeEnum = "SERVICE_CIDR_BLOCK"
UpdateSecurityRuleDetailsDestinationTypeNetworkSecurityGroup UpdateSecurityRuleDetailsDestinationTypeEnum = "NETWORK_SECURITY_GROUP"
)
func GetMappingUpdateSecurityRuleDetailsDestinationTypeEnum(val string) (UpdateSecurityRuleDetailsDestinationTypeEnum, bool)
GetMappingUpdateSecurityRuleDetailsDestinationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateSecurityRuleDetailsDestinationTypeEnumValues() []UpdateSecurityRuleDetailsDestinationTypeEnum
GetUpdateSecurityRuleDetailsDestinationTypeEnumValues Enumerates the set of values for UpdateSecurityRuleDetailsDestinationTypeEnum
UpdateSecurityRuleDetailsDirectionEnum Enum with underlying type: string
type UpdateSecurityRuleDetailsDirectionEnum string
Set of constants representing the allowable values for UpdateSecurityRuleDetailsDirectionEnum
const (
UpdateSecurityRuleDetailsDirectionEgress UpdateSecurityRuleDetailsDirectionEnum = "EGRESS"
UpdateSecurityRuleDetailsDirectionIngress UpdateSecurityRuleDetailsDirectionEnum = "INGRESS"
)
func GetMappingUpdateSecurityRuleDetailsDirectionEnum(val string) (UpdateSecurityRuleDetailsDirectionEnum, bool)
GetMappingUpdateSecurityRuleDetailsDirectionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateSecurityRuleDetailsDirectionEnumValues() []UpdateSecurityRuleDetailsDirectionEnum
GetUpdateSecurityRuleDetailsDirectionEnumValues Enumerates the set of values for UpdateSecurityRuleDetailsDirectionEnum
UpdateSecurityRuleDetailsSourceTypeEnum Enum with underlying type: string
type UpdateSecurityRuleDetailsSourceTypeEnum string
Set of constants representing the allowable values for UpdateSecurityRuleDetailsSourceTypeEnum
const (
UpdateSecurityRuleDetailsSourceTypeCidrBlock UpdateSecurityRuleDetailsSourceTypeEnum = "CIDR_BLOCK"
UpdateSecurityRuleDetailsSourceTypeServiceCidrBlock UpdateSecurityRuleDetailsSourceTypeEnum = "SERVICE_CIDR_BLOCK"
UpdateSecurityRuleDetailsSourceTypeNetworkSecurityGroup UpdateSecurityRuleDetailsSourceTypeEnum = "NETWORK_SECURITY_GROUP"
)
func GetMappingUpdateSecurityRuleDetailsSourceTypeEnum(val string) (UpdateSecurityRuleDetailsSourceTypeEnum, bool)
GetMappingUpdateSecurityRuleDetailsSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateSecurityRuleDetailsSourceTypeEnumValues() []UpdateSecurityRuleDetailsSourceTypeEnum
GetUpdateSecurityRuleDetailsSourceTypeEnumValues Enumerates the set of values for UpdateSecurityRuleDetailsSourceTypeEnum
UpdateServiceGatewayDetails The representation of UpdateServiceGatewayDetails
type UpdateServiceGatewayDetails struct {
// Whether the service gateway blocks all traffic through it. The default is `false`. When
// this is `true`, traffic is not routed to any services, regardless of route rules.
// Example: `true`
BlockTraffic *bool `mandatory:"false" json:"blockTraffic"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the service gateway will use.
// For information about why you would associate a route table with a service gateway, see
// Transit Routing: Private Access to Oracle Services (https://docs.oracle.com/iaas/Content/Network/Tasks/transitroutingoracleservices.htm).
RouteTableId *string `mandatory:"false" json:"routeTableId"`
// List of all the `Service` objects you want enabled on this service gateway. Sending an empty list
// means you want to disable all services. Omitting this parameter entirely keeps the
// existing list of services intact.
// You can also enable or disable a particular `Service` by using
// AttachServiceId or
// DetachServiceId.
// For each enabled `Service`, make sure there's a route rule with the `Service` object's `cidrBlock`
// as the rule's destination and the service gateway as the rule's target. See
// RouteTable.
Services []ServiceIdRequestDetails `mandatory:"false" json:"services"`
}
func (m UpdateServiceGatewayDetails) String() string
func (m UpdateServiceGatewayDetails) 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
UpdateSubnetDetails The representation of UpdateSubnetDetails
type UpdateSubnetDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the set of DHCP options the subnet will use.
DhcpOptionsId *string `mandatory:"false" json:"dhcpOptionsId"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the subnet will use.
RouteTableId *string `mandatory:"false" json:"routeTableId"`
// The OCIDs of the security list or lists the subnet will use. This
// replaces the entire current set of security lists. Remember that
// security lists are associated *with the subnet*, but the rules are
// applied to the individual VNICs in the subnet.
SecurityListIds []string `mandatory:"false" json:"securityListIds"`
// The CIDR block of the subnet. The new CIDR block must meet the following criteria:
// - Must be valid.
// - The CIDR block's IP range must be completely within one of the VCN's CIDR block ranges.
// - The old and new CIDR block ranges must use the same network address. Example: `10.0.0.0/25` and `10.0.0.0/24`.
// - Must contain all IP addresses in use in the old CIDR range.
// - The new CIDR range's broadcast address (last IP address of CIDR range) must not be an IP address in use in the old CIDR range.
// **Note:** If you are changing the CIDR block, you cannot create VNICs or private IPs for this resource while the update is in progress.
// Example: `172.16.0.0/16`
CidrBlock *string `mandatory:"false" json:"cidrBlock"`
// This is the IPv6 CIDR block for the subnet's IP address space.
// The subnet size is always /64.
// See IPv6 Addresses (https://docs.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
// The provided CIDR must maintain the following rules -
// a. The IPv6 CIDR block is valid and correctly formatted.
// b. The IPv6 CIDR is within the parent VCN IPv6 range.
// Example: `2001:0db8:0123:1111::/64`
Ipv6CidrBlock *string `mandatory:"false" json:"ipv6CidrBlock"`
// The list of all IPv6 CIDR blocks (Oracle allocated IPv6 GUA, ULA or private IPv6 CIDR blocks, BYOIPv6 CIDR blocks) for the subnet that meets the following criteria:
// - The CIDR blocks must be valid.
// - Multiple CIDR blocks must not overlap each other or the on-premises network CIDR block.
// - The number of CIDR blocks must not exceed the limit of IPv6 CIDR blocks allowed to a subnet.
Ipv6CidrBlocks []string `mandatory:"false" json:"ipv6CidrBlocks"`
}
func (m UpdateSubnetDetails) String() string
func (m UpdateSubnetDetails) 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
UpdateTunnelCpeDeviceConfigDetails The representation of UpdateTunnelCpeDeviceConfigDetails
type UpdateTunnelCpeDeviceConfigDetails struct {
// The set of configuration answers for a CPE device.
TunnelCpeDeviceConfig []CpeDeviceConfigAnswer `mandatory:"false" json:"tunnelCpeDeviceConfig"`
}
func (m UpdateTunnelCpeDeviceConfigDetails) String() string
func (m UpdateTunnelCpeDeviceConfigDetails) 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
UpdateVcnDetails The representation of UpdateVcnDetails
type UpdateVcnDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}
func (m UpdateVcnDetails) String() string
func (m UpdateVcnDetails) 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
UpdateVirtualCircuitDetails The representation of UpdateVirtualCircuitDetails
type UpdateVirtualCircuitDetails struct {
// The provisioned data rate of the connection. To get a list of the
// available bandwidth levels (that is, shapes), see
// ListFastConnectProviderVirtualCircuitBandwidthShapes.
// To be updated only by the customer who owns the virtual circuit.
BandwidthShapeName *string `mandatory:"false" json:"bandwidthShapeName"`
// An array of mappings, each containing properties for a cross-connect or
// cross-connect group associated with this virtual circuit.
// The customer and provider can update different properties in the mapping
// depending on the situation. See the description of the
// CrossConnectMapping.
CrossConnectMappings []CrossConnectMapping `mandatory:"false" json:"crossConnectMappings"`
// The routing policy sets how routing information about the Oracle cloud is shared over a public virtual circuit.
// Policies available are: `ORACLE_SERVICE_NETWORK`, `REGIONAL`, `MARKET_LEVEL`, and `GLOBAL`.
// See Route Filtering (https://docs.oracle.com/iaas/Content/Network/Concepts/routingonprem.htm#route_filtering) for details.
// By default, routing information is shared for all routes in the same market.
RoutingPolicy []UpdateVirtualCircuitDetailsRoutingPolicyEnum `mandatory:"false" json:"routingPolicy,omitempty"`
// Set to `ENABLED` (the default) to activate the BGP session of the virtual circuit, set to `DISABLED` to deactivate the virtual circuit.
BgpAdminState UpdateVirtualCircuitDetailsBgpAdminStateEnum `mandatory:"false" json:"bgpAdminState,omitempty"`
// Set to `true` to enable BFD for IPv4 BGP peering, or set to `false` to disable BFD. If this is not set, the default is `false`.
IsBfdEnabled *bool `mandatory:"false" json:"isBfdEnabled"`
// Set to `true` for the virtual circuit to carry only encrypted traffic, or set to `false` for the virtual circuit to carry unencrypted traffic. If this is not set, the default is `false`.
IsTransportMode *bool `mandatory:"false" json:"isTransportMode"`
// Deprecated. Instead use `customerAsn`.
// If you specify values for both, the request will be rejected.
CustomerBgpAsn *int `mandatory:"false" json:"customerBgpAsn"`
// The BGP ASN of the network at the other end of the BGP
// session from Oracle.
// If the BGP session is from the customer's edge router to Oracle, the
// required value is the customer's ASN, and it can be updated only
// by the customer.
// If the BGP session is from the provider's edge router to Oracle, the
// required value is the provider's ASN, and it can be updated only
// by the provider.
// Can be a 2-byte or 4-byte ASN. Uses "asplain" format.
CustomerAsn *int64 `mandatory:"false" json:"customerAsn"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Drg
// that this private virtual circuit uses.
// To be updated only by the customer who owns the virtual circuit.
GatewayId *string `mandatory:"false" json:"gatewayId"`
// The provider's state in relation to this virtual circuit. Relevant only
// if the customer is using FastConnect via a provider. ACTIVE
// means the provider has provisioned the virtual circuit from their
// end. INACTIVE means the provider has not yet provisioned the virtual
// circuit, or has de-provisioned it.
// To be updated only by the provider.
ProviderState UpdateVirtualCircuitDetailsProviderStateEnum `mandatory:"false" json:"providerState,omitempty"`
// The service key name offered by the provider (if the customer is connecting via a provider).
ProviderServiceKeyName *string `mandatory:"false" json:"providerServiceKeyName"`
// Provider-supplied reference information about this virtual circuit.
// Relevant only if the customer is using FastConnect via a provider.
// To be updated only by the provider.
ReferenceComment *string `mandatory:"false" json:"referenceComment"`
// The layer 3 IP MTU to use on this virtual circuit.
IpMtu VirtualCircuitIpMtuEnum `mandatory:"false" json:"ipMtu,omitempty"`
}
func (m UpdateVirtualCircuitDetails) String() string
func (m UpdateVirtualCircuitDetails) 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
UpdateVirtualCircuitDetailsBgpAdminStateEnum Enum with underlying type: string
type UpdateVirtualCircuitDetailsBgpAdminStateEnum string
Set of constants representing the allowable values for UpdateVirtualCircuitDetailsBgpAdminStateEnum
const (
UpdateVirtualCircuitDetailsBgpAdminStateEnabled UpdateVirtualCircuitDetailsBgpAdminStateEnum = "ENABLED"
UpdateVirtualCircuitDetailsBgpAdminStateDisabled UpdateVirtualCircuitDetailsBgpAdminStateEnum = "DISABLED"
)
func GetMappingUpdateVirtualCircuitDetailsBgpAdminStateEnum(val string) (UpdateVirtualCircuitDetailsBgpAdminStateEnum, bool)
GetMappingUpdateVirtualCircuitDetailsBgpAdminStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateVirtualCircuitDetailsBgpAdminStateEnumValues() []UpdateVirtualCircuitDetailsBgpAdminStateEnum
GetUpdateVirtualCircuitDetailsBgpAdminStateEnumValues Enumerates the set of values for UpdateVirtualCircuitDetailsBgpAdminStateEnum
UpdateVirtualCircuitDetailsProviderStateEnum Enum with underlying type: string
type UpdateVirtualCircuitDetailsProviderStateEnum string
Set of constants representing the allowable values for UpdateVirtualCircuitDetailsProviderStateEnum
const (
UpdateVirtualCircuitDetailsProviderStateActive UpdateVirtualCircuitDetailsProviderStateEnum = "ACTIVE"
UpdateVirtualCircuitDetailsProviderStateInactive UpdateVirtualCircuitDetailsProviderStateEnum = "INACTIVE"
)
func GetMappingUpdateVirtualCircuitDetailsProviderStateEnum(val string) (UpdateVirtualCircuitDetailsProviderStateEnum, bool)
GetMappingUpdateVirtualCircuitDetailsProviderStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateVirtualCircuitDetailsProviderStateEnumValues() []UpdateVirtualCircuitDetailsProviderStateEnum
GetUpdateVirtualCircuitDetailsProviderStateEnumValues Enumerates the set of values for UpdateVirtualCircuitDetailsProviderStateEnum
UpdateVirtualCircuitDetailsRoutingPolicyEnum Enum with underlying type: string
type UpdateVirtualCircuitDetailsRoutingPolicyEnum string
Set of constants representing the allowable values for UpdateVirtualCircuitDetailsRoutingPolicyEnum
const (
UpdateVirtualCircuitDetailsRoutingPolicyOracleServiceNetwork UpdateVirtualCircuitDetailsRoutingPolicyEnum = "ORACLE_SERVICE_NETWORK"
UpdateVirtualCircuitDetailsRoutingPolicyRegional UpdateVirtualCircuitDetailsRoutingPolicyEnum = "REGIONAL"
UpdateVirtualCircuitDetailsRoutingPolicyMarketLevel UpdateVirtualCircuitDetailsRoutingPolicyEnum = "MARKET_LEVEL"
UpdateVirtualCircuitDetailsRoutingPolicyGlobal UpdateVirtualCircuitDetailsRoutingPolicyEnum = "GLOBAL"
)
func GetMappingUpdateVirtualCircuitDetailsRoutingPolicyEnum(val string) (UpdateVirtualCircuitDetailsRoutingPolicyEnum, bool)
GetMappingUpdateVirtualCircuitDetailsRoutingPolicyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateVirtualCircuitDetailsRoutingPolicyEnumValues() []UpdateVirtualCircuitDetailsRoutingPolicyEnum
GetUpdateVirtualCircuitDetailsRoutingPolicyEnumValues Enumerates the set of values for UpdateVirtualCircuitDetailsRoutingPolicyEnum
UpdateVlanDetails The representation of UpdateVlanDetails
type UpdateVlanDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// A list of the OCIDs of the network security groups (NSGs) to use with
// this VLAN. All VNICs in the VLAN will belong to these NSGs. For more
// information about NSGs, see
// NetworkSecurityGroup.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the VLAN will use.
RouteTableId *string `mandatory:"false" json:"routeTableId"`
// The CIDR block of the VLAN. The new CIDR block must meet the following criteria:
// - Must be valid.
// - The CIDR block's IP range must be completely within one of the VCN's CIDR block ranges.
// - The old and new CIDR block ranges must use the same network address. Example: `10.0.0.0/25` and `10.0.0.0/24`.
// - Must contain all IP addresses in use in the old CIDR range.
// - The new CIDR range's broadcast address (last IP address of CIDR range) must not be an IP address in use in the old CIDR range.
// **Note:** If you are changing the CIDR block, you cannot create VNICs or private IPs for this resource while the update is in progress.
CidrBlock *string `mandatory:"false" json:"cidrBlock"`
}
func (m UpdateVlanDetails) String() string
func (m UpdateVlanDetails) 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
UpdateVnicDetails The representation of UpdateVnicDetails
type UpdateVnicDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname
// portion of the primary private IP's fully qualified domain name (FQDN)
// (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`).
// Must be unique across all VNICs in the subnet and comply with
// RFC 952 (https://tools.ietf.org/html/rfc952) and
// RFC 1123 (https://tools.ietf.org/html/rfc1123).
// The value appears in the Vnic object and also the
// PrivateIp object returned by
// ListPrivateIps and
// GetPrivateIp.
// For more information, see
// DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm).
HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`
// A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. Setting this as
// an empty array removes the VNIC from all network security groups.
// If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of
// belonging to a subnet), the value of the `nsgIds` attribute is ignored. Instead, the
// VNIC belongs to the NSGs that are associated with the VLAN itself. See Vlan.
// For more information about NSGs, see
// NetworkSecurityGroup.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// Whether the source/destination check is disabled on the VNIC.
// Defaults to `false`, which means the check is performed. For information about why you would
// skip the source/destination check, see
// Using a Private IP as a Route Target (https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip).
// If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of
// belonging to a subnet), the value of the `skipSourceDestCheck` attribute is ignored.
// This is because the source/destination check is always disabled for VNICs in a VLAN.
// Example: `true`
SkipSourceDestCheck *bool `mandatory:"false" json:"skipSourceDestCheck"`
}
func (m UpdateVnicDetails) String() string
func (m UpdateVnicDetails) 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
UpdateVtapDetails These details can be included in a request to update a virtual test access point (VTAP).
type UpdateVtapDetails struct {
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source point where packets are captured.
SourceId *string `mandatory:"false" json:"sourceId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the destination resource where mirrored packets are sent.
TargetId *string `mandatory:"false" json:"targetId"`
// The IP address of the destination resource where mirrored packets are sent.
TargetIp *string `mandatory:"false" json:"targetIp"`
// The capture filter's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
CaptureFilterId *string `mandatory:"false" json:"captureFilterId"`
// Defines an encapsulation header type for the VTAP's mirrored traffic.
EncapsulationProtocol UpdateVtapDetailsEncapsulationProtocolEnum `mandatory:"false" json:"encapsulationProtocol,omitempty"`
// The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.
VxlanNetworkIdentifier *int64 `mandatory:"false" json:"vxlanNetworkIdentifier"`
// Used to start or stop a `Vtap` resource.
// * `TRUE` directs the VTAP to start mirroring traffic.
// * `FALSE` (Default) directs the VTAP to stop mirroring traffic.
IsVtapEnabled *bool `mandatory:"false" json:"isVtapEnabled"`
// Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
TrafficMode UpdateVtapDetailsTrafficModeEnum `mandatory:"false" json:"trafficMode,omitempty"`
// The maximum size of the packets to be included in the filter.
MaxPacketSize *int `mandatory:"false" json:"maxPacketSize"`
// The IP Address of the source private endpoint.
SourcePrivateEndpointIp *string `mandatory:"false" json:"sourcePrivateEndpointIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet that source private endpoint belongs to.
SourcePrivateEndpointSubnetId *string `mandatory:"false" json:"sourcePrivateEndpointSubnetId"`
// The target type for the VTAP.
TargetType UpdateVtapDetailsTargetTypeEnum `mandatory:"false" json:"targetType,omitempty"`
// The source type for the VTAP.
SourceType UpdateVtapDetailsSourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`
}
func (m UpdateVtapDetails) String() string
func (m UpdateVtapDetails) 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
UpdateVtapDetailsEncapsulationProtocolEnum Enum with underlying type: string
type UpdateVtapDetailsEncapsulationProtocolEnum string
Set of constants representing the allowable values for UpdateVtapDetailsEncapsulationProtocolEnum
const (
UpdateVtapDetailsEncapsulationProtocolVxlan UpdateVtapDetailsEncapsulationProtocolEnum = "VXLAN"
)
func GetMappingUpdateVtapDetailsEncapsulationProtocolEnum(val string) (UpdateVtapDetailsEncapsulationProtocolEnum, bool)
GetMappingUpdateVtapDetailsEncapsulationProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateVtapDetailsEncapsulationProtocolEnumValues() []UpdateVtapDetailsEncapsulationProtocolEnum
GetUpdateVtapDetailsEncapsulationProtocolEnumValues Enumerates the set of values for UpdateVtapDetailsEncapsulationProtocolEnum
UpdateVtapDetailsSourceTypeEnum Enum with underlying type: string
type UpdateVtapDetailsSourceTypeEnum string
Set of constants representing the allowable values for UpdateVtapDetailsSourceTypeEnum
const (
UpdateVtapDetailsSourceTypeVnic UpdateVtapDetailsSourceTypeEnum = "VNIC"
UpdateVtapDetailsSourceTypeSubnet UpdateVtapDetailsSourceTypeEnum = "SUBNET"
UpdateVtapDetailsSourceTypeLoadBalancer UpdateVtapDetailsSourceTypeEnum = "LOAD_BALANCER"
UpdateVtapDetailsSourceTypeDbSystem UpdateVtapDetailsSourceTypeEnum = "DB_SYSTEM"
UpdateVtapDetailsSourceTypeExadataVmCluster UpdateVtapDetailsSourceTypeEnum = "EXADATA_VM_CLUSTER"
UpdateVtapDetailsSourceTypeAutonomousDataWarehouse UpdateVtapDetailsSourceTypeEnum = "AUTONOMOUS_DATA_WAREHOUSE"
)
func GetMappingUpdateVtapDetailsSourceTypeEnum(val string) (UpdateVtapDetailsSourceTypeEnum, bool)
GetMappingUpdateVtapDetailsSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateVtapDetailsSourceTypeEnumValues() []UpdateVtapDetailsSourceTypeEnum
GetUpdateVtapDetailsSourceTypeEnumValues Enumerates the set of values for UpdateVtapDetailsSourceTypeEnum
UpdateVtapDetailsTargetTypeEnum Enum with underlying type: string
type UpdateVtapDetailsTargetTypeEnum string
Set of constants representing the allowable values for UpdateVtapDetailsTargetTypeEnum
const (
UpdateVtapDetailsTargetTypeVnic UpdateVtapDetailsTargetTypeEnum = "VNIC"
UpdateVtapDetailsTargetTypeNetworkLoadBalancer UpdateVtapDetailsTargetTypeEnum = "NETWORK_LOAD_BALANCER"
UpdateVtapDetailsTargetTypeIpAddress UpdateVtapDetailsTargetTypeEnum = "IP_ADDRESS"
)
func GetMappingUpdateVtapDetailsTargetTypeEnum(val string) (UpdateVtapDetailsTargetTypeEnum, bool)
GetMappingUpdateVtapDetailsTargetTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateVtapDetailsTargetTypeEnumValues() []UpdateVtapDetailsTargetTypeEnum
GetUpdateVtapDetailsTargetTypeEnumValues Enumerates the set of values for UpdateVtapDetailsTargetTypeEnum
UpdateVtapDetailsTrafficModeEnum Enum with underlying type: string
type UpdateVtapDetailsTrafficModeEnum string
Set of constants representing the allowable values for UpdateVtapDetailsTrafficModeEnum
const (
UpdateVtapDetailsTrafficModeDefault UpdateVtapDetailsTrafficModeEnum = "DEFAULT"
UpdateVtapDetailsTrafficModePriority UpdateVtapDetailsTrafficModeEnum = "PRIORITY"
)
func GetMappingUpdateVtapDetailsTrafficModeEnum(val string) (UpdateVtapDetailsTrafficModeEnum, bool)
GetMappingUpdateVtapDetailsTrafficModeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateVtapDetailsTrafficModeEnumValues() []UpdateVtapDetailsTrafficModeEnum
GetUpdateVtapDetailsTrafficModeEnumValues Enumerates the set of values for UpdateVtapDetailsTrafficModeEnum
UpdatedNetworkSecurityGroupSecurityRules The representation of UpdatedNetworkSecurityGroupSecurityRules
type UpdatedNetworkSecurityGroupSecurityRules struct {
// The NSG security rules that were updated.
SecurityRules []SecurityRule `mandatory:"false" json:"securityRules"`
}
func (m UpdatedNetworkSecurityGroupSecurityRules) String() string
func (m UpdatedNetworkSecurityGroupSecurityRules) 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
UpgradeStatus The upgrade status of a DRG.
type UpgradeStatus struct {
// The `drgId` of the upgraded DRG.
DrgId *string `mandatory:"true" json:"drgId"`
// The current upgrade status of the DRG attachment.
Status UpgradeStatusStatusEnum `mandatory:"true" json:"status"`
// The number of upgraded connections.
UpgradedConnections *string `mandatory:"true" json:"upgradedConnections"`
}
func (m UpgradeStatus) String() string
func (m UpgradeStatus) 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
UpgradeStatusStatusEnum Enum with underlying type: string
type UpgradeStatusStatusEnum string
Set of constants representing the allowable values for UpgradeStatusStatusEnum
const (
UpgradeStatusStatusNotUpgraded UpgradeStatusStatusEnum = "NOT_UPGRADED"
UpgradeStatusStatusInProgress UpgradeStatusStatusEnum = "IN_PROGRESS"
UpgradeStatusStatusUpgraded UpgradeStatusStatusEnum = "UPGRADED"
)
func GetMappingUpgradeStatusStatusEnum(val string) (UpgradeStatusStatusEnum, bool)
GetMappingUpgradeStatusStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpgradeStatusStatusEnumValues() []UpgradeStatusStatusEnum
GetUpgradeStatusStatusEnumValues Enumerates the set of values for UpgradeStatusStatusEnum
Vcn A virtual cloud network (VCN). For more information, see Overview of the Networking Service (https://docs.oracle.com/iaas/Content/Network/Concepts/overview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type Vcn struct {
// Deprecated. The first CIDR IP address from cidrBlocks.
// Example: `172.16.0.0/16`
CidrBlock *string `mandatory:"true" json:"cidrBlock"`
// The list of IPv4 CIDR blocks the VCN will use.
CidrBlocks []string `mandatory:"true" json:"cidrBlocks"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the VCN.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The VCN's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"true" json:"id"`
// The VCN's current state.
LifecycleState VcnLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The list of BYOIPv6 CIDR blocks required to create a VCN that uses BYOIPv6 ranges.
Byoipv6CidrBlocks []string `mandatory:"false" json:"byoipv6CidrBlocks"`
// For an IPv6-enabled VCN, this is the list of Private IPv6 CIDR blocks for the VCN's IP address space.
Ipv6PrivateCidrBlocks []string `mandatory:"false" json:"ipv6PrivateCidrBlocks"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the VCN's default set of DHCP options.
DefaultDhcpOptionsId *string `mandatory:"false" json:"defaultDhcpOptionsId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the VCN's default route table.
DefaultRouteTableId *string `mandatory:"false" json:"defaultRouteTableId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the VCN's default security list.
DefaultSecurityListId *string `mandatory:"false" json:"defaultSecurityListId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// A DNS label for the VCN, used in conjunction with the VNIC's hostname and
// subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC
// within this subnet (for example, `bminstance1.subnet123.vcn1.oraclevcn.com`).
// Must be an alphanumeric string that begins with a letter.
// The value cannot be changed.
// The absence of this parameter means the Internet and VCN Resolver will
// not work for this VCN.
// For more information, see
// DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm).
// Example: `vcn1`
DnsLabel *string `mandatory:"false" json:"dnsLabel"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// For an IPv6-enabled VCN, this is the list of IPv6 CIDR blocks for the VCN's IP address space.
// The CIDRs are provided by Oracle and the sizes are always /56.
Ipv6CidrBlocks []string `mandatory:"false" json:"ipv6CidrBlocks"`
// The date and time the VCN was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The VCN's domain name, which consists of the VCN's DNS label, and the
// `oraclevcn.com` domain.
// For more information, see
// DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm).
// Example: `vcn1.oraclevcn.com`
VcnDomainName *string `mandatory:"false" json:"vcnDomainName"`
}
func (m Vcn) String() string
func (m Vcn) 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
VcnDnsResolverAssociation The information about the VCN and the DNS resolver in the association.
type VcnDnsResolverAssociation struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN in the association.
VcnId *string `mandatory:"true" json:"vcnId"`
// The current state of the association.
LifecycleState VcnDnsResolverAssociationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DNS resolver in the association.
DnsResolverId *string `mandatory:"false" json:"dnsResolverId"`
}
func (m VcnDnsResolverAssociation) String() string
func (m VcnDnsResolverAssociation) 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
VcnDnsResolverAssociationLifecycleStateEnum Enum with underlying type: string
type VcnDnsResolverAssociationLifecycleStateEnum string
Set of constants representing the allowable values for VcnDnsResolverAssociationLifecycleStateEnum
const (
VcnDnsResolverAssociationLifecycleStateProvisioning VcnDnsResolverAssociationLifecycleStateEnum = "PROVISIONING"
VcnDnsResolverAssociationLifecycleStateAvailable VcnDnsResolverAssociationLifecycleStateEnum = "AVAILABLE"
VcnDnsResolverAssociationLifecycleStateTerminating VcnDnsResolverAssociationLifecycleStateEnum = "TERMINATING"
VcnDnsResolverAssociationLifecycleStateTerminated VcnDnsResolverAssociationLifecycleStateEnum = "TERMINATED"
)
func GetMappingVcnDnsResolverAssociationLifecycleStateEnum(val string) (VcnDnsResolverAssociationLifecycleStateEnum, bool)
GetMappingVcnDnsResolverAssociationLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVcnDnsResolverAssociationLifecycleStateEnumValues() []VcnDnsResolverAssociationLifecycleStateEnum
GetVcnDnsResolverAssociationLifecycleStateEnumValues Enumerates the set of values for VcnDnsResolverAssociationLifecycleStateEnum
VcnDrgAttachmentNetworkCreateDetails Specifies the VCN Attachment
type VcnDrgAttachmentNetworkCreateDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG.
Id *string `mandatory:"false" json:"id"`
// This is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table that is used to route the traffic as it enters a VCN through this attachment.
// For information about why you would associate a route table with a DRG attachment, see
// Advanced Scenario: Transit Routing (https://docs.oracle.com/iaas/Content/Network/Tasks/transitrouting.htm).
// For information about why you would associate a route table with a DRG attachment, see:
// * Transit Routing: Access to Multiple VCNs in Same Region (https://docs.oracle.com/iaas/Content/Network/Tasks/transitrouting.htm)
// * Transit Routing: Private Access to Oracle Services (https://docs.oracle.com/iaas/Content/Network/Tasks/transitroutingoracleservices.htm)
RouteTableId *string `mandatory:"false" json:"routeTableId"`
// Indicates whether the VCN CIDRs or the individual subnet CIDRs are imported from the attachment.
// Routes from the VCN ingress route table are always imported.
VcnRouteType VcnDrgAttachmentNetworkDetailsVcnRouteTypeEnum `mandatory:"false" json:"vcnRouteType,omitempty"`
}
func (m VcnDrgAttachmentNetworkCreateDetails) GetId() *string
GetId returns Id
func (m VcnDrgAttachmentNetworkCreateDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m VcnDrgAttachmentNetworkCreateDetails) String() string
func (m VcnDrgAttachmentNetworkCreateDetails) 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
VcnDrgAttachmentNetworkDetails Specifies details within the VCN.
type VcnDrgAttachmentNetworkDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG.
Id *string `mandatory:"false" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the DRG attachment is using.
// For information about why you would associate a route table with a DRG attachment, see:
// * Transit Routing: Access to Multiple VCNs in Same Region (https://docs.oracle.com/iaas/Content/Network/Tasks/transitrouting.htm)
// * Transit Routing: Private Access to Oracle Services (https://docs.oracle.com/iaas/Content/Network/Tasks/transitroutingoracleservices.htm)
RouteTableId *string `mandatory:"false" json:"routeTableId"`
// Indicates whether the VCN CIDRs or the individual subnet CIDRs are imported from the attachment.
// Routes from the VCN ingress route table are always imported.
VcnRouteType VcnDrgAttachmentNetworkDetailsVcnRouteTypeEnum `mandatory:"false" json:"vcnRouteType,omitempty"`
}
func (m VcnDrgAttachmentNetworkDetails) GetId() *string
GetId returns Id
func (m VcnDrgAttachmentNetworkDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m VcnDrgAttachmentNetworkDetails) String() string
func (m VcnDrgAttachmentNetworkDetails) 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
VcnDrgAttachmentNetworkDetailsVcnRouteTypeEnum Enum with underlying type: string
type VcnDrgAttachmentNetworkDetailsVcnRouteTypeEnum string
Set of constants representing the allowable values for VcnDrgAttachmentNetworkDetailsVcnRouteTypeEnum
const (
VcnDrgAttachmentNetworkDetailsVcnRouteTypeVcnCidrs VcnDrgAttachmentNetworkDetailsVcnRouteTypeEnum = "VCN_CIDRS"
VcnDrgAttachmentNetworkDetailsVcnRouteTypeSubnetCidrs VcnDrgAttachmentNetworkDetailsVcnRouteTypeEnum = "SUBNET_CIDRS"
)
func GetMappingVcnDrgAttachmentNetworkDetailsVcnRouteTypeEnum(val string) (VcnDrgAttachmentNetworkDetailsVcnRouteTypeEnum, bool)
GetMappingVcnDrgAttachmentNetworkDetailsVcnRouteTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVcnDrgAttachmentNetworkDetailsVcnRouteTypeEnumValues() []VcnDrgAttachmentNetworkDetailsVcnRouteTypeEnum
GetVcnDrgAttachmentNetworkDetailsVcnRouteTypeEnumValues Enumerates the set of values for VcnDrgAttachmentNetworkDetailsVcnRouteTypeEnum
VcnDrgAttachmentNetworkUpdateDetails Specifies the update details for the VCN attachment.
type VcnDrgAttachmentNetworkUpdateDetails struct {
// This is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table that is used to route the traffic as it enters a VCN through this attachment.
// For information about why you would associate a route table with a DRG attachment, see:
// * Transit Routing: Access to Multiple VCNs in Same Region (https://docs.oracle.com/iaas/Content/Network/Tasks/transitrouting.htm)
// * Transit Routing: Private Access to Oracle Services (https://docs.oracle.com/iaas/Content/Network/Tasks/transitroutingoracleservices.htm)
RouteTableId *string `mandatory:"false" json:"routeTableId"`
// Indicates whether the VCN CIDRs or the individual subnet CIDRs are imported from the attachment.
// Routes from the VCN ingress route table are always imported.
VcnRouteType VcnDrgAttachmentNetworkDetailsVcnRouteTypeEnum `mandatory:"false" json:"vcnRouteType,omitempty"`
}
func (m VcnDrgAttachmentNetworkUpdateDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m VcnDrgAttachmentNetworkUpdateDetails) String() string
func (m VcnDrgAttachmentNetworkUpdateDetails) 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
VcnLifecycleStateEnum Enum with underlying type: string
type VcnLifecycleStateEnum string
Set of constants representing the allowable values for VcnLifecycleStateEnum
const (
VcnLifecycleStateProvisioning VcnLifecycleStateEnum = "PROVISIONING"
VcnLifecycleStateAvailable VcnLifecycleStateEnum = "AVAILABLE"
VcnLifecycleStateTerminating VcnLifecycleStateEnum = "TERMINATING"
VcnLifecycleStateTerminated VcnLifecycleStateEnum = "TERMINATED"
VcnLifecycleStateUpdating VcnLifecycleStateEnum = "UPDATING"
)
func GetMappingVcnLifecycleStateEnum(val string) (VcnLifecycleStateEnum, bool)
GetMappingVcnLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVcnLifecycleStateEnumValues() []VcnLifecycleStateEnum
GetVcnLifecycleStateEnumValues Enumerates the set of values for VcnLifecycleStateEnum
VcnRoutingConfiguration Identifies the VCN route table and rule that allowed the traffic to be forwarded.
type VcnRoutingConfiguration struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN route
// table that allowed the traffic.
VcnRouteTableId *string `mandatory:"true" json:"vcnRouteTableId"`
RouteRule *RouteRule `mandatory:"true" json:"routeRule"`
}
func (m VcnRoutingConfiguration) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m VcnRoutingConfiguration) String() string
func (m VcnRoutingConfiguration) 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
VcnTopology Defines the representation of a virtual network topology for a VCN.
type VcnTopology struct {
// Lists entities comprising the virtual network topology.
Entities []interface{} `mandatory:"true" json:"entities"`
// Lists relationships between entities in the virtual network topology.
Relationships []TopologyEntityRelationship `mandatory:"true" json:"relationships"`
// Lists entities that are limited during ingestion.
// The values for the items in the list are the entity type names of the limitedEntities.
// Example: `vcn`
LimitedEntities []string `mandatory:"true" json:"limitedEntities"`
// Records when the virtual network topology was created, in RFC3339 (https://tools.ietf.org/html/rfc3339) format for date and time.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN for which the topology is generated.
VcnId *string `mandatory:"false" json:"vcnId"`
}
func (m VcnTopology) GetEntities() []interface{}
GetEntities returns Entities
func (m VcnTopology) GetLimitedEntities() []string
GetLimitedEntities returns LimitedEntities
func (m VcnTopology) GetRelationships() []TopologyEntityRelationship
GetRelationships returns Relationships
func (m VcnTopology) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m VcnTopology) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m VcnTopology) String() string
func (m *VcnTopology) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m VcnTopology) 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
VirtualCircuit For use with Oracle Cloud Infrastructure FastConnect. A virtual circuit is an isolated network path that runs over one or more physical network connections to provide a single, logical connection between the edge router on the customer's existing network and Oracle Cloud Infrastructure. *Private* virtual circuits support private peering, and *public* virtual circuits support public peering. For more information, see FastConnect Overview (https://docs.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm). Each virtual circuit is made up of information shared between a customer, Oracle, and a provider (if the customer is using FastConnect via a provider). Who fills in a given property of a virtual circuit depends on whether the BGP session related to that virtual circuit goes from the customer's edge router to Oracle, or from the provider's edge router to Oracle. Also, in the case where the customer is using a provider, values for some of the properties may not be present immediately, but may get filled in as the provider and Oracle each do their part to provision the virtual circuit. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type VirtualCircuit struct {
// The provisioned data rate of the connection. To get a list of the
// available bandwidth levels (that is, shapes), see
// ListFastConnectProviderVirtualCircuitBandwidthShapes.
// Example: `10 Gbps`
BandwidthShapeName *string `mandatory:"false" json:"bandwidthShapeName"`
// Deprecated. Instead use the information in
// FastConnectProviderService.
BgpManagement VirtualCircuitBgpManagementEnum `mandatory:"false" json:"bgpManagement,omitempty"`
// The state of the Ipv4 BGP session associated with the virtual circuit.
BgpSessionState VirtualCircuitBgpSessionStateEnum `mandatory:"false" json:"bgpSessionState,omitempty"`
// The state of the Ipv6 BGP session associated with the virtual circuit.
BgpIpv6SessionState VirtualCircuitBgpIpv6SessionStateEnum `mandatory:"false" json:"bgpIpv6SessionState,omitempty"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the virtual circuit.
CompartmentId *string `mandatory:"false" json:"compartmentId"`
// An array of mappings, each containing properties for a
// cross-connect or cross-connect group that is associated with this
// virtual circuit.
CrossConnectMappings []CrossConnectMapping `mandatory:"false" json:"crossConnectMappings"`
// The routing policy sets how routing information about the Oracle cloud is shared over a public virtual circuit.
// Policies available are: `ORACLE_SERVICE_NETWORK`, `REGIONAL`, `MARKET_LEVEL`, and `GLOBAL`.
// See Route Filtering (https://docs.oracle.com/iaas/Content/Network/Concepts/routingonprem.htm#route_filtering) for details.
// By default, routing information is shared for all routes in the same market.
RoutingPolicy []VirtualCircuitRoutingPolicyEnum `mandatory:"false" json:"routingPolicy,omitempty"`
// Set to `ENABLED` (the default) to activate the BGP session of the virtual circuit, set to `DISABLED` to deactivate the virtual circuit.
BgpAdminState VirtualCircuitBgpAdminStateEnum `mandatory:"false" json:"bgpAdminState,omitempty"`
// Set to `true` to enable BFD for IPv4 BGP peering, or set to `false` to disable BFD. If this is not set, the default is `false`.
IsBfdEnabled *bool `mandatory:"false" json:"isBfdEnabled"`
// Set to `true` for the virtual circuit to carry only encrypted traffic, or set to `false` for the virtual circuit to carry unencrypted traffic. If this is not set, the default is `false`.
IsTransportMode *bool `mandatory:"false" json:"isTransportMode"`
// Deprecated. Instead use `customerAsn`.
// If you specify values for both, the request will be rejected.
CustomerBgpAsn *int `mandatory:"false" json:"customerBgpAsn"`
// The BGP ASN of the network at the other end of the BGP
// session from Oracle. If the session is between the customer's
// edge router and Oracle, the value is the customer's ASN. If the BGP
// session is between the provider's edge router and Oracle, the value
// is the provider's ASN.
// Can be a 2-byte or 4-byte ASN. Uses "asplain" format.
CustomerAsn *int64 `mandatory:"false" json:"customerAsn"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customer's Drg
// that this virtual circuit uses. Applicable only to private virtual circuits.
GatewayId *string `mandatory:"false" json:"gatewayId"`
// The virtual circuit's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"false" json:"id"`
// The virtual circuit's current state. For information about
// the different states, see
// FastConnect Overview (https://docs.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm).
LifecycleState VirtualCircuitLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The Oracle BGP ASN.
OracleBgpAsn *int `mandatory:"false" json:"oracleBgpAsn"`
// Deprecated. Instead use `providerServiceId`.
ProviderName *string `mandatory:"false" json:"providerName"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the service offered by the provider (if the customer is connecting via a provider).
ProviderServiceId *string `mandatory:"false" json:"providerServiceId"`
// The service key name offered by the provider (if the customer is connecting via a provider).
ProviderServiceKeyName *string `mandatory:"false" json:"providerServiceKeyName"`
// Deprecated. Instead use `providerServiceId`.
ProviderServiceName *string `mandatory:"false" json:"providerServiceName"`
// The provider's state in relation to this virtual circuit (if the
// customer is connecting via a provider). ACTIVE means
// the provider has provisioned the virtual circuit from their end.
// INACTIVE means the provider has not yet provisioned the virtual
// circuit, or has de-provisioned it.
ProviderState VirtualCircuitProviderStateEnum `mandatory:"false" json:"providerState,omitempty"`
// For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to
// advertise across the connection. All prefix sizes are allowed.
PublicPrefixes []string `mandatory:"false" json:"publicPrefixes"`
// Provider-supplied reference information about this virtual circuit
// (if the customer is connecting via a provider).
ReferenceComment *string `mandatory:"false" json:"referenceComment"`
// The Oracle Cloud Infrastructure region where this virtual
// circuit is located.
Region *string `mandatory:"false" json:"region"`
// Provider service type.
ServiceType VirtualCircuitServiceTypeEnum `mandatory:"false" json:"serviceType,omitempty"`
// The date and time the virtual circuit was created,
// in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Whether the virtual circuit supports private or public peering. For more information,
// see FastConnect Overview (https://docs.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm).
Type VirtualCircuitTypeEnum `mandatory:"false" json:"type,omitempty"`
// The layer 3 IP MTU to use on this virtual circuit.
IpMtu VirtualCircuitIpMtuEnum `mandatory:"false" json:"ipMtu,omitempty"`
}
func (m VirtualCircuit) String() string
func (m VirtualCircuit) 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
VirtualCircuitAssociatedTunnelDetails Detailed private tunnel info associated with the virtual circuit.
type VirtualCircuitAssociatedTunnelDetails struct {
// The type of the tunnel associated with the virtual circuit.
TunnelType VirtualCircuitAssociatedTunnelDetailsTunnelTypeEnum `mandatory:"true" json:"tunnelType"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IPSec tunnel associated with the virtual circuit.
TunnelId *string `mandatory:"true" json:"tunnelId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of IPSec connection associated with the virtual circuit.
IpsecConnectionId *string `mandatory:"false" json:"ipsecConnectionId"`
}
func (m VirtualCircuitAssociatedTunnelDetails) String() string
func (m VirtualCircuitAssociatedTunnelDetails) 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
VirtualCircuitAssociatedTunnelDetailsTunnelTypeEnum Enum with underlying type: string
type VirtualCircuitAssociatedTunnelDetailsTunnelTypeEnum string
Set of constants representing the allowable values for VirtualCircuitAssociatedTunnelDetailsTunnelTypeEnum
const (
VirtualCircuitAssociatedTunnelDetailsTunnelTypeIpsec VirtualCircuitAssociatedTunnelDetailsTunnelTypeEnum = "IPSEC"
)
func GetMappingVirtualCircuitAssociatedTunnelDetailsTunnelTypeEnum(val string) (VirtualCircuitAssociatedTunnelDetailsTunnelTypeEnum, bool)
GetMappingVirtualCircuitAssociatedTunnelDetailsTunnelTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVirtualCircuitAssociatedTunnelDetailsTunnelTypeEnumValues() []VirtualCircuitAssociatedTunnelDetailsTunnelTypeEnum
GetVirtualCircuitAssociatedTunnelDetailsTunnelTypeEnumValues Enumerates the set of values for VirtualCircuitAssociatedTunnelDetailsTunnelTypeEnum
VirtualCircuitBandwidthShape An individual bandwidth level for virtual circuits.
type VirtualCircuitBandwidthShape struct {
// The name of the bandwidth shape.
// Example: `10 Gbps`
Name *string `mandatory:"true" json:"name"`
// The bandwidth in Mbps.
// Example: `10000`
BandwidthInMbps *int `mandatory:"false" json:"bandwidthInMbps"`
}
func (m VirtualCircuitBandwidthShape) String() string
func (m VirtualCircuitBandwidthShape) 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
VirtualCircuitBgpAdminStateEnum Enum with underlying type: string
type VirtualCircuitBgpAdminStateEnum string
Set of constants representing the allowable values for VirtualCircuitBgpAdminStateEnum
const (
VirtualCircuitBgpAdminStateEnabled VirtualCircuitBgpAdminStateEnum = "ENABLED"
VirtualCircuitBgpAdminStateDisabled VirtualCircuitBgpAdminStateEnum = "DISABLED"
)
func GetMappingVirtualCircuitBgpAdminStateEnum(val string) (VirtualCircuitBgpAdminStateEnum, bool)
GetMappingVirtualCircuitBgpAdminStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVirtualCircuitBgpAdminStateEnumValues() []VirtualCircuitBgpAdminStateEnum
GetVirtualCircuitBgpAdminStateEnumValues Enumerates the set of values for VirtualCircuitBgpAdminStateEnum
VirtualCircuitBgpIpv6SessionStateEnum Enum with underlying type: string
type VirtualCircuitBgpIpv6SessionStateEnum string
Set of constants representing the allowable values for VirtualCircuitBgpIpv6SessionStateEnum
const (
VirtualCircuitBgpIpv6SessionStateUp VirtualCircuitBgpIpv6SessionStateEnum = "UP"
VirtualCircuitBgpIpv6SessionStateDown VirtualCircuitBgpIpv6SessionStateEnum = "DOWN"
)
func GetMappingVirtualCircuitBgpIpv6SessionStateEnum(val string) (VirtualCircuitBgpIpv6SessionStateEnum, bool)
GetMappingVirtualCircuitBgpIpv6SessionStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVirtualCircuitBgpIpv6SessionStateEnumValues() []VirtualCircuitBgpIpv6SessionStateEnum
GetVirtualCircuitBgpIpv6SessionStateEnumValues Enumerates the set of values for VirtualCircuitBgpIpv6SessionStateEnum
VirtualCircuitBgpManagementEnum Enum with underlying type: string
type VirtualCircuitBgpManagementEnum string
Set of constants representing the allowable values for VirtualCircuitBgpManagementEnum
const (
VirtualCircuitBgpManagementCustomerManaged VirtualCircuitBgpManagementEnum = "CUSTOMER_MANAGED"
VirtualCircuitBgpManagementProviderManaged VirtualCircuitBgpManagementEnum = "PROVIDER_MANAGED"
VirtualCircuitBgpManagementOracleManaged VirtualCircuitBgpManagementEnum = "ORACLE_MANAGED"
)
func GetMappingVirtualCircuitBgpManagementEnum(val string) (VirtualCircuitBgpManagementEnum, bool)
GetMappingVirtualCircuitBgpManagementEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVirtualCircuitBgpManagementEnumValues() []VirtualCircuitBgpManagementEnum
GetVirtualCircuitBgpManagementEnumValues Enumerates the set of values for VirtualCircuitBgpManagementEnum
VirtualCircuitBgpSessionStateEnum Enum with underlying type: string
type VirtualCircuitBgpSessionStateEnum string
Set of constants representing the allowable values for VirtualCircuitBgpSessionStateEnum
const (
VirtualCircuitBgpSessionStateUp VirtualCircuitBgpSessionStateEnum = "UP"
VirtualCircuitBgpSessionStateDown VirtualCircuitBgpSessionStateEnum = "DOWN"
)
func GetMappingVirtualCircuitBgpSessionStateEnum(val string) (VirtualCircuitBgpSessionStateEnum, bool)
GetMappingVirtualCircuitBgpSessionStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVirtualCircuitBgpSessionStateEnumValues() []VirtualCircuitBgpSessionStateEnum
GetVirtualCircuitBgpSessionStateEnumValues Enumerates the set of values for VirtualCircuitBgpSessionStateEnum
VirtualCircuitDrgAttachmentNetworkDetails Specifies the virtual circuit attached to the DRG.
type VirtualCircuitDrgAttachmentNetworkDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG.
Id *string `mandatory:"false" json:"id"`
// Boolean flag that determines wether all traffic over the virtual circuits is encrypted.
// Example: `true`
TransportOnlyMode *bool `mandatory:"false" json:"transportOnlyMode"`
}
func (m VirtualCircuitDrgAttachmentNetworkDetails) GetId() *string
GetId returns Id
func (m VirtualCircuitDrgAttachmentNetworkDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m VirtualCircuitDrgAttachmentNetworkDetails) String() string
func (m VirtualCircuitDrgAttachmentNetworkDetails) 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
VirtualCircuitIpMtuEnum Enum with underlying type: string
type VirtualCircuitIpMtuEnum string
Set of constants representing the allowable values for VirtualCircuitIpMtuEnum
const (
VirtualCircuitIpMtuMtu1500 VirtualCircuitIpMtuEnum = "MTU_1500"
VirtualCircuitIpMtuMtu9000 VirtualCircuitIpMtuEnum = "MTU_9000"
)
func GetMappingVirtualCircuitIpMtuEnum(val string) (VirtualCircuitIpMtuEnum, bool)
GetMappingVirtualCircuitIpMtuEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVirtualCircuitIpMtuEnumValues() []VirtualCircuitIpMtuEnum
GetVirtualCircuitIpMtuEnumValues Enumerates the set of values for VirtualCircuitIpMtuEnum
VirtualCircuitLifecycleStateEnum Enum with underlying type: string
type VirtualCircuitLifecycleStateEnum string
Set of constants representing the allowable values for VirtualCircuitLifecycleStateEnum
const (
VirtualCircuitLifecycleStatePendingProvider VirtualCircuitLifecycleStateEnum = "PENDING_PROVIDER"
VirtualCircuitLifecycleStateVerifying VirtualCircuitLifecycleStateEnum = "VERIFYING"
VirtualCircuitLifecycleStateProvisioning VirtualCircuitLifecycleStateEnum = "PROVISIONING"
VirtualCircuitLifecycleStateProvisioned VirtualCircuitLifecycleStateEnum = "PROVISIONED"
VirtualCircuitLifecycleStateFailed VirtualCircuitLifecycleStateEnum = "FAILED"
VirtualCircuitLifecycleStateInactive VirtualCircuitLifecycleStateEnum = "INACTIVE"
VirtualCircuitLifecycleStateTerminating VirtualCircuitLifecycleStateEnum = "TERMINATING"
VirtualCircuitLifecycleStateTerminated VirtualCircuitLifecycleStateEnum = "TERMINATED"
)
func GetMappingVirtualCircuitLifecycleStateEnum(val string) (VirtualCircuitLifecycleStateEnum, bool)
GetMappingVirtualCircuitLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVirtualCircuitLifecycleStateEnumValues() []VirtualCircuitLifecycleStateEnum
GetVirtualCircuitLifecycleStateEnumValues Enumerates the set of values for VirtualCircuitLifecycleStateEnum
VirtualCircuitProviderStateEnum Enum with underlying type: string
type VirtualCircuitProviderStateEnum string
Set of constants representing the allowable values for VirtualCircuitProviderStateEnum
const (
VirtualCircuitProviderStateActive VirtualCircuitProviderStateEnum = "ACTIVE"
VirtualCircuitProviderStateInactive VirtualCircuitProviderStateEnum = "INACTIVE"
)
func GetMappingVirtualCircuitProviderStateEnum(val string) (VirtualCircuitProviderStateEnum, bool)
GetMappingVirtualCircuitProviderStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVirtualCircuitProviderStateEnumValues() []VirtualCircuitProviderStateEnum
GetVirtualCircuitProviderStateEnumValues Enumerates the set of values for VirtualCircuitProviderStateEnum
VirtualCircuitPublicPrefix A public IP prefix and its details. With a public virtual circuit, the customer specifies the customer-owned public IP prefixes to advertise across the connection. For more information, see FastConnect Overview (https://docs.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm).
type VirtualCircuitPublicPrefix struct {
// Publix IP prefix (CIDR) that the customer specified.
CidrBlock *string `mandatory:"true" json:"cidrBlock"`
// Oracle must verify that the customer owns the public IP prefix before traffic
// for that prefix can flow across the virtual circuit. Verification can take a
// few business days. `IN_PROGRESS` means Oracle is verifying the prefix. `COMPLETED`
// means verification succeeded. `FAILED` means verification failed and traffic for
// this prefix will not flow across the connection.
VerificationState VirtualCircuitPublicPrefixVerificationStateEnum `mandatory:"true" json:"verificationState"`
}
func (m VirtualCircuitPublicPrefix) String() string
func (m VirtualCircuitPublicPrefix) 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
VirtualCircuitPublicPrefixVerificationStateEnum Enum with underlying type: string
type VirtualCircuitPublicPrefixVerificationStateEnum string
Set of constants representing the allowable values for VirtualCircuitPublicPrefixVerificationStateEnum
const (
VirtualCircuitPublicPrefixVerificationStateInProgress VirtualCircuitPublicPrefixVerificationStateEnum = "IN_PROGRESS"
VirtualCircuitPublicPrefixVerificationStateCompleted VirtualCircuitPublicPrefixVerificationStateEnum = "COMPLETED"
VirtualCircuitPublicPrefixVerificationStateFailed VirtualCircuitPublicPrefixVerificationStateEnum = "FAILED"
)
func GetMappingVirtualCircuitPublicPrefixVerificationStateEnum(val string) (VirtualCircuitPublicPrefixVerificationStateEnum, bool)
GetMappingVirtualCircuitPublicPrefixVerificationStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVirtualCircuitPublicPrefixVerificationStateEnumValues() []VirtualCircuitPublicPrefixVerificationStateEnum
GetVirtualCircuitPublicPrefixVerificationStateEnumValues Enumerates the set of values for VirtualCircuitPublicPrefixVerificationStateEnum
VirtualCircuitRoutingPolicyEnum Enum with underlying type: string
type VirtualCircuitRoutingPolicyEnum string
Set of constants representing the allowable values for VirtualCircuitRoutingPolicyEnum
const (
VirtualCircuitRoutingPolicyOracleServiceNetwork VirtualCircuitRoutingPolicyEnum = "ORACLE_SERVICE_NETWORK"
VirtualCircuitRoutingPolicyRegional VirtualCircuitRoutingPolicyEnum = "REGIONAL"
VirtualCircuitRoutingPolicyMarketLevel VirtualCircuitRoutingPolicyEnum = "MARKET_LEVEL"
VirtualCircuitRoutingPolicyGlobal VirtualCircuitRoutingPolicyEnum = "GLOBAL"
)
func GetMappingVirtualCircuitRoutingPolicyEnum(val string) (VirtualCircuitRoutingPolicyEnum, bool)
GetMappingVirtualCircuitRoutingPolicyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVirtualCircuitRoutingPolicyEnumValues() []VirtualCircuitRoutingPolicyEnum
GetVirtualCircuitRoutingPolicyEnumValues Enumerates the set of values for VirtualCircuitRoutingPolicyEnum
VirtualCircuitServiceTypeEnum Enum with underlying type: string
type VirtualCircuitServiceTypeEnum string
Set of constants representing the allowable values for VirtualCircuitServiceTypeEnum
const (
VirtualCircuitServiceTypeColocated VirtualCircuitServiceTypeEnum = "COLOCATED"
VirtualCircuitServiceTypeLayer2 VirtualCircuitServiceTypeEnum = "LAYER2"
VirtualCircuitServiceTypeLayer3 VirtualCircuitServiceTypeEnum = "LAYER3"
)
func GetMappingVirtualCircuitServiceTypeEnum(val string) (VirtualCircuitServiceTypeEnum, bool)
GetMappingVirtualCircuitServiceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVirtualCircuitServiceTypeEnumValues() []VirtualCircuitServiceTypeEnum
GetVirtualCircuitServiceTypeEnumValues Enumerates the set of values for VirtualCircuitServiceTypeEnum
VirtualCircuitTypeEnum Enum with underlying type: string
type VirtualCircuitTypeEnum string
Set of constants representing the allowable values for VirtualCircuitTypeEnum
const (
VirtualCircuitTypePublic VirtualCircuitTypeEnum = "PUBLIC"
VirtualCircuitTypePrivate VirtualCircuitTypeEnum = "PRIVATE"
)
func GetMappingVirtualCircuitTypeEnum(val string) (VirtualCircuitTypeEnum, bool)
GetMappingVirtualCircuitTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVirtualCircuitTypeEnumValues() []VirtualCircuitTypeEnum
GetVirtualCircuitTypeEnumValues Enumerates the set of values for VirtualCircuitTypeEnum
VisibleTrafficNode Defines the configuration of a traffic node that is visible to the user.
type VisibleTrafficNode struct {
EgressTraffic *EgressTrafficSpec `mandatory:"false" json:"egressTraffic"`
NextHopRoutingAction RoutingAction `mandatory:"false" json:"nextHopRoutingAction"`
EgressSecurityAction SecurityAction `mandatory:"false" json:"egressSecurityAction"`
IngressSecurityAction SecurityAction `mandatory:"false" json:"ingressSecurityAction"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the OCI entity that
// represents the traffic node (Instance, GW, LB, etc.).
EntityId *string `mandatory:"false" json:"entityId"`
// Describes how the traffic was transformed. For example, if an address is translated by a NAT GW,
// the string will describe the translation: 'SNAT: 10.0.0.1->204.0.0.1'
TransformationDescription *string `mandatory:"false" json:"transformationDescription"`
}
func (m VisibleTrafficNode) GetEgressSecurityAction() SecurityAction
GetEgressSecurityAction returns EgressSecurityAction
func (m VisibleTrafficNode) GetEgressTraffic() *EgressTrafficSpec
GetEgressTraffic returns EgressTraffic
func (m VisibleTrafficNode) GetIngressSecurityAction() SecurityAction
GetIngressSecurityAction returns IngressSecurityAction
func (m VisibleTrafficNode) GetNextHopRoutingAction() RoutingAction
GetNextHopRoutingAction returns NextHopRoutingAction
func (m VisibleTrafficNode) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m VisibleTrafficNode) String() string
func (m *VisibleTrafficNode) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m VisibleTrafficNode) 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
Vlan A resource to be used only with the Oracle Cloud VMware Solution. Conceptually, a virtual LAN (VLAN) is a broadcast domain that is created by partitioning and isolating a network at the data link layer (a *layer 2 network*). VLANs work by using IEEE 802.1Q VLAN tags. Layer 2 traffic is forwarded within the VLAN based on MAC learning. In the Networking service, a VLAN is an object within a VCN. You use VLANs to partition the VCN at the data link layer (layer 2). A VLAN is analagous to a subnet, which is an object for partitioning the VCN at the IP layer (layer 3).
type Vlan struct {
// The range of IPv4 addresses that will be used for layer 3 communication with
// hosts outside the VLAN.
// Example: `192.168.1.0/24`
CidrBlock *string `mandatory:"true" json:"cidrBlock"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the VLAN.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The VLAN's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"true" json:"id"`
// The VLAN's current state.
LifecycleState VlanLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN the VLAN is in.
VcnId *string `mandatory:"true" json:"vcnId"`
// The VLAN's availability domain. This attribute will be null if this is a regional VLAN
// rather than an AD-specific VLAN.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// A list of the OCIDs of the network security groups (NSGs) to use with this VLAN.
// All VNICs in the VLAN belong to these NSGs. For more
// information about NSGs, see
// NetworkSecurityGroup.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// The IEEE 802.1Q VLAN tag of this VLAN.
// Example: `100`
VlanTag *int `mandatory:"false" json:"vlanTag"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table that the VLAN uses.
RouteTableId *string `mandatory:"false" json:"routeTableId"`
// The date and time the VLAN was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
}
func (m Vlan) String() string
func (m Vlan) 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
VlanEndpoint Defines the details required for a VLAN-type `Endpoint`.
type VlanEndpoint struct {
// The IPv4 address of the `Endpoint`.
Address *string `mandatory:"true" json:"address"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN containing the IP address.
// This can be used to disambiguate which VLAN is queried, in case the endpoint IP
// address belongs to more than one VLAN (when there are VLANs with overlapping IP ranges).
VlanId *string `mandatory:"true" json:"vlanId"`
}
func (m VlanEndpoint) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m VlanEndpoint) String() string
func (m VlanEndpoint) 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
VlanLifecycleStateEnum Enum with underlying type: string
type VlanLifecycleStateEnum string
Set of constants representing the allowable values for VlanLifecycleStateEnum
const (
VlanLifecycleStateProvisioning VlanLifecycleStateEnum = "PROVISIONING"
VlanLifecycleStateAvailable VlanLifecycleStateEnum = "AVAILABLE"
VlanLifecycleStateTerminating VlanLifecycleStateEnum = "TERMINATING"
VlanLifecycleStateTerminated VlanLifecycleStateEnum = "TERMINATED"
VlanLifecycleStateUpdating VlanLifecycleStateEnum = "UPDATING"
)
func GetMappingVlanLifecycleStateEnum(val string) (VlanLifecycleStateEnum, bool)
GetMappingVlanLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVlanLifecycleStateEnumValues() []VlanLifecycleStateEnum
GetVlanLifecycleStateEnumValues Enumerates the set of values for VlanLifecycleStateEnum
VnMonitoringClient a client for VnMonitoring
type VnMonitoringClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewVnMonitoringClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client VnMonitoringClient, err error)
NewVnMonitoringClientWithConfigurationProvider Creates a new default VnMonitoring client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewVnMonitoringClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client VnMonitoringClient, err error)
NewVnMonitoringClientWithOboToken Creates a new default VnMonitoring client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client VnMonitoringClient) ChangePathAnalyzerTestCompartment(ctx context.Context, request ChangePathAnalyzerTestCompartmentRequest) (response ChangePathAnalyzerTestCompartmentResponse, err error)
ChangePathAnalyzerTestCompartment Moves a `PathAnalyzerTest` resource from one compartment to another based on the identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/ChangePathAnalyzerTestCompartment.go.html to see an example of how to use ChangePathAnalyzerTestCompartment API.
func (client *VnMonitoringClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client VnMonitoringClient) CreatePathAnalyzerTest(ctx context.Context, request CreatePathAnalyzerTestRequest) (response CreatePathAnalyzerTestResponse, err error)
CreatePathAnalyzerTest Creates a new `PathAnalyzerTest` resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/CreatePathAnalyzerTest.go.html to see an example of how to use CreatePathAnalyzerTest API.
func (client VnMonitoringClient) DeletePathAnalyzerTest(ctx context.Context, request DeletePathAnalyzerTestRequest) (response DeletePathAnalyzerTestResponse, err error)
DeletePathAnalyzerTest Deletes a `PathAnalyzerTest` resource using its identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/DeletePathAnalyzerTest.go.html to see an example of how to use DeletePathAnalyzerTest API.
func (client VnMonitoringClient) GetPathAnalysis(ctx context.Context, request GetPathAnalysisRequest) (response GetPathAnalysisResponse, err error)
GetPathAnalysis Use this method to initiate a Network Path Analyzer (https://docs.oracle.com/iaas/Content/Network/Concepts/path_analyzer.htm) analysis. This method returns an opc-work-request-id, and you can poll the status of the work request until it either fails or succeeds. If the work request status is successful, use ListWorkRequestResults with the work request ID to ask for the successful analysis results. If the work request status is failed, use ListWorkRequestErrors with the work request ID to ask for the analysis failure information. The information returned from either of these methods can be used to build a final report.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/GetPathAnalysis.go.html to see an example of how to use GetPathAnalysis API.
func (client VnMonitoringClient) GetPathAnalyzerTest(ctx context.Context, request GetPathAnalyzerTestRequest) (response GetPathAnalyzerTestResponse, err error)
GetPathAnalyzerTest Gets a `PathAnalyzerTest` using its identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/GetPathAnalyzerTest.go.html to see an example of how to use GetPathAnalyzerTest API.
func (client VnMonitoringClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the details of a work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API.
func (client VnMonitoringClient) ListPathAnalyzerTests(ctx context.Context, request ListPathAnalyzerTestsRequest) (response ListPathAnalyzerTestsResponse, err error)
ListPathAnalyzerTests Returns a list of all `PathAnalyzerTests` in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/ListPathAnalyzerTests.go.html to see an example of how to use ListPathAnalyzerTests API.
func (client VnMonitoringClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Returns a (paginated) list of errors for the work request with the given ID. This information is used to build the final report output.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API.
func (client VnMonitoringClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Returns a (paginated) list of logs for the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API.
func (client VnMonitoringClient) ListWorkRequestResults(ctx context.Context, request ListWorkRequestResultsRequest) (response ListWorkRequestResultsResponse, err error)
ListWorkRequestResults Returns a (paginated) list of results for a successful work request. This information is used to build the final report output.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/ListWorkRequestResults.go.html to see an example of how to use ListWorkRequestResults API.
func (client VnMonitoringClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.
func (client *VnMonitoringClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client VnMonitoringClient) UpdatePathAnalyzerTest(ctx context.Context, request UpdatePathAnalyzerTestRequest) (response UpdatePathAnalyzerTestResponse, err error)
UpdatePathAnalyzerTest Updates a `PathAnalyzerTest` using its identifier.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/vnmonitoring/UpdatePathAnalyzerTest.go.html to see an example of how to use UpdatePathAnalyzerTest API.
Vnic A virtual network interface card. Each VNIC resides in a subnet in a VCN. An instance attaches to a VNIC to obtain a network connection into the VCN through that subnet. Each instance has a *primary VNIC* that is automatically created and attached during launch. You can add *secondary VNICs* to an instance after it's launched. For more information, see Virtual Network Interface Cards (VNICs) (https://docs.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm). Each VNIC has a *primary private IP* that is automatically assigned during launch. You can add *secondary private IPs* to a VNIC after it's created. For more information, see CreatePrivateIp and IP Addresses (https://docs.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm).
If you are an Oracle Cloud VMware Solution customer, you will have secondary VNICs that reside in a VLAN instead of a subnet. These VNICs have other differences, which are called out in the descriptions of the relevant attributes in the `Vnic` object. Also see Vlan. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
type Vnic struct {
// The VNIC's availability domain.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the VNIC.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC.
Id *string `mandatory:"true" json:"id"`
// The current state of the VNIC.
LifecycleState VnicLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The date and time the VNIC was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname
// portion of the primary private IP's fully qualified domain name (FQDN)
// (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`).
// Must be unique across all VNICs in the subnet and comply with
// RFC 952 (https://tools.ietf.org/html/rfc952) and
// RFC 1123 (https://tools.ietf.org/html/rfc1123).
// For more information, see
// DNS in Your Virtual Cloud Network (https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm).
// Example: `bminstance1`
HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`
// Whether the VNIC is the primary VNIC (the VNIC that is automatically created
// and attached during instance launch).
IsPrimary *bool `mandatory:"false" json:"isPrimary"`
// The MAC address of the VNIC.
// If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution,
// the MAC address is learned. If the VNIC belongs to a subnet, the
// MAC address is a static, Oracle-provided value.
// Example: `00:00:00:00:00:01`
MacAddress *string `mandatory:"false" json:"macAddress"`
// A list of the OCIDs of the network security groups that the VNIC belongs to.
// If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of
// belonging to a subnet), the value of the `nsgIds` attribute is ignored. Instead, the
// VNIC belongs to the NSGs that are associated with the VLAN itself. See Vlan.
// For more information about NSGs, see
// NetworkSecurityGroup.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of
// belonging to a subnet), the `vlanId` is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN the VNIC is in. See
// Vlan. If the VNIC is instead in a subnet, `subnetId` has a value.
VlanId *string `mandatory:"false" json:"vlanId"`
// The private IP address of the primary `privateIp` object on the VNIC.
// The address is within the CIDR of the VNIC's subnet.
// Example: `10.0.3.3`
PrivateIp *string `mandatory:"false" json:"privateIp"`
// The public IP address of the VNIC, if one is assigned.
PublicIp *string `mandatory:"false" json:"publicIp"`
// Whether the source/destination check is disabled on the VNIC.
// Defaults to `false`, which means the check is performed. For information
// about why you would skip the source/destination check, see
// Using a Private IP as a Route Target (https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip).
//
// If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of
// belonging to a subnet), the `skipSourceDestCheck` attribute is `true`.
// This is because the source/destination check is always disabled for VNICs in a VLAN.
// Example: `true`
SkipSourceDestCheck *bool `mandatory:"false" json:"skipSourceDestCheck"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet the VNIC is in.
SubnetId *string `mandatory:"false" json:"subnetId"`
}
func (m Vnic) String() string
func (m Vnic) 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
VnicEndpoint Defines the details required for a VNIC-type `Endpoint`.
type VnicEndpoint struct {
// The IPv4 address of a VNIC type `Endpoint`.
Address *string `mandatory:"true" json:"address"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC.
VnicId *string `mandatory:"true" json:"vnicId"`
}
func (m VnicEndpoint) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m VnicEndpoint) String() string
func (m VnicEndpoint) 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
VnicLifecycleStateEnum Enum with underlying type: string
type VnicLifecycleStateEnum string
Set of constants representing the allowable values for VnicLifecycleStateEnum
const (
VnicLifecycleStateProvisioning VnicLifecycleStateEnum = "PROVISIONING"
VnicLifecycleStateAvailable VnicLifecycleStateEnum = "AVAILABLE"
VnicLifecycleStateTerminating VnicLifecycleStateEnum = "TERMINATING"
VnicLifecycleStateTerminated VnicLifecycleStateEnum = "TERMINATED"
)
func GetMappingVnicLifecycleStateEnum(val string) (VnicLifecycleStateEnum, bool)
GetMappingVnicLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVnicLifecycleStateEnumValues() []VnicLifecycleStateEnum
GetVnicLifecycleStateEnumValues Enumerates the set of values for VnicLifecycleStateEnum
Vtap A virtual test access point (VTAP) provides a way to mirror all traffic from a designated source to a selected target in order to facilitate troubleshooting, security analysis, and data monitoring. A VTAP is functionally similar to a test access point (TAP) you might deploy in your on-premises network. A *CaptureFilter* contains a set of *CaptureFilterRuleDetails* governing what traffic a VTAP mirrors.
type Vtap struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `Vtap` resource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN containing the `Vtap` resource.
VcnId *string `mandatory:"true" json:"vcnId"`
// The VTAP's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
Id *string `mandatory:"true" json:"id"`
// The VTAP's administrative lifecycle state.
LifecycleState VtapLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source point where packets are captured.
SourceId *string `mandatory:"true" json:"sourceId"`
// The capture filter's Oracle ID (OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
CaptureFilterId *string `mandatory:"true" json:"captureFilterId"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// A user-friendly name. Does not have to be unique, and it's changeable.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The VTAP's current running state.
LifecycleStateDetails VtapLifecycleStateDetailsEnum `mandatory:"false" json:"lifecycleStateDetails,omitempty"`
// The date and time the VTAP was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2020-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the destination resource where mirrored packets are sent.
TargetId *string `mandatory:"false" json:"targetId"`
// The IP address of the destination resource where mirrored packets are sent.
TargetIp *string `mandatory:"false" json:"targetIp"`
// Defines an encapsulation header type for the VTAP's mirrored traffic.
EncapsulationProtocol VtapEncapsulationProtocolEnum `mandatory:"false" json:"encapsulationProtocol,omitempty"`
// The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.
VxlanNetworkIdentifier *int64 `mandatory:"false" json:"vxlanNetworkIdentifier"`
// Used to start or stop a `Vtap` resource.
// * `TRUE` directs the VTAP to start mirroring traffic.
// * `FALSE` (Default) directs the VTAP to stop mirroring traffic.
IsVtapEnabled *bool `mandatory:"false" json:"isVtapEnabled"`
// The source type for the VTAP.
SourceType VtapSourceTypeEnum `mandatory:"false" json:"sourceType,omitempty"`
// Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
TrafficMode VtapTrafficModeEnum `mandatory:"false" json:"trafficMode,omitempty"`
// The maximum size of the packets to be included in the filter.
MaxPacketSize *int `mandatory:"false" json:"maxPacketSize"`
// The target type for the VTAP.
TargetType VtapTargetTypeEnum `mandatory:"false" json:"targetType,omitempty"`
// The IP Address of the source private endpoint.
SourcePrivateEndpointIp *string `mandatory:"false" json:"sourcePrivateEndpointIp"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet that source private endpoint belongs to.
SourcePrivateEndpointSubnetId *string `mandatory:"false" json:"sourcePrivateEndpointSubnetId"`
}
func (m Vtap) String() string
func (m Vtap) 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
VtapCaptureFilterRuleDetails This resource contains the rules governing what traffic a VTAP mirrors.
type VtapCaptureFilterRuleDetails struct {
// The traffic direction the VTAP is configured to mirror.
TrafficDirection VtapCaptureFilterRuleDetailsTrafficDirectionEnum `mandatory:"true" json:"trafficDirection"`
// Include or exclude packets meeting this definition from mirrored traffic.
RuleAction VtapCaptureFilterRuleDetailsRuleActionEnum `mandatory:"false" json:"ruleAction,omitempty"`
// Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.
SourceCidr *string `mandatory:"false" json:"sourceCidr"`
// Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.
DestinationCidr *string `mandatory:"false" json:"destinationCidr"`
// The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter.
// Supported options are:
// * 1 = ICMP
// * 6 = TCP
// * 17 = UDP
Protocol *string `mandatory:"false" json:"protocol"`
IcmpOptions *IcmpOptions `mandatory:"false" json:"icmpOptions"`
TcpOptions *TcpOptions `mandatory:"false" json:"tcpOptions"`
UdpOptions *UdpOptions `mandatory:"false" json:"udpOptions"`
}
func (m VtapCaptureFilterRuleDetails) String() string
func (m VtapCaptureFilterRuleDetails) 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
VtapCaptureFilterRuleDetailsRuleActionEnum Enum with underlying type: string
type VtapCaptureFilterRuleDetailsRuleActionEnum string
Set of constants representing the allowable values for VtapCaptureFilterRuleDetailsRuleActionEnum
const (
VtapCaptureFilterRuleDetailsRuleActionInclude VtapCaptureFilterRuleDetailsRuleActionEnum = "INCLUDE"
VtapCaptureFilterRuleDetailsRuleActionExclude VtapCaptureFilterRuleDetailsRuleActionEnum = "EXCLUDE"
)
func GetMappingVtapCaptureFilterRuleDetailsRuleActionEnum(val string) (VtapCaptureFilterRuleDetailsRuleActionEnum, bool)
GetMappingVtapCaptureFilterRuleDetailsRuleActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVtapCaptureFilterRuleDetailsRuleActionEnumValues() []VtapCaptureFilterRuleDetailsRuleActionEnum
GetVtapCaptureFilterRuleDetailsRuleActionEnumValues Enumerates the set of values for VtapCaptureFilterRuleDetailsRuleActionEnum
VtapCaptureFilterRuleDetailsTrafficDirectionEnum Enum with underlying type: string
type VtapCaptureFilterRuleDetailsTrafficDirectionEnum string
Set of constants representing the allowable values for VtapCaptureFilterRuleDetailsTrafficDirectionEnum
const (
VtapCaptureFilterRuleDetailsTrafficDirectionIngress VtapCaptureFilterRuleDetailsTrafficDirectionEnum = "INGRESS"
VtapCaptureFilterRuleDetailsTrafficDirectionEgress VtapCaptureFilterRuleDetailsTrafficDirectionEnum = "EGRESS"
)
func GetMappingVtapCaptureFilterRuleDetailsTrafficDirectionEnum(val string) (VtapCaptureFilterRuleDetailsTrafficDirectionEnum, bool)
GetMappingVtapCaptureFilterRuleDetailsTrafficDirectionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVtapCaptureFilterRuleDetailsTrafficDirectionEnumValues() []VtapCaptureFilterRuleDetailsTrafficDirectionEnum
GetVtapCaptureFilterRuleDetailsTrafficDirectionEnumValues Enumerates the set of values for VtapCaptureFilterRuleDetailsTrafficDirectionEnum
VtapEncapsulationProtocolEnum Enum with underlying type: string
type VtapEncapsulationProtocolEnum string
Set of constants representing the allowable values for VtapEncapsulationProtocolEnum
const (
VtapEncapsulationProtocolVxlan VtapEncapsulationProtocolEnum = "VXLAN"
)
func GetMappingVtapEncapsulationProtocolEnum(val string) (VtapEncapsulationProtocolEnum, bool)
GetMappingVtapEncapsulationProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVtapEncapsulationProtocolEnumValues() []VtapEncapsulationProtocolEnum
GetVtapEncapsulationProtocolEnumValues Enumerates the set of values for VtapEncapsulationProtocolEnum
VtapLifecycleStateDetailsEnum Enum with underlying type: string
type VtapLifecycleStateDetailsEnum string
Set of constants representing the allowable values for VtapLifecycleStateDetailsEnum
const (
VtapLifecycleStateDetailsRunning VtapLifecycleStateDetailsEnum = "RUNNING"
VtapLifecycleStateDetailsStopped VtapLifecycleStateDetailsEnum = "STOPPED"
)
func GetMappingVtapLifecycleStateDetailsEnum(val string) (VtapLifecycleStateDetailsEnum, bool)
GetMappingVtapLifecycleStateDetailsEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVtapLifecycleStateDetailsEnumValues() []VtapLifecycleStateDetailsEnum
GetVtapLifecycleStateDetailsEnumValues Enumerates the set of values for VtapLifecycleStateDetailsEnum
VtapLifecycleStateEnum Enum with underlying type: string
type VtapLifecycleStateEnum string
Set of constants representing the allowable values for VtapLifecycleStateEnum
const (
VtapLifecycleStateProvisioning VtapLifecycleStateEnum = "PROVISIONING"
VtapLifecycleStateAvailable VtapLifecycleStateEnum = "AVAILABLE"
VtapLifecycleStateUpdating VtapLifecycleStateEnum = "UPDATING"
VtapLifecycleStateTerminating VtapLifecycleStateEnum = "TERMINATING"
VtapLifecycleStateTerminated VtapLifecycleStateEnum = "TERMINATED"
)
func GetMappingVtapLifecycleStateEnum(val string) (VtapLifecycleStateEnum, bool)
GetMappingVtapLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVtapLifecycleStateEnumValues() []VtapLifecycleStateEnum
GetVtapLifecycleStateEnumValues Enumerates the set of values for VtapLifecycleStateEnum
VtapSourceTypeEnum Enum with underlying type: string
type VtapSourceTypeEnum string
Set of constants representing the allowable values for VtapSourceTypeEnum
const (
VtapSourceTypeVnic VtapSourceTypeEnum = "VNIC"
VtapSourceTypeSubnet VtapSourceTypeEnum = "SUBNET"
VtapSourceTypeLoadBalancer VtapSourceTypeEnum = "LOAD_BALANCER"
VtapSourceTypeDbSystem VtapSourceTypeEnum = "DB_SYSTEM"
VtapSourceTypeExadataVmCluster VtapSourceTypeEnum = "EXADATA_VM_CLUSTER"
VtapSourceTypeAutonomousDataWarehouse VtapSourceTypeEnum = "AUTONOMOUS_DATA_WAREHOUSE"
)
func GetMappingVtapSourceTypeEnum(val string) (VtapSourceTypeEnum, bool)
GetMappingVtapSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVtapSourceTypeEnumValues() []VtapSourceTypeEnum
GetVtapSourceTypeEnumValues Enumerates the set of values for VtapSourceTypeEnum
VtapTargetTypeEnum Enum with underlying type: string
type VtapTargetTypeEnum string
Set of constants representing the allowable values for VtapTargetTypeEnum
const (
VtapTargetTypeVnic VtapTargetTypeEnum = "VNIC"
VtapTargetTypeNetworkLoadBalancer VtapTargetTypeEnum = "NETWORK_LOAD_BALANCER"
VtapTargetTypeIpAddress VtapTargetTypeEnum = "IP_ADDRESS"
)
func GetMappingVtapTargetTypeEnum(val string) (VtapTargetTypeEnum, bool)
GetMappingVtapTargetTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVtapTargetTypeEnumValues() []VtapTargetTypeEnum
GetVtapTargetTypeEnumValues Enumerates the set of values for VtapTargetTypeEnum
VtapTrafficModeEnum Enum with underlying type: string
type VtapTrafficModeEnum string
Set of constants representing the allowable values for VtapTrafficModeEnum
const (
VtapTrafficModeDefault VtapTrafficModeEnum = "DEFAULT"
VtapTrafficModePriority VtapTrafficModeEnum = "PRIORITY"
)
func GetMappingVtapTrafficModeEnum(val string) (VtapTrafficModeEnum, bool)
GetMappingVtapTrafficModeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetVtapTrafficModeEnumValues() []VtapTrafficModeEnum
GetVtapTrafficModeEnumValues Enumerates the set of values for VtapTrafficModeEnum
WorkRequest An asynchronous work request.
type WorkRequest struct {
// Type of the work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment
// that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// 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 status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The date and time the work request was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request transitioned from `ACCEPTED` to `IN_PROGRESS`,
// in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request reached a terminal state, either `FAILED` or `SUCCEEDED`.
// Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
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
WorkRequestError An error encountered while executing an operation that is tracked by a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured.
Code *string `mandatory:"true" json:"code"`
// A human-readable error string.
Message *string `mandatory:"true" json:"message"`
// The date and time the error occurred, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
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
WorkRequestErrorCollection Results of a `WorkRequestError` search.
type WorkRequestErrorCollection struct {
// List of `WorkRequestError` objects.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
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
WorkRequestLogEntry A log message from executing an operation that is tracked by a work request.
type WorkRequestLogEntry struct {
// A human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The date and time the log message was written, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) 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
WorkRequestLogEntryCollection Results of a `WorkRequestLog` search.
type WorkRequestLogEntryCollection struct {
// List of work request log entries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) 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
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request.
// A resource being created, updated, or deleted will remain in the `IN_PROGRESS` state until
// work is complete for that resource at which point it will transition to `CREATED`, `UPDATED`,
// or `DELETED`, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// The identifier of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that you can do a GET operation on to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
}
func (m WorkRequestResource) String() string
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
WorkRequestResult Ephemeral data resulting from an asynchronous operation.
type WorkRequestResult interface {
}
WorkRequestResultCollection Results of a `WorkRequestResult` search.
type WorkRequestResultCollection struct {
// List of `WorkRequestResult` objects.
Items []WorkRequestResult `mandatory:"true" json:"items"`
}
func (m WorkRequestResultCollection) String() string
func (m *WorkRequestResultCollection) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m WorkRequestResultCollection) 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
WorkRequestResultResultTypeEnum Enum with underlying type: string
type WorkRequestResultResultTypeEnum string
Set of constants representing the allowable values for WorkRequestResultResultTypeEnum
const (
WorkRequestResultResultTypePathAnalysis WorkRequestResultResultTypeEnum = "PATH_ANALYSIS"
)
func GetMappingWorkRequestResultResultTypeEnum(val string) (WorkRequestResultResultTypeEnum, bool)
GetMappingWorkRequestResultResultTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResultResultTypeEnumValues() []WorkRequestResultResultTypeEnum
GetWorkRequestResultResultTypeEnumValues Enumerates the set of values for WorkRequestResultResultTypeEnum
WorkRequestSummary A summary of the status of a work request.
type WorkRequestSummary struct {
// Type of the work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment
// that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// 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 status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The date and time the work request was created, in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the work request transitioned from `ACCEPTED` to `IN_PROGRESS`,
// in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the work request reached a terminal state, either `FAILED` or `SUCCEEDED`,
// in the format defined by RFC3339 (https://tools.ietf.org/html/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequestSummary) String() string
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
WorkRequestSummaryCollection Results of a `WorkRequest` search.
type WorkRequestSummaryCollection struct {
// List of `WorkRequestSummary` objects.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
func (m WorkRequestSummaryCollection) 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