package gax

Import Path
	github.com/googleapis/gax-go/v2 (on go.dev)

Dependency Relation
	imports 8 packages, and imported by 13 packages

Involved Source Files

	      call_option.go
	   d➜ gax.go
		Package gax contains a set of modules which aid the development of APIs
		for clients and servers based on gRPC and Google API conventions.

		Application code will rarely need to use this library directly.
		However, code generated automatically from API definition files can use it
		to simplify code generation and to provide more convenient and idiomatic API surfaces.

	      header.go
	      invoke.go
Code Examples

	OnCodes
		package main
		
		import (
			"context"
			"time"
		
			"github.com/googleapis/gax-go/v2"
			"google.golang.org/grpc/codes"
		)
		
		const someRPCTimeout = 5 * time.Minute
		
		// Some result that the client might return.
		type fakeResponse struct{}
		
		// Some client that can perform RPCs.
		type fakeClient struct{}
		
		// PerformSomeRPC is a fake RPC that a client might perform.
		func (c *fakeClient) PerformSomeRPC(ctx context.Context) (*fakeResponse, error) {
			// An actual client would return something meaningful here.
			return nil, nil
		}
		
		func main() {
			ctx := context.Background()
			c := &fakeClient{}
		
			// UNKNOWN and UNAVAILABLE are typically safe to retry for idempotent RPCs.
			retryer := gax.OnCodes([]codes.Code{codes.Unknown, codes.Unavailable}, gax.Backoff{
				Initial:    time.Second,
				Max:        32 * time.Second,
				Multiplier: 2,
			})
		
			performSomeRPCWithRetry := func(ctx context.Context) (*fakeResponse, error) {
				for {
					resp, err := c.PerformSomeRPC(ctx)
					if err != nil {
						if delay, shouldRetry := retryer.Retry(err); shouldRetry {
							if err := gax.Sleep(ctx, delay); err != nil {
								return nil, err
							}
							continue
						}
						return nil, err
					}
					return resp, err
				}
			}
		
			// It's recommended to set deadlines on RPCs and around retrying. This is
			// also usually preferred over setting some fixed number of retries: one
			// advantage this has is that backoff settings can be changed independently
			// of the deadline, whereas with a fixed number of retries the deadline
			// would be a constantly-shifting goalpost.
			ctxWithTimeout, cancel := context.WithDeadline(ctx, time.Now().Add(someRPCTimeout))
			defer cancel()
		
			resp, err := performSomeRPCWithRetry(ctxWithTimeout)
			if err != nil {
				// TODO: handle err
			}
			_ = resp // TODO: use resp if err is nil
		}


Package-Level Type Names (total 9, in which 5 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type APICall (func)
		APICall is a user defined call stub.

		As Inputs Of (at least 2, in which 1 are exported)
			func Invoke(ctx context.Context, call APICall, opts ...CallOption) error
			/* at least one unexported ... *//* at least one unexported: */
			func invoke(ctx context.Context, call APICall, settings CallSettings, sp sleeper) error

	 type Backoff (struct)
		Backoff implements exponential backoff.
		The wait time between retries is a random value between 0 and the "retry envelope".
		The envelope starts at Initial and increases by the factor of Multiplier every retry,
		but is capped at Max.

		Fields (total 4, in which 3 are exported)
			Initial time.Duration
				Initial is the initial value of the retry envelope, defaults to 1 second.

			Max time.Duration
				Max is the maximum value of the retry envelope, defaults to 30 seconds.

			Multiplier float64
				Multiplier is the factor by which the retry envelope increases.
				It should be greater than 1 and defaults to 2.

			/* one unexported ... *//* one unexported: */
			cur time.Duration
				cur is the current retry envelope

		Methods (only one, which is exported)
			(*T) Pause() time.Duration
				Pause returns the next time.Duration that the caller should use to backoff.

		Implements (at least one exported)
			*T : google.golang.org/api/internal/gensupport.Backoff
		As Inputs Of (at least 3, in which 2 are exported)
			func OnCodes(cc []codes.Code, bo Backoff) Retryer
			func cloud.google.com/go/internal.Retry(ctx context.Context, bo Backoff, f func() (stop bool, err error)) error
			/* at least one unexported ... *//* at least one unexported: */
			func cloud.google.com/go/internal.retry(ctx context.Context, bo Backoff, f func() (stop bool, err error), sleep func(context.Context, time.Duration) error) error

	 type CallOption (interface)
		CallOption is an option used by Invoke to control behaviors of RPC calls.
		CallOption works by modifying relevant fields of CallSettings.

		Methods (only one, which is exported)
			( T) Resolve(cs *CallSettings)
				Resolve applies the option by modifying cs.

		Implemented By (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 grpcOpt
			 retryerOption
		As Outputs Of (at least 2, both are exported)
			func WithGRPCOptions(opt ...grpc.CallOption) CallOption
			func WithRetry(fn func() Retryer) CallOption
		As Inputs Of (at least 136, all are exported)
			func Invoke(ctx context.Context, call APICall, opts ...CallOption) error
			func cloud.google.com/go/cloudtasks/apiv2.(*Client).CreateQueue(ctx context.Context, req *taskspb.CreateQueueRequest, opts ...CallOption) (*taskspb.Queue, error)
			func cloud.google.com/go/cloudtasks/apiv2.(*Client).CreateTask(ctx context.Context, req *taskspb.CreateTaskRequest, opts ...CallOption) (*taskspb.Task, error)
			func cloud.google.com/go/cloudtasks/apiv2.(*Client).DeleteQueue(ctx context.Context, req *taskspb.DeleteQueueRequest, opts ...CallOption) error
			func cloud.google.com/go/cloudtasks/apiv2.(*Client).DeleteTask(ctx context.Context, req *taskspb.DeleteTaskRequest, opts ...CallOption) error
			func cloud.google.com/go/cloudtasks/apiv2.(*Client).GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...CallOption) (*iampb.Policy, error)
			func cloud.google.com/go/cloudtasks/apiv2.(*Client).GetQueue(ctx context.Context, req *taskspb.GetQueueRequest, opts ...CallOption) (*taskspb.Queue, error)
			func cloud.google.com/go/cloudtasks/apiv2.(*Client).GetTask(ctx context.Context, req *taskspb.GetTaskRequest, opts ...CallOption) (*taskspb.Task, error)
			func cloud.google.com/go/cloudtasks/apiv2.(*Client).ListQueues(ctx context.Context, req *taskspb.ListQueuesRequest, opts ...CallOption) *cloudtasks.QueueIterator
			func cloud.google.com/go/cloudtasks/apiv2.(*Client).ListTasks(ctx context.Context, req *taskspb.ListTasksRequest, opts ...CallOption) *cloudtasks.TaskIterator
			func cloud.google.com/go/cloudtasks/apiv2.(*Client).PauseQueue(ctx context.Context, req *taskspb.PauseQueueRequest, opts ...CallOption) (*taskspb.Queue, error)
			func cloud.google.com/go/cloudtasks/apiv2.(*Client).PurgeQueue(ctx context.Context, req *taskspb.PurgeQueueRequest, opts ...CallOption) (*taskspb.Queue, error)
			func cloud.google.com/go/cloudtasks/apiv2.(*Client).ResumeQueue(ctx context.Context, req *taskspb.ResumeQueueRequest, opts ...CallOption) (*taskspb.Queue, error)
			func cloud.google.com/go/cloudtasks/apiv2.(*Client).RunTask(ctx context.Context, req *taskspb.RunTaskRequest, opts ...CallOption) (*taskspb.Task, error)
			func cloud.google.com/go/cloudtasks/apiv2.(*Client).SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...CallOption) (*iampb.Policy, error)
			func cloud.google.com/go/cloudtasks/apiv2.(*Client).TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...CallOption) (*iampb.TestIamPermissionsResponse, error)
			func cloud.google.com/go/cloudtasks/apiv2.(*Client).UpdateQueue(ctx context.Context, req *taskspb.UpdateQueueRequest, opts ...CallOption) (*taskspb.Queue, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).CancelOperation(ctx context.Context, req *containerpb.CancelOperationRequest, opts ...CallOption) error
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).CompleteIPRotation(ctx context.Context, req *containerpb.CompleteIPRotationRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).CreateCluster(ctx context.Context, req *containerpb.CreateClusterRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).CreateNodePool(ctx context.Context, req *containerpb.CreateNodePoolRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).DeleteCluster(ctx context.Context, req *containerpb.DeleteClusterRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).DeleteNodePool(ctx context.Context, req *containerpb.DeleteNodePoolRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).GetCluster(ctx context.Context, req *containerpb.GetClusterRequest, opts ...CallOption) (*containerpb.Cluster, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).GetNodePool(ctx context.Context, req *containerpb.GetNodePoolRequest, opts ...CallOption) (*containerpb.NodePool, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).GetOperation(ctx context.Context, req *containerpb.GetOperationRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).GetServerConfig(ctx context.Context, req *containerpb.GetServerConfigRequest, opts ...CallOption) (*containerpb.ServerConfig, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).ListClusters(ctx context.Context, req *containerpb.ListClustersRequest, opts ...CallOption) (*containerpb.ListClustersResponse, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).ListNodePools(ctx context.Context, req *containerpb.ListNodePoolsRequest, opts ...CallOption) (*containerpb.ListNodePoolsResponse, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).ListOperations(ctx context.Context, req *containerpb.ListOperationsRequest, opts ...CallOption) (*containerpb.ListOperationsResponse, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).ListUsableSubnetworks(ctx context.Context, req *containerpb.ListUsableSubnetworksRequest, opts ...CallOption) *container.UsableSubnetworkIterator
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).RollbackNodePoolUpgrade(ctx context.Context, req *containerpb.RollbackNodePoolUpgradeRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).SetAddonsConfig(ctx context.Context, req *containerpb.SetAddonsConfigRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).SetLabels(ctx context.Context, req *containerpb.SetLabelsRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).SetLegacyAbac(ctx context.Context, req *containerpb.SetLegacyAbacRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).SetLocations(ctx context.Context, req *containerpb.SetLocationsRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).SetLoggingService(ctx context.Context, req *containerpb.SetLoggingServiceRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).SetMaintenancePolicy(ctx context.Context, req *containerpb.SetMaintenancePolicyRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).SetMasterAuth(ctx context.Context, req *containerpb.SetMasterAuthRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).SetMonitoringService(ctx context.Context, req *containerpb.SetMonitoringServiceRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).SetNetworkPolicy(ctx context.Context, req *containerpb.SetNetworkPolicyRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).SetNodePoolAutoscaling(ctx context.Context, req *containerpb.SetNodePoolAutoscalingRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).SetNodePoolManagement(ctx context.Context, req *containerpb.SetNodePoolManagementRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).SetNodePoolSize(ctx context.Context, req *containerpb.SetNodePoolSizeRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).StartIPRotation(ctx context.Context, req *containerpb.StartIPRotationRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).UpdateCluster(ctx context.Context, req *containerpb.UpdateClusterRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).UpdateMaster(ctx context.Context, req *containerpb.UpdateMasterRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/container/apiv1.(*ClusterManagerClient).UpdateNodePool(ctx context.Context, req *containerpb.UpdateNodePoolRequest, opts ...CallOption) (*containerpb.Operation, error)
			func cloud.google.com/go/errorreporting/apiv1beta1.(*ErrorGroupClient).GetGroup(ctx context.Context, req *clouderrorreportingpb.GetGroupRequest, opts ...CallOption) (*clouderrorreportingpb.ErrorGroup, error)
			func cloud.google.com/go/errorreporting/apiv1beta1.(*ErrorGroupClient).UpdateGroup(ctx context.Context, req *clouderrorreportingpb.UpdateGroupRequest, opts ...CallOption) (*clouderrorreportingpb.ErrorGroup, error)
			func cloud.google.com/go/errorreporting/apiv1beta1.(*ErrorStatsClient).DeleteEvents(ctx context.Context, req *clouderrorreportingpb.DeleteEventsRequest, opts ...CallOption) (*clouderrorreportingpb.DeleteEventsResponse, error)
			func cloud.google.com/go/errorreporting/apiv1beta1.(*ErrorStatsClient).ListEvents(ctx context.Context, req *clouderrorreportingpb.ListEventsRequest, opts ...CallOption) *errorreporting.ErrorEventIterator
			func cloud.google.com/go/errorreporting/apiv1beta1.(*ErrorStatsClient).ListGroupStats(ctx context.Context, req *clouderrorreportingpb.ListGroupStatsRequest, opts ...CallOption) *errorreporting.ErrorGroupStatsIterator
			func cloud.google.com/go/errorreporting/apiv1beta1.(*ReportErrorsClient).ReportErrorEvent(ctx context.Context, req *clouderrorreportingpb.ReportErrorEventRequest, opts ...CallOption) (*clouderrorreportingpb.ReportErrorEventResponse, error)
			func cloud.google.com/go/logging/apiv2.(*Client).DeleteLog(ctx context.Context, req *loggingpb.DeleteLogRequest, opts ...CallOption) error
			func cloud.google.com/go/logging/apiv2.(*Client).ListLogEntries(ctx context.Context, req *loggingpb.ListLogEntriesRequest, opts ...CallOption) *logging.LogEntryIterator
			func cloud.google.com/go/logging/apiv2.(*Client).ListLogs(ctx context.Context, req *loggingpb.ListLogsRequest, opts ...CallOption) *logging.StringIterator
			func cloud.google.com/go/logging/apiv2.(*Client).ListMonitoredResourceDescriptors(ctx context.Context, req *loggingpb.ListMonitoredResourceDescriptorsRequest, opts ...CallOption) *logging.MonitoredResourceDescriptorIterator
			func cloud.google.com/go/logging/apiv2.(*Client).WriteLogEntries(ctx context.Context, req *loggingpb.WriteLogEntriesRequest, opts ...CallOption) (*loggingpb.WriteLogEntriesResponse, error)
			func cloud.google.com/go/logging/apiv2.(*ConfigClient).CreateExclusion(ctx context.Context, req *loggingpb.CreateExclusionRequest, opts ...CallOption) (*loggingpb.LogExclusion, error)
			func cloud.google.com/go/logging/apiv2.(*ConfigClient).CreateSink(ctx context.Context, req *loggingpb.CreateSinkRequest, opts ...CallOption) (*loggingpb.LogSink, error)
			func cloud.google.com/go/logging/apiv2.(*ConfigClient).DeleteExclusion(ctx context.Context, req *loggingpb.DeleteExclusionRequest, opts ...CallOption) error
			func cloud.google.com/go/logging/apiv2.(*ConfigClient).DeleteSink(ctx context.Context, req *loggingpb.DeleteSinkRequest, opts ...CallOption) error
			func cloud.google.com/go/logging/apiv2.(*ConfigClient).GetExclusion(ctx context.Context, req *loggingpb.GetExclusionRequest, opts ...CallOption) (*loggingpb.LogExclusion, error)
			func cloud.google.com/go/logging/apiv2.(*ConfigClient).GetSink(ctx context.Context, req *loggingpb.GetSinkRequest, opts ...CallOption) (*loggingpb.LogSink, error)
			func cloud.google.com/go/logging/apiv2.(*ConfigClient).ListExclusions(ctx context.Context, req *loggingpb.ListExclusionsRequest, opts ...CallOption) *logging.LogExclusionIterator
			func cloud.google.com/go/logging/apiv2.(*ConfigClient).ListSinks(ctx context.Context, req *loggingpb.ListSinksRequest, opts ...CallOption) *logging.LogSinkIterator
			func cloud.google.com/go/logging/apiv2.(*ConfigClient).UpdateExclusion(ctx context.Context, req *loggingpb.UpdateExclusionRequest, opts ...CallOption) (*loggingpb.LogExclusion, error)
			func cloud.google.com/go/logging/apiv2.(*ConfigClient).UpdateSink(ctx context.Context, req *loggingpb.UpdateSinkRequest, opts ...CallOption) (*loggingpb.LogSink, error)
			func cloud.google.com/go/logging/apiv2.(*MetricsClient).CreateLogMetric(ctx context.Context, req *loggingpb.CreateLogMetricRequest, opts ...CallOption) (*loggingpb.LogMetric, error)
			func cloud.google.com/go/logging/apiv2.(*MetricsClient).DeleteLogMetric(ctx context.Context, req *loggingpb.DeleteLogMetricRequest, opts ...CallOption) error
			func cloud.google.com/go/logging/apiv2.(*MetricsClient).GetLogMetric(ctx context.Context, req *loggingpb.GetLogMetricRequest, opts ...CallOption) (*loggingpb.LogMetric, error)
			func cloud.google.com/go/logging/apiv2.(*MetricsClient).ListLogMetrics(ctx context.Context, req *loggingpb.ListLogMetricsRequest, opts ...CallOption) *logging.LogMetricIterator
			func cloud.google.com/go/logging/apiv2.(*MetricsClient).UpdateLogMetric(ctx context.Context, req *loggingpb.UpdateLogMetricRequest, opts ...CallOption) (*loggingpb.LogMetric, error)
			func cloud.google.com/go/monitoring/apiv3.(*AlertPolicyClient).CreateAlertPolicy(ctx context.Context, req *monitoringpb.CreateAlertPolicyRequest, opts ...CallOption) (*monitoringpb.AlertPolicy, error)
			func cloud.google.com/go/monitoring/apiv3.(*AlertPolicyClient).DeleteAlertPolicy(ctx context.Context, req *monitoringpb.DeleteAlertPolicyRequest, opts ...CallOption) error
			func cloud.google.com/go/monitoring/apiv3.(*AlertPolicyClient).GetAlertPolicy(ctx context.Context, req *monitoringpb.GetAlertPolicyRequest, opts ...CallOption) (*monitoringpb.AlertPolicy, error)
			func cloud.google.com/go/monitoring/apiv3.(*AlertPolicyClient).ListAlertPolicies(ctx context.Context, req *monitoringpb.ListAlertPoliciesRequest, opts ...CallOption) *monitoring.AlertPolicyIterator
			func cloud.google.com/go/monitoring/apiv3.(*AlertPolicyClient).UpdateAlertPolicy(ctx context.Context, req *monitoringpb.UpdateAlertPolicyRequest, opts ...CallOption) (*monitoringpb.AlertPolicy, error)
			func cloud.google.com/go/monitoring/apiv3.(*GroupClient).CreateGroup(ctx context.Context, req *monitoringpb.CreateGroupRequest, opts ...CallOption) (*monitoringpb.Group, error)
			func cloud.google.com/go/monitoring/apiv3.(*GroupClient).DeleteGroup(ctx context.Context, req *monitoringpb.DeleteGroupRequest, opts ...CallOption) error
			func cloud.google.com/go/monitoring/apiv3.(*GroupClient).GetGroup(ctx context.Context, req *monitoringpb.GetGroupRequest, opts ...CallOption) (*monitoringpb.Group, error)
			func cloud.google.com/go/monitoring/apiv3.(*GroupClient).ListGroupMembers(ctx context.Context, req *monitoringpb.ListGroupMembersRequest, opts ...CallOption) *monitoring.MonitoredResourceIterator
			func cloud.google.com/go/monitoring/apiv3.(*GroupClient).ListGroups(ctx context.Context, req *monitoringpb.ListGroupsRequest, opts ...CallOption) *monitoring.GroupIterator
			func cloud.google.com/go/monitoring/apiv3.(*GroupClient).UpdateGroup(ctx context.Context, req *monitoringpb.UpdateGroupRequest, opts ...CallOption) (*monitoringpb.Group, error)
			func cloud.google.com/go/monitoring/apiv3.(*MetricClient).CreateMetricDescriptor(ctx context.Context, req *monitoringpb.CreateMetricDescriptorRequest, opts ...CallOption) (*metricpb.MetricDescriptor, error)
			func cloud.google.com/go/monitoring/apiv3.(*MetricClient).CreateTimeSeries(ctx context.Context, req *monitoringpb.CreateTimeSeriesRequest, opts ...CallOption) error
			func cloud.google.com/go/monitoring/apiv3.(*MetricClient).DeleteMetricDescriptor(ctx context.Context, req *monitoringpb.DeleteMetricDescriptorRequest, opts ...CallOption) error
			func cloud.google.com/go/monitoring/apiv3.(*MetricClient).GetMetricDescriptor(ctx context.Context, req *monitoringpb.GetMetricDescriptorRequest, opts ...CallOption) (*metricpb.MetricDescriptor, error)
			func cloud.google.com/go/monitoring/apiv3.(*MetricClient).GetMonitoredResourceDescriptor(ctx context.Context, req *monitoringpb.GetMonitoredResourceDescriptorRequest, opts ...CallOption) (*monitoredrespb.MonitoredResourceDescriptor, error)
			func cloud.google.com/go/monitoring/apiv3.(*MetricClient).ListMetricDescriptors(ctx context.Context, req *monitoringpb.ListMetricDescriptorsRequest, opts ...CallOption) *monitoring.MetricDescriptorIterator
			func cloud.google.com/go/monitoring/apiv3.(*MetricClient).ListMonitoredResourceDescriptors(ctx context.Context, req *monitoringpb.ListMonitoredResourceDescriptorsRequest, opts ...CallOption) *monitoring.MonitoredResourceDescriptorIterator
			func cloud.google.com/go/monitoring/apiv3.(*MetricClient).ListTimeSeries(ctx context.Context, req *monitoringpb.ListTimeSeriesRequest, opts ...CallOption) *monitoring.TimeSeriesIterator
			func cloud.google.com/go/monitoring/apiv3.(*NotificationChannelClient).CreateNotificationChannel(ctx context.Context, req *monitoringpb.CreateNotificationChannelRequest, opts ...CallOption) (*monitoringpb.NotificationChannel, error)
			func cloud.google.com/go/monitoring/apiv3.(*NotificationChannelClient).DeleteNotificationChannel(ctx context.Context, req *monitoringpb.DeleteNotificationChannelRequest, opts ...CallOption) error
			func cloud.google.com/go/monitoring/apiv3.(*NotificationChannelClient).GetNotificationChannel(ctx context.Context, req *monitoringpb.GetNotificationChannelRequest, opts ...CallOption) (*monitoringpb.NotificationChannel, error)
			func cloud.google.com/go/monitoring/apiv3.(*NotificationChannelClient).GetNotificationChannelDescriptor(ctx context.Context, req *monitoringpb.GetNotificationChannelDescriptorRequest, opts ...CallOption) (*monitoringpb.NotificationChannelDescriptor, error)
			func cloud.google.com/go/monitoring/apiv3.(*NotificationChannelClient).GetNotificationChannelVerificationCode(ctx context.Context, req *monitoringpb.GetNotificationChannelVerificationCodeRequest, opts ...CallOption) (*monitoringpb.GetNotificationChannelVerificationCodeResponse, error)
			func cloud.google.com/go/monitoring/apiv3.(*NotificationChannelClient).ListNotificationChannelDescriptors(ctx context.Context, req *monitoringpb.ListNotificationChannelDescriptorsRequest, opts ...CallOption) *monitoring.NotificationChannelDescriptorIterator
			func cloud.google.com/go/monitoring/apiv3.(*NotificationChannelClient).ListNotificationChannels(ctx context.Context, req *monitoringpb.ListNotificationChannelsRequest, opts ...CallOption) *monitoring.NotificationChannelIterator
			func cloud.google.com/go/monitoring/apiv3.(*NotificationChannelClient).SendNotificationChannelVerificationCode(ctx context.Context, req *monitoringpb.SendNotificationChannelVerificationCodeRequest, opts ...CallOption) error
			func cloud.google.com/go/monitoring/apiv3.(*NotificationChannelClient).UpdateNotificationChannel(ctx context.Context, req *monitoringpb.UpdateNotificationChannelRequest, opts ...CallOption) (*monitoringpb.NotificationChannel, error)
			func cloud.google.com/go/monitoring/apiv3.(*NotificationChannelClient).VerifyNotificationChannel(ctx context.Context, req *monitoringpb.VerifyNotificationChannelRequest, opts ...CallOption) (*monitoringpb.NotificationChannel, error)
			func cloud.google.com/go/monitoring/apiv3.(*ServiceMonitoringClient).CreateService(ctx context.Context, req *monitoringpb.CreateServiceRequest, opts ...CallOption) (*monitoringpb.Service, error)
			func cloud.google.com/go/monitoring/apiv3.(*ServiceMonitoringClient).CreateServiceLevelObjective(ctx context.Context, req *monitoringpb.CreateServiceLevelObjectiveRequest, opts ...CallOption) (*monitoringpb.ServiceLevelObjective, error)
			func cloud.google.com/go/monitoring/apiv3.(*ServiceMonitoringClient).DeleteService(ctx context.Context, req *monitoringpb.DeleteServiceRequest, opts ...CallOption) error
			func cloud.google.com/go/monitoring/apiv3.(*ServiceMonitoringClient).DeleteServiceLevelObjective(ctx context.Context, req *monitoringpb.DeleteServiceLevelObjectiveRequest, opts ...CallOption) error
			func cloud.google.com/go/monitoring/apiv3.(*ServiceMonitoringClient).GetService(ctx context.Context, req *monitoringpb.GetServiceRequest, opts ...CallOption) (*monitoringpb.Service, error)
			func cloud.google.com/go/monitoring/apiv3.(*ServiceMonitoringClient).GetServiceLevelObjective(ctx context.Context, req *monitoringpb.GetServiceLevelObjectiveRequest, opts ...CallOption) (*monitoringpb.ServiceLevelObjective, error)
			func cloud.google.com/go/monitoring/apiv3.(*ServiceMonitoringClient).ListServiceLevelObjectives(ctx context.Context, req *monitoringpb.ListServiceLevelObjectivesRequest, opts ...CallOption) *monitoring.ServiceLevelObjectiveIterator
			func cloud.google.com/go/monitoring/apiv3.(*ServiceMonitoringClient).ListServices(ctx context.Context, req *monitoringpb.ListServicesRequest, opts ...CallOption) *monitoring.ServiceIterator
			func cloud.google.com/go/monitoring/apiv3.(*ServiceMonitoringClient).UpdateService(ctx context.Context, req *monitoringpb.UpdateServiceRequest, opts ...CallOption) (*monitoringpb.Service, error)
			func cloud.google.com/go/monitoring/apiv3.(*ServiceMonitoringClient).UpdateServiceLevelObjective(ctx context.Context, req *monitoringpb.UpdateServiceLevelObjectiveRequest, opts ...CallOption) (*monitoringpb.ServiceLevelObjective, error)
			func cloud.google.com/go/monitoring/apiv3.(*UptimeCheckClient).CreateUptimeCheckConfig(ctx context.Context, req *monitoringpb.CreateUptimeCheckConfigRequest, opts ...CallOption) (*monitoringpb.UptimeCheckConfig, error)
			func cloud.google.com/go/monitoring/apiv3.(*UptimeCheckClient).DeleteUptimeCheckConfig(ctx context.Context, req *monitoringpb.DeleteUptimeCheckConfigRequest, opts ...CallOption) error
			func cloud.google.com/go/monitoring/apiv3.(*UptimeCheckClient).GetUptimeCheckConfig(ctx context.Context, req *monitoringpb.GetUptimeCheckConfigRequest, opts ...CallOption) (*monitoringpb.UptimeCheckConfig, error)
			func cloud.google.com/go/monitoring/apiv3.(*UptimeCheckClient).ListUptimeCheckConfigs(ctx context.Context, req *monitoringpb.ListUptimeCheckConfigsRequest, opts ...CallOption) *monitoring.UptimeCheckConfigIterator
			func cloud.google.com/go/monitoring/apiv3.(*UptimeCheckClient).ListUptimeCheckIps(ctx context.Context, req *monitoringpb.ListUptimeCheckIpsRequest, opts ...CallOption) *monitoring.UptimeCheckIpIterator
			func cloud.google.com/go/monitoring/apiv3.(*UptimeCheckClient).UpdateUptimeCheckConfig(ctx context.Context, req *monitoringpb.UpdateUptimeCheckConfigRequest, opts ...CallOption) (*monitoringpb.UptimeCheckConfig, error)
			func cloud.google.com/go/secretmanager/apiv1.(*Client).AccessSecretVersion(ctx context.Context, req *secretmanagerpb.AccessSecretVersionRequest, opts ...CallOption) (*secretmanagerpb.AccessSecretVersionResponse, error)
			func cloud.google.com/go/secretmanager/apiv1.(*Client).AddSecretVersion(ctx context.Context, req *secretmanagerpb.AddSecretVersionRequest, opts ...CallOption) (*secretmanagerpb.SecretVersion, error)
			func cloud.google.com/go/secretmanager/apiv1.(*Client).CreateSecret(ctx context.Context, req *secretmanagerpb.CreateSecretRequest, opts ...CallOption) (*secretmanagerpb.Secret, error)
			func cloud.google.com/go/secretmanager/apiv1.(*Client).DeleteSecret(ctx context.Context, req *secretmanagerpb.DeleteSecretRequest, opts ...CallOption) error
			func cloud.google.com/go/secretmanager/apiv1.(*Client).DestroySecretVersion(ctx context.Context, req *secretmanagerpb.DestroySecretVersionRequest, opts ...CallOption) (*secretmanagerpb.SecretVersion, error)
			func cloud.google.com/go/secretmanager/apiv1.(*Client).DisableSecretVersion(ctx context.Context, req *secretmanagerpb.DisableSecretVersionRequest, opts ...CallOption) (*secretmanagerpb.SecretVersion, error)
			func cloud.google.com/go/secretmanager/apiv1.(*Client).EnableSecretVersion(ctx context.Context, req *secretmanagerpb.EnableSecretVersionRequest, opts ...CallOption) (*secretmanagerpb.SecretVersion, error)
			func cloud.google.com/go/secretmanager/apiv1.(*Client).GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...CallOption) (*iampb.Policy, error)
			func cloud.google.com/go/secretmanager/apiv1.(*Client).GetSecret(ctx context.Context, req *secretmanagerpb.GetSecretRequest, opts ...CallOption) (*secretmanagerpb.Secret, error)
			func cloud.google.com/go/secretmanager/apiv1.(*Client).GetSecretVersion(ctx context.Context, req *secretmanagerpb.GetSecretVersionRequest, opts ...CallOption) (*secretmanagerpb.SecretVersion, error)
			func cloud.google.com/go/secretmanager/apiv1.(*Client).ListSecrets(ctx context.Context, req *secretmanagerpb.ListSecretsRequest, opts ...CallOption) *secretmanager.SecretIterator
			func cloud.google.com/go/secretmanager/apiv1.(*Client).ListSecretVersions(ctx context.Context, req *secretmanagerpb.ListSecretVersionsRequest, opts ...CallOption) *secretmanager.SecretVersionIterator
			func cloud.google.com/go/secretmanager/apiv1.(*Client).SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...CallOption) (*iampb.Policy, error)
			func cloud.google.com/go/secretmanager/apiv1.(*Client).TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...CallOption) (*iampb.TestIamPermissionsResponse, error)
			func cloud.google.com/go/secretmanager/apiv1.(*Client).UpdateSecret(ctx context.Context, req *secretmanagerpb.UpdateSecretRequest, opts ...CallOption) (*secretmanagerpb.Secret, error)
			func cloud.google.com/go/trace/apiv2.(*Client).BatchWriteSpans(ctx context.Context, req *cloudtracepb.BatchWriteSpansRequest, opts ...CallOption) error
			func cloud.google.com/go/trace/apiv2.(*Client).CreateSpan(ctx context.Context, req *cloudtracepb.Span, opts ...CallOption) (*cloudtracepb.Span, error)
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var cloud.google.com/go/iam.withRetry

	 type CallSettings (struct)
		CallSettings allow fine-grained control over how calls are made.

		Fields (total 2, both are exported)
			GRPC []grpc.CallOption
				CallOptions to be forwarded to GRPC.

			Retry func() Retryer
				Retry returns a Retryer to be used to control retry logic of a method call.
				If Retry is nil or the returned Retryer is nil, the call will not be retried.

		As Inputs Of (at least 2, in which 1 are exported)
			func CallOption.Resolve(cs *CallSettings)
			/* at least one unexported ... *//* at least one unexported: */
			func invoke(ctx context.Context, call APICall, settings CallSettings, sp sleeper) error

	 type Retryer (interface)
		Retryer is used by Invoke to determine retry behavior.

		Methods (only one, which is exported)
			( T) Retry(err error) (pause time.Duration, shouldRetry bool)
				Retry reports whether a request should be retriedand how long to pause before retrying
				if the previous attempt returned with err. Invoke never calls Retry with nil error.

		Implemented By (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*boRetryer
			*cloud.google.com/go/profiler.retryer
		As Outputs Of (at least one exported)
			func OnCodes(cc []codes.Code, bo Backoff) Retryer

	/* 4 unexporteds ... *//* 4 unexporteds: */
	 type boRetryer (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			backoff Backoff
			codes []codes.Code
		Methods (only one, which is exported)
			(*T) Retry(err error) (time.Duration, bool)
		Implements (at least one exported)
			*T : Retryer

	 type grpcOpt ([]T)

		Methods (only one, which is exported)
			( T) Resolve(s *CallSettings)
		Implements (at least one exported)
			 T : CallOption

	 type retryerOption (func)

		Methods (only one, which is exported)
			( T) Resolve(s *CallSettings)
		Implements (at least one exported)
			 T : CallOption

	 type sleeper (func)

		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func invoke(ctx context.Context, call APICall, settings CallSettings, sp sleeper) error


Package-Level Functions (total 7, in which 6 are exported)

	 func Invoke(ctx context.Context, call APICall, opts ...CallOption) error
		Invoke calls the given APICall,
		performing retries as specified by opts, if any.

	 func OnCodes(cc []codes.Code, bo Backoff) Retryer
		OnCodes returns a Retryer that retries if and only if
		the previous attempt returns a GRPC error whose error code is stored in cc.
		Pause times between retries are specified by bo.

		bo is only used for its parameters; each Retryer has its own copy.

	 func Sleep(ctx context.Context, d time.Duration) error
		Sleep is similar to time.Sleep, but it can be interrupted by ctx.Done() closing.
		If interrupted, Sleep returns ctx.Err().

	 func WithGRPCOptions(opt ...grpc.CallOption) CallOption
		WithGRPCOptions allows passing gRPC call options during client creation.

	 func WithRetry(fn func() Retryer) CallOption
		WithRetry sets CallSettings.Retry to fn.

	 func XGoogHeader(keyval ...string) string
		XGoogHeader is for use by the Google Cloud Libraries only.

		XGoogHeader formats key-value pairs.
		The resulting string is suitable for x-goog-api-client header.

	/* one unexported ... *//* one unexported: */
	 func invoke(ctx context.Context, call APICall, settings CallSettings, sp sleeper) error
		invoke implements Invoke, taking an additional sleeper argument for testing.


Package-Level Constants (only one, which is exported)

	const Version = "2.0.4"
		Version specifies the gax-go version being used.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.