Class GetTargetSiteRequest (0.40.0)

public final class GetTargetSiteRequest extends GeneratedMessageV3 implements GetTargetSiteRequestOrBuilder

Request message for SiteSearchEngineService.GetTargetSite method.

Protobuf type google.cloud.discoveryengine.v1alpha.GetTargetSiteRequest

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GetTargetSiteRequest getDefaultInstance()
Returns
Type Description
GetTargetSiteRequest

getDescriptor()

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

newBuilder()

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

newBuilder(GetTargetSiteRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public GetTargetSiteRequest getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for name.

getParserForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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