Class Control (2.26.0)

public final class Control extends GeneratedMessageV3 implements ControlOrBuilder

Selects and configures the service controller used by the service.

Example:

 control:
   environment: servicecontrol.googleapis.com

Protobuf type google.api.Control

Implements

ControlOrBuilder

Static Fields

ENVIRONMENT_FIELD_NUMBER

public static final int ENVIRONMENT_FIELD_NUMBER
Field Value
TypeDescription
int

METHOD_POLICIES_FIELD_NUMBER

public static final int METHOD_POLICIES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Control getDefaultInstance()
Returns
TypeDescription
Control

getDescriptor()

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

newBuilder()

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

newBuilder(Control prototype)

public static Control.Builder newBuilder(Control prototype)
Parameter
NameDescription
prototypeControl
Returns
TypeDescription
Control.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Control> parser()
Returns
TypeDescription
Parser<Control>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Control getDefaultInstanceForType()
Returns
TypeDescription
Control

getEnvironment()

public String getEnvironment()

The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com

string environment = 1;

Returns
TypeDescription
String

The environment.

getEnvironmentBytes()

public ByteString getEnvironmentBytes()

The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com

string environment = 1;

Returns
TypeDescription
ByteString

The bytes for environment.

getMethodPolicies(int index)

public MethodPolicy getMethodPolicies(int index)

Defines policies applying to the API methods of the service.

repeated .google.api.MethodPolicy method_policies = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
MethodPolicy

getMethodPoliciesCount()

public int getMethodPoliciesCount()

Defines policies applying to the API methods of the service.

repeated .google.api.MethodPolicy method_policies = 4;

Returns
TypeDescription
int

getMethodPoliciesList()

public List<MethodPolicy> getMethodPoliciesList()

Defines policies applying to the API methods of the service.

repeated .google.api.MethodPolicy method_policies = 4;

Returns
TypeDescription
List<MethodPolicy>

getMethodPoliciesOrBuilder(int index)

public MethodPolicyOrBuilder getMethodPoliciesOrBuilder(int index)

Defines policies applying to the API methods of the service.

repeated .google.api.MethodPolicy method_policies = 4;

Parameter
NameDescription
indexint
Returns
TypeDescription
MethodPolicyOrBuilder

getMethodPoliciesOrBuilderList()

public List<? extends MethodPolicyOrBuilder> getMethodPoliciesOrBuilderList()

Defines policies applying to the API methods of the service.

repeated .google.api.MethodPolicy method_policies = 4;

Returns
TypeDescription
List<? extends com.google.api.MethodPolicyOrBuilder>

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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