client

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 12, 2021 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Overview

Package run is an auto-generated package for the Cloud Run Admin API.

Deploy and manage user provided container images that scale automatically based on HTTP traffic.

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.

For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultAuthScopes 

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

Types

type AuthorizedDomainIterator 

type AuthorizedDomainIterator 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 []*runpb.AuthorizedDomain, nextPageToken string, err error)
	// contains filtered or unexported fields
}

AuthorizedDomainIterator manages a stream of *runpb.AuthorizedDomain.

func (*AuthorizedDomainIterator) Next 

func (it *AuthorizedDomainIterator) Next() (*runpb.AuthorizedDomain, 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 (*AuthorizedDomainIterator) PageInfo 

func (it *AuthorizedDomainIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type AuthorizedDomainsCallOptions 

type AuthorizedDomainsCallOptions struct {
	ListAuthorizedDomains []gax.CallOption
}

AuthorizedDomainsCallOptions contains the retry settings for each method of AuthorizedDomainsClient.

type AuthorizedDomainsClient 

type AuthorizedDomainsClient struct {

	// The call options for this service.
	CallOptions *AuthorizedDomainsCallOptions
	// contains filtered or unexported fields
}

AuthorizedDomainsClient is a client for interacting with Cloud Run Admin API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewAuthorizedDomainsClient 

func NewAuthorizedDomainsClient(ctx context.Context, opts ...option.ClientOption) (*AuthorizedDomainsClient, error)

NewAuthorizedDomainsClient creates a new authorized domains client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

func (*AuthorizedDomainsClient) Close 

func (c *AuthorizedDomainsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*AuthorizedDomainsClient) Connection 

func (c *AuthorizedDomainsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*AuthorizedDomainsClient) ListAuthorizedDomains 

func (c *AuthorizedDomainsClient) ListAuthorizedDomains(ctx context.Context, req *runpb.ListAuthorizedDomainsRequest, opts ...gax.CallOption) *AuthorizedDomainIterator

ListAuthorizedDomains list authorized domains.

type ConfigurationsCallOptions 

type ConfigurationsCallOptions struct {
	GetConfiguration   []gax.CallOption
	ListConfigurations []gax.CallOption
}

ConfigurationsCallOptions contains the retry settings for each method of ConfigurationsClient.

type ConfigurationsClient 

type ConfigurationsClient struct {

	// The call options for this service.
	CallOptions *ConfigurationsCallOptions
	// contains filtered or unexported fields
}

ConfigurationsClient is a client for interacting with Cloud Run Admin API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewConfigurationsClient 

func NewConfigurationsClient(ctx context.Context, opts ...option.ClientOption) (*ConfigurationsClient, error)

NewConfigurationsClient creates a new configurations client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

func (*ConfigurationsClient) Close 

func (c *ConfigurationsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*ConfigurationsClient) Connection 

func (c *ConfigurationsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*ConfigurationsClient) GetConfiguration 

func (c *ConfigurationsClient) GetConfiguration(ctx context.Context, req *runpb.GetConfigurationRequest, opts ...gax.CallOption) (*runpb.Configuration, error)

GetConfiguration get information about a configuration.

func (*ConfigurationsClient) ListConfigurations 

func (c *ConfigurationsClient) ListConfigurations(ctx context.Context, req *runpb.ListConfigurationsRequest, opts ...gax.CallOption) (*runpb.ListConfigurationsResponse, error)

ListConfigurations list configurations.

type DomainMappingsCallOptions 

type DomainMappingsCallOptions struct {
	CreateDomainMapping []gax.CallOption
	DeleteDomainMapping []gax.CallOption
	GetDomainMapping    []gax.CallOption
	ListDomainMappings  []gax.CallOption
}

DomainMappingsCallOptions contains the retry settings for each method of DomainMappingsClient.

type DomainMappingsClient 

type DomainMappingsClient struct {

	// The call options for this service.
	CallOptions *DomainMappingsCallOptions
	// contains filtered or unexported fields
}

DomainMappingsClient is a client for interacting with Cloud Run Admin API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewDomainMappingsClient 

func NewDomainMappingsClient(ctx context.Context, opts ...option.ClientOption) (*DomainMappingsClient, error)

NewDomainMappingsClient creates a new domain mappings client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

func (*DomainMappingsClient) Close 

func (c *DomainMappingsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*DomainMappingsClient) Connection 

func (c *DomainMappingsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*DomainMappingsClient) CreateDomainMapping 

func (c *DomainMappingsClient) CreateDomainMapping(ctx context.Context, req *runpb.CreateDomainMappingRequest, opts ...gax.CallOption) (*runpb.DomainMapping, error)

CreateDomainMapping create a new domain mapping.

func (*DomainMappingsClient) DeleteDomainMapping 

func (c *DomainMappingsClient) DeleteDomainMapping(ctx context.Context, req *runpb.DeleteDomainMappingRequest, opts ...gax.CallOption) (*metapb.Status, error)

DeleteDomainMapping delete a domain mapping.

func (*DomainMappingsClient) GetDomainMapping 

func (c *DomainMappingsClient) GetDomainMapping(ctx context.Context, req *runpb.GetDomainMappingRequest, opts ...gax.CallOption) (*runpb.DomainMapping, error)

GetDomainMapping get information about a domain mapping.

func (*DomainMappingsClient) ListDomainMappings 

func (c *DomainMappingsClient) ListDomainMappings(ctx context.Context, req *runpb.ListDomainMappingsRequest, opts ...gax.CallOption) (*runpb.ListDomainMappingsResponse, error)

ListDomainMappings list domain mappings.

type RevisionsCallOptions 

type RevisionsCallOptions struct {
	GetRevision    []gax.CallOption
	ListRevisions  []gax.CallOption
	DeleteRevision []gax.CallOption
}

RevisionsCallOptions contains the retry settings for each method of RevisionsClient.

type RevisionsClient 

type RevisionsClient struct {

	// The call options for this service.
	CallOptions *RevisionsCallOptions
	// contains filtered or unexported fields
}

RevisionsClient is a client for interacting with Cloud Run Admin API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewRevisionsClient 

func NewRevisionsClient(ctx context.Context, opts ...option.ClientOption) (*RevisionsClient, error)

NewRevisionsClient creates a new revisions client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

func (*RevisionsClient) Close 

func (c *RevisionsClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*RevisionsClient) Connection 

func (c *RevisionsClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*RevisionsClient) DeleteRevision 

func (c *RevisionsClient) DeleteRevision(ctx context.Context, req *runpb.DeleteRevisionRequest, opts ...gax.CallOption) (*metapb.Status, error)

DeleteRevision delete a revision.

func (*RevisionsClient) GetRevision 

func (c *RevisionsClient) GetRevision(ctx context.Context, req *runpb.GetRevisionRequest, opts ...gax.CallOption) (*runpb.Revision, error)

GetRevision get information about a revision.

func (*RevisionsClient) ListRevisions 

func (c *RevisionsClient) ListRevisions(ctx context.Context, req *runpb.ListRevisionsRequest, opts ...gax.CallOption) (*runpb.ListRevisionsResponse, error)

ListRevisions list revisions.

type RoutesCallOptions 

type RoutesCallOptions struct {
	GetRoute   []gax.CallOption
	ListRoutes []gax.CallOption
}

RoutesCallOptions contains the retry settings for each method of RoutesClient.

type RoutesClient 

type RoutesClient struct {

	// The call options for this service.
	CallOptions *RoutesCallOptions
	// contains filtered or unexported fields
}

RoutesClient is a client for interacting with Cloud Run Admin API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewRoutesClient 

func NewRoutesClient(ctx context.Context, opts ...option.ClientOption) (*RoutesClient, error)

NewRoutesClient creates a new routes client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

func (*RoutesClient) Close 

func (c *RoutesClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*RoutesClient) Connection 

func (c *RoutesClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*RoutesClient) GetRoute 

func (c *RoutesClient) GetRoute(ctx context.Context, req *runpb.GetRouteRequest, opts ...gax.CallOption) (*runpb.Route, error)

GetRoute get information about a route.

func (*RoutesClient) ListRoutes 

func (c *RoutesClient) ListRoutes(ctx context.Context, req *runpb.ListRoutesRequest, opts ...gax.CallOption) (*runpb.ListRoutesResponse, error)

ListRoutes list routes.

type ServicesCallOptions 

type ServicesCallOptions struct {
	CreateService      []gax.CallOption
	GetService         []gax.CallOption
	ListServices       []gax.CallOption
	ReplaceService     []gax.CallOption
	DeleteService      []gax.CallOption
	TestIamPermissions []gax.CallOption
	GetIamPolicy       []gax.CallOption
	SetIamPolicy       []gax.CallOption
}

ServicesCallOptions contains the retry settings for each method of ServicesClient.

type ServicesClient 

type ServicesClient struct {

	// The call options for this service.
	CallOptions *ServicesCallOptions
	// contains filtered or unexported fields
}

ServicesClient is a client for interacting with Cloud Run Admin API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewServicesClient 

func NewServicesClient(ctx context.Context, opts ...option.ClientOption) (*ServicesClient, error)

NewServicesClient creates a new services client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

func (*ServicesClient) Close 

func (c *ServicesClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*ServicesClient) Connection 

func (c *ServicesClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*ServicesClient) CreateService 

func (c *ServicesClient) CreateService(ctx context.Context, req *runpb.CreateServiceRequest, opts ...gax.CallOption) (*runpb.Service, error)

CreateService create a service.

func (*ServicesClient) DeleteService 

func (c *ServicesClient) DeleteService(ctx context.Context, req *runpb.DeleteServiceRequest, opts ...gax.CallOption) (*metapb.Status, error)

DeleteService delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and Revisions.

func (*ServicesClient) GetIamPolicy 

func (c *ServicesClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)

GetIamPolicy get the IAM Access Control policy currently in effect for the given Cloud Run service. This result does not include any inherited policies.

func (*ServicesClient) GetService 

func (c *ServicesClient) GetService(ctx context.Context, req *runpb.GetServiceRequest, opts ...gax.CallOption) (*runpb.Service, error)

GetService get information about a service.

func (*ServicesClient) ListServices 

func (c *ServicesClient) ListServices(ctx context.Context, req *runpb.ListServicesRequest, opts ...gax.CallOption) (*runpb.ListServicesResponse, error)

ListServices list services.

func (*ServicesClient) ReplaceService 

func (c *ServicesClient) ReplaceService(ctx context.Context, req *runpb.ReplaceServiceRequest, opts ...gax.CallOption) (*runpb.Service, error)

ReplaceService replace a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the ‘status’ match the requested ‘spec’. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control.

func (*ServicesClient) SetIamPolicy 

func (c *ServicesClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)

SetIamPolicy sets the IAM Access control policy for the specified Service. Overwrites any existing policy.

func (*ServicesClient) TestIamPermissions 

func (c *ServicesClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)

TestIamPermissions returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.