Class RecommenderConfig (2.23.0)

public final class RecommenderConfig extends GeneratedMessageV3 implements RecommenderConfigOrBuilder

Configuration for a Recommender.

Protobuf type google.cloud.recommender.v1beta1.RecommenderConfig

Static Fields

ANNOTATIONS_FIELD_NUMBER

public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

RECOMMENDER_GENERATION_CONFIG_FIELD_NUMBER

public static final int RECOMMENDER_GENERATION_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

REVISION_ID_FIELD_NUMBER

public static final int REVISION_ID_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RecommenderConfig getDefaultInstance()
Returns
TypeDescription
RecommenderConfig

getDescriptor()

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

newBuilder()

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

newBuilder(RecommenderConfig prototype)

public static RecommenderConfig.Builder newBuilder(RecommenderConfig prototype)
Parameter
NameDescription
prototypeRecommenderConfig
Returns
TypeDescription
RecommenderConfig.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<RecommenderConfig> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

getAnnotations()

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getDefaultInstanceForType()

public RecommenderConfig getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.

string etag = 3;

Returns
TypeDescription
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.

string etag = 3;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getRecommenderGenerationConfig()

public RecommenderGenerationConfig getRecommenderGenerationConfig()

RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.

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

Returns
TypeDescription
RecommenderGenerationConfig

The recommenderGenerationConfig.

getRecommenderGenerationConfigOrBuilder()

public RecommenderGenerationConfigOrBuilder getRecommenderGenerationConfigOrBuilder()

RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for revisionId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Last time when the config was updated.

.google.protobuf.Timestamp update_time = 4;

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Last time when the config was updated.

.google.protobuf.Timestamp update_time = 4;

Returns
TypeDescription
TimestampOrBuilder

hasRecommenderGenerationConfig()

public boolean hasRecommenderGenerationConfig()

RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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