@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

package/dist/docs/specifications/api/docs-cloud-f5-com.0062.public.ves.io.schema.cloud_link.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.cloud_link","description":"CloudLink is used to establish private connectivity from customer network to Cloud Sites or private connectivity from\nF5 XC Regional Edge(RE) to customer Cloud Sites","version":""},"paths":{"/api/config/namespaces/system/cloud_links/{name}/reapply_config":{"post":{"summary":"CloudLink ","description":"Reapply CloudLink Config","operationId":"ves.io.schema.cloud_link.CustomDataAPI.ReapplyConfig","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloud_linkReapplyConfigResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"name","description":"Name\n\nx-example: \"aws-cloud-link-east\"\nName of Cloud Link.","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloud_linkReapplyConfigRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-cloud_link-customdataapi-reapplyconfig"},"x-ves-proto-rpc":"ves.io.schema.cloud_link.CustomDataAPI.ReapplyConfig"},"x-displayname":"CloudLink","x-ves-proto-service":"ves.io.schema.cloud_link.CustomDataAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/cloud_links":{"post":{"summary":"Create CloudLink","description":"Creates a new CloudLink with configured parameters","operationId":"ves.io.schema.cloud_link.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloud_linkCreateResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloud_linkCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-cloud_link-api-create"},"x-ves-proto-rpc":"ves.io.schema.cloud_link.API.Create"},"x-displayname":"CloudLink","x-ves-proto-service":"ves.io.schema.cloud_link.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{metadata.namespace}/cloud_links/{metadata.name}":{"put":{"summary":"Replace CloudLink","description":"Replaces configured CloudLink with new set of parameters","operationId":"ves.io.schema.cloud_link.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloud_linkReplaceResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"metadata.namespace","description":"namespace\n\nx-example: \"staging\"\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"metadata.name","description":"name\n\nx-example: \"acmecorp-web\"\nThe configuration object to be replaced will be looked up by name","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloud_linkReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-cloud_link-api-replace"},"x-ves-proto-rpc":"ves.io.schema.cloud_link.API.Replace"},"x-displayname":"CloudLink","x-ves-proto-service":"ves.io.schema.cloud_link.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/cloud_links":{"get":{"summary":"List CloudLink","description":"List the set of cloud_link in a namespace","operationId":"ves.io.schema.cloud_link.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloud_linkListResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace to scope the listing of cloud_link","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"label_filter","description":"x-example: \"env in (staging, testing), tier in (web, db)\"\nA LabelSelectorType expression that every item in list response will satisfy","in":"query","required":false,"x-displayname":"Label Filter","schema":{"type":"string"}},{"name":"report_fields","description":"x-example: \"\"\nExtra fields to return along with summary fields","in":"query","required":false,"x-displayname":"Report Fields","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"report_status_fields","description":"x-example: \"\"\nExtra status fields to return along with summary fields","in":"query","required":false,"x-displayname":"Report Status Fields","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-cloud_link-api-list"},"x-ves-proto-rpc":"ves.io.schema.cloud_link.API.List"},"x-displayname":"CloudLink","x-ves-proto-service":"ves.io.schema.cloud_link.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/cloud_links/{name}":{"get":{"summary":"Get CloudLink","description":"Gets CloudLink parameters","operationId":"ves.io.schema.cloud_link.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloud_linkGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nThe namespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nThe name of the configuration object to be fetched","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"response_format","description":"The format in which the configuration object is to be fetched. This could be for example\n    - in GetSpec form for the contents of object\n    - in CreateRequest form to create a new similar object\n    - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object","in":"query","required":false,"x-displayname":"Broken Referred Objects","schema":{"type":"string","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-cloud_link-api-get"},"x-ves-proto-rpc":"ves.io.schema.cloud_link.API.Get"},"delete":{"summary":"Delete CloudLink","description":"Delete the specified cloud_link","operationId":"ves.io.schema.cloud_link.API.Delete","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"ns1\"\nNamespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nName of the configuration object","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cloud_linkDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-cloud_link-api-delete"},"x-ves-proto-rpc":"ves.io.schema.cloud_link.API.Delete"},"x-displayname":"CloudLink","x-ves-proto-service":"ves.io.schema.cloud_link.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"CloudLink","x-ves-proto-package":"ves.io.schema.cloud_link","components":{"schemas":{"cloud_linkAWSBYOCListType":{"type":"object","description":"List of Bring You Own Connection","title":"Bring You Own Connection List","x-displayname":"Bring Your Own Connections","x-ves-proto-message":"ves.io.schema.cloud_link.AWSBYOCListType","properties":{"connections":{"type":"array","description":" List of Bring You Own Connections. These AWS Direct Connect connections are not managed by F5XC but will be used for connecting sites and REs.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 10\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"List of Bring You Own Connections","minItems":1,"maxItems":10,"items":{"$ref":"#/components/schemas/cloud_linkAWSBYOCType"},"x-displayname":"Bring Your Own Connections","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"10","ves.io.schema.rules.repeated.min_items":"1"}}}},"cloud_linkAWSBYOCType":{"type":"object","description":"AWS Bring You Own Connection. F5XC supports Virtual interfaces from the same AWS cloud account.","title":"Bring You Own Connection","x-displayname":"Bring You Own Connection","x-ves-oneof-field-ip_type":"[\"ipv4\"]","x-ves-oneof-field-resource_name_choice":"[\"system_generated_name\",\"user_assigned_name\"]","x-ves-proto-message":"ves.io.schema.cloud_link.AWSBYOCType","properties":{"auth_key":{"$ref":"#/components/schemas/schemaSecretType"},"bgp_asn":{"type":"integer","description":" The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of your on-premises\n router for the new virtual interface to be configured on AWS.\n\nExample: ` \"64512\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 2147483647\n","title":"BGP ASN","format":"int64","x-displayname":"BGP ASN","x-ves-example":"64512","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"2147483647"}},"connection_id":{"type":"string","description":" Id of the existing AWS Direct Connect Connection\n\nExample: ` \"dxcon-a2h48678\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 64\n  ves.io.schema.rules.string.pattern: ^(dxcon-)([a-z0-9]{8}|[a-z0-9]{17})$\n","title":"Direct Connect Connection Id","maxLength":64,"x-displayname":"Direct Connect Connection Id","x-ves-example":"dxcon-a2h48678","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"64","ves.io.schema.rules.string.pattern":"^(dxcon-)([a-z0-9]{8}|[a-z0-9]{17})$"}},"ipv4":{"$ref":"#/components/schemas/cloud_linkIpv4Type"},"metadata":{"$ref":"#/components/schemas/schemaMessageMetaType"},"region":{"type":"string","description":" Region where the connection is setup\n\nExample: ` \"us-east-1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.in: [\\\"ap-northeast-1\\\",\\\"ap-southeast-1\\\",\\\"eu-central-1\\\",\\\"eu-west-1\\\",\\\"eu-west-3\\\",\\\"sa-east-1\\\",\\\"us-east-1\\\",\\\"us-east-2\\\",\\\"us-west-2\\\",\\\"ca-central-1\\\",\\\"af-south-1\\\",\\\"ap-east-1\\\",\\\"ap-south-1\\\",\\\"ap-northeast-2\\\",\\\"ap-southeast-2\\\",\\\"eu-south-1\\\",\\\"eu-north-1\\\",\\\"eu-west-2\\\",\\\"me-south-1\\\",\\\"us-west-1\\\",\\\"ap-southeast-3\\\"]\n","title":"Region","x-displayname":"Region","x-ves-example":"us-east-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.in":"[\\\"ap-northeast-1\\\",\\\"ap-southeast-1\\\",\\\"eu-central-1\\\",\\\"eu-west-1\\\",\\\"eu-west-3\\\",\\\"sa-east-1\\\",\\\"us-east-1\\\",\\\"us-east-2\\\",\\\"us-west-2\\\",\\\"ca-central-1\\\",\\\"af-south-1\\\",\\\"ap-east-1\\\",\\\"ap-south-1\\\",\\\"ap-northeast-2\\\",\\\"ap-southeast-2\\\",\\\"eu-south-1\\\",\\\"eu-north-1\\\",\\\"eu-west-2\\\",\\\"me-south-1\\\",\\\"us-west-1\\\",\\\"ap-southeast-3\\\"]"}},"system_generated_name":{"$ref":"#/components/schemas/ioschemaEmpty"},"tags":{"type":"object","description":" AWS Tags is a label consisting of a user-defined key and value.\n It helps to manage, identify, organize, search for, and filter resources in AWS console.\n Specified tags will be added to Virtual interface along with any F5XC specific tags\n\nExample: ` \"devstaging\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 128\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.max_pairs: 40\n  ves.io.schema.rules.map.values.string.max_len: 256\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"AWS Tags","x-displayname":"AWS Tags","x-ves-example":"dev: staging","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"128","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.max_pairs":"40","ves.io.schema.rules.map.values.string.max_len":"256","ves.io.schema.rules.map.values.string.min_len":"1"}},"user_assigned_name":{"type":"string","description":"Exclusive with [system_generated_name]\n User is managing the AWS resource name\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","title":"User Assigned","maxLength":256,"x-displayname":"User Assigned","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"virtual_interface_type":{"$ref":"#/components/schemas/cloud_linkVirtualInterfaceType"},"vlan":{"type":"integer","description":" Virtual Local Area Network number for the new virtual interface to be configured on the AWS.\n This tag is required for any traffic traversing the AWS Direct Connect connection\n\nExample: ` \"700\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 4094\n","title":"Virtual Local Area Network (VLAN)","format":"int64","x-displayname":"Virtual Local Area Network (VLAN)","x-ves-example":"700","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"4094"}}}},"cloud_linkAWSF5XCManagedType":{"type":"object","description":"x-displayName: \"F5 XC Managed CloudLink Connection\"\nAWS F5 XC Managed CloudLink Connection","title":"F5 XC Managed CloudLink Connection"},"cloud_linkAWSStatusType":{"type":"object","description":"Status reported by this Cloud Link and associated Amazon Web Services (AWS) cloud components","title":"Amazon Web Services (AWS) Cloud Link Status","x-displayname":"Amazon Web Services (AWS) Cloud Link Status","x-ves-proto-message":"ves.io.schema.cloud_link.AWSStatusType","properties":{"cloud_link_state":{"$ref":"#/components/schemas/schemaCloudLinkState"},"connection_status":{"type":"array","description":" Status reported by Amazon Web Services (AWS) CloudLink Connection","title":"CloudLink Direct Connect Connection Status","items":{"$ref":"#/components/schemas/cloud_linkDirectConnectConnectionStatusType"},"x-displayname":"CloudLink Direct Connect Connection Status"},"deployment_status":{"$ref":"#/components/schemas/cloud_linkCloudLinkDeploymentStatus"},"error_description":{"type":"string","description":" Description of error on site\n\nExample: ` \"value\"`","title":"Error Description","x-displayname":"Error Description","x-ves-example":"value"},"suggested_action":{"type":"string","description":" Suggested action for customer on error\n\nExample: ` \"value\"`","title":"Suggested Action","x-displayname":"Suggested Action","x-ves-example":"value"}}},"cloud_linkAWSType":{"type":"object","description":"CloudLink for AWS Cloud Provider","title":"Amazon Web Services(AWS) CloudLink Provider","x-displayname":"Amazon Web Services(AWS) CloudLink Provider","x-ves-oneof-field-cloud_link_type":"[\"byoc\"]","x-ves-oneof-field-direct_connect_gateway_asn_choice":"[\"custom_asn\"]","x-ves-proto-message":"ves.io.schema.cloud_link.AWSType","properties":{"aws_cred":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"byoc":{"$ref":"#/components/schemas/cloud_linkAWSBYOCListType"},"custom_asn":{"type":"integer","description":"Exclusive with []\n F5XC will use custom ASN to create a Direct Connect Gateway\n\nExample: ` \"64512\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.ranges: 64512-65534, 4200000000-4294967294\n","title":"Custom ASN","format":"int64","x-displayname":"Custom ASN","x-ves-example":"64512","x-ves-validation-rules":{"ves.io.schema.rules.uint32.ranges":"64512-65534, 4200000000-4294967294"}}}},"cloud_linkAzureStatusType":{"type":"object","description":"Status reported by associated Azure cloud components","title":"Azure Cloud Link Status","x-displayname":"Azure Cloud Link Status","x-ves-proto-message":"ves.io.schema.cloud_link.AzureStatusType"},"cloud_linkAzureType":{"type":"object","description":"x-displayName: \"Azure Cloud Provider\"\nCloudLink for Azure Cloud Provider","title":"Azure Cloud Provider"},"cloud_linkBGPPeerType":{"type":"object","description":"The BGP peer object.","title":"BGP Peer","x-displayname":"BGP Peer","x-ves-proto-message":"ves.io.schema.cloud_link.BGPPeerType","properties":{"address_family":{"type":"string","description":" The address family setup for the BGP peer.\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"ipv4\\\",\\\"ipv6\\\"]\n","title":"Address Family","x-displayname":"Address Family","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"ipv4\\\",\\\"ipv6\\\"]"}},"asn":{"type":"integer","description":" The autonomous system number (ASN) for the cloud provider side of the connection","title":"Cloud Provider ASN","format":"int64","x-displayname":"Cloud Provider ASN"},"bgp_peer_id":{"type":"string","description":" The ID of the BGP peer","title":"BGP Peer IP","x-displayname":"BGP Peer IP"},"bgp_peer_state":{"type":"string","description":" The state of the BGP peer.\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"verifying\\\",\\\"pending\\\",\\\"available\\\",\\\"deleting\\\",\\\"deleted\\\"]\n","title":"BGP Peer State","x-displayname":"BGP Peer State","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"verifying\\\",\\\"pending\\\",\\\"available\\\",\\\"deleting\\\",\\\"deleted\\\"]"}},"bgp_status":{"type":"string","description":" The status of the BGP peer.\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"up\\\",\\\"down\\\",\\\"unknown\\\"]\n","title":"BGP Peer Status","x-displayname":"BGP Peer Status","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"up\\\",\\\"down\\\",\\\"unknown\\\"]"}},"cloud_provider_address":{"type":"string","description":" The BGP peer IP configured on the cloud provider endpoint","title":"Cloud Provider Router Peer IP","x-displayname":"Cloud Provider Router Peer IP"},"customer_address":{"type":"string","description":" The BGP peer IP configured on the Customer endpoint","title":"Customer Peer IP","x-displayname":"Customer Peer IP"}}},"cloud_linkCloudLinkDeploymentStatus":{"type":"string","description":"Status of the CloudLink deployment\n\n - IN_PROGRESS: In-Progress\n\nCloudLink provisioning is in-progress\n - ERROR: Error\n\nAn error occurred while deploying CloudLink. Check the error description and suggested action\n - READY: Ready\n\nCloudLink is ready for use\n - DELETING: Deleting\n\nCloudLink deleting in progress\n - CUSTOMER_DEPLOYED: Customer Deployed\n\nCustomer deploys the CloudLink\n - NOT_APPLICABLE: NotApplicable\n\nDeployment status not applicable","title":"CloudLink Status","enum":["IN_PROGRESS","ERROR","READY","DELETING","CUSTOMER_DEPLOYED","NOT_APPLICABLE"],"default":"IN_PROGRESS","x-displayname":"Status","x-ves-proto-enum":"ves.io.schema.cloud_link.CloudLinkDeploymentStatus"},"cloud_linkCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of cloud_link","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.cloud_link.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/schemacloud_linkCreateSpecType"}}},"cloud_linkCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.cloud_link.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/schemacloud_linkGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"cloud_linkDeleteRequest":{"type":"object","description":"This is the input message of the 'Delete' RPC.","title":"DeleteRequest is used to delete a cloud_link","x-displayname":"Delete Request","x-ves-proto-message":"ves.io.schema.cloud_link.DeleteRequest","properties":{"fail_if_referred":{"type":"boolean","description":" Fail the delete operation if this object is being referred by other objects","title":"fail_if_referred","format":"boolean","x-displayname":"Fail-If-Referred"},"name":{"type":"string","description":" Name of the configuration object\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" Namespace in which the configuration object is present\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"}}},"cloud_linkDirectConnectConnectionStatusType":{"type":"object","description":"Status reported by Amazon Web Services (AWS) Direct Connect Connection related to this Cloud Link","title":"CloudLink Direct Connect Connection Status","x-displayname":"CloudLink Direct Connect Connection Status","x-ves-proto-message":"ves.io.schema.cloud_link.DirectConnectConnectionStatusType","properties":{"aws_path":{"type":"string","description":" Link to Amazon Web Services (AWS) object","title":"AWS Object Link","x-displayname":"AWS Object Link"},"bandwidth":{"type":"string","description":" The bandwidth of the connection.","title":"Bandwidth","x-displayname":"Bandwidth"},"connection_id":{"type":"string","description":" The ID of the direct connect connection","title":"Connection Id","x-displayname":"Connection Id"},"connection_name":{"type":"string","description":" The Name of the connection","title":"Connection Name","x-displayname":"Connection Name"},"connection_state":{"type":"string","description":" The state of the Direct Connect Connection\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"ordering\\\",\\\"requested\\\",\\\"pending\\\",\\\"available\\\",\\\"down\\\",\\\"deleting\\\",\\\"deleted\\\",\\\"rejected\\\",\\\"unknown\\\"]\n","title":"Connection State","x-displayname":"Connection State","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"ordering\\\",\\\"requested\\\",\\\"pending\\\",\\\"available\\\",\\\"down\\\",\\\"deleting\\\",\\\"deleted\\\",\\\"rejected\\\",\\\"unknown\\\"]"}},"gateway_status":{"$ref":"#/components/schemas/cloud_linkDirectConnectGatewayStatusType"},"has_logical_redundancy":{"type":"string","description":" Whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6)\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"unknown\\\",\\\"yes\\\",\\\"no\\\"]\n","title":"Logical Redundancy Status","x-displayname":"Logical Redundancy Status","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"unknown\\\",\\\"yes\\\",\\\"no\\\"]"}},"jumbo_frame_capable":{"type":"boolean","description":" Indicates whether jumbo frames (9001 MTU) are supported.","title":"Jumbo Frame Capable","format":"boolean","x-displayname":"Jumbo Frame Capable"},"location":{"type":"string","description":" Location of the connection","title":"Location","x-displayname":"Location"},"owner_account":{"type":"string","description":" The ID of the AWS account that owns the connection","title":"Owner Account","x-displayname":"Owner Account"},"partner_name":{"type":"string","description":" The name of the AWS Direct Connect service provider associated with the connection.","title":"Connection Partner","x-displayname":"Connection Partner"},"provider_name":{"type":"string","description":" The name of the service provider associated with the connection.","title":"Connection Provider","x-displayname":"Connection Provider"},"region":{"type":"string","description":" Region where the connection is located","title":"Region","x-displayname":"Region"},"tags":{"type":"object","description":" AWS Tags is a label consisting of a user-defined key and value which are assocaited with this coonnection.\n It helps to manage, identify, organize, search for, and filter resources in AWS console.\n\nExample: ` \"devstaging\"`","title":"AWS Tags","x-displayname":"AWS Tags","x-ves-example":"dev: staging"},"vif_status":{"$ref":"#/components/schemas/cloud_linkVirtualInterfaceStatusType"},"vlan":{"type":"integer","description":" Virtual Local Area Network number for the new virtual interface to be configured on the AWS.\n\nExample: ` \"700\"`","title":"Virtual Local Area Network (VLAN)","format":"int64","x-displayname":"Virtual Local Area Network (VLAN)","x-ves-example":"700"}}},"cloud_linkDirectConnectGatewayStatusType":{"type":"object","description":"Status reported by Amazon Web Services (AWS) Direct Connect Gateway Status and associations related to this Cloud Link","title":"Direct Connect Gateway Status","x-displayname":"Direct Connect Gateway Status","x-ves-proto-message":"ves.io.schema.cloud_link.DirectConnectGatewayStatusType","properties":{"amazon_asn":{"type":"string","description":" The autonomous system number (ASN) for the Amazon side of the connection","title":"Amazon Web Services (AWS) ASN","format":"uint64","x-displayname":"Amazon Web Services (AWS) ASN"},"aws_path":{"type":"string","description":" Link to Amazon Web Services (AWS) object","title":"AWS Object Link","x-displayname":"AWS Object Link"},"direct_connect_gateway_id":{"type":"string","description":" The ID of the direct connect gateway","title":"Gateway Id","x-displayname":"Gateway Id"},"direct_connect_gateway_name":{"type":"string","description":" The Name of the direct connect gateway","title":"Gateway Name","x-displayname":"Gateway Name"},"direct_connect_gateway_state":{"type":"string","description":" The state of the Direct Connect gateway\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"pending\\\",\\\"available\\\",\\\"deleting\\\",\\\"deleted\\\"]\n","title":"Direct Connect Gateway State","x-displayname":"Direct Connect Gateway State","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"pending\\\",\\\"available\\\",\\\"deleting\\\",\\\"deleted\\\"]"}},"owner_account":{"type":"string","description":" The ID of the AWS account that owns the connection","title":"Owner Account","x-displayname":"Owner Account"},"state_change_error":{"type":"string","description":" The error message if the state of an object failed to advance","title":"Direct Connect Gateway Error","x-displayname":"Direct Connect Gateway Error"}}},"cloud_linkGCPBYOCListType":{"type":"object","description":"List of GCP Bring You Own Connections","title":"GCP Bring You Own Connection List","x-displayname":"GCP Bring Your Own Connections","x-ves-proto-message":"ves.io.schema.cloud_link.GCPBYOCListType","properties":{"connections":{"type":"array","description":"Each 'Bring Your Own Connection' represents a virtual connection that the customer has provisioned in the Cloud (example: AWS Direct Connect). F5XC will orchestrate networking resources in the cloud to facilitate seamless private connectivity. \n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 10\n  ves.io.schema.rules.repeated.min_items: 1\n","title":"List of Bring You Own Connections","minItems":1,"maxItems":10,"items":{"$ref":"#/components/schemas/cloud_linkGCPBYOCType"},"x-displayname":"Bring Your Own Connections","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"10","ves.io.schema.rules.repeated.min_items":"1"}}}},"cloud_linkGCPBYOCType":{"type":"object","description":"GCP Bring You Own Connection.","title":"Bring You Own Connection","x-displayname":"Bring You Own Connection","x-ves-oneof-field-project_choice":"[\"project\",\"same_as_credential\"]","x-ves-proto-message":"ves.io.schema.cloud_link.GCPBYOCType","properties":{"interconnect_attachment_name":{"type":"string","description":" Name of already-existing GCP Cloud Interconnect Attachment\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 63\n  ves.io.schema.rules.string.min_len: 1\n","title":"Interconnect Attachment Name","minLength":1,"maxLength":63,"x-displayname":"Interconnect Attachment Name","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"63","ves.io.schema.rules.string.min_len":"1"}},"metadata":{"$ref":"#/components/schemas/schemaMessageMetaType"},"project":{"type":"string","description":"Exclusive with [same_as_credential]\n Specify a GCP Project for the interconnect attachment\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 30\n  ves.io.schema.rules.string.min_len: 4\n","title":"Project ID","minLength":4,"maxLength":30,"x-displayname":"Specified Project","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"30","ves.io.schema.rules.string.min_len":"4"}},"region":{"type":"string","description":" GCP Region in which the GCP Cloud Interconnect attachment is configured\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.in: [\\\"asia-east1\\\",\\\"asia-east2\\\",\\\"asia-northeast1\\\",\\\"asia-northeast2\\\",\\\"asia-northeast3\\\",\\\"asia-southeast1\\\",\\\"asia-southeast2\\\",\\\"europe-central2\\\",\\\"europe-north1\\\",\\\"europe-west1\\\",\\\"europe-west2\\\",\\\"europe-west3\\\",\\\"europe-west4\\\",\\\"europe-west6\\\",\\\"europe-west8\\\",\\\"europe-west9\\\",\\\"europe-west10\\\",\\\"europe-west12\\\",\\\"europe-southwest1\\\",\\\"me-west1\\\",\\\"me-central1\\\",\\\"me-central2\\\",\\\"northamerica-northeast1\\\",\\\"northamerica-northeast2\\\",\\\"us-central1\\\",\\\"us-east1\\\",\\\"us-east4\\\",\\\"us-east5\\\",\\\"us-south1\\\",\\\"us-west1\\\",\\\"us-west2\\\",\\\"us-west3\\\",\\\"us-west4\\\",\\\"southamerica-east1\\\",\\\"southamerica-west1\\\",\\\"australia-southeast1\\\",\\\"australia-southeast2\\\",\\\"asia-south1\\\",\\\"asia-south2\\\"]\n","title":"Region","x-displayname":"Region","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.in":"[\\\"asia-east1\\\",\\\"asia-east2\\\",\\\"asia-northeast1\\\",\\\"asia-northeast2\\\",\\\"asia-northeast3\\\",\\\"asia-southeast1\\\",\\\"asia-southeast2\\\",\\\"europe-central2\\\",\\\"europe-north1\\\",\\\"europe-west1\\\",\\\"europe-west2\\\",\\\"europe-west3\\\",\\\"europe-west4\\\",\\\"europe-west6\\\",\\\"europe-west8\\\",\\\"europe-west9\\\",\\\"europe-west10\\\",\\\"europe-west12\\\",\\\"europe-southwest1\\\",\\\"me-west1\\\",\\\"me-central1\\\",\\\"me-central2\\\",\\\"northamerica-northeast1\\\",\\\"northamerica-northeast2\\\",\\\"us-central1\\\",\\\"us-east1\\\",\\\"us-east4\\\",\\\"us-east5\\\",\\\"us-south1\\\",\\\"us-west1\\\",\\\"us-west2\\\",\\\"us-west3\\\",\\\"us-west4\\\",\\\"southamerica-east1\\\",\\\"southamerica-west1\\\",\\\"australia-southeast1\\\",\\\"australia-southeast2\\\",\\\"asia-south1\\\",\\\"asia-south2\\\"]"}},"same_as_credential":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"cloud_linkGCPCloudInterconnectAttachmentStatusType":{"type":"object","description":"Status reported by Google Cloud Platform (GCP) Cloud Interconnect attachment related to this Cloud Link","title":"CloudLink GCP Cloud Interconnect Connection Status","x-displayname":"CloudLink GCP Cloud Interconnect Connection Status","x-ves-proto-message":"ves.io.schema.cloud_link.GCPCloudInterconnectAttachmentStatusType","properties":{"admin_enabled":{"type":"boolean","description":" Whether the GCP Cloud Interconnect attachment is administratively enabled","title":"Admin Enabled","format":"boolean","x-displayname":"Admin Enabled"},"attachment_state":{"type":"string","description":" The state of the GCP Cloud Interconnect Attachment.\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"ACTIVE\\\",\\\"UNPROVISIONED\\\",\\\"PENDING_PARTNER\\\",\\\"PARTNER_REQUEST_RECEIVED\\\",\\\"PENDING_CUSTOMER\\\",\\\"DEFUNCT\\\"]\n","title":"GCP Cloud Interconnect Attachment State","x-displayname":"GCP Cloud Interconnect Attachment State","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"ACTIVE\\\",\\\"UNPROVISIONED\\\",\\\"PENDING_PARTNER\\\",\\\"PARTNER_REQUEST_RECEIVED\\\",\\\"PENDING_CUSTOMER\\\",\\\"DEFUNCT\\\"]"}},"availability_domain":{"type":"string","description":" Desired availability domain this attachment. Defaults to AVAILABILITY_DOMAIN_ANY.","title":"Availability Domain","x-displayname":"Availability Domain"},"bandwidth":{"type":"string","description":" Provisioned bandwidth capacity for this GCP Cloud Interconnect attachment","title":"Bandwidth","x-displayname":"Bandwidth"},"bgp_peers":{"type":"array","description":" BGP peer status for this GCP Cloud Interconnect.","title":"BGP Peers","items":{"$ref":"#/components/schemas/cloud_linkBGPPeerType"},"x-displayname":"BGP Peers"},"cloud_router_ip":{"type":"string","description":" IP address of this interconnect attachment on the GCP Cloud Router","title":"Cloud Router IP Address","x-displayname":"Cloud Router IP Address"},"customer_router_ip":{"type":"string","description":" IP address of this interconnect attachment on the customer side","title":"Customer Router IP Address","x-displayname":"Customer Router IP Address"},"dataplane_version":{"type":"integer","description":" The dataplane version of the GCP Cloud Interconnect Attachment.","title":"Dataplane Version","format":"int32","x-displayname":"GCP Cloud Interconnect Dataplane Version"},"encryption":{"type":"string","description":" Encryption type for this GCP Cloud Interconnect attachment\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"NONE\\\",\\\"IPSEC\\\"]\n","title":"Encryption","x-displayname":"Encryption","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"NONE\\\",\\\"IPSEC\\\"]"}},"gcp_path":{"type":"string","description":" Link to this interconnect's Cloud Router object in Google Cloud Platform","title":"GCP Object Link","x-displayname":"GCP Cloud Router Link"},"interconnect":{"type":"string","description":" Name of the underlying GCP Cloud Interconnect that this attachment is attached to","title":"GCP Cloud Interconnect","x-displayname":"GCP Cloud Interconnect"},"labels":{"type":"object","description":" Labels are user-defined keys and values associated with this GCP Cloud Interconnect attachment\n\nExample: ` \"devstaging\"`","title":"Labels","x-displayname":"Labels","x-ves-example":"dev: staging"},"mtu":{"type":"integer","description":" Maximum Transmission Unit (MTU) for the GCP Cloud Interconnect attachment.\n\nValidation Rules:\n  ves.io.schema.rules.uint32.ranges: 1440,1500\n","title":"Maximum Transmission Unit (MTU)","format":"int64","x-displayname":"Maximum Transmission Unit (MTU)","x-ves-validation-rules":{"ves.io.schema.rules.uint32.ranges":"1440,1500"}},"name":{"type":"string","description":" The name of the GCP Cloud Interconnect Attachment","title":"GCP Cloud Interconnect Attachment Name","x-displayname":"GCP Cloud Interconnect Attachment Name"},"operational_status":{"type":"string","description":" Provisioning status of this GCP Cloud Interconnect attachment","title":"Operational Status","x-displayname":"Operational Status"},"partner_asn":{"type":"integer","description":" Partner Autonomous System Number (ASN) for this GCP Cloud Interconnect attachment","title":"Partner ASN","format":"int64","x-displayname":"Partner ASN"},"partner_metadata":{"$ref":"#/components/schemas/cloud_linkGCPPartnerMetadata"},"project":{"type":"string","description":" GCP Project ID of this interconnect's Cloud Router","title":"Cloud Router Project ID","x-displayname":"Cloud Router Project ID"},"region":{"type":"string","description":" Region of this interconnect's Cloud Router","title":"Cloud Router Region","x-displayname":"Cloud Router Region"},"router":{"type":"string","description":" Name of the GCP Cloud Router to which this GCP Cloud Interconnect is connected","title":"Router","x-displayname":"Cloud Router"},"stack_type":{"type":"string","description":" TCP/IP Stack Type of the GCP Cloud Interconnect attachment.  Defaults to IPV4_ONLY.","title":"Stack Type","x-displayname":"Stack Type"},"type":{"type":"string","description":" Type of GCP Cloud Interconnect attachment\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.in: [\\\"DEDICATED\\\",\\\"PARTNER\\\",\\\"PARTNER_PROVIDER\\\"]\n","title":"Type","x-displayname":"Type","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.in":"[\\\"DEDICATED\\\",\\\"PARTNER\\\",\\\"PARTNER_PROVIDER\\\"]"}},"vlan":{"type":"integer","description":" Virtual Local Area Network number for the GCP Cloud Interconnect attachment.\n This tag is required for any traffic traversing the GCP Cloud Router via this connection.\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 1\n  ves.io.schema.rules.uint32.lte: 4094\n","title":"Virtual Local Area Network (VLAN)","format":"int64","x-displayname":"Virtual Local Area Network (VLAN)","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"1","ves.io.schema.rules.uint32.lte":"4094"}},"vpc_network":{"type":"string","description":" VPC Network of this interconnect's Cloud Router","title":"Cloud Router VPC Network","x-displayname":"Cloud Router VPC Network"}}},"cloud_linkGCPPartnerMetadata":{"type":"object","description":"Partner metadata for a GCP Cloud Interconnect attachment","title":"GCP Partner Metadata","x-displayname":"GCP Partner Metadata","x-ves-proto-message":"ves.io.schema.cloud_link.GCPPartnerMetadata","properties":{"interconnect":{"type":"string","description":" Name of partner interconnect associated with a GCP Cloud Interconnect attachment","title":"Interconnect Name","x-displayname":"Interconnect Name"},"name":{"type":"string","description":" Name of partner associated with a GCP Cloud Interconnect attachment","title":"Name","x-displayname":"Name"},"portal_url":{"type":"string","description":" URL to the partner portal for the interconnect associated with this GCP Cloud Interconnect attachment","title":"Portal URL","x-displayname":"Portal URL"}}},"cloud_linkGCPStatusType":{"type":"object","description":"Status reported by associated GCP cloud components","title":"GCP Cloud Link Status","x-displayname":"GCP Cloud Link Status","x-ves-proto-message":"ves.io.schema.cloud_link.GCPStatusType","properties":{"cloud_link_state":{"$ref":"#/components/schemas/schemaCloudLinkState"},"connection_status":{"type":"array","description":" Status reported by Google Cloud Platform (GCP) CloudLink Connection","title":"CloudLink GCP Cloud Interconnect Status","items":{"$ref":"#/components/schemas/cloud_linkGCPCloudInterconnectAttachmentStatusType"},"x-displayname":"CloudLink GCP Cloud Interconnect Connection Status"}}},"cloud_linkGCPType":{"type":"object","description":"CloudLink for GCP Cloud Provider","title":"Google Cloud Platform (GCP) CloudLink Provider","x-displayname":"Google Cloud Platform (GCP) CloudLink Provider","x-ves-oneof-field-cloud_link_type":"[\"byoc\"]","x-ves-proto-message":"ves.io.schema.cloud_link.GCPType","properties":{"byoc":{"$ref":"#/components/schemas/cloud_linkGCPBYOCListType"},"gcp_cred":{"$ref":"#/components/schemas/schemaviewsObjectRefType"}}},"cloud_linkGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read cloud_link","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.cloud_link.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/cloud_linkCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/cloud_linkReplaceRequest"},"spec":{"$ref":"#/components/schemas/schemacloud_linkGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/cloud_linkStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"cloud_linkGetResponseFormatCode":{"type":"string","description":"x-displayName: \"Get Response Format\"\nThis is the various forms that can be requested to be sent in the GetResponse\n\n - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\"\nDefault format of returned resource\n - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\"\nResponse should be in CreateRequest format\n - GET_RSP_FORMAT_FOR_REPLACE: x-displayName: \"Replace request format\"\nResponse should be in ReplaceRequest format\n - GET_RSP_FORMAT_STATUS: x-displayName: \"Status format\"\nResponse should be in StatusObject(s) format\n - GET_RSP_FORMAT_READ: x-displayName: \"GetSpecType format\"\nResponse should be in format of GetSpecType\n - GET_RSP_FORMAT_REFERRING_OBJECTS: x-displayName: \"Referring Objects\"\nResponse should have other objects referring to this object\n - GET_RSP_FORMAT_BROKEN_REFERENCES: x-displayName: \"Broken Referred Objects\"\nResponse should have deleted and disabled objects referrred by this object","title":"GetResponseFormatCode","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"},"cloud_linkIpv4Type":{"type":"object","description":"Configure BGP IPv4 peering for endpoints","title":"IPv4 Peering","x-displayname":"IPv4 Peering","x-ves-proto-message":"ves.io.schema.cloud_link.Ipv4Type","properties":{"aws_router_peer_address":{"type":"string","description":" The BGP peer IP configured on the AWS endpoint\n\nExample: ` \"10.1.0.0/31\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.ipv4_prefix: true\n  ves.io.schema.rules.string.max_ip_prefix_length: 32\n  ves.io.schema.rules.string.min_ip_prefix_length: 1\n","title":"AWS Router Peer IP/Prefix","x-displayname":"AWS Router IP/Prefix","x-ves-example":"10.1.0.0/31","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.ipv4_prefix":"true","ves.io.schema.rules.string.max_ip_prefix_length":"32","ves.io.schema.rules.string.min_ip_prefix_length":"1"}},"router_peer_address":{"type":"string","description":" The BGP peer IP configured on your (customer) endpoint\n\nExample: ` \"10.1.0.0/31\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.ipv4_prefix: true\n  ves.io.schema.rules.string.max_ip_prefix_length: 32\n  ves.io.schema.rules.string.min_ip_prefix_length: 1\n","title":"Customer Peer IP/Prefix","x-displayname":"Customer Router IP/Prefix","x-ves-example":"10.1.0.0/31","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.ipv4_prefix":"true","ves.io.schema.rules.string.max_ip_prefix_length":"32","ves.io.schema.rules.string.min_ip_prefix_length":"1"}}}},"cloud_linkIpv6Type":{"type":"object","description":"x-displayName: \"IPv6 Peering\"\nConfigure BGP IPv6 peering for endpoints","title":"IPv6 Peering"},"cloud_linkListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of cloud_link","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.cloud_link.ListResponse","properties":{"errors":{"type":"array","description":" Errors(if any) while listing items from collection","title":"errors","items":{"$ref":"#/components/schemas/schemaErrorType"},"x-displayname":"Errors"},"items":{"type":"array","description":" items represents the collection in response","title":"items","items":{"$ref":"#/components/schemas/cloud_linkListResponseItem"},"x-displayname":"Items"}}},"cloud_linkListResponseItem":{"type":"object","description":"By default a summary of cloud_link is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.","title":"ListResponseItem is an individual item in a collection of cloud_link","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.cloud_link.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this cloud_link","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this cloud_link","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates cloud_link is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/schemacloud_linkGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this cloud_link","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this cloud_link\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" The namespace this item belongs to\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"status_set":{"type":"array","description":" The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/cloud_linkStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"},"tenant":{"type":"string","description":" The tenant this item belongs to\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" The unique uid of this cloud_link\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"cloud_linkReapplyConfigRequest":{"type":"object","description":"Reapply CloudLink Config","title":"CloudLink Reapply Config Request","x-displayname":"CloudLink Reapply Config Request","x-ves-proto-message":"ves.io.schema.cloud_link.ReapplyConfigRequest","properties":{"name":{"type":"string","description":" Name of Cloud Link.\n\nExample: ` \"aws-cloud-link-east\"`","title":"Name","x-displayname":"Name","x-ves-example":"aws-cloud-link-east"}}},"cloud_linkReapplyConfigResponse":{"type":"object","description":"Reapply CloudLink Config","title":"CloudLink Reapply Config Response","x-displayname":"CloudLink Reapply Config Response","x-ves-proto-message":"ves.io.schema.cloud_link.ReapplyConfigResponse"},"cloud_linkReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a cloud_link","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.cloud_link.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/schemacloud_linkReplaceSpecType"}}},"cloud_linkReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.cloud_link.ReplaceResponse"},"cloud_linkStatusObject":{"type":"object","description":"Most recently observed status of object","title":"Status for Cloud Link","x-displayname":"Status","x-ves-displayorder":"1,3,4","x-ves-oneof-field-cloud_link_status":"[\"aws_status\",\"azure_status\",\"gcp_status\"]","x-ves-proto-message":"ves.io.schema.cloud_link.StatusObject","properties":{"aws_status":{"$ref":"#/components/schemas/cloud_linkAWSStatusType"},"azure_status":{"$ref":"#/components/schemas/cloud_linkAzureStatusType"},"conditions":{"type":"array","description":" Conditions reported by various component of the system","title":"conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"gcp_status":{"$ref":"#/components/schemas/cloud_linkGCPStatusType"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" Reference to object for current status","title":"object_refs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"}}},"cloud_linkVirtualInterfaceStatusType":{"type":"object","description":"Status reported by Amazon Web Services (AWS) Virtual Interface Status related to this Cloud Link","title":"Virtual Interface Status","x-displayname":"Virtual Interface Status","x-ves-proto-message":"ves.io.schema.cloud_link.VirtualInterfaceStatusType","properties":{"address_family":{"type":"string","description":" The address family setup for the BGP peer.\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"ipv4\\\",\\\"ipv6\\\"]\n","title":"Address Family","x-displayname":"Address Family","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"ipv4\\\",\\\"ipv6\\\"]"}},"amazon_address":{"type":"string","description":" The BGP peer IP configured on the AWS endpoint","title":"AWS Router Peer IP","x-displayname":"AWS Router Peer IP"},"amazon_asn":{"type":"string","description":" The autonomous system number (ASN) for the Amazon side of the connection","title":"Amazon Web Services (AWS) ASN","format":"uint64","x-displayname":"Amazon Web Services (AWS) ASN"},"attachment_state_change_error":{"type":"string","description":" The error message if the state of an object failed to advance.","title":"Gateway Attachment State Error","x-displayname":"Gateway Attachment State Error"},"aws_path":{"type":"string","description":" Link to Amazon Web Services (AWS) object","title":"AWS Object Link","x-displayname":"AWS Object Link"},"bgp_asn":{"type":"integer","description":" The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration","title":"Border Gateway Protocol (BGP) ASN","format":"int64","x-displayname":"Border Gateway Protocol (BGP) ASN"},"bgp_peers":{"type":"array","description":" The BGP peers configured on this virtual interface.","title":"BGP Peers","items":{"$ref":"#/components/schemas/cloud_linkBGPPeerType"},"x-displayname":"BGP Peers"},"connection_id":{"type":"string","description":" The ID of the direct connect connection","title":"Connection Id","x-displayname":"Connection Id"},"direct_connect_attachment_state":{"type":"string","description":" The state of the Attachment.\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"attaching\\\",\\\"attached\\\",\\\"detaching\\\",\\\"detached\\\"]\n","title":"Direct Connect Attachment State","x-displayname":"Direct Connect  Attachment State","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"attaching\\\",\\\"attached\\\",\\\"detaching\\\",\\\"detached\\\"]"}},"direct_connect_gateway_id":{"type":"string","description":" The ID of the direct connect gateway","title":"Gateway Id","x-displayname":"Gateway Id"},"direct_connect_gateway_name":{"type":"string","description":" The Name of the direct connect gateway","title":"Gateway Name","x-displayname":"Gateway Name"},"jumbo_frame_capable":{"type":"boolean","description":" Indicates whether jumbo frames (9001 MTU) are supported.","title":"Jumbo Frame Capable","format":"boolean","x-displayname":"Jumbo Frame Capable"},"location":{"type":"string","description":" Location where the virtual interface is located","title":"Location","x-displayname":"Location"},"mtu":{"type":"integer","description":" The maximum transmission unit (MTU), in bytes.","title":"Maximum Transmission Unit (MTU)","format":"int64","x-displayname":"Maximum Transmission Unit (MTU)"},"owner_account":{"type":"string","description":" The ID of the AWS account that owns the connection","title":"Owner Account","x-displayname":"Owner Account"},"region":{"type":"string","description":" Region where the virtual interface is located","title":"Region","x-displayname":"Region"},"tags":{"type":"object","description":" AWS Tags is a label consisting of a user-defined key and value which are assocaited with this coonnection.\n It helps to manage, identify, organize, search for, and filter resources in AWS console.\n\nExample: ` \"devstaging\"`","title":"AWS Tags","x-displayname":"AWS Tags","x-ves-example":"dev: staging"},"virtual_interface_id":{"type":"string","description":" ID of the virtual interface","title":"Virtual Interface Id","x-displayname":"Virtual Interface Id"},"virtual_interface_name":{"type":"string","description":" Name of the virtual interface","title":"Virtual Interface Name","x-displayname":"Virtual Interface Name"},"virtual_interface_state":{"type":"string","description":" The state of the virtual interface\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"confirming\\\",\\\"verifying\\\",\\\"pending\\\",\\\"available\\\",\\\"down\\\",\\\"deleting\\\",\\\"deleted\\\",\\\"rejected\\\",\\\"unknown\\\"]\n","title":"Virtual Interface State","x-displayname":"Virtual Interface State","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"confirming\\\",\\\"verifying\\\",\\\"pending\\\",\\\"available\\\",\\\"down\\\",\\\"deleting\\\",\\\"deleted\\\",\\\"rejected\\\",\\\"unknown\\\"]"}},"virtual_interface_type":{"type":"string","description":" Type of the virtual interface\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"private\\\",\\\"public\\\",\\\"transit\\\"]\n","title":"Virtual Interface Type","x-displayname":"Virtual Interface Type","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"private\\\",\\\"public\\\",\\\"transit\\\"]"}},"vlan":{"type":"integer","description":" Virtual Local Area Network number for the new virtual interface to be configured on the AWS.\n\nExample: ` \"700\"`","title":"Virtual Local Area Network (VLAN)","format":"int64","x-displayname":"Virtual Local Area Network (VLAN)","x-ves-example":"700"}}},"cloud_linkVirtualInterfaceType":{"type":"string","description":"Defines the type of virtual interface that needs to be configured on AWS\n\n - PRIVATE: Private\n\nA private virtual interface should be used to access an Amazon VPC using private IP addresses.\n - TRANSIT: Transit\n\nA transit virtual interface is a VLAN that transports traffic from a Direct Connect gateway to one or more transit gateways.","title":"Virtual Interface Type","enum":["PRIVATE"],"default":"PRIVATE","x-displayname":"Virtual Interface Type","x-ves-proto-enum":"ves.io.schema.cloud_link.VirtualInterfaceType"},"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaBlindfoldSecretInfoType":{"type":"object","description":"BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management","title":"BlindfoldSecretInfoType","x-displayname":"Blindfold Secret","x-ves-displayorder":"3,1,2","x-ves-proto-message":"ves.io.schema.BlindfoldSecretInfoType","properties":{"decryption_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the backend Secret Management service.\n\nExample: ` \"value\"`","title":"Decryption Provider","x-displayname":"Decryption Provider","x-ves-example":"value"},"location":{"type":"string","description":" Location is the uri_ref. It could be in url format for string:///\n Or it could be a path if the store provider is an http/https location\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.uri_ref: true\n","title":"Location","x-displayname":"Location","x-ves-example":"string:///U2VjcmV0SW5mb3JtYXRpb24=","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.uri_ref":"true"}},"store_provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"value\"`","title":"Store Provider","x-displayname":"Store Provider","x-ves-example":"value"}}},"schemaClearSecretInfoType":{"type":"object","description":"ClearSecretInfoType specifies information about the Secret that is not encrypted.","title":"ClearSecretInfoType","x-displayname":"In-Clear Secret","x-ves-displayorder":"2,1","x-ves-proto-message":"ves.io.schema.ClearSecretInfoType","properties":{"provider":{"type":"string","description":" Name of the Secret Management Access object that contains information about the store to get encrypted bytes\n This field needs to be provided only if the url scheme is not string:///\n\nExample: ` \"box-provider\"`","title":"Provider","x-displayname":"Provider","x-ves-example":"box-provider"},"url":{"type":"string","description":" URL of the secret. Currently supported URL schemes is string:///.\n For string:/// scheme, Secret needs to be encoded Base64 format.\n When asked for this secret, caller will get Secret bytes after Base64 decoding.\n\nExample: ` \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 131072\n  ves.io.schema.rules.string.uri_ref: true\n","title":"URL","maxLength":131072,"x-displayname":"URL","x-ves-example":"string:///U2VjcmV0SW5mb3JtYXRpb24=","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"131072","ves.io.schema.rules.string.uri_ref":"true"}}}},"schemaCloudLinkState":{"type":"string","description":"State of the CloudLink connections\n\n - UP: Up\n\nCloudLink and their corresponding Direct Connect connections are up and healthy\n - DOWN: Down\n\nCloudLink and their corresponding Direct Connect connections are down\n - DEGRADED: Degraded\n\nSome of Direct Connect connections with the CloudLink are down\n - NOT_APPLICABLE: NotApplicable\n\nCloudLinkState not applicable","title":"CloudLink State","enum":["UP","DOWN","DEGRADED","NOT_APPLICABLE"],"default":"UP","x-displayname":"CloudLink State","x-ves-proto-enum":"ves.io.schema.CloudLinkState"},"schemaConditionType":{"type":"object","description":"Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.","title":"ConditionType","x-displayname":"Status Condition","x-ves-proto-message":"ves.io.schema.ConditionType","properties":{"hostname":{"type":"string","description":" Hostname of the instance of the site that sent the status","title":"hostname","x-displayname":"Hostname"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. Requested operation was successful.\n \"Failed\"  Validation has failed.\n \"Incomplete\" Validation of configuration has failed due to missing configuration.\n \"Installed\" Validation has passed and configuration has been installed in data path or K8s\n \"Down\" Configuration is operationally down. e.g. down interface\n \"Disabled\" Configuration is administratively disabled i.e. ObjectMetaType.Disable = true.\n \"NotApplicable\" Configuration is not applicable e.g. tenant service_policy_set(s) in system namespace are not applicable on REs\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","title":"status","x-displayname":"Status","x-ves-example":"Failed","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"}},"type":{"type":"string","description":" Type of the condition\n \"Validation\" represents validation user given configuration object\n \"Operational\" represents operational status of a given configuration object\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"schemaMessageMetaType":{"type":"object","description":"MessageMetaType is metadata (common attributes) of a message that only certain messages\nhave. This information is propagated to the metadata of a child object that gets created\nfrom the containing message during view processing.\nThe information in this type can be specified by user during create and replace APIs.","title":"MessageMetaType","x-displayname":"Message Metadata","x-ves-proto-message":"ves.io.schema.MessageMetaType","properties":{"description":{"type":"string","description":" Human readable description.\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","title":"description","maxLength":256,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"name":{"type":"string","description":" This is the name of the message.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.min_len: 1\n  ves.io.schema.rules.string.ves_object_name: true\n","title":"name","minLength":1,"x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.min_len":"1","ves.io.schema.rules.string.ves_object_name":"true"}}}},"schemaObjectCreateMetaType":{"type":"object","description":"ObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","x-displayname":"Create Metadata","x-ves-proto-message":"ves.io.schema.ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaSecretEncodingType":{"type":"string","description":"x-displayName: \"Secret Encoding\"\nSecretEncodingType defines the encoding type of the secret before handled by the Secret Management Service.\n\n - EncodingNone: x-displayName: \"None\"\nNo Encoding\n - EncodingBase64: Base64\n\nx-displayName: \"Base64\"\nBase64 encoding","title":"SecretEncodingType","enum":["EncodingNone","EncodingBase64"],"default":"EncodingNone"},"schemaSecretType":{"type":"object","description":"SecretType is used in an object to indicate a sensitive/confidential field","title":"SecretType","x-displayname":"Secret","x-ves-oneof-field-secret_info_oneof":"[\"blindfold_secret_info\",\"clear_secret_info\"]","x-ves-proto-message":"ves.io.schema.SecretType","properties":{"blindfold_secret_info":{"$ref":"#/components/schemas/schemaBlindfoldSecretInfoType"},"clear_secret_info":{"$ref":"#/components/schemas/schemaClearSecretInfoType"}}},"schemaStatusMetaType":{"type":"object","description":"StatusMetaType is metadata that all status must have.","title":"StatusMetaType","x-displayname":"Metadata","x-ves-proto-message":"ves.io.schema.StatusMetaType","properties":{"creation_timestamp":{"type":"string","description":" creation_timestamp is when the status object was created. It is used to find/tie-break\n for latest status object from same origin","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" Class of creator which created this StatusObject. This will be service's DNS FQDN.\n This will be set by the system based on client certificate information.\n\nExample: ` \"ver.re1.int.ves.io\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"ver.re1.int.ves.io"},"creator_id":{"type":"string","description":" ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\n identifying the environment also). This will be set by the system based on client certificate\n information\n\nExample: ` \"ver-instance-1\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"ver-instance-1"},"publish":{"$ref":"#/components/schemas/schemaStatusPublishType"},"status_id":{"type":"string","description":" status_id is a field used by the generator to distinguish (if necessary) between two status\n objects for the same config object from the same site and same service and potentially same\n daemon(creator-id)","title":"status_id","x-displayname":"Status ID"},"uid":{"type":"string","description":" uid is the unique in time and space value for a StatusObject.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Origin of this status exchanged by VTRP.","title":"vtrp_id","x-displayname":"VTRP ID"},"vtrp_stale":{"type":"boolean","description":" Indicate whether mars deems this object to be stale via graceful restart timer information","title":"vtrp_stale","format":"boolean","x-displayname":"VTRP Stale"}}},"schemaStatusPublishType":{"type":"string","description":"StatusPublishType is all possible publish operations on a StatusObject\n\n - STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n - STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable","title":"StatusPublishType","enum":["STATUS_DO_NOT_PUBLISH","STATUS_PUBLISH"],"default":"STATUS_DO_NOT_PUBLISH","x-displayname":"Status Publish Type","x-ves-proto-enum":"ves.io.schema.StatusPublishType"},"schemaStatusType":{"type":"object","description":"Status is a return value for calls that don't return other objects.","title":"StatusType","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.StatusType","properties":{"code":{"type":"integer","description":" Suggested HTTP return code for this status, 0 if not set.\n\nExample: ` \"0\"`","title":"code","format":"int32","x-displayname":"Code","x-ves-example":"0"},"reason":{"type":"string","description":" A human-readable description of why this operation is in the\n \"Failure\" status. If this value is empty there\n is no information available.\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"status":{"type":"string","description":" Status of the operation.\n One of: \"Success\" or \"Failure\".\n\nExample: ` \"value\"`","title":"status","x-displayname":"Status","x-ves-example":"value"}}},"schemaSystemObjectGetMetaType":{"type":"object","description":"SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.","title":"SystemObjectGetMetaType","x-displayname":"System Metadata","x-ves-proto-message":"ves.io.schema.SystemObjectGetMetaType","properties":{"creation_timestamp":{"type":"string","description":" CreationTimestamp is a timestamp representing the server time when this object was\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients may not set this value. It is represented in RFC3339 form and is in UTC.","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"prism"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"admin@acmecorp.com"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the operator or software. Values here can be interpreted\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaVaultSecretInfoType":{"type":"object","description":"x-displayName: \"Vault Secret\"\nVaultSecretInfoType specifies information about the Secret managed by Hashicorp Vault.","title":"VaultSecretInfoType","properties":{"key":{"type":"string","description":"x-displayName: \"Key\"\nx-example: \"key_pem\"\nKey of the individual secret. Vault Secrets are stored as key-value pair.\nIf user is only interested in one value from the map, this field should be set to the corresponding key.\nIf not provided entire secret will be returned.","title":"Key"},"location":{"type":"string","description":"x-displayName: \"Location\"\nx-required\nx-example: \"v1/data/vhost_key\"\nPath to secret in Vault.","title":"Location"},"provider":{"type":"string","description":"x-displayName: \"Provider\"\nx-required\nx-example: \"vault-vh-provider\"\nName of the Secret Management Access object that contains information about the backend Vault.","title":"Provider"},"secret_encoding":{"$ref":"#/components/schemas/schemaSecretEncodingType"},"version":{"type":"integer","description":"x-displayName: \"Version\"\nx-example: \"1\"\nVersion of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version.\nIf not provided latest version will be returned.","title":"Version","format":"int64"}}},"schemaViewRefType":{"type":"object","description":"ViewRefType represents a reference to a view","title":"ViewRefType","x-displayname":"View Reference","x-ves-proto-message":"ves.io.schema.ViewRefType","properties":{"kind":{"type":"string","description":" Kind of the view object\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}},"schemaWingmanSecretInfoType":{"type":"object","description":"x-displayName: \"Wingman Secret\"\nWingmanSecretInfoType specifies the handle to the wingman secret","title":"WingmanSecretInfoType","properties":{"name":{"type":"string","description":"x-displayName: \"Name\"\nx-required\nx-example: \"ChargeBack-API-Key\"\nName of the secret.","title":"Name"}}},"schemacloud_linkCreateSpecType":{"type":"object","description":"Creates a new CloudLink with configured parameters","title":"Create CloudLink","x-displayname":"Create CloudLink","x-ves-oneof-field-cloud_provider":"[\"aws\",\"gcp\"]","x-ves-oneof-field-enable_connection_to_re_choice":"[\"disabled\",\"enabled\"]","x-ves-proto-message":"ves.io.schema.cloud_link.CreateSpecType","properties":{"aws":{"$ref":"#/components/schemas/cloud_linkAWSType"},"disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"enabled":{"$ref":"#/components/schemas/viewsCloudLinkADNType"},"gcp":{"$ref":"#/components/schemas/cloud_linkGCPType"}}},"schemacloud_linkGetSpecType":{"type":"object","description":"Gets CloudLink parameters","title":"Get CloudLink","x-displayname":"Get CloudLink","x-ves-oneof-field-cloud_provider":"[\"aws\",\"gcp\"]","x-ves-oneof-field-enable_connection_to_re_choice":"[\"disabled\",\"enabled\"]","x-ves-proto-message":"ves.io.schema.cloud_link.GetSpecType","properties":{"aws":{"$ref":"#/components/schemas/cloud_linkAWSType"},"cloud_link_state":{"$ref":"#/components/schemas/schemaCloudLinkState"},"disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"enabled":{"$ref":"#/components/schemas/viewsCloudLinkADNType"},"gcp":{"$ref":"#/components/schemas/cloud_linkGCPType"},"sites":{"type":"integer","description":" This field indicates the number of Sites connected to this CloudLink object.\n\nValidation Rules:\n  ves.io.schema.rules.int32.lte: 20\n","format":"int32","x-displayname":"Sites","x-ves-validation-rules":{"ves.io.schema.rules.int32.lte":"20"}},"status":{"$ref":"#/components/schemas/cloud_linkCloudLinkDeploymentStatus"}}},"schemacloud_linkReplaceSpecType":{"type":"object","description":"Replaces configured CloudLink with new set of parameters","title":"Replace CloudLink","x-displayname":"Replace CloudLink","x-ves-oneof-field-cloud_provider":"[\"aws\",\"gcp\"]","x-ves-oneof-field-enable_connection_to_re_choice":"[\"disabled\",\"enabled\"]","x-ves-proto-message":"ves.io.schema.cloud_link.ReplaceSpecType","properties":{"aws":{"$ref":"#/components/schemas/cloud_linkAWSType"},"disabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"enabled":{"$ref":"#/components/schemas/viewsCloudLinkADNType"},"gcp":{"$ref":"#/components/schemas/cloud_linkGCPType"}}},"schemaviewsObjectRefType":{"type":"object","description":"This type establishes a direct reference from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.views.ObjectRefType","properties":{"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contacts-route\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 128\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"name","minLength":1,"maxLength":128,"x-displayname":"Name","x-ves-example":"contacts-route","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"128","ves.io.schema.rules.string.min_bytes":"1"}},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"namespace","maxLength":64,"x-displayname":"Namespace","x-ves-example":"ns1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"tenant","maxLength":64,"x-displayname":"Tenant","x-ves-example":"acmecorp","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}}}},"siteCoordinates":{"type":"object","description":"x-displayName: \"Site Coordinates\"\nCoordinates of the site which provides the site physical location","title":"Site Coordinates","properties":{"latitude":{"type":"number","description":"x-displayName: \"Latitude\"\nx-example: \"10.0\"\nLatitude of the site location","title":"latitude","format":"float"},"longitude":{"type":"number","description":"x-displayName: \"Longitude\"\nx-example: \"20.0\"\nlongitude of site location","title":"longitude","format":"float"}}},"viewsCloudLinkADNType":{"type":"object","title":"CloudLink ADN Network Config","x-displayname":"CloudLink ADN Network Config","x-ves-proto-message":"ves.io.schema.views.CloudLinkADNType","properties":{"cloudlink_network_name":{"type":"string","description":" Establish private connectivity with the F5 Distributed Cloud Global Network using a Private ADN network. To provision a Private ADN network, please contact F5 Distributed Cloud support.\n\nExample: ` \"private-cloud-ntw\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"Private ADN Network","maxLength":64,"x-displayname":"Private ADN Network","x-ves-example":"private-cloud-ntw","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"64"}}}}}}}