Skip to content

meta.v1.apiGroup

"APIGroup contains the name, the supported versions, and the preferred version of a group."

Index

Fields

fn new

new(name)

new returns an instance of APIGroup

fn withName

withName(name)

"name is the name of the group."

fn withServerAddressByClientCIDRs

withServerAddressByClientCIDRs(serverAddressByClientCIDRs)

"a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP."

fn withServerAddressByClientCIDRsMixin

withServerAddressByClientCIDRsMixin(serverAddressByClientCIDRs)

"a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP."

Note: This function appends passed data to existing values

fn withVersions

withVersions(versions)

"versions are the versions supported in this group."

fn withVersionsMixin

withVersionsMixin(versions)

"versions are the versions supported in this group."

Note: This function appends passed data to existing values

obj preferredVersion

"GroupVersion contains the \"group/version\" and \"version\" string of a version. It is made a struct to keep extensibility."

fn preferredVersion.withGroupVersion

withGroupVersion(groupVersion)

"groupVersion specifies the API group and version in the form \"group/version\

fn preferredVersion.withVersion

withVersion(version)

"version specifies the version in the form of \"version\". This is to save the clients the trouble of splitting the GroupVersion."