Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::CreateSampleQueryRequest (v0.16.0)

Version latest

• 0.16.0 (latest)
• 0.15.0
• 0.14.2
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.2
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.1
• 0.1.0

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::CreateSampleQueryRequest.

Request message for SampleQueryService.CreateSampleQuery method.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#parent

def parent() -> ::String

Returns

• (::String) — Required. The parent resource name, such as projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

#parent=

def parent=(value) -> ::String

Parameter

• value (::String) — Required. The parent resource name, such as projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

Returns

• (::String) — Required. The parent resource name, such as projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

#sample_query

def sample_query() -> ::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery) — Required. The SampleQuery to create.

#sample_query=

def sample_query=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery) — Required. The SampleQuery to create.

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery) — Required. The SampleQuery to create.

#sample_query_id

def sample_query_id() -> ::String

Returns

• (::String) — Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name.

  If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  This field must be unique among all SampleQuerys with the same parent. Otherwise, an ALREADY_EXISTS error is returned.

  This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

#sample_query_id=

def sample_query_id=(value) -> ::String

Parameter

• value (::String) — Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name.

  If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  This field must be unique among all SampleQuerys with the same parent. Otherwise, an ALREADY_EXISTS error is returned.

  This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Returns

• (::String) — Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name.

  If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  This field must be unique among all SampleQuerys with the same parent. Otherwise, an ALREADY_EXISTS error is returned.

  This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.