Skip to content

Commit

Permalink
feat: add SearchDataItems RPC in aiplatform version v1 and v1beta1 da…
Browse files Browse the repository at this point in the history
…taset_service.proto

PiperOrigin-RevId: 493139921

Source-Link: googleapis/googleapis@268ee4d

Source-Link: googleapis/googleapis-gen@f4b4248
Copy-Tag: eyJwIjoiYXBpcy9Hb29nbGUuQ2xvdWQuQUlQbGF0Zm9ybS5WMS8uT3dsQm90LnlhbWwiLCJoIjoiZjRiNDI0ODMxMzU0YzViNTZhMmE0YjFmZWZkMGY2YjRkNmM2NDYwZSJ9
  • Loading branch information
gcf-owl-bot[bot] authored and jskeet committed Dec 6, 2022
1 parent 0d8dba3 commit c44d0dc
Show file tree
Hide file tree
Showing 9 changed files with 2,270 additions and 196 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Generated code. DO NOT EDIT!

namespace Google.Cloud.AIPlatform.V1.Snippets
{
// [START aiplatform_v1_generated_DatasetService_SearchDataItems_async]
using Google.Api.Gax;
using Google.Cloud.AIPlatform.V1;
using Google.Protobuf.WellKnownTypes;
using System;
using System.Linq;
using System.Threading.Tasks;

public sealed partial class GeneratedDatasetServiceClientSnippets
{
/// <summary>Snippet for SearchDataItemsAsync</summary>
/// <remarks>
/// This snippet has been automatically generated and should be regarded as a code template only.
/// It will require modifications to work:
/// - It may require correct/in-range values for request initialization.
/// - It may require specifying regional endpoints when creating the service client as shown in
/// https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
/// </remarks>
public async Task SearchDataItemsRequestObjectAsync()
{
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
SearchDataItemsRequest request = new SearchDataItemsRequest
{
DatasetAsDatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
DataLabelingJob = "",
DataItemFilter = "",
FieldMask = new FieldMask(),
AnnotationsLimit = 0,
AnnotationFilters = { "", },
OrderByDataItem = "",
};
// Make the request
PagedAsyncEnumerable<SearchDataItemsResponse, DataItemView> response = datasetServiceClient.SearchDataItemsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DataItemView item) =>
{
// Do something with each item
Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((SearchDataItemsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (DataItemView item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataItemView> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataItemView item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
}
}
// [END aiplatform_v1_generated_DatasetService_SearchDataItems_async]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Generated code. DO NOT EDIT!

namespace Google.Cloud.AIPlatform.V1.Snippets
{
// [START aiplatform_v1_generated_DatasetService_SearchDataItems_sync]
using Google.Api.Gax;
using Google.Cloud.AIPlatform.V1;
using Google.Protobuf.WellKnownTypes;
using System;

public sealed partial class GeneratedDatasetServiceClientSnippets
{
/// <summary>Snippet for SearchDataItems</summary>
/// <remarks>
/// This snippet has been automatically generated and should be regarded as a code template only.
/// It will require modifications to work:
/// - It may require correct/in-range values for request initialization.
/// - It may require specifying regional endpoints when creating the service client as shown in
/// https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
/// </remarks>
public void SearchDataItemsRequestObject()
{
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
SearchDataItemsRequest request = new SearchDataItemsRequest
{
DatasetAsDatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
DataLabelingJob = "",
DataItemFilter = "",
FieldMask = new FieldMask(),
AnnotationsLimit = 0,
AnnotationFilters = { "", },
OrderByDataItem = "",
};
// Make the request
PagedEnumerable<SearchDataItemsResponse, DataItemView> response = datasetServiceClient.SearchDataItems(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (DataItemView item in response)
{
// Do something with each item
Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (SearchDataItemsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (DataItemView item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataItemView> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataItemView item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
}
}
// [END aiplatform_v1_generated_DatasetService_SearchDataItems_sync]
}
Original file line number Diff line number Diff line change
Expand Up @@ -1751,6 +1751,83 @@
}
]
},
{
"regionTag": "aiplatform_v1_generated_DatasetService_SearchDataItems_sync",
"title": "SearchDataItemsRequestObject",
"description": "Snippet for SearchDataItems",
"file": "DatasetServiceClient.SearchDataItemsRequestObjectSnippet.g.cs",
"language": "C_SHARP",
"clientMethod": {
"shortName": "SearchDataItems",
"fullName": "Google.Cloud.AIPlatform.V1.DatasetServiceClient.SearchDataItems",
"resultType": "Google.Api.Gax.PagedEnumerable<Google.Cloud.AIPlatform.V1.SearchDataItemsResponse, Google.Cloud.AIPlatform.V1.DataItemView>",
"client": {
"shortName": "DatasetServiceClient",
"fullName": "Google.Cloud.AIPlatform.V1.DatasetServiceClient"
},
"method": {
"shortName": "SearchDataItems",
"fullName": "google.cloud.aiplatform.v1.DatasetService.SearchDataItems",
"service": {
"shortName": "DatasetService",
"fullName": "google.cloud.aiplatform.v1.DatasetService"
}
}
},
"canonical": true,
"origin": "API_DEFINITION",
"segments": [
{
"start": 20,
"end": 85,
"type": "FULL"
},
{
"start": 37,
"end": 83,
"type": "SHORT"
}
]
},
{
"regionTag": "aiplatform_v1_generated_DatasetService_SearchDataItems_async",
"title": "SearchDataItemsRequestObjectAsync",
"description": "Snippet for SearchDataItemsAsync",
"file": "DatasetServiceClient.SearchDataItemsRequestObjectAsyncSnippet.g.cs",
"language": "C_SHARP",
"clientMethod": {
"shortName": "SearchDataItemsAsync",
"fullName": "Google.Cloud.AIPlatform.V1.DatasetServiceClient.SearchDataItemsAsync",
"async": true,
"resultType": "Google.Api.Gax.PagedAsyncEnumerable<Google.Cloud.AIPlatform.V1.SearchDataItemsResponse, Google.Cloud.AIPlatform.V1.DataItemView>",
"client": {
"shortName": "DatasetServiceClient",
"fullName": "Google.Cloud.AIPlatform.V1.DatasetServiceClient"
},
"method": {
"shortName": "SearchDataItems",
"fullName": "google.cloud.aiplatform.v1.DatasetService.SearchDataItems",
"service": {
"shortName": "DatasetService",
"fullName": "google.cloud.aiplatform.v1.DatasetService"
}
}
},
"canonical": true,
"origin": "API_DEFINITION",
"segments": [
{
"start": 20,
"end": 87,
"type": "FULL"
},
{
"start": 39,
"end": 85,
"type": "SHORT"
}
]
},
{
"regionTag": "aiplatform_v1_generated_DatasetService_ListSavedQueries_sync",
"title": "ListSavedQueriesRequestObject",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1513,6 +1513,114 @@ await response.AsRawResponses().ForEachAsync((ListDataItemsResponse page) =>
// End snippet
}

/// <summary>Snippet for SearchDataItems</summary>
public void SearchDataItemsRequestObject()
{
// Snippet: SearchDataItems(SearchDataItemsRequest, CallSettings)
// Create client
DatasetServiceClient datasetServiceClient = DatasetServiceClient.Create();
// Initialize request argument(s)
SearchDataItemsRequest request = new SearchDataItemsRequest
{
DatasetAsDatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
DataLabelingJob = "",
DataItemFilter = "",
FieldMask = new FieldMask(),
AnnotationsLimit = 0,
AnnotationFilters = { "", },
OrderByDataItem = "",
};
// Make the request
PagedEnumerable<SearchDataItemsResponse, DataItemView> response = datasetServiceClient.SearchDataItems(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (DataItemView item in response)
{
// Do something with each item
Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (SearchDataItemsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (DataItemView item in page)
{
// Do something with each item
Console.WriteLine(item);
}
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataItemView> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataItemView item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
// End snippet
}

/// <summary>Snippet for SearchDataItemsAsync</summary>
public async Task SearchDataItemsRequestObjectAsync()
{
// Snippet: SearchDataItemsAsync(SearchDataItemsRequest, CallSettings)
// Create client
DatasetServiceClient datasetServiceClient = await DatasetServiceClient.CreateAsync();
// Initialize request argument(s)
SearchDataItemsRequest request = new SearchDataItemsRequest
{
DatasetAsDatasetName = DatasetName.FromProjectLocationDataset("[PROJECT]", "[LOCATION]", "[DATASET]"),
DataLabelingJob = "",
DataItemFilter = "",
FieldMask = new FieldMask(),
AnnotationsLimit = 0,
AnnotationFilters = { "", },
OrderByDataItem = "",
};
// Make the request
PagedAsyncEnumerable<SearchDataItemsResponse, DataItemView> response = datasetServiceClient.SearchDataItemsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DataItemView item) =>
{
// Do something with each item
Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((SearchDataItemsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (DataItemView item in page)
{
// Do something with each item
Console.WriteLine(item);
}
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataItemView> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataItemView item in singlePage)
{
// Do something with each item
Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;
// End snippet
}

/// <summary>Snippet for ListSavedQueries</summary>
public void ListSavedQueriesRequestObject()
{
Expand Down
Loading

0 comments on commit c44d0dc

Please sign in to comment.