Class ApiTarget (0.5.0) 

public final class ApiTarget extends GeneratedMessageV3 implements ApiTargetOrBuilder

A restriction for a specific service and optionally one or multiple specific methods. Both fields are case insensitive.

Protobuf type google.api.apikeys.v2.ApiTarget

Inheritance

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

Implements

ApiTargetOrBuilder

Static Fields

METHODS_FIELD_NUMBER

public static final int METHODS_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_FIELD_NUMBER

public static final int SERVICE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ApiTarget getDefaultInstance()
Returns
Type Description
ApiTarget

getDescriptor()

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

newBuilder()

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

newBuilder(ApiTarget prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ApiTarget getDefaultInstanceForType()
Returns
Type Description
ApiTarget

getMethods(int index)

public String getMethods(int index)

Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard () can be used as the last symbol. Valid examples: google.cloud.translate.v2.TranslateService.GetSupportedLanguage TranslateText Get translate.googleapis.com.Get*

repeated string methods = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The methods at the given index.

getMethodsBytes(int index)

public ByteString getMethodsBytes(int index)

Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard () can be used as the last symbol. Valid examples: google.cloud.translate.v2.TranslateService.GetSupportedLanguage TranslateText Get translate.googleapis.com.Get*

repeated string methods = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the methods at the given index.

getMethodsCount()

public int getMethodsCount()

Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard () can be used as the last symbol. Valid examples: google.cloud.translate.v2.TranslateService.GetSupportedLanguage TranslateText Get translate.googleapis.com.Get*

repeated string methods = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of methods.

getMethodsList()

public ProtocolStringList getMethodsList()

Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard () can be used as the last symbol. Valid examples: google.cloud.translate.v2.TranslateService.GetSupportedLanguage TranslateText Get translate.googleapis.com.Get*

repeated string methods = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the methods.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getService()

public String getService()

The service for this restriction. It should be the canonical service name, for example: translate.googleapis.com. You can use gcloud services list to get a list of services that are enabled in the project.

string service = 1;

Returns
Type Description
String

The service.

getServiceBytes()

public ByteString getServiceBytes()

The service for this restriction. It should be the canonical service name, for example: translate.googleapis.com. You can use gcloud services list to get a list of services that are enabled in the project.

string service = 1;

Returns
Type Description
ByteString

The bytes for service.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
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 ApiTarget.Builder newBuilderForType()
Returns
Type Description
ApiTarget.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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