Package io.fabric8.kubernetes.api.model.gatewayapi.v1

Class BackendObjectReference

java.lang.Object

io.fabric8.kubernetes.api.model.gatewayapi.v1.BackendObjectReference

All Implemented Interfaces:

io.fabric8.kubernetes.api.builder.Editable<BackendObjectReferenceBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class BackendObjectReference
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<BackendObjectReferenceBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource

BackendObjectReference defines how an ObjectReference that is specific to BackendRef. It includes a few additional fields and features than a regular ObjectReference.

Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.

The API object must be valid in the cluster; the Group and Kind must be registered in the cluster for this reference to be valid.

References to objects with invalid Group and Kind are not valid, and must be rejected by the implementation, with appropriate Conditions set on the containing object.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
BackendObjectReference()	No args constructor for use in serialization
BackendObjectReference(String group, String kind, String name, String namespace, Integer port)

Method Summary

Modifier and Type	Method	Description
BackendObjectReferenceBuilder	edit()
Map<String,Object>	getAdditionalProperties()
String	getGroup()	Group is the group of the referent.
String	getKind()	Kind is the Kubernetes resource kind of the referent.
String	getName()	Name is the name of the referent.
String	getNamespace()	Namespace is the namespace of the backend.
Integer	getPort()	Port specifies the destination port number to use for this resource.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setGroup(String group)	Group is the group of the referent.
void	setKind(String kind)	Kind is the Kubernetes resource kind of the referent.
void	setName(String name)	Name is the name of the referent.
void	setNamespace(String namespace)	Namespace is the namespace of the backend.
void	setPort(Integer port)	Port specifies the destination port number to use for this resource.
BackendObjectReferenceBuilder	toBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BackendObjectReference

public BackendObjectReference()

No args constructor for use in serialization

BackendObjectReference

public BackendObjectReference(String group,
                              String kind,
                              String name,
                              String namespace,
                              Integer port)

Method Detail

getGroup

public String getGroup()

Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.

setGroup

public void setGroup(String group)

Group is the group of the referent. For example, "gateway.networking.k8s.io". When unspecified or empty string, core API group is inferred.

getKind

public String getKind()

Kind is the Kubernetes resource kind of the referent. For example "Service".

Defaults to "Service" when not specified.

ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services.

Support: Core (Services with a type other than ExternalName)

Support: Implementation-specific (Services with type ExternalName)

setKind

public void setKind(String kind)

Kind is the Kubernetes resource kind of the referent. For example "Service".

Defaults to "Service" when not specified.

ExternalName services can refer to CNAME DNS records that may live outside of the cluster and as such are difficult to reason about in terms of conformance. They also may not be safe to forward to (see CVE-2021-25740 for more information). Implementations SHOULD NOT support ExternalName Services.

Support: Core (Services with a type other than ExternalName)

Support: Implementation-specific (Services with type ExternalName)

getName

public String getName()

Name is the name of the referent.

setName

public void setName(String name)

Name is the name of the referent.

getNamespace

public String getNamespace()

Namespace is the namespace of the backend. When unspecified, the local namespace is inferred.

Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.

Support: Core

setNamespace

public void setNamespace(String namespace)

Namespace is the namespace of the backend. When unspecified, the local namespace is inferred.

Note that when a namespace different than the local namespace is specified, a ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.

Support: Core

getPort

public Integer getPort()

Port specifies the destination port number to use for this resource. Port is required when the referent is a Kubernetes Service. In this case, the port number is the service port number, not the target port. For other resources, destination port might be derived from the referent resource or this field.

setPort

public void setPort(Integer port)

Port specifies the destination port number to use for this resource. Port is required when the referent is a Kubernetes Service. In this case, the port number is the service port number, not the target port. For other resources, destination port might be derived from the referent resource or this field.

edit

public BackendObjectReferenceBuilder edit()

Specified by:

edit in interface io.fabric8.kubernetes.api.builder.Editable<BackendObjectReferenceBuilder>

toBuilder

public BackendObjectReferenceBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)