Class RecommenderConfig (2.57.0)

public final class RecommenderConfig extends GeneratedMessageV3 implements RecommenderConfigOrBuilder

Configuration for a Recommender.

Protobuf type google.cloud.recommender.v1.RecommenderConfig

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RECOMMENDER_GENERATION_CONFIG_FIELD_NUMBER

public static final int RECOMMENDER_GENERATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

REVISION_ID_FIELD_NUMBER

public static final int REVISION_ID_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RecommenderConfig getDefaultInstance()
Returns
Type Description
RecommenderConfig

getDescriptor()

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

newBuilder()

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

newBuilder(RecommenderConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

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.

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.

getParserForType()

public Parser<RecommenderConfig> getParserForType()
Returns
Type Description
Parser<RecommenderConfig>
Overrides

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.

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Last time when the config was updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type Description
Timestamp

The updateTime.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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