Class GetSiteSearchEngineRequest.Builder (0.81.0)

public static final class GetSiteSearchEngineRequest.Builder extends GeneratedMessage.Builder<GetSiteSearchEngineRequest.Builder> implements GetSiteSearchEngineRequestOrBuilder

Request message for SiteSearchEngineService.GetSiteSearchEngine method.

Protobuf type google.cloud.discoveryengine.v1.GetSiteSearchEngineRequest

Static Methods

getDescriptor()

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

Methods

build()

public GetSiteSearchEngineRequest build()
Returns
Type Description
GetSiteSearchEngineRequest

buildPartial()

public GetSiteSearchEngineRequest buildPartial()
Returns
Type Description
GetSiteSearchEngineRequest

clear()

public GetSiteSearchEngineRequest.Builder clear()
Returns
Type Description
GetSiteSearchEngineRequest.Builder
Overrides

clearName()

public GetSiteSearchEngineRequest.Builder clearName()

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
GetSiteSearchEngineRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public GetSiteSearchEngineRequest getDefaultInstanceForType()
Returns
Type Description
GetSiteSearchEngineRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GetSiteSearchEngineRequest other)

public GetSiteSearchEngineRequest.Builder mergeFrom(GetSiteSearchEngineRequest other)
Parameter
Name Description
other GetSiteSearchEngineRequest
Returns
Type Description
GetSiteSearchEngineRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GetSiteSearchEngineRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetSiteSearchEngineRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GetSiteSearchEngineRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GetSiteSearchEngineRequest.Builder
Overrides

setName(String value)

public GetSiteSearchEngineRequest.Builder setName(String value)

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) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
GetSiteSearchEngineRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public GetSiteSearchEngineRequest.Builder setNameBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
GetSiteSearchEngineRequest.Builder

This builder for chaining.