Class GetTargetSiteRequest (0.32.0) 

public final class GetTargetSiteRequest extends GeneratedMessageV3 implements GetTargetSiteRequestOrBuilder

Request message for SiteSearchEngineService.GetTargetSite method.

Protobuf type google.cloud.discoveryengine.v1.GetTargetSiteRequest

Inheritance

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

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static GetTargetSiteRequest getDefaultInstance()
Returns
TypeDescription
GetTargetSiteRequest

getDescriptor()

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

newBuilder()

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

newBuilder(GetTargetSiteRequest prototype)

public static GetTargetSiteRequest.Builder newBuilder(GetTargetSiteRequest prototype)
Parameter
NameDescription
prototypeGetTargetSiteRequest
Returns
TypeDescription
GetTargetSiteRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public GetTargetSiteRequest getDefaultInstanceForType()
Returns
TypeDescription
GetTargetSiteRequest

getName()

public String getName()

Required. Full resource name of TargetSite, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}.

If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested TargetSite does not exist, a NOT_FOUND error is returned.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Full resource name of TargetSite, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}.

If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested TargetSite does not exist, a NOT_FOUND error is returned.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<GetTargetSiteRequest> getParserForType()
Returns
TypeDescription
Parser<GetTargetSiteRequest>
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 GetTargetSiteRequest.Builder newBuilderForType()
Returns
TypeDescription
GetTargetSiteRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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