Class MethodPolicy (2.43.0)

public final class MethodPolicy extends GeneratedMessageV3 implements MethodPolicyOrBuilder

Defines policies applying to an RPC method.

Protobuf type google.api.MethodPolicy

Static Fields

REQUEST_POLICIES_FIELD_NUMBER

public static final int REQUEST_POLICIES_FIELD_NUMBER
Field Value
Type Description
int

SELECTOR_FIELD_NUMBER

public static final int SELECTOR_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MethodPolicy getDefaultInstance()
Returns
Type Description
MethodPolicy

getDescriptor()

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

newBuilder()

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

newBuilder(MethodPolicy prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public MethodPolicy getDefaultInstanceForType()
Returns
Type Description
MethodPolicy

getParserForType()

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

getRequestPolicies(int index)

public FieldPolicy getRequestPolicies(int index)

Policies that are applicable to the request message.

repeated .google.api.FieldPolicy request_policies = 2;

Parameter
Name Description
index int
Returns
Type Description
FieldPolicy

getRequestPoliciesCount()

public int getRequestPoliciesCount()

Policies that are applicable to the request message.

repeated .google.api.FieldPolicy request_policies = 2;

Returns
Type Description
int

getRequestPoliciesList()

public List<FieldPolicy> getRequestPoliciesList()

Policies that are applicable to the request message.

repeated .google.api.FieldPolicy request_policies = 2;

Returns
Type Description
List<FieldPolicy>

getRequestPoliciesOrBuilder(int index)

public FieldPolicyOrBuilder getRequestPoliciesOrBuilder(int index)

Policies that are applicable to the request message.

repeated .google.api.FieldPolicy request_policies = 2;

Parameter
Name Description
index int
Returns
Type Description
FieldPolicyOrBuilder

getRequestPoliciesOrBuilderList()

public List<? extends FieldPolicyOrBuilder> getRequestPoliciesOrBuilderList()

Policies that are applicable to the request message.

repeated .google.api.FieldPolicy request_policies = 2;

Returns
Type Description
List<? extends com.google.api.FieldPolicyOrBuilder>

getSelector()

public String getSelector()

Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription".

Refer to selector for syntax details.

NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .

string selector = 9;

Returns
Type Description
String

The selector.

getSelectorBytes()

public ByteString getSelectorBytes()

Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription".

Refer to selector for syntax details.

NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .

string selector = 9;

Returns
Type Description
ByteString

The bytes for selector.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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