Show / Hide Table of Contents

Class V1APIGroup

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

Inheritance
object
V1APIGroup
Implements
IKubernetesObject
IEquatable<V1APIGroup>
Inherited Members
object.GetType()
object.MemberwiseClone()
object.Equals(object, object)
object.ReferenceEquals(object, object)
Namespace: k8s.Models
Assembly: KubernetesClient.dll
Syntax
[KubernetesEntity(Group = "", Kind = "APIGroup", ApiVersion = "v1", PluralName = "")]
public record V1APIGroup : IKubernetesObject, IEquatable<V1APIGroup>

Constructors

View Source

V1APIGroup()

Declaration
public V1APIGroup()
View Source

V1APIGroup(V1APIGroup)

Declaration
protected V1APIGroup(V1APIGroup original)
Parameters
Type Name Description
V1APIGroup original

Fields

View Source

KubeApiVersion

Declaration
public const string KubeApiVersion = "v1"
Field Value
Type Description
string
View Source

KubeGroup

Declaration
public const string KubeGroup = ""
Field Value
Type Description
string
View Source

KubeKind

Declaration
public const string KubeKind = "APIGroup"
Field Value
Type Description
string
View Source

KubePluralName

Declaration
public const string KubePluralName = ""
Field Value
Type Description
string

Properties

View Source

ApiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Declaration
[JsonPropertyName("apiVersion")]
public string ApiVersion { get; set; }
Property Value
Type Description
string
View Source

EqualityContract

Declaration
protected virtual Type EqualityContract { get; }
Property Value
Type Description
Type
View Source

Kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Declaration
[JsonPropertyName("kind")]
public string Kind { get; set; }
Property Value
Type Description
string
View Source

Name

name is the name of the group.

Declaration
[JsonPropertyName("name")]
public string Name { get; set; }
Property Value
Type Description
string
View Source

PreferredVersion

preferredVersion is the version preferred by the API server, which probably is the storage version.

Declaration
[JsonPropertyName("preferredVersion")]
public V1GroupVersionForDiscovery PreferredVersion { get; set; }
Property Value
Type Description
V1GroupVersionForDiscovery
View Source

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.

Declaration
[JsonPropertyName("serverAddressByClientCIDRs")]
public IList<V1ServerAddressByClientCIDR> ServerAddressByClientCIDRs { get; set; }
Property Value
Type Description
IList<V1ServerAddressByClientCIDR>
View Source

Versions

versions are the versions supported in this group.

Declaration
[JsonPropertyName("versions")]
public IList<V1GroupVersionForDiscovery> Versions { get; set; }
Property Value
Type Description
IList<V1GroupVersionForDiscovery>

Methods

View Source

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
object.Equals(object)
View Source

Equals(V1APIGroup?)

Declaration
public virtual bool Equals(V1APIGroup? other)
Parameters
Type Name Description
V1APIGroup other
Returns
Type Description
bool
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
object.GetHashCode()
View Source

PrintMembers(StringBuilder)

Declaration
protected virtual bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description
StringBuilder builder
Returns
Type Description
bool
View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
object.ToString()

Operators

View Source

operator ==(V1APIGroup?, V1APIGroup?)

Declaration
public static bool operator ==(V1APIGroup? left, V1APIGroup? right)
Parameters
Type Name Description
V1APIGroup left
V1APIGroup right
Returns
Type Description
bool
View Source

operator !=(V1APIGroup?, V1APIGroup?)

Declaration
public static bool operator !=(V1APIGroup? left, V1APIGroup? right)
Parameters
Type Name Description
V1APIGroup left
V1APIGroup right
Returns
Type Description
bool

Implements

IKubernetesObject
IEquatable<T>

Extension Methods

ModelExtensions.ApiGroup(IKubernetesObject)
ModelExtensions.ApiGroupAndVersion(IKubernetesObject)
ModelExtensions.ApiGroupVersion(IKubernetesObject)
ModelExtensions.GetApiGroupAndVersion(IKubernetesObject, out string, out string)
Extensions.GetKubernetesTypeMetadata<T>(T)
Extensions.Initialize<T>(T)
  • View Source
In this article
Back to top Generated by DocFX