Class GetSiteSearchEngineRequest (0.40.0)

public final class GetSiteSearchEngineRequest extends GeneratedMessageV3 implements GetSiteSearchEngineRequestOrBuilder

Request message for SiteSearchEngineService.GetSiteSearchEngine method.

Protobuf type google.cloud.discoveryengine.v1alpha.GetSiteSearchEngineRequest

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GetSiteSearchEngineRequest getDefaultInstance()
Returns
Type Description
GetSiteSearchEngineRequest

getDescriptor()

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

newBuilder()

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

newBuilder(GetSiteSearchEngineRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public GetSiteSearchEngineRequest getDefaultInstanceForType()
Returns
Type Description
GetSiteSearchEngineRequest

getName()

public String getName()

Required. Resource name of SiteSearchEngine, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED 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. Resource name of SiteSearchEngine, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED 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<GetSiteSearchEngineRequest> getParserForType()
Returns
Type Description
Parser<GetSiteSearchEngineRequest>
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 GetSiteSearchEngineRequest.Builder newBuilderForType()
Returns
Type Description
GetSiteSearchEngineRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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