Package com.google.cloud.discoveryengine.v1beta

Interface CreateSampleQueryRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CreateSampleQueryRequest, CreateSampleQueryRequest.Builder
@Generated public interface CreateSampleQueryRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    SampleQuery
    getSampleQuery()
    Required.
    String
    getSampleQueryId()
    Required.
    com.google.protobuf.ByteString
    getSampleQueryIdBytes()
    Required.
    SampleQueryOrBuilder
    getSampleQueryOrBuilder()
    Required.
    boolean
    hasSampleQuery()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getParent

      String getParent()
       Required. The parent resource name, such as
 `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The parent resource name, such as
 `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • hasSampleQuery

      boolean hasSampleQuery()
       Required. The
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] to create.
      .google.cloud.discoveryengine.v1beta.SampleQuery sample_query = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the sampleQuery field is set.

    • getSampleQuery

      SampleQuery getSampleQuery()
       Required. The
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] to create.
      .google.cloud.discoveryengine.v1beta.SampleQuery sample_query = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The sampleQuery.

    • getSampleQueryOrBuilder

      SampleQueryOrBuilder getSampleQueryOrBuilder()
       Required. The
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery] to create.
      .google.cloud.discoveryengine.v1beta.SampleQuery sample_query = 2 [(.google.api.field_behavior) = REQUIRED];

    • getSampleQueryId

      String getSampleQueryId()
       Required. The ID to use for the
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], which will
 become the final component of the
 [SampleQuery.name][google.cloud.discoveryengine.v1beta.SampleQuery.name].

 If the caller does not have permission to create the
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], regardless
 of whether or not it exists, a `PERMISSION_DENIED` error is returned.

 This field must be unique among all
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s with the
 same
 [parent][google.cloud.discoveryengine.v1beta.CreateSampleQueryRequest.parent].
 Otherwise, an `ALREADY_EXISTS` error is returned.

 This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 standard with a length limit of 63 characters. Otherwise, an
 `INVALID_ARGUMENT` error is returned.
      string sample_query_id = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The sampleQueryId.

    • getSampleQueryIdBytes

      com.google.protobuf.ByteString getSampleQueryIdBytes()
       Required. The ID to use for the
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], which will
 become the final component of the
 [SampleQuery.name][google.cloud.discoveryengine.v1beta.SampleQuery.name].

 If the caller does not have permission to create the
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery], regardless
 of whether or not it exists, a `PERMISSION_DENIED` error is returned.

 This field must be unique among all
 [SampleQuery][google.cloud.discoveryengine.v1beta.SampleQuery]s with the
 same
 [parent][google.cloud.discoveryengine.v1beta.CreateSampleQueryRequest.parent].
 Otherwise, an `ALREADY_EXISTS` error is returned.

 This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 standard with a length limit of 63 characters. Otherwise, an
 `INVALID_ARGUMENT` error is returned.
      string sample_query_id = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for sampleQueryId.