Class KubernetesResource (1.24.0)

public final class KubernetesResource extends GeneratedMessageV3 implements KubernetesResourceOrBuilder

KubernetesResource contains the YAML manifests and configuration for Membership Kubernetes resources in the cluster. After CreateMembership or UpdateMembership, these resources should be re-applied in the cluster.

Protobuf type google.cloud.gkehub.v1.KubernetesResource

Static Fields

CONNECT_RESOURCES_FIELD_NUMBER

public static final int CONNECT_RESOURCES_FIELD_NUMBER
Field Value
TypeDescription
int

MEMBERSHIP_CR_MANIFEST_FIELD_NUMBER

public static final int MEMBERSHIP_CR_MANIFEST_FIELD_NUMBER
Field Value
TypeDescription
int

MEMBERSHIP_RESOURCES_FIELD_NUMBER

public static final int MEMBERSHIP_RESOURCES_FIELD_NUMBER
Field Value
TypeDescription
int

RESOURCE_OPTIONS_FIELD_NUMBER

public static final int RESOURCE_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static KubernetesResource getDefaultInstance()
Returns
TypeDescription
KubernetesResource

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static KubernetesResource.Builder newBuilder()
Returns
TypeDescription
KubernetesResource.Builder

newBuilder(KubernetesResource prototype)

public static KubernetesResource.Builder newBuilder(KubernetesResource prototype)
Parameter
NameDescription
prototypeKubernetesResource
Returns
TypeDescription
KubernetesResource.Builder

parseDelimitedFrom(InputStream input)

public static KubernetesResource parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
KubernetesResource
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KubernetesResource parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KubernetesResource
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static KubernetesResource parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
KubernetesResource
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static KubernetesResource parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KubernetesResource
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static KubernetesResource parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
KubernetesResource
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static KubernetesResource parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KubernetesResource
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static KubernetesResource parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
KubernetesResource
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static KubernetesResource parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KubernetesResource
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static KubernetesResource parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
KubernetesResource
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KubernetesResource parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KubernetesResource
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static KubernetesResource parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
KubernetesResource
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static KubernetesResource parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KubernetesResource
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<KubernetesResource> parser()
Returns
TypeDescription
Parser<KubernetesResource>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getConnectResources(int index)

public ResourceManifest getConnectResources(int index)

Output only. The Kubernetes resources for installing the GKE Connect agent

This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.

repeated .google.cloud.gkehub.v1.ResourceManifest connect_resources = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
ResourceManifest

getConnectResourcesCount()

public int getConnectResourcesCount()

Output only. The Kubernetes resources for installing the GKE Connect agent

This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.

repeated .google.cloud.gkehub.v1.ResourceManifest connect_resources = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

getConnectResourcesList()

public List<ResourceManifest> getConnectResourcesList()

Output only. The Kubernetes resources for installing the GKE Connect agent

This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.

repeated .google.cloud.gkehub.v1.ResourceManifest connect_resources = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<ResourceManifest>

getConnectResourcesOrBuilder(int index)

public ResourceManifestOrBuilder getConnectResourcesOrBuilder(int index)

Output only. The Kubernetes resources for installing the GKE Connect agent

This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.

repeated .google.cloud.gkehub.v1.ResourceManifest connect_resources = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
ResourceManifestOrBuilder

getConnectResourcesOrBuilderList()

public List<? extends ResourceManifestOrBuilder> getConnectResourcesOrBuilderList()

Output only. The Kubernetes resources for installing the GKE Connect agent

This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.

repeated .google.cloud.gkehub.v1.ResourceManifest connect_resources = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<? extends com.google.cloud.gkehub.v1.ResourceManifestOrBuilder>

getDefaultInstanceForType()

public KubernetesResource getDefaultInstanceForType()
Returns
TypeDescription
KubernetesResource

getMembershipCrManifest()

public String getMembershipCrManifest()

Input only. The YAML representation of the Membership CR. This field is ignored for GKE clusters where Hub can read the CR directly.

Callers should provide the CR that is currently present in the cluster during CreateMembership or UpdateMembership, or leave this field empty if none exists. The CR manifest is used to validate the cluster has not been registered with another Membership.

string membership_cr_manifest = 1 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
String

The membershipCrManifest.

getMembershipCrManifestBytes()

public ByteString getMembershipCrManifestBytes()

Input only. The YAML representation of the Membership CR. This field is ignored for GKE clusters where Hub can read the CR directly.

Callers should provide the CR that is currently present in the cluster during CreateMembership or UpdateMembership, or leave this field empty if none exists. The CR manifest is used to validate the cluster has not been registered with another Membership.

string membership_cr_manifest = 1 [(.google.api.field_behavior) = INPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for membershipCrManifest.

getMembershipResources(int index)

public ResourceManifest getMembershipResources(int index)

Output only. Additional Kubernetes resources that need to be applied to the cluster after Membership creation, and after every update.

This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.

repeated .google.cloud.gkehub.v1.ResourceManifest membership_resources = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
ResourceManifest

getMembershipResourcesCount()

public int getMembershipResourcesCount()

Output only. Additional Kubernetes resources that need to be applied to the cluster after Membership creation, and after every update.

This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.

repeated .google.cloud.gkehub.v1.ResourceManifest membership_resources = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

getMembershipResourcesList()

public List<ResourceManifest> getMembershipResourcesList()

Output only. Additional Kubernetes resources that need to be applied to the cluster after Membership creation, and after every update.

This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.

repeated .google.cloud.gkehub.v1.ResourceManifest membership_resources = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<ResourceManifest>

getMembershipResourcesOrBuilder(int index)

public ResourceManifestOrBuilder getMembershipResourcesOrBuilder(int index)

Output only. Additional Kubernetes resources that need to be applied to the cluster after Membership creation, and after every update.

This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.

repeated .google.cloud.gkehub.v1.ResourceManifest membership_resources = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
ResourceManifestOrBuilder

getMembershipResourcesOrBuilderList()

public List<? extends ResourceManifestOrBuilder> getMembershipResourcesOrBuilderList()

Output only. Additional Kubernetes resources that need to be applied to the cluster after Membership creation, and after every update.

This field is only populated in the Membership returned from a successful long-running operation from CreateMembership or UpdateMembership. It is not populated during normal GetMembership or ListMemberships requests. To get the resource manifest after the initial registration, the caller should make a UpdateMembership call with an empty field mask.

repeated .google.cloud.gkehub.v1.ResourceManifest membership_resources = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<? extends com.google.cloud.gkehub.v1.ResourceManifestOrBuilder>

getParserForType()

public Parser<KubernetesResource> getParserForType()
Returns
TypeDescription
Parser<KubernetesResource>
Overrides

getResourceOptions()

public ResourceOptions getResourceOptions()

Optional. Options for Kubernetes resource generation.

.google.cloud.gkehub.v1.ResourceOptions resource_options = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ResourceOptions

The resourceOptions.

getResourceOptionsOrBuilder()

public ResourceOptionsOrBuilder getResourceOptionsOrBuilder()

Optional. Options for Kubernetes resource generation.

.google.cloud.gkehub.v1.ResourceOptions resource_options = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ResourceOptionsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasResourceOptions()

public boolean hasResourceOptions()

Optional. Options for Kubernetes resource generation.

.google.cloud.gkehub.v1.ResourceOptions resource_options = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the resourceOptions field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public KubernetesResource.Builder newBuilderForType()
Returns
TypeDescription
KubernetesResource.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected KubernetesResource.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
KubernetesResource.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public KubernetesResource.Builder toBuilder()
Returns
TypeDescription
KubernetesResource.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException