|
- // Copyright 2019 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.
-
- // Code generated by gapic-generator. DO NOT EDIT.
-
- package talent
-
- import (
- "context"
- "math"
- "time"
-
- "github.com/golang/protobuf/proto"
- gax "github.com/googleapis/gax-go/v2"
- "google.golang.org/api/iterator"
- "google.golang.org/api/option"
- "google.golang.org/api/transport"
- talentpb "google.golang.org/genproto/googleapis/cloud/talent/v4beta1"
- "google.golang.org/grpc"
- "google.golang.org/grpc/codes"
- "google.golang.org/grpc/metadata"
- )
-
- // ProfileCallOptions contains the retry settings for each method of ProfileClient.
- type ProfileCallOptions struct {
- ListProfiles []gax.CallOption
- CreateProfile []gax.CallOption
- GetProfile []gax.CallOption
- UpdateProfile []gax.CallOption
- DeleteProfile []gax.CallOption
- SearchProfiles []gax.CallOption
- }
-
- func defaultProfileClientOptions() []option.ClientOption {
- return []option.ClientOption{
- option.WithEndpoint("jobs.googleapis.com:443"),
- option.WithScopes(DefaultAuthScopes()...),
- }
- }
-
- func defaultProfileCallOptions() *ProfileCallOptions {
- retry := map[[2]string][]gax.CallOption{
- {"default", "idempotent"}: {
- gax.WithRetry(func() gax.Retryer {
- return gax.OnCodes([]codes.Code{
- codes.DeadlineExceeded,
- codes.Unavailable,
- }, gax.Backoff{
- Initial: 100 * time.Millisecond,
- Max: 60000 * time.Millisecond,
- Multiplier: 1.3,
- })
- }),
- },
- }
- return &ProfileCallOptions{
- ListProfiles: retry[[2]string{"default", "idempotent"}],
- CreateProfile: retry[[2]string{"default", "non_idempotent"}],
- GetProfile: retry[[2]string{"default", "idempotent"}],
- UpdateProfile: retry[[2]string{"default", "non_idempotent"}],
- DeleteProfile: retry[[2]string{"default", "idempotent"}],
- SearchProfiles: retry[[2]string{"default", "non_idempotent"}],
- }
- }
-
- // ProfileClient is a client for interacting with Cloud Talent Solution API.
- //
- // Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
- type ProfileClient struct {
- // The connection to the service.
- conn *grpc.ClientConn
-
- // The gRPC API client.
- profileClient talentpb.ProfileServiceClient
-
- // The call options for this service.
- CallOptions *ProfileCallOptions
-
- // The x-goog-* metadata to be sent with each request.
- xGoogMetadata metadata.MD
- }
-
- // NewProfileClient creates a new profile service client.
- //
- // A service that handles profile management, including profile CRUD,
- // enumeration and search.
- func NewProfileClient(ctx context.Context, opts ...option.ClientOption) (*ProfileClient, error) {
- conn, err := transport.DialGRPC(ctx, append(defaultProfileClientOptions(), opts...)...)
- if err != nil {
- return nil, err
- }
- c := &ProfileClient{
- conn: conn,
- CallOptions: defaultProfileCallOptions(),
-
- profileClient: talentpb.NewProfileServiceClient(conn),
- }
- c.setGoogleClientInfo()
- return c, nil
- }
-
- // Connection returns the client's connection to the API service.
- func (c *ProfileClient) Connection() *grpc.ClientConn {
- return c.conn
- }
-
- // Close closes the connection to the API service. The user should invoke this when
- // the client is no longer required.
- func (c *ProfileClient) Close() error {
- return c.conn.Close()
- }
-
- // setGoogleClientInfo sets the name and version of the application in
- // the `x-goog-api-client` header passed on each request. Intended for
- // use by Google-written clients.
- func (c *ProfileClient) setGoogleClientInfo(keyval ...string) {
- kv := append([]string{"gl-go", versionGo()}, keyval...)
- kv = append(kv, "gapic", versionClient, "gax", gax.Version, "grpc", grpc.Version)
- c.xGoogMetadata = metadata.Pairs("x-goog-api-client", gax.XGoogHeader(kv...))
- }
-
- // ListProfiles lists profiles by filter. The order is unspecified.
- func (c *ProfileClient) ListProfiles(ctx context.Context, req *talentpb.ListProfilesRequest, opts ...gax.CallOption) *ProfileIterator {
- ctx = insertMetadata(ctx, c.xGoogMetadata)
- opts = append(c.CallOptions.ListProfiles[0:len(c.CallOptions.ListProfiles):len(c.CallOptions.ListProfiles)], opts...)
- it := &ProfileIterator{}
- req = proto.Clone(req).(*talentpb.ListProfilesRequest)
- it.InternalFetch = func(pageSize int, pageToken string) ([]*talentpb.Profile, string, error) {
- var resp *talentpb.ListProfilesResponse
- req.PageToken = pageToken
- if pageSize > math.MaxInt32 {
- req.PageSize = math.MaxInt32
- } else {
- req.PageSize = int32(pageSize)
- }
- err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
- var err error
- resp, err = c.profileClient.ListProfiles(ctx, req, settings.GRPC...)
- return err
- }, opts...)
- if err != nil {
- return nil, "", err
- }
- return resp.Profiles, resp.NextPageToken, nil
- }
- fetch := func(pageSize int, pageToken string) (string, error) {
- items, nextPageToken, err := it.InternalFetch(pageSize, pageToken)
- if err != nil {
- return "", err
- }
- it.items = append(it.items, items...)
- return nextPageToken, nil
- }
- it.pageInfo, it.nextFunc = iterator.NewPageInfo(fetch, it.bufLen, it.takeBuf)
- it.pageInfo.MaxSize = int(req.PageSize)
- return it
- }
-
- // CreateProfile creates and returns a new profile.
- func (c *ProfileClient) CreateProfile(ctx context.Context, req *talentpb.CreateProfileRequest, opts ...gax.CallOption) (*talentpb.Profile, error) {
- ctx = insertMetadata(ctx, c.xGoogMetadata)
- opts = append(c.CallOptions.CreateProfile[0:len(c.CallOptions.CreateProfile):len(c.CallOptions.CreateProfile)], opts...)
- var resp *talentpb.Profile
- err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
- var err error
- resp, err = c.profileClient.CreateProfile(ctx, req, settings.GRPC...)
- return err
- }, opts...)
- if err != nil {
- return nil, err
- }
- return resp, nil
- }
-
- // GetProfile gets the specified profile.
- func (c *ProfileClient) GetProfile(ctx context.Context, req *talentpb.GetProfileRequest, opts ...gax.CallOption) (*talentpb.Profile, error) {
- ctx = insertMetadata(ctx, c.xGoogMetadata)
- opts = append(c.CallOptions.GetProfile[0:len(c.CallOptions.GetProfile):len(c.CallOptions.GetProfile)], opts...)
- var resp *talentpb.Profile
- err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
- var err error
- resp, err = c.profileClient.GetProfile(ctx, req, settings.GRPC...)
- return err
- }, opts...)
- if err != nil {
- return nil, err
- }
- return resp, nil
- }
-
- // UpdateProfile updates the specified profile and returns the updated result.
- func (c *ProfileClient) UpdateProfile(ctx context.Context, req *talentpb.UpdateProfileRequest, opts ...gax.CallOption) (*talentpb.Profile, error) {
- ctx = insertMetadata(ctx, c.xGoogMetadata)
- opts = append(c.CallOptions.UpdateProfile[0:len(c.CallOptions.UpdateProfile):len(c.CallOptions.UpdateProfile)], opts...)
- var resp *talentpb.Profile
- err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
- var err error
- resp, err = c.profileClient.UpdateProfile(ctx, req, settings.GRPC...)
- return err
- }, opts...)
- if err != nil {
- return nil, err
- }
- return resp, nil
- }
-
- // DeleteProfile deletes the specified profile.
- func (c *ProfileClient) DeleteProfile(ctx context.Context, req *talentpb.DeleteProfileRequest, opts ...gax.CallOption) error {
- ctx = insertMetadata(ctx, c.xGoogMetadata)
- opts = append(c.CallOptions.DeleteProfile[0:len(c.CallOptions.DeleteProfile):len(c.CallOptions.DeleteProfile)], opts...)
- err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
- var err error
- _, err = c.profileClient.DeleteProfile(ctx, req, settings.GRPC...)
- return err
- }, opts...)
- return err
- }
-
- // SearchProfiles searches for profiles within a tenant.
- //
- // For example, search by raw queries "software engineer in Mountain View" or
- // search by structured filters (location filter, education filter, etc.).
- //
- // See
- // [SearchProfilesRequest][google.cloud.talent.v4beta1.SearchProfilesRequest]
- // for more information.
- func (c *ProfileClient) SearchProfiles(ctx context.Context, req *talentpb.SearchProfilesRequest, opts ...gax.CallOption) *HistogramQueryResultIterator {
- ctx = insertMetadata(ctx, c.xGoogMetadata)
- opts = append(c.CallOptions.SearchProfiles[0:len(c.CallOptions.SearchProfiles):len(c.CallOptions.SearchProfiles)], opts...)
- it := &HistogramQueryResultIterator{}
- req = proto.Clone(req).(*talentpb.SearchProfilesRequest)
- it.InternalFetch = func(pageSize int, pageToken string) ([]*talentpb.HistogramQueryResult, string, error) {
- var resp *talentpb.SearchProfilesResponse
- req.PageToken = pageToken
- if pageSize > math.MaxInt32 {
- req.PageSize = math.MaxInt32
- } else {
- req.PageSize = int32(pageSize)
- }
- err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error {
- var err error
- resp, err = c.profileClient.SearchProfiles(ctx, req, settings.GRPC...)
- return err
- }, opts...)
- if err != nil {
- return nil, "", err
- }
- return resp.HistogramQueryResults, resp.NextPageToken, nil
- }
- fetch := func(pageSize int, pageToken string) (string, error) {
- items, nextPageToken, err := it.InternalFetch(pageSize, pageToken)
- if err != nil {
- return "", err
- }
- it.items = append(it.items, items...)
- return nextPageToken, nil
- }
- it.pageInfo, it.nextFunc = iterator.NewPageInfo(fetch, it.bufLen, it.takeBuf)
- it.pageInfo.MaxSize = int(req.PageSize)
- return it
- }
-
- // HistogramQueryResultIterator manages a stream of *talentpb.HistogramQueryResult.
- type HistogramQueryResultIterator struct {
- items []*talentpb.HistogramQueryResult
- pageInfo *iterator.PageInfo
- nextFunc func() error
-
- // 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 []*talentpb.HistogramQueryResult, nextPageToken string, err error)
- }
-
- // PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
- func (it *HistogramQueryResultIterator) PageInfo() *iterator.PageInfo {
- return it.pageInfo
- }
-
- // 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 (it *HistogramQueryResultIterator) Next() (*talentpb.HistogramQueryResult, error) {
- var item *talentpb.HistogramQueryResult
- if err := it.nextFunc(); err != nil {
- return item, err
- }
- item = it.items[0]
- it.items = it.items[1:]
- return item, nil
- }
-
- func (it *HistogramQueryResultIterator) bufLen() int {
- return len(it.items)
- }
-
- func (it *HistogramQueryResultIterator) takeBuf() interface{} {
- b := it.items
- it.items = nil
- return b
- }
-
- // ProfileIterator manages a stream of *talentpb.Profile.
- type ProfileIterator struct {
- items []*talentpb.Profile
- pageInfo *iterator.PageInfo
- nextFunc func() error
-
- // 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 []*talentpb.Profile, nextPageToken string, err error)
- }
-
- // PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
- func (it *ProfileIterator) PageInfo() *iterator.PageInfo {
- return it.pageInfo
- }
-
- // 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 (it *ProfileIterator) Next() (*talentpb.Profile, error) {
- var item *talentpb.Profile
- if err := it.nextFunc(); err != nil {
- return item, err
- }
- item = it.items[0]
- it.items = it.items[1:]
- return item, nil
- }
-
- func (it *ProfileIterator) bufLen() int {
- return len(it.items)
- }
-
- func (it *ProfileIterator) takeBuf() interface{} {
- b := it.items
- it.items = nil
- return b
- }
|