Class Control (2.43.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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Control

Implements

ControlOrBuilder

Static Fields

ENVIRONMENT_FIELD_NUMBER

public static final int ENVIRONMENT_FIELD_NUMBER
Field Value
Type Description
int

METHOD_POLICIES_FIELD_NUMBER

public static final int METHOD_POLICIES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Control getDefaultInstance()
Returns
Type Description
Control

getDescriptor()

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

newBuilder()

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

newBuilder(Control prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Control getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
MethodPolicy

getMethodPoliciesCount()

public int getMethodPoliciesCount()

Defines policies applying to the API methods of the service.

repeated .google.api.MethodPolicy method_policies = 4;

Returns
Type Description
int

getMethodPoliciesList()

public List<MethodPolicy> getMethodPoliciesList()

Defines policies applying to the API methods of the service.

repeated .google.api.MethodPolicy method_policies = 4;

Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.api.MethodPolicyOrBuilder>

getParserForType()

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

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 Control.Builder newBuilderForType()
Returns
Type Description
Control.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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