Class GetSiteSearchEngineRequest (0.30.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
TypeDescription
int

Static Methods

getDefaultInstance()

public static GetSiteSearchEngineRequest getDefaultInstance()
Returns
TypeDescription
GetSiteSearchEngineRequest

getDescriptor()

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

newBuilder()

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

newBuilder(GetSiteSearchEngineRequest prototype)

public static GetSiteSearchEngineRequest.Builder newBuilder(GetSiteSearchEngineRequest prototype)
Parameter
NameDescription
prototypeGetSiteSearchEngineRequest
Returns
TypeDescription
GetSiteSearchEngineRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public GetSiteSearchEngineRequest getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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