Package gkerecommender is an auto-generated package for the GKE Recommender API.
GKE Recommender API
NOTE : This package is in beta . It is not stable , and may be subject to changes .
General documentation
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview . Some information on this page includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage
To get started with this package, create a client.
// go get cloud.google.com/go/gkerecommender/apiv1@latest ctx := context . Background () // 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c , err := gkerecommender . NewGkeInferenceQuickstartClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close ()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client
The following is an example of making an API call with the newly created client, mentioned above.
req := & gkerecommenderpb . FetchBenchmarkingDataRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb#FetchBenchmarkingDataRequest. } resp , err := c . FetchBenchmarkingData ( ctx , req ) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context
The ctx passed to NewGkeInferenceQuickstartClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
GkeInferenceQuickstartCallOptions
type
GkeInferenceQuickstartCallOptions
struct
{
FetchModels
[]
gax
.
CallOption
FetchModelServers
[]
gax
.
CallOption
FetchModelServerVersions
[]
gax
.
CallOption
FetchProfiles
[]
gax
.
CallOption
GenerateOptimizedManifest
[]
gax
.
CallOption
FetchBenchmarkingData
[]
gax
.
CallOption
}
GkeInferenceQuickstartCallOptions contains the retry settings for each method of GkeInferenceQuickstartClient.
GkeInferenceQuickstartClient
type
GkeInferenceQuickstartClient
struct
{
// The call options for this service.
CallOptions
*
GkeInferenceQuickstartCallOptions
// contains filtered or unexported fields
}
GkeInferenceQuickstartClient is a client for interacting with GKE Recommender API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
GKE Inference Quickstart (GIQ) service provides profiles with performance metrics for popular models and model servers across multiple accelerators. These profiles help generate optimized best practices for running inference on GKE.
func NewGkeInferenceQuickstartClient
func
NewGkeInferenceQuickstartClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
GkeInferenceQuickstartClient
,
error
)
NewGkeInferenceQuickstartClient creates a new gke inference quickstart client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
GKE Inference Quickstart (GIQ) service provides profiles with performance metrics for popular models and model servers across multiple accelerators. These profiles help generate optimized best practices for running inference on GKE.
Example
package
main
import
(
"context"
gkerecommender
"cloud.google.com/go/gkerecommender/apiv1"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
gkerecommender
.
NewGkeInferenceQuickstartClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewGkeInferenceQuickstartRESTClient
func
NewGkeInferenceQuickstartRESTClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
GkeInferenceQuickstartClient
,
error
)
NewGkeInferenceQuickstartRESTClient creates a new gke inference quickstart rest client.
GKE Inference Quickstart (GIQ) service provides profiles with performance metrics for popular models and model servers across multiple accelerators. These profiles help generate optimized best practices for running inference on GKE.
Example
package
main
import
(
"context"
gkerecommender
"cloud.google.com/go/gkerecommender/apiv1"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
gkerecommender
.
NewGkeInferenceQuickstartRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*GkeInferenceQuickstartClient) Close
func
(
c
*
GkeInferenceQuickstartClient
)
Close
()
error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*GkeInferenceQuickstartClient) Connection (deprecated)
func
(
c
*
GkeInferenceQuickstartClient
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*GkeInferenceQuickstartClient) FetchBenchmarkingData
func
(
c
*
GkeInferenceQuickstartClient
)
FetchBenchmarkingData
(
ctx
context
.
Context
,
req
*
gkerecommenderpb
.
FetchBenchmarkingDataRequest
,
opts
...
gax
.
CallOption
)
(
*
gkerecommenderpb
.
FetchBenchmarkingDataResponse
,
error
)
FetchBenchmarkingData fetches all of the benchmarking data available for a profile. Benchmarking data returns all of the performance metrics available for a given model server setup on a given instance type.
Example
package
main
import
(
"context"
gkerecommender
"cloud.google.com/go/gkerecommender/apiv1"
gkerecommenderpb
"cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
gkerecommender
.
NewGkeInferenceQuickstartClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& gkerecommenderpb
.
FetchBenchmarkingDataRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb#FetchBenchmarkingDataRequest.
}
resp
,
err
:=
c
.
FetchBenchmarkingData
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*GkeInferenceQuickstartClient) FetchModelServerVersions
func
(
c
*
GkeInferenceQuickstartClient
)
FetchModelServerVersions
(
ctx
context
.
Context
,
req
*
gkerecommenderpb
.
FetchModelServerVersionsRequest
,
opts
...
gax
.
CallOption
)
*
StringIterator
FetchModelServerVersions fetches available model server versions. Open-source servers use their own versioning schemas (e.g., vllm uses semver like v1.0.0).
Some model servers have different versioning schemas depending on the accelerator. For example, vllm uses semver on GPUs, but returns nightly build tags on TPUs. All available versions will be returned when different schemas are present.
Examples
package
main
import
(
"context"
gkerecommender
"cloud.google.com/go/gkerecommender/apiv1"
gkerecommenderpb
"cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
gkerecommender
.
NewGkeInferenceQuickstartClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& gkerecommenderpb
.
FetchModelServerVersionsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb#FetchModelServerVersionsRequest.
}
it
:=
c
.
FetchModelServerVersions
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
gkerecommenderpb
.
FetchModelServerVersionsResponse
)
}
}
all
package
main
import
(
"context"
gkerecommender
"cloud.google.com/go/gkerecommender/apiv1"
gkerecommenderpb
"cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
gkerecommender
.
NewGkeInferenceQuickstartClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& gkerecommenderpb
.
FetchModelServerVersionsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb#FetchModelServerVersionsRequest.
}
for
resp
,
err
:=
range
c
.
FetchModelServerVersions
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*GkeInferenceQuickstartClient) FetchModelServers
func
(
c
*
GkeInferenceQuickstartClient
)
FetchModelServers
(
ctx
context
.
Context
,
req
*
gkerecommenderpb
.
FetchModelServersRequest
,
opts
...
gax
.
CallOption
)
*
StringIterator
FetchModelServers fetches available model servers. Open-source model servers use simplified, lowercase names (e.g., vllm).
Examples
package
main
import
(
"context"
gkerecommender
"cloud.google.com/go/gkerecommender/apiv1"
gkerecommenderpb
"cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
gkerecommender
.
NewGkeInferenceQuickstartClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& gkerecommenderpb
.
FetchModelServersRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb#FetchModelServersRequest.
}
it
:=
c
.
FetchModelServers
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
gkerecommenderpb
.
FetchModelServersResponse
)
}
}
all
package
main
import
(
"context"
gkerecommender
"cloud.google.com/go/gkerecommender/apiv1"
gkerecommenderpb
"cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
gkerecommender
.
NewGkeInferenceQuickstartClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& gkerecommenderpb
.
FetchModelServersRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb#FetchModelServersRequest.
}
for
resp
,
err
:=
range
c
.
FetchModelServers
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*GkeInferenceQuickstartClient) FetchModels
func
(
c
*
GkeInferenceQuickstartClient
)
FetchModels
(
ctx
context
.
Context
,
req
*
gkerecommenderpb
.
FetchModelsRequest
,
opts
...
gax
.
CallOption
)
*
StringIterator
FetchModels fetches available models. Open-source models follow the Huggingface Hub owner/model_name format.
Examples
package
main
import
(
"context"
gkerecommender
"cloud.google.com/go/gkerecommender/apiv1"
gkerecommenderpb
"cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
gkerecommender
.
NewGkeInferenceQuickstartClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& gkerecommenderpb
.
FetchModelsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb#FetchModelsRequest.
}
it
:=
c
.
FetchModels
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
gkerecommenderpb
.
FetchModelsResponse
)
}
}
all
package
main
import
(
"context"
gkerecommender
"cloud.google.com/go/gkerecommender/apiv1"
gkerecommenderpb
"cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
gkerecommender
.
NewGkeInferenceQuickstartClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& gkerecommenderpb
.
FetchModelsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb#FetchModelsRequest.
}
for
resp
,
err
:=
range
c
.
FetchModels
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*GkeInferenceQuickstartClient) FetchProfiles
func
(
c
*
GkeInferenceQuickstartClient
)
FetchProfiles
(
ctx
context
.
Context
,
req
*
gkerecommenderpb
.
FetchProfilesRequest
,
opts
...
gax
.
CallOption
)
*
ProfileIterator
FetchProfiles fetches available profiles. A profile contains performance metrics and cost information for a specific model server setup. Profiles can be filtered by parameters. If no filters are provided, all profiles are returned.
Profiles display a single value per performance metric based on the provided performance requirements. If no requirements are given, the metrics represent the inflection point. See Run best practice inference with GKE Inference Quickstart recipes (at https://cloud.google.com/kubernetes-engine/docs/how-to/machine-learning/inference/inference-quickstart#how ) for details.
Examples
package
main
import
(
"context"
gkerecommender
"cloud.google.com/go/gkerecommender/apiv1"
gkerecommenderpb
"cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
gkerecommender
.
NewGkeInferenceQuickstartClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& gkerecommenderpb
.
FetchProfilesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb#FetchProfilesRequest.
}
it
:=
c
.
FetchProfiles
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
gkerecommenderpb
.
FetchProfilesResponse
)
}
}
all
package
main
import
(
"context"
gkerecommender
"cloud.google.com/go/gkerecommender/apiv1"
gkerecommenderpb
"cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
gkerecommender
.
NewGkeInferenceQuickstartClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& gkerecommenderpb
.
FetchProfilesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb#FetchProfilesRequest.
}
for
resp
,
err
:=
range
c
.
FetchProfiles
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*GkeInferenceQuickstartClient) GenerateOptimizedManifest
func
(
c
*
GkeInferenceQuickstartClient
)
GenerateOptimizedManifest
(
ctx
context
.
Context
,
req
*
gkerecommenderpb
.
GenerateOptimizedManifestRequest
,
opts
...
gax
.
CallOption
)
(
*
gkerecommenderpb
.
GenerateOptimizedManifestResponse
,
error
)
GenerateOptimizedManifest generates an optimized deployment manifest for a given model and model server, based on the specified accelerator, performance targets, and configurations. See Run best practice inference with GKE Inference Quickstart recipes (at https://cloud.google.com/kubernetes-engine/docs/how-to/machine-learning/inference/inference-quickstart ) for deployment details.
Example
package
main
import
(
"context"
gkerecommender
"cloud.google.com/go/gkerecommender/apiv1"
gkerecommenderpb
"cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// 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://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
gkerecommender
.
NewGkeInferenceQuickstartClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& gkerecommenderpb
.
GenerateOptimizedManifestRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/gkerecommender/apiv1/gkerecommenderpb#GenerateOptimizedManifestRequest.
}
resp
,
err
:=
c
.
GenerateOptimizedManifest
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
ProfileIterator
type
ProfileIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
gkerecommenderpb
.
Profile
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ProfileIterator manages a stream of *gkerecommenderpb.Profile.
func (*ProfileIterator) All
func
(
it
*
ProfileIterator
)
All
()
iter
.
Seq2
[
*
gkerecommenderpb
.
Profile
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*ProfileIterator) Next
func
(
it
*
ProfileIterator
)
Next
()
(
*
gkerecommenderpb
.
Profile
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ProfileIterator) PageInfo
func
(
it
*
ProfileIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
StringIterator
type
StringIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
string
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
StringIterator manages a stream of string.
func (*StringIterator) All
func
(
it
*
StringIterator
)
All
()
iter
.
Seq2
[
string
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*StringIterator) Next
func
(
it
*
StringIterator
)
Next
()
(
string
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*StringIterator) PageInfo
func
(
it
*
StringIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
