kubernetes_asyncio.client.models.v1_service_port module

Kubernetes

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501

The version of the OpenAPI document: v1.34.3 Generated by: https://openapi-generator.tech

class kubernetes_asyncio.client.models.v1_service_port.V1ServicePort(app_protocol=None, name=None, node_port=None, port=None, protocol=None, target_port=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

property app_protocol

Gets the app_protocol of this V1ServicePort. # noqa: E501

The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either: * Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). * Kubernetes-defined prefixed names: * ‘kubernetes.io/h2c’ - HTTP/2 prior knowledge over cleartext as described in https://www.rfc-editor.org/rfc/rfc9113.html#name-starting-http-2-with-prior- * ‘kubernetes.io/ws’ - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 * ‘kubernetes.io/wss’ - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 * Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol. # noqa: E501

Returns:

The app_protocol of this V1ServicePort. # noqa: E501

Return type:

str

attribute_map = {'app_protocol': 'appProtocol', 'name': 'name', 'node_port': 'nodePort', 'port': 'port', 'protocol': 'protocol', 'target_port': 'targetPort'}

property name

Gets the name of this V1ServicePort. # noqa: E501

The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the ‘name’ field in the EndpointPort. Optional if only one ServicePort is defined on this service. # noqa: E501

Returns:

The name of this V1ServicePort. # noqa: E501

Return type:

str

property node_port

Gets the node_port of this V1ServicePort. # noqa: E501

The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport # noqa: E501

Returns:

The node_port of this V1ServicePort. # noqa: E501

Return type:

int

openapi_types = {'app_protocol': 'str', 'name': 'str', 'node_port': 'int', 'port': 'int', 'protocol': 'str', 'target_port': 'object'}

property port

Gets the port of this V1ServicePort. # noqa: E501

The port that will be exposed by this service. # noqa: E501

Returns:

The port of this V1ServicePort. # noqa: E501

Return type:

int

property protocol

Gets the protocol of this V1ServicePort. # noqa: E501

The IP protocol for this port. Supports “TCP”, “UDP”, and “SCTP”. Default is TCP. # noqa: E501

Returns:

The protocol of this V1ServicePort. # noqa: E501

Return type:

str

property target_port

Gets the target_port of this V1ServicePort. # noqa: E501

Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod’s container ports. If this is not specified, the value of the ‘port’ field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the ‘port’ field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service # noqa: E501

Returns:

The target_port of this V1ServicePort. # noqa: E501

Return type:

object

to_dict(serialize=False)

Returns the model properties as a dict

to_str()

Returns the string representation of the model