Class RecommenderConfig.Builder (2.51.0)

public static final class RecommenderConfig.Builder extends GeneratedMessageV3.Builder<RecommenderConfig.Builder> implements RecommenderConfigOrBuilder

Configuration for a Recommender.

Protobuf type google.cloud.recommender.v1.RecommenderConfig

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RecommenderConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RecommenderConfig.Builder
Overrides

build()

public RecommenderConfig build()
Returns
Type Description
RecommenderConfig

buildPartial()

public RecommenderConfig buildPartial()
Returns
Type Description
RecommenderConfig

clear()

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

clearAnnotations()

public RecommenderConfig.Builder clearAnnotations()
Returns
Type Description
RecommenderConfig.Builder

clearDisplayName()

public RecommenderConfig.Builder clearDisplayName()

A user-settable field to provide a human-readable name to be used in user interfaces.

string display_name = 7;

Returns
Type Description
RecommenderConfig.Builder

This builder for chaining.

clearEtag()

public RecommenderConfig.Builder clearEtag()

Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.

string etag = 3;

Returns
Type Description
RecommenderConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RecommenderConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RecommenderConfig.Builder
Overrides

clearName()

public RecommenderConfig.Builder clearName()

Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

string name = 1;

Returns
Type Description
RecommenderConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RecommenderConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RecommenderConfig.Builder
Overrides

clearRecommenderGenerationConfig()

public RecommenderConfig.Builder clearRecommenderGenerationConfig()

RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.

.google.cloud.recommender.v1.RecommenderGenerationConfig recommender_generation_config = 2;

Returns
Type Description
RecommenderConfig.Builder

clearRevisionId()

public RecommenderConfig.Builder clearRevisionId()

Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string.

string revision_id = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
RecommenderConfig.Builder

This builder for chaining.

clearUpdateTime()

public RecommenderConfig.Builder clearUpdateTime()

Last time when the config was updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type Description
RecommenderConfig.Builder

clone()

public RecommenderConfig.Builder clone()
Returns
Type Description
RecommenderConfig.Builder
Overrides

containsAnnotations(String key)

public boolean containsAnnotations(String key)

Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

map<string, string> annotations = 6;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAnnotations() (deprecated)

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

map<string, string> annotations = 6;

Returns
Type Description
int

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

map<string, string> annotations = 6;

Returns
Type Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

map<string, string> annotations = 6;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

map<string, string> annotations = 6;

Parameter
Name Description
key String
Returns
Type Description
String

getDefaultInstanceForType()

public RecommenderConfig getDefaultInstanceForType()
Returns
Type Description
RecommenderConfig

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

A user-settable field to provide a human-readable name to be used in user interfaces.

string display_name = 7;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

A user-settable field to provide a human-readable name to be used in user interfaces.

string display_name = 7;

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.

string etag = 3;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.

string etag = 3;

Returns
Type Description
ByteString

The bytes for etag.

getMutableAnnotations() (deprecated)

public Map<String,String> getMutableAnnotations()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getRecommenderGenerationConfig()

public RecommenderGenerationConfig getRecommenderGenerationConfig()

RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.

.google.cloud.recommender.v1.RecommenderGenerationConfig recommender_generation_config = 2;

Returns
Type Description
RecommenderGenerationConfig

The recommenderGenerationConfig.

getRecommenderGenerationConfigBuilder()

public RecommenderGenerationConfig.Builder getRecommenderGenerationConfigBuilder()

RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.

.google.cloud.recommender.v1.RecommenderGenerationConfig recommender_generation_config = 2;

Returns
Type Description
RecommenderGenerationConfig.Builder

getRecommenderGenerationConfigOrBuilder()

public RecommenderGenerationConfigOrBuilder getRecommenderGenerationConfigOrBuilder()

RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.

.google.cloud.recommender.v1.RecommenderGenerationConfig recommender_generation_config = 2;

Returns
Type Description
RecommenderGenerationConfigOrBuilder

getRevisionId()

public String getRevisionId()

Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string.

string revision_id = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The revisionId.

getRevisionIdBytes()

public ByteString getRevisionIdBytes()

Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string.

string revision_id = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for revisionId.

getUpdateTime()

public Timestamp getUpdateTime()

Last time when the config was updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Last time when the config was updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Last time when the config was updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type Description
TimestampOrBuilder

hasRecommenderGenerationConfig()

public boolean hasRecommenderGenerationConfig()

RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.

.google.cloud.recommender.v1.RecommenderGenerationConfig recommender_generation_config = 2;

Returns
Type Description
boolean

Whether the recommenderGenerationConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Last time when the config was updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RecommenderConfig other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeRecommenderGenerationConfig(RecommenderGenerationConfig value)

public RecommenderConfig.Builder mergeRecommenderGenerationConfig(RecommenderGenerationConfig value)

RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.

.google.cloud.recommender.v1.RecommenderGenerationConfig recommender_generation_config = 2;

Parameter
Name Description
value RecommenderGenerationConfig
Returns
Type Description
RecommenderConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RecommenderConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RecommenderConfig.Builder
Overrides

mergeUpdateTime(Timestamp value)

public RecommenderConfig.Builder mergeUpdateTime(Timestamp value)

Last time when the config was updated.

.google.protobuf.Timestamp update_time = 4;

Parameter
Name Description
value Timestamp
Returns
Type Description
RecommenderConfig.Builder

putAllAnnotations(Map<String,String> values)

public RecommenderConfig.Builder putAllAnnotations(Map<String,String> values)

Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

map<string, string> annotations = 6;

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

putAnnotations(String key, String value)

public RecommenderConfig.Builder putAnnotations(String key, String value)

Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

map<string, string> annotations = 6;

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

removeAnnotations(String key)

public RecommenderConfig.Builder removeAnnotations(String key)

Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

map<string, string> annotations = 6;

Parameter
Name Description
key String
Returns
Type Description
RecommenderConfig.Builder

setDisplayName(String value)

public RecommenderConfig.Builder setDisplayName(String value)

A user-settable field to provide a human-readable name to be used in user interfaces.

string display_name = 7;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
RecommenderConfig.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public RecommenderConfig.Builder setDisplayNameBytes(ByteString value)

A user-settable field to provide a human-readable name to be used in user interfaces.

string display_name = 7;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
RecommenderConfig.Builder

This builder for chaining.

setEtag(String value)

public RecommenderConfig.Builder setEtag(String value)

Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.

string etag = 3;

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
RecommenderConfig.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public RecommenderConfig.Builder setEtagBytes(ByteString value)

Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.

string etag = 3;

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
RecommenderConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RecommenderConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RecommenderConfig.Builder
Overrides

setName(String value)

public RecommenderConfig.Builder setName(String value)

Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

string name = 1;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
RecommenderConfig.Builder

This builder for chaining.

setNameBytes(ByteString value)

public RecommenderConfig.Builder setNameBytes(ByteString value)

Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
RecommenderConfig.Builder

This builder for chaining.

setRecommenderGenerationConfig(RecommenderGenerationConfig value)

public RecommenderConfig.Builder setRecommenderGenerationConfig(RecommenderGenerationConfig value)

RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.

.google.cloud.recommender.v1.RecommenderGenerationConfig recommender_generation_config = 2;

Parameter
Name Description
value RecommenderGenerationConfig
Returns
Type Description
RecommenderConfig.Builder

setRecommenderGenerationConfig(RecommenderGenerationConfig.Builder builderForValue)

public RecommenderConfig.Builder setRecommenderGenerationConfig(RecommenderGenerationConfig.Builder builderForValue)

RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.

.google.cloud.recommender.v1.RecommenderGenerationConfig recommender_generation_config = 2;

Parameter
Name Description
builderForValue RecommenderGenerationConfig.Builder
Returns
Type Description
RecommenderConfig.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RecommenderConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RecommenderConfig.Builder
Overrides

setRevisionId(String value)

public RecommenderConfig.Builder setRevisionId(String value)

Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string.

string revision_id = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The revisionId to set.

Returns
Type Description
RecommenderConfig.Builder

This builder for chaining.

setRevisionIdBytes(ByteString value)

public RecommenderConfig.Builder setRevisionIdBytes(ByteString value)

Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string.

string revision_id = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for revisionId to set.

Returns
Type Description
RecommenderConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RecommenderConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RecommenderConfig.Builder
Overrides

setUpdateTime(Timestamp value)

public RecommenderConfig.Builder setUpdateTime(Timestamp value)

Last time when the config was updated.

.google.protobuf.Timestamp update_time = 4;

Parameter
Name Description
value Timestamp
Returns
Type Description
RecommenderConfig.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public RecommenderConfig.Builder setUpdateTime(Timestamp.Builder builderForValue)

Last time when the config was updated.

.google.protobuf.Timestamp update_time = 4;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
RecommenderConfig.Builder