Service

---

Functions

set

Set any specific field to a value

Args

• **kwargs

  • Arbitrary list of keys as variables in formation of YAML path separated by underscores with their assocaited values. For example, to set the value at

  {
      "spec": {
          "template": {
              "spec": ""
          }
      }
  }
  

  use

  obj.set(spec_template_spec="foobar")
  

  • You can also specify an incomplete path and k8sGen will attempt to find a unique location whose ending path matches what you have specified. For the case of the above structure, running

  obj.set(template_spec="foobar")
  

  will set the same location because the only path that ends in ‘template/spec’ is ‘spec/template/spec’

Returns

List of return values for each variable set

Possible return values include:

• True : value was set successfully
• (False, ‘invalid key name’) : the key you are trying to set does not exist for this object
• (False, ‘abniguous key name’) : the key you are trying to set does not refer to a unique location

get

Get the values that have been set for specific fields

Args

• *args

  • Arbitrary list of keys as variables in formation of YAML path separated by underscores

Returns

List of return values for each variable set

Possible return values include:

• {Value} : The key’s value
• (False, ‘invalid key name’) : the key you are trying to set does not exist for this object

Key Names and Types

Key	Type
apiVersion	v1
kind	Service
metadata	<COMPONENT.Metadata>
spec_clusterIP	<string>
spec_externalIPs	<[]string>
spec_externalName	<string>
spec_externalTrafficPolicy	<string>
spec_healthCheckNodePort	<integer>
spec_ipFamily	<string>
spec_loadBalancerIP	<string>
spec_loadBalancerSourceRanges	<[]string>
spec_ports	<[]COMPONENT.ServicePort>
spec_publishNotReadyAddresses	<boolean>
spec_selector	<map[string]string>
spec_sessionAffinity	<string>
spec_sessionAffinityConfig_clientIP_timeoutSeconds	<integer>
spec_topologyKeys	<[]string>
spec_type	<string>

JSON fields

{
    "apiVersion": "v1",
    "kind": "Service",
    "metadata": "<COMPONENT.Metadata>",
    "spec": {
        "clusterIP": "<string>",
        "externalIPs": "<[]string>",
        "externalName": "<string>",
        "externalTrafficPolicy": "<string>",
        "healthCheckNodePort": "<integer>",
        "ipFamily": "<string>",
        "loadBalancerIP": "<string>",
        "loadBalancerSourceRanges": "<[]string>",
        "ports": "<[]COMPONENT.ServicePort>",
        "publishNotReadyAddresses": "<boolean>",
        "selector": "<map[string]string>",
        "sessionAffinity": "<string>",
        "sessionAffinityConfig": {
            "clientIP": {
                "timeoutSeconds": "<integer>"
            }
        },
        "topologyKeys": "<[]string>",
        "type": "<string>"
    }
}