Class KubernetesResource (1.45.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
Type Description
int

MEMBERSHIP_CR_MANIFEST_FIELD_NUMBER

public static final int MEMBERSHIP_CR_MANIFEST_FIELD_NUMBER
Field Value
Type Description
int

MEMBERSHIP_RESOURCES_FIELD_NUMBER

public static final int MEMBERSHIP_RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_OPTIONS_FIELD_NUMBER

public static final int RESOURCE_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static KubernetesResource getDefaultInstance()
Returns
Type Description
KubernetesResource

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static KubernetesResource.Builder newBuilder()
Returns
Type Description
KubernetesResource.Builder

newBuilder(KubernetesResource prototype)

public static KubernetesResource.Builder newBuilder(KubernetesResource prototype)
Parameter
Name Description
prototype KubernetesResource
Returns
Type Description
KubernetesResource.Builder

parseDelimitedFrom(InputStream input)

public static KubernetesResource parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
KubernetesResource
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KubernetesResource parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KubernetesResource
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static KubernetesResource parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
KubernetesResource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static KubernetesResource parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KubernetesResource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static KubernetesResource parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
KubernetesResource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static KubernetesResource parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KubernetesResource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static KubernetesResource parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
KubernetesResource
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static KubernetesResource parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KubernetesResource
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static KubernetesResource parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
KubernetesResource
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KubernetesResource parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KubernetesResource
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static KubernetesResource parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
KubernetesResource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static KubernetesResource parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KubernetesResource
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<KubernetesResource> parser()
Returns
Type Description
Parser<KubernetesResource>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.cloud.gkehub.v1.ResourceManifestOrBuilder>

getDefaultInstanceForType()

public KubernetesResource getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.cloud.gkehub.v1.ResourceManifestOrBuilder>

getParserForType()

public Parser<KubernetesResource> getParserForType()
Returns
Type Description
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
Type Description
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
Type Description
ResourceOptionsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
boolean

Whether the resourceOptions field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public KubernetesResource.Builder newBuilderForType()
Returns
Type Description
KubernetesResource.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected KubernetesResource.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
KubernetesResource.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public KubernetesResource.Builder toBuilder()
Returns
Type Description
KubernetesResource.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException