Package modelarmor is an auto-generated package for the Model Armor API.
Model Armor helps you protect against risks like prompt injection, harmful content, and data leakage in generative AI applications by letting you define policies that filter user prompts and model responses.
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/modelarmor/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 := modelarmor . NewClient ( 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 := & modelarmorpb . CreateTemplateRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/modelarmor/apiv1/modelarmorpb#CreateTemplateRequest. } resp , err := c . CreateTemplate ( ctx , req ) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context
The ctx passed to NewClient 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.
CallOptions
type
CallOptions
struct
{
ListTemplates
[]
gax
.
CallOption
GetTemplate
[]
gax
.
CallOption
CreateTemplate
[]
gax
.
CallOption
UpdateTemplate
[]
gax
.
CallOption
DeleteTemplate
[]
gax
.
CallOption
GetFloorSetting
[]
gax
.
CallOption
UpdateFloorSetting
[]
gax
.
CallOption
SanitizeUserPrompt
[]
gax
.
CallOption
SanitizeModelResponse
[]
gax
.
CallOption
GetLocation
[]
gax
.
CallOption
ListLocations
[]
gax
.
CallOption
}
CallOptions contains the retry settings for each method of Client.
Client
type
Client
struct
{
// The call options for this service.
CallOptions
*
CallOptions
// contains filtered or unexported fields
}
Client is a client for interacting with Model Armor API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Service describing handlers for resources
func NewClient
NewClient creates a new model armor client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Service describing handlers for resources
Example
package
main
import
(
"context"
modelarmor
"cloud.google.com/go/modelarmor/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
:=
modelarmor
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewRESTClient
NewRESTClient creates a new model armor rest client.
Service describing handlers for resources
Example
package
main
import
(
"context"
modelarmor
"cloud.google.com/go/modelarmor/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
:=
modelarmor
.
NewRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*Client) Close
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Connection (deprecated)
func
(
c
*
Client
)
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 (*Client) CreateTemplate
func
(
c
*
Client
)
CreateTemplate
(
ctx
context
.
Context
,
req
*
modelarmorpb
.
CreateTemplateRequest
,
opts
...
gax
.
CallOption
)
(
*
modelarmorpb
.
Template
,
error
)
CreateTemplate creates a new Template in a given project and location.
Example
package
main
import
(
"context"
modelarmor
"cloud.google.com/go/modelarmor/apiv1"
modelarmorpb
"cloud.google.com/go/modelarmor/apiv1/modelarmorpb"
)
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
:=
modelarmor
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& modelarmorpb
.
CreateTemplateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/modelarmor/apiv1/modelarmorpb#CreateTemplateRequest.
}
resp
,
err
:=
c
.
CreateTemplate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) DeleteTemplate
func
(
c
*
Client
)
DeleteTemplate
(
ctx
context
.
Context
,
req
*
modelarmorpb
.
DeleteTemplateRequest
,
opts
...
gax
.
CallOption
)
error
DeleteTemplate deletes a single Template.
Example
package
main
import
(
"context"
modelarmor
"cloud.google.com/go/modelarmor/apiv1"
modelarmorpb
"cloud.google.com/go/modelarmor/apiv1/modelarmorpb"
)
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
:=
modelarmor
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& modelarmorpb
.
DeleteTemplateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/modelarmor/apiv1/modelarmorpb#DeleteTemplateRequest.
}
err
=
c
.
DeleteTemplate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) GetFloorSetting
func
(
c
*
Client
)
GetFloorSetting
(
ctx
context
.
Context
,
req
*
modelarmorpb
.
GetFloorSettingRequest
,
opts
...
gax
.
CallOption
)
(
*
modelarmorpb
.
FloorSetting
,
error
)
GetFloorSetting gets details of a single floor setting of a project
Example
package
main
import
(
"context"
modelarmor
"cloud.google.com/go/modelarmor/apiv1"
modelarmorpb
"cloud.google.com/go/modelarmor/apiv1/modelarmorpb"
)
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
:=
modelarmor
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& modelarmorpb
.
GetFloorSettingRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/modelarmor/apiv1/modelarmorpb#GetFloorSettingRequest.
}
resp
,
err
:=
c
.
GetFloorSetting
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetLocation
func
(
c
*
Client
)
GetLocation
(
ctx
context
.
Context
,
req
*
locationpb
.
GetLocationRequest
,
opts
...
gax
.
CallOption
)
(
*
locationpb
.
Location
,
error
)
GetLocation gets information about a location.
Example
package
main
import
(
"context"
modelarmor
"cloud.google.com/go/modelarmor/apiv1"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
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
:=
modelarmor
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
GetLocationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest.
}
resp
,
err
:=
c
.
GetLocation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetTemplate
func
(
c
*
Client
)
GetTemplate
(
ctx
context
.
Context
,
req
*
modelarmorpb
.
GetTemplateRequest
,
opts
...
gax
.
CallOption
)
(
*
modelarmorpb
.
Template
,
error
)
GetTemplate gets details of a single Template.
Example
package
main
import
(
"context"
modelarmor
"cloud.google.com/go/modelarmor/apiv1"
modelarmorpb
"cloud.google.com/go/modelarmor/apiv1/modelarmorpb"
)
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
:=
modelarmor
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& modelarmorpb
.
GetTemplateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/modelarmor/apiv1/modelarmorpb#GetTemplateRequest.
}
resp
,
err
:=
c
.
GetTemplate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) ListLocations
func
(
c
*
Client
)
ListLocations
(
ctx
context
.
Context
,
req
*
locationpb
.
ListLocationsRequest
,
opts
...
gax
.
CallOption
)
*
LocationIterator
ListLocations lists information about the supported locations for this service.
Examples
package
main
import
(
"context"
modelarmor
"cloud.google.com/go/modelarmor/apiv1"
"google.golang.org/api/iterator"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
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
:=
modelarmor
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
ListLocationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
}
it
:=
c
.
ListLocations
(
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
.(
*
locationpb
.
ListLocationsResponse
)
}
}
all
package
main
import
(
"context"
modelarmor
"cloud.google.com/go/modelarmor/apiv1"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
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
:=
modelarmor
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
ListLocationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
}
for
resp
,
err
:=
range
c
.
ListLocations
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListTemplates
func
(
c
*
Client
)
ListTemplates
(
ctx
context
.
Context
,
req
*
modelarmorpb
.
ListTemplatesRequest
,
opts
...
gax
.
CallOption
)
*
TemplateIterator
ListTemplates lists Templates in a given project and location.
Examples
package
main
import
(
"context"
modelarmor
"cloud.google.com/go/modelarmor/apiv1"
modelarmorpb
"cloud.google.com/go/modelarmor/apiv1/modelarmorpb"
"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
:=
modelarmor
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& modelarmorpb
.
ListTemplatesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/modelarmor/apiv1/modelarmorpb#ListTemplatesRequest.
}
it
:=
c
.
ListTemplates
(
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
.(
*
modelarmorpb
.
ListTemplatesResponse
)
}
}
all
package
main
import
(
"context"
modelarmor
"cloud.google.com/go/modelarmor/apiv1"
modelarmorpb
"cloud.google.com/go/modelarmor/apiv1/modelarmorpb"
)
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
:=
modelarmor
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& modelarmorpb
.
ListTemplatesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/modelarmor/apiv1/modelarmorpb#ListTemplatesRequest.
}
for
resp
,
err
:=
range
c
.
ListTemplates
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) SanitizeModelResponse
func
(
c
*
Client
)
SanitizeModelResponse
(
ctx
context
.
Context
,
req
*
modelarmorpb
.
SanitizeModelResponseRequest
,
opts
...
gax
.
CallOption
)
(
*
modelarmorpb
.
SanitizeModelResponseResponse
,
error
)
SanitizeModelResponse sanitizes Model Response.
Example
package
main
import
(
"context"
modelarmor
"cloud.google.com/go/modelarmor/apiv1"
modelarmorpb
"cloud.google.com/go/modelarmor/apiv1/modelarmorpb"
)
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
:=
modelarmor
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& modelarmorpb
.
SanitizeModelResponseRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/modelarmor/apiv1/modelarmorpb#SanitizeModelResponseRequest.
}
resp
,
err
:=
c
.
SanitizeModelResponse
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) SanitizeUserPrompt
func
(
c
*
Client
)
SanitizeUserPrompt
(
ctx
context
.
Context
,
req
*
modelarmorpb
.
SanitizeUserPromptRequest
,
opts
...
gax
.
CallOption
)
(
*
modelarmorpb
.
SanitizeUserPromptResponse
,
error
)
SanitizeUserPrompt sanitizes User Prompt.
Example
package
main
import
(
"context"
modelarmor
"cloud.google.com/go/modelarmor/apiv1"
modelarmorpb
"cloud.google.com/go/modelarmor/apiv1/modelarmorpb"
)
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
:=
modelarmor
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& modelarmorpb
.
SanitizeUserPromptRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/modelarmor/apiv1/modelarmorpb#SanitizeUserPromptRequest.
}
resp
,
err
:=
c
.
SanitizeUserPrompt
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) UpdateFloorSetting
func
(
c
*
Client
)
UpdateFloorSetting
(
ctx
context
.
Context
,
req
*
modelarmorpb
.
UpdateFloorSettingRequest
,
opts
...
gax
.
CallOption
)
(
*
modelarmorpb
.
FloorSetting
,
error
)
UpdateFloorSetting updates the parameters of a single floor setting of a project
Example
package
main
import
(
"context"
modelarmor
"cloud.google.com/go/modelarmor/apiv1"
modelarmorpb
"cloud.google.com/go/modelarmor/apiv1/modelarmorpb"
)
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
:=
modelarmor
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& modelarmorpb
.
UpdateFloorSettingRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/modelarmor/apiv1/modelarmorpb#UpdateFloorSettingRequest.
}
resp
,
err
:=
c
.
UpdateFloorSetting
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) UpdateTemplate
func
(
c
*
Client
)
UpdateTemplate
(
ctx
context
.
Context
,
req
*
modelarmorpb
.
UpdateTemplateRequest
,
opts
...
gax
.
CallOption
)
(
*
modelarmorpb
.
Template
,
error
)
UpdateTemplate updates the parameters of a single Template.
Example
package
main
import
(
"context"
modelarmor
"cloud.google.com/go/modelarmor/apiv1"
modelarmorpb
"cloud.google.com/go/modelarmor/apiv1/modelarmorpb"
)
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
:=
modelarmor
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& modelarmorpb
.
UpdateTemplateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/modelarmor/apiv1/modelarmorpb#UpdateTemplateRequest.
}
resp
,
err
:=
c
.
UpdateTemplate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
LocationIterator
type
LocationIterator
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
[]
*
locationpb
.
Location
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
LocationIterator manages a stream of *locationpb.Location.
func (*LocationIterator) All
func
(
it
*
LocationIterator
)
All
()
iter
.
Seq2
[
*
locationpb
.
Location
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*LocationIterator) Next
func
(
it
*
LocationIterator
)
Next
()
(
*
locationpb
.
Location
,
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 (*LocationIterator) PageInfo
func
(
it
*
LocationIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
TemplateIterator
type
TemplateIterator
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
[]
*
modelarmorpb
.
Template
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
TemplateIterator manages a stream of *modelarmorpb.Template.
func (*TemplateIterator) All
func
(
it
*
TemplateIterator
)
All
()
iter
.
Seq2
[
*
modelarmorpb
.
Template
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*TemplateIterator) Next
func
(
it
*
TemplateIterator
)
Next
()
(
*
modelarmorpb
.
Template
,
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 (*TemplateIterator) PageInfo
func
(
it
*
TemplateIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
