Class GetTargetSiteRequest.Builder (0.29.0)

public static final class GetTargetSiteRequest.Builder extends GeneratedMessageV3.Builder<GetTargetSiteRequest.Builder> implements GetTargetSiteRequestOrBuilder

Request message for SiteSearchEngineService.GetTargetSite method.

Protobuf type google.cloud.discoveryengine.v1alpha.GetTargetSiteRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GetTargetSiteRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
GetTargetSiteRequest.Builder
Overrides

build()

public GetTargetSiteRequest build()
Returns
TypeDescription
GetTargetSiteRequest

buildPartial()

public GetTargetSiteRequest buildPartial()
Returns
TypeDescription
GetTargetSiteRequest

clear()

public GetTargetSiteRequest.Builder clear()
Returns
TypeDescription
GetTargetSiteRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public GetTargetSiteRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
GetTargetSiteRequest.Builder
Overrides

clearName()

public GetTargetSiteRequest.Builder clearName()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GetTargetSiteRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
GetTargetSiteRequest.Builder
Overrides

clone()

public GetTargetSiteRequest.Builder clone()
Returns
TypeDescription
GetTargetSiteRequest.Builder
Overrides

getDefaultInstanceForType()

public GetTargetSiteRequest getDefaultInstanceForType()
Returns
TypeDescription
GetTargetSiteRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(GetTargetSiteRequest other)

public GetTargetSiteRequest.Builder mergeFrom(GetTargetSiteRequest other)
Parameter
NameDescription
otherGetTargetSiteRequest
Returns
TypeDescription
GetTargetSiteRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GetTargetSiteRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GetTargetSiteRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public GetTargetSiteRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
GetTargetSiteRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GetTargetSiteRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
GetTargetSiteRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public GetTargetSiteRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
GetTargetSiteRequest.Builder
Overrides

setName(String value)

public GetTargetSiteRequest.Builder setName(String value)

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
GetTargetSiteRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public GetTargetSiteRequest.Builder setNameBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
GetTargetSiteRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GetTargetSiteRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
GetTargetSiteRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final GetTargetSiteRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
GetTargetSiteRequest.Builder
Overrides