Class AclRule (0.49.0)

public final class AclRule extends GeneratedMessage implements AclRuleOrBuilder

A single ACL rule which defines the policy for a user.

Protobuf type google.cloud.memorystore.v1.AclRule

Implements

AclRuleOrBuilder

Static Fields

RULE_FIELD_NUMBER

public static final int RULE_FIELD_NUMBER
Field Value
Type Description
int

USERNAME_FIELD_NUMBER

public static final int USERNAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AclRule getDefaultInstance()
Returns
Type Description
AclRule

getDescriptor()

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

newBuilder()

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

newBuilder(AclRule prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public AclRule getDefaultInstanceForType()
Returns
Type Description
AclRule

getParserForType()

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

getRule()

public String getRule()

Required. The rule to be applied to the username. Ex: "on >password123 ~* +@all" The format of the rule is defined by Valkey OSS: https://valkey.io/topics/acl/

string rule = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The rule.

getRuleBytes()

public ByteString getRuleBytes()

Required. The rule to be applied to the username. Ex: "on >password123 ~* +@all" The format of the rule is defined by Valkey OSS: https://valkey.io/topics/acl/

string rule = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for rule.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUsername()

public String getUsername()

Required. Specifies the IAM user or service account to be added to the ACL policy. This username will be directly set on the Valkey OSS.

string username = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The username.

getUsernameBytes()

public ByteString getUsernameBytes()

Required. Specifies the IAM user or service account to be added to the ACL policy. This username will be directly set on the Valkey OSS.

string username = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for username.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected AclRule.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AclRule.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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