Class Scope.Builder (1.85.0)

public static final class Scope.Builder extends GeneratedMessage.Builder<Scope.Builder> implements ScopeOrBuilder

Scope represents a Scope in a Fleet.

Protobuf type google.cloud.gkehub.v1.Scope

Implements

ScopeOrBuilder

Static Methods

getDescriptor()

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

Methods

build()

public Scope build()
Returns
Type Description
Scope

buildPartial()

public Scope buildPartial()
Returns
Type Description
Scope

clear()

public Scope.Builder clear()
Returns
Type Description
Scope.Builder
Overrides

clearCreateTime()

public Scope.Builder clearCreateTime()

Output only. When the scope was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Scope.Builder

clearDeleteTime()

public Scope.Builder clearDeleteTime()

Output only. When the scope was deleted.

.google.protobuf.Timestamp delete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Scope.Builder

clearLabels()

public Scope.Builder clearLabels()
Returns
Type Description
Scope.Builder

clearName()

public Scope.Builder clearName()

The resource name for the scope projects/{project}/locations/{location}/scopes/{scope}

string name = 1;

Returns
Type Description
Scope.Builder

This builder for chaining.

clearNamespaceLabels()

public Scope.Builder clearNamespaceLabels()
Returns
Type Description
Scope.Builder

clearState()

public Scope.Builder clearState()

Output only. State of the scope resource.

.google.cloud.gkehub.v1.ScopeLifecycleState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Scope.Builder

clearUid()

public Scope.Builder clearUid()

Output only. Google-generated UUID for this resource. This is unique across all scope resources. If a scope resource is deleted and another resource with the same name is created, it gets a different uid.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Scope.Builder

This builder for chaining.

clearUpdateTime()

public Scope.Builder clearUpdateTime()

Output only. When the scope was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Scope.Builder

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels for this Scope.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

containsNamespaceLabels(String key)

public boolean containsNamespaceLabels(String key)

Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (namespace_labels in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant.

map<string, string> namespace_labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. When the scope was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. When the scope was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. When the scope was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Scope getDefaultInstanceForType()
Returns
Type Description
Scope

getDeleteTime()

public Timestamp getDeleteTime()

Output only. When the scope was deleted.

.google.protobuf.Timestamp delete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The deleteTime.

getDeleteTimeBuilder()

public Timestamp.Builder getDeleteTimeBuilder()

Output only. When the scope was deleted.

.google.protobuf.Timestamp delete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. When the scope was deleted.

.google.protobuf.Timestamp delete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels for this Scope.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels for this Scope.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels for this Scope.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Labels for this Scope.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableNamespaceLabels() (deprecated)

public Map<String,String> getMutableNamespaceLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

The resource name for the scope projects/{project}/locations/{location}/scopes/{scope}

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The resource name for the scope projects/{project}/locations/{location}/scopes/{scope}

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getNamespaceLabels() (deprecated)

public Map<String,String> getNamespaceLabels()
Returns
Type Description
Map<String,String>

getNamespaceLabelsCount()

public int getNamespaceLabelsCount()

Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (namespace_labels in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant.

map<string, string> namespace_labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getNamespaceLabelsMap()

public Map<String,String> getNamespaceLabelsMap()

Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (namespace_labels in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant.

map<string, string> namespace_labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getNamespaceLabelsOrDefault(String key, String defaultValue)

public String getNamespaceLabelsOrDefault(String key, String defaultValue)

Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (namespace_labels in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant.

map<string, string> namespace_labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getNamespaceLabelsOrThrow(String key)

public String getNamespaceLabelsOrThrow(String key)

Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (namespace_labels in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant.

map<string, string> namespace_labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getState()

public ScopeLifecycleState getState()

Output only. State of the scope resource.

.google.cloud.gkehub.v1.ScopeLifecycleState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ScopeLifecycleState

The state.

getStateBuilder()

public ScopeLifecycleState.Builder getStateBuilder()

Output only. State of the scope resource.

.google.cloud.gkehub.v1.ScopeLifecycleState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ScopeLifecycleState.Builder

getStateOrBuilder()

public ScopeLifecycleStateOrBuilder getStateOrBuilder()

Output only. State of the scope resource.

.google.cloud.gkehub.v1.ScopeLifecycleState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ScopeLifecycleStateOrBuilder

getUid()

public String getUid()

Output only. Google-generated UUID for this resource. This is unique across all scope resources. If a scope resource is deleted and another resource with the same name is created, it gets a different uid.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. Google-generated UUID for this resource. This is unique across all scope resources. If a scope resource is deleted and another resource with the same name is created, it gets a different uid.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. When the scope was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. When the scope was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. When the scope was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. When the scope was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDeleteTime()

public boolean hasDeleteTime()

Output only. When the scope was deleted.

.google.protobuf.Timestamp delete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the deleteTime field is set.

hasState()

public boolean hasState()

Output only. State of the scope resource.

.google.cloud.gkehub.v1.ScopeLifecycleState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the state field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. When the scope was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Scope.Builder mergeCreateTime(Timestamp value)

Output only. When the scope was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Scope.Builder

mergeDeleteTime(Timestamp value)

public Scope.Builder mergeDeleteTime(Timestamp value)

Output only. When the scope was deleted.

.google.protobuf.Timestamp delete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Scope.Builder

mergeFrom(Scope other)

public Scope.Builder mergeFrom(Scope other)
Parameter
Name Description
other Scope
Returns
Type Description
Scope.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Scope.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Scope.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Scope.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Scope.Builder
Overrides

mergeState(ScopeLifecycleState value)

public Scope.Builder mergeState(ScopeLifecycleState value)

Output only. State of the scope resource.

.google.cloud.gkehub.v1.ScopeLifecycleState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ScopeLifecycleState
Returns
Type Description
Scope.Builder

mergeUpdateTime(Timestamp value)

public Scope.Builder mergeUpdateTime(Timestamp value)

Output only. When the scope was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Scope.Builder

putAllLabels(Map<String,String> values)

public Scope.Builder putAllLabels(Map<String,String> values)

Optional. Labels for this Scope.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Scope.Builder

putAllNamespaceLabels(Map<String,String> values)

public Scope.Builder putAllNamespaceLabels(Map<String,String> values)

Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (namespace_labels in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant.

map<string, string> namespace_labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Scope.Builder

putLabels(String key, String value)

public Scope.Builder putLabels(String key, String value)

Optional. Labels for this Scope.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
Scope.Builder

putNamespaceLabels(String key, String value)

public Scope.Builder putNamespaceLabels(String key, String value)

Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (namespace_labels in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant.

map<string, string> namespace_labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
Scope.Builder

removeLabels(String key)

public Scope.Builder removeLabels(String key)

Optional. Labels for this Scope.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Scope.Builder

removeNamespaceLabels(String key)

public Scope.Builder removeNamespaceLabels(String key)

Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (namespace_labels in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant.

map<string, string> namespace_labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
Scope.Builder

setCreateTime(Timestamp value)

public Scope.Builder setCreateTime(Timestamp value)

Output only. When the scope was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Scope.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Scope.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. When the scope was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Scope.Builder

setDeleteTime(Timestamp value)

public Scope.Builder setDeleteTime(Timestamp value)

Output only. When the scope was deleted.

.google.protobuf.Timestamp delete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Scope.Builder

setDeleteTime(Timestamp.Builder builderForValue)

public Scope.Builder setDeleteTime(Timestamp.Builder builderForValue)

Output only. When the scope was deleted.

.google.protobuf.Timestamp delete_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Scope.Builder

setName(String value)

public Scope.Builder setName(String value)

The resource name for the scope projects/{project}/locations/{location}/scopes/{scope}

string name = 1;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Scope.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Scope.Builder setNameBytes(ByteString value)

The resource name for the scope projects/{project}/locations/{location}/scopes/{scope}

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Scope.Builder

This builder for chaining.

setState(ScopeLifecycleState value)

public Scope.Builder setState(ScopeLifecycleState value)

Output only. State of the scope resource.

.google.cloud.gkehub.v1.ScopeLifecycleState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ScopeLifecycleState
Returns
Type Description
Scope.Builder

setState(ScopeLifecycleState.Builder builderForValue)

public Scope.Builder setState(ScopeLifecycleState.Builder builderForValue)

Output only. State of the scope resource.

.google.cloud.gkehub.v1.ScopeLifecycleState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue ScopeLifecycleState.Builder
Returns
Type Description
Scope.Builder

setUid(String value)

public Scope.Builder setUid(String value)

Output only. Google-generated UUID for this resource. This is unique across all scope resources. If a scope resource is deleted and another resource with the same name is created, it gets a different uid.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The uid to set.

Returns
Type Description
Scope.Builder

This builder for chaining.

setUidBytes(ByteString value)

public Scope.Builder setUidBytes(ByteString value)

Output only. Google-generated UUID for this resource. This is unique across all scope resources. If a scope resource is deleted and another resource with the same name is created, it gets a different uid.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for uid to set.

Returns
Type Description
Scope.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public Scope.Builder setUpdateTime(Timestamp value)

Output only. When the scope was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Scope.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Scope.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. When the scope was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Scope.Builder