Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: [discoveryengine] update sample query, sample query set patterns #5558

Merged
merged 4 commits into from
Jul 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -94,14 +94,14 @@ message Evaluation {
FAILED = 4;
}

// Immutable. The full resource name of the
// Identifier. The full resource name of the
// [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], in the
// format of
// `projects/{project}/locations/{location}/evaluations/{evaluation}`.
//
// This field must be a UTF-8 encoded string with a length limit of 1024
// characters.
string name = 1 [(google.api.field_behavior) = IMMUTABLE];
string name = 1 [(google.api.field_behavior) = IDENTIFIER];

// Required. The specification of the evaluation.
EvaluationSpec evaluation_spec = 2 [(google.api.field_behavior) = REQUIRED];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
message SampleQuery {
option (google.api.resource) = {
type: "discoveryengine.googleapis.com/SampleQuery"
pattern: "projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}"
pattern: "projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}"
};

// Query Entry captures metadata to be used for search evaluation.
Expand Down Expand Up @@ -71,12 +71,12 @@ message SampleQuery {
QueryEntry query_entry = 2;
}

// Immutable. The full resource name of the sample query, in the format of
// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`.
// Identifier. The full resource name of the sample query, in the format of
// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
//
// This field must be a UTF-8 encoded string with a length limit of 1024
// characters.
string name = 1 [(google.api.field_behavior) = IMMUTABLE];
string name = 1 [(google.api.field_behavior) = IDENTIFIER];

// Output only. Timestamp the
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] was created
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ service SampleQueryService {
message GetSampleQueryRequest {
// Required. Full resource name of
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], such as
// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`.
// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
//
// If the caller does not have permission to access the
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], regardless
Expand Down Expand Up @@ -247,7 +247,7 @@ message UpdateSampleQueryRequest {
message DeleteSampleQueryRequest {
// Required. Full resource name of
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], such as
// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`.
// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
//
// If the caller does not have permission to delete the
// [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], regardless
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
message SampleQuerySet {
option (google.api.resource) = {
type: "discoveryengine.googleapis.com/SampleQuerySet"
pattern: "projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}"
pattern: "projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}"
};

// Immutable. The full resource name of the
// Identifier. The full resource name of the
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], in
// the format of
// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
//
// This field must be a UTF-8 encoded string with a length limit of 1024
// characters.
string name = 1 [(google.api.field_behavior) = IMMUTABLE];
string name = 1 [(google.api.field_behavior) = IDENTIFIER];

// Required. The sample query set display name.
//
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ message GetSampleQuerySetRequest {
// Required. Full resource name of
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], such
// as
// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
//
// If the caller does not have permission to access the
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
Expand Down Expand Up @@ -239,7 +239,7 @@ message DeleteSampleQuerySetRequest {
// Required. Full resource name of
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], such
// as
// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
//
// If the caller does not have permission to delete the
// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
Expand Down
10 changes: 5 additions & 5 deletions packages/google-cloud-discoveryengine/protos/protos.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ function main(name) {
/**
* Required. Full resource name of
* SampleQuery google.cloud.discoveryengine.v1alpha.SampleQuery, such as
* `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`.
* `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
* If the caller does not have permission to delete the
* SampleQuery google.cloud.discoveryengine.v1alpha.SampleQuery, regardless
* of whether or not it exists, a `PERMISSION_DENIED` error is returned.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ function main(name) {
/**
* Required. Full resource name of
* SampleQuery google.cloud.discoveryengine.v1alpha.SampleQuery, such as
* `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`.
* `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
* If the caller does not have permission to access the
* SampleQuery google.cloud.discoveryengine.v1alpha.SampleQuery, regardless
* of whether or not it exists, a PERMISSION_DENIED error is returned.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ function main(name) {
* Required. Full resource name of
* SampleQuerySet google.cloud.discoveryengine.v1alpha.SampleQuerySet, such
* as
* `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
* `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
* If the caller does not have permission to delete the
* SampleQuerySet google.cloud.discoveryengine.v1alpha.SampleQuerySet,
* regardless of whether or not it exists, a `PERMISSION_DENIED` error is
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ function main(name) {
* Required. Full resource name of
* SampleQuerySet google.cloud.discoveryengine.v1alpha.SampleQuerySet, such
* as
* `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
* `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
* If the caller does not have permission to access the
* SampleQuerySet google.cloud.discoveryengine.v1alpha.SampleQuerySet,
* regardless of whether or not it exists, a PERMISSION_DENIED error is
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -340,10 +340,10 @@ export class AclConfigServiceClient {
'projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'
),
sampleQueryPathTemplate: new this._gaxModule.PathTemplate(
'projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}'
'projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}'
),
sampleQuerySetPathTemplate: new this._gaxModule.PathTemplate(
'projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}'
'projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}'
),
};

Expand Down Expand Up @@ -3989,8 +3989,8 @@ export class AclConfigServiceClient {
*
* @param {string} project
* @param {string} location
* @param {string} sampleQuerySet
* @param {string} sampleQuery
* @param {string} sample_query_set
* @param {string} sample_query
* @returns {string} Resource name string.
*/
sampleQueryPath(
Expand All @@ -4002,8 +4002,8 @@ export class AclConfigServiceClient {
return this.pathTemplates.sampleQueryPathTemplate.render({
project: project,
location: location,
sampleQuerySet: sampleQuerySet,
sampleQuery: sampleQuery,
sample_query_set: sampleQuerySet,
sample_query: sampleQuery,
});
}

Expand Down Expand Up @@ -4032,35 +4032,35 @@ export class AclConfigServiceClient {
}

/**
* Parse the sampleQuerySet from SampleQuery resource.
* Parse the sample_query_set from SampleQuery resource.
*
* @param {string} sampleQueryName
* A fully-qualified path representing SampleQuery resource.
* @returns {string} A string representing the sampleQuerySet.
* @returns {string} A string representing the sample_query_set.
*/
matchSampleQuerySetFromSampleQueryName(sampleQueryName: string) {
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
.sampleQuerySet;
.sample_query_set;
}

/**
* Parse the sampleQuery from SampleQuery resource.
* Parse the sample_query from SampleQuery resource.
*
* @param {string} sampleQueryName
* A fully-qualified path representing SampleQuery resource.
* @returns {string} A string representing the sampleQuery.
* @returns {string} A string representing the sample_query.
*/
matchSampleQueryFromSampleQueryName(sampleQueryName: string) {
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
.sampleQuery;
.sample_query;
}

/**
* Return a fully-qualified sampleQuerySet resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} sampleQuerySet
* @param {string} sample_query_set
* @returns {string} Resource name string.
*/
sampleQuerySetPath(
Expand All @@ -4071,7 +4071,7 @@ export class AclConfigServiceClient {
return this.pathTemplates.sampleQuerySetPathTemplate.render({
project: project,
location: location,
sampleQuerySet: sampleQuerySet,
sample_query_set: sampleQuerySet,
});
}

Expand Down Expand Up @@ -4102,16 +4102,16 @@ export class AclConfigServiceClient {
}

/**
* Parse the sampleQuerySet from SampleQuerySet resource.
* Parse the sample_query_set from SampleQuerySet resource.
*
* @param {string} sampleQuerySetName
* A fully-qualified path representing SampleQuerySet resource.
* @returns {string} A string representing the sampleQuerySet.
* @returns {string} A string representing the sample_query_set.
*/
matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string) {
return this.pathTemplates.sampleQuerySetPathTemplate.match(
sampleQuerySetName
).sampleQuerySet;
).sample_query_set;
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -344,10 +344,10 @@ export class ChunkServiceClient {
'projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'
),
sampleQueryPathTemplate: new this._gaxModule.PathTemplate(
'projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}'
'projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}'
),
sampleQuerySetPathTemplate: new this._gaxModule.PathTemplate(
'projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}'
'projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}'
),
};

Expand Down Expand Up @@ -4147,8 +4147,8 @@ export class ChunkServiceClient {
*
* @param {string} project
* @param {string} location
* @param {string} sampleQuerySet
* @param {string} sampleQuery
* @param {string} sample_query_set
* @param {string} sample_query
* @returns {string} Resource name string.
*/
sampleQueryPath(
Expand All @@ -4160,8 +4160,8 @@ export class ChunkServiceClient {
return this.pathTemplates.sampleQueryPathTemplate.render({
project: project,
location: location,
sampleQuerySet: sampleQuerySet,
sampleQuery: sampleQuery,
sample_query_set: sampleQuerySet,
sample_query: sampleQuery,
});
}

Expand Down Expand Up @@ -4190,35 +4190,35 @@ export class ChunkServiceClient {
}

/**
* Parse the sampleQuerySet from SampleQuery resource.
* Parse the sample_query_set from SampleQuery resource.
*
* @param {string} sampleQueryName
* A fully-qualified path representing SampleQuery resource.
* @returns {string} A string representing the sampleQuerySet.
* @returns {string} A string representing the sample_query_set.
*/
matchSampleQuerySetFromSampleQueryName(sampleQueryName: string) {
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
.sampleQuerySet;
.sample_query_set;
}

/**
* Parse the sampleQuery from SampleQuery resource.
* Parse the sample_query from SampleQuery resource.
*
* @param {string} sampleQueryName
* A fully-qualified path representing SampleQuery resource.
* @returns {string} A string representing the sampleQuery.
* @returns {string} A string representing the sample_query.
*/
matchSampleQueryFromSampleQueryName(sampleQueryName: string) {
return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
.sampleQuery;
.sample_query;
}

/**
* Return a fully-qualified sampleQuerySet resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} sampleQuerySet
* @param {string} sample_query_set
* @returns {string} Resource name string.
*/
sampleQuerySetPath(
Expand All @@ -4229,7 +4229,7 @@ export class ChunkServiceClient {
return this.pathTemplates.sampleQuerySetPathTemplate.render({
project: project,
location: location,
sampleQuerySet: sampleQuerySet,
sample_query_set: sampleQuerySet,
});
}

Expand Down Expand Up @@ -4260,16 +4260,16 @@ export class ChunkServiceClient {
}

/**
* Parse the sampleQuerySet from SampleQuerySet resource.
* Parse the sample_query_set from SampleQuerySet resource.
*
* @param {string} sampleQuerySetName
* A fully-qualified path representing SampleQuerySet resource.
* @returns {string} A string representing the sampleQuerySet.
* @returns {string} A string representing the sample_query_set.
*/
matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string) {
return this.pathTemplates.sampleQuerySetPathTemplate.match(
sampleQuerySetName
).sampleQuerySet;
).sample_query_set;
}

/**
Expand Down
Loading
Loading