Share via


Module Class

  • java.lang.Object
    • com.azure.resourcemanager.redisenterprise.models.Module

Implements

public final class Module
implements JsonSerializable<Module>

Module settings Specifies configuration of a redis module.

Constructor Summary

Constructor Description
Module()

Creates an instance of Module class.

Method Summary

Modifier and Type Method and Description
String args()

Get the args property: Configuration options for the module, e.g.

static Module fromJson(JsonReader jsonReader)

Reads an instance of Module from the JsonReader.

String name()

Get the name property: The name of the module, e.g.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

String version()

Get the version property: The version of the module, e.g.

Module withArgs(String args)

Set the args property: Configuration options for the module, e.g.

Module withName(String name)

Set the name property: The name of the module, e.g.

Methods inherited from java.lang.Object

Constructor Details

Module

public Module()

Creates an instance of Module class.

Method Details

args

public String args()

Get the args property: Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'.

Returns:

the args value.

fromJson

public static Module fromJson(JsonReader jsonReader)

Reads an instance of Module from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of Module if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

name

public String name()

Get the name property: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'.

Returns:

the name value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

version

public String version()

Get the version property: The version of the module, e.g. '1.0'.

Returns:

the version value.

withArgs

public Module withArgs(String args)

Set the args property: Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'.

Parameters:

args - the args value to set.

Returns:

the Module object itself.

withName

public Module withName(String name)

Set the name property: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'.

Parameters:

name - the name value to set.

Returns:

the Module object itself.

Applies to