serviceusagepb

package
v1.9.2 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2024 License: Apache-2.0 Imports: 13 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "DISABLED",
		2: "ENABLED",
	}
	State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"DISABLED":          1,
		"ENABLED":           2,
	}
)

Enum value maps for State.

View Source 
var (
	DisableServiceRequest_CheckIfServiceHasUsage_name = map[int32]string{
		0: "CHECK_IF_SERVICE_HAS_USAGE_UNSPECIFIED",
		1: "SKIP",
		2: "CHECK",
	}
	DisableServiceRequest_CheckIfServiceHasUsage_value = map[string]int32{
		"CHECK_IF_SERVICE_HAS_USAGE_UNSPECIFIED": 0,
		"SKIP":                                   1,
		"CHECK":                                  2,
	}
)

Enum value maps for DisableServiceRequest_CheckIfServiceHasUsage.

View Source 
var File_google_api_serviceusage_v1_resources_proto protoreflect.FileDescriptor
View Source 
var File_google_api_serviceusage_v1_serviceusage_proto protoreflect.FileDescriptor

Functions

func RegisterServiceUsageServer 

func RegisterServiceUsageServer(s *grpc.Server, srv ServiceUsageServer)

Types

type BatchEnableServicesRequest 

type BatchEnableServicesRequest struct {

	// Parent to enable services on.
	//
	// An example name would be:
	// `projects/123` where `123` is the project number.
	//
	// The `BatchEnableServices` method currently only supports projects.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The identifiers of the services to enable on the project.
	//
	// A valid identifier would be:
	// serviceusage.googleapis.com
	//
	// Enabling services requires that each service is public or is shared with
	// the user enabling the service.
	//
	// A single request can enable a maximum of 20 services at a time. If more
	// than 20 services are specified, the request will fail, and no state changes
	// will occur.
	ServiceIds []string `protobuf:"bytes,2,rep,name=service_ids,json=serviceIds,proto3" json:"service_ids,omitempty"`
	// contains filtered or unexported fields
}

Request message for the `BatchEnableServices` method.

func (*BatchEnableServicesRequest) Descriptor deprecated 

func (*BatchEnableServicesRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchEnableServicesRequest.ProtoReflect.Descriptor instead.

func (*BatchEnableServicesRequest) GetParent 

func (x *BatchEnableServicesRequest) GetParent() string

func (*BatchEnableServicesRequest) GetServiceIds 

func (x *BatchEnableServicesRequest) GetServiceIds() []string

func (*BatchEnableServicesRequest) ProtoMessage 

func (*BatchEnableServicesRequest) ProtoMessage()

func (*BatchEnableServicesRequest) ProtoReflect 

func (x *BatchEnableServicesRequest) ProtoReflect() protoreflect.Message

func (*BatchEnableServicesRequest) Reset 

func (x *BatchEnableServicesRequest) Reset()

func (*BatchEnableServicesRequest) String 

func (x *BatchEnableServicesRequest) String() string

type BatchEnableServicesResponse 

type BatchEnableServicesResponse struct {

	// The new state of the services after enabling.
	Services []*Service `protobuf:"bytes,1,rep,name=services,proto3" json:"services,omitempty"`
	// If allow_partial_success is true, and one or more services could not be
	// enabled, this field contains the details about each failure.
	Failures []*BatchEnableServicesResponse_EnableFailure `protobuf:"bytes,2,rep,name=failures,proto3" json:"failures,omitempty"`
	// contains filtered or unexported fields
}

Response message for the `BatchEnableServices` method. This response message is assigned to the `response` field of the returned Operation when that operation is done.

func (*BatchEnableServicesResponse) Descriptor deprecated 

func (*BatchEnableServicesResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchEnableServicesResponse.ProtoReflect.Descriptor instead.

func (*BatchEnableServicesResponse) GetFailures 

func (x *BatchEnableServicesResponse) GetFailures() []*BatchEnableServicesResponse_EnableFailure

func (*BatchEnableServicesResponse) GetServices 

func (x *BatchEnableServicesResponse) GetServices() []*Service

func (*BatchEnableServicesResponse) ProtoMessage 

func (*BatchEnableServicesResponse) ProtoMessage()

func (*BatchEnableServicesResponse) ProtoReflect 

func (x *BatchEnableServicesResponse) ProtoReflect() protoreflect.Message

func (*BatchEnableServicesResponse) Reset 

func (x *BatchEnableServicesResponse) Reset()

func (*BatchEnableServicesResponse) String 

func (x *BatchEnableServicesResponse) String() string

type BatchEnableServicesResponse_EnableFailure 

type BatchEnableServicesResponse_EnableFailure struct {

	// The service id of a service that could not be enabled.
	ServiceId string `protobuf:"bytes,1,opt,name=service_id,json=serviceId,proto3" json:"service_id,omitempty"`
	// An error message describing why the service could not be enabled.
	ErrorMessage string `protobuf:"bytes,2,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

Provides error messages for the failing services.

func (*BatchEnableServicesResponse_EnableFailure) Descriptor deprecated 

func (*BatchEnableServicesResponse_EnableFailure) Descriptor() ([]byte, []int)

Deprecated: Use BatchEnableServicesResponse_EnableFailure.ProtoReflect.Descriptor instead.

func (*BatchEnableServicesResponse_EnableFailure) GetErrorMessage 

func (x *BatchEnableServicesResponse_EnableFailure) GetErrorMessage() string

func (*BatchEnableServicesResponse_EnableFailure) GetServiceId 

func (x *BatchEnableServicesResponse_EnableFailure) GetServiceId() string

func (*BatchEnableServicesResponse_EnableFailure) ProtoMessage 

func (*BatchEnableServicesResponse_EnableFailure) ProtoMessage()

func (*BatchEnableServicesResponse_EnableFailure) ProtoReflect 

func (x *BatchEnableServicesResponse_EnableFailure) ProtoReflect() protoreflect.Message

func (*BatchEnableServicesResponse_EnableFailure) Reset 

func (x *BatchEnableServicesResponse_EnableFailure) Reset()

func (*BatchEnableServicesResponse_EnableFailure) String 

func (x *BatchEnableServicesResponse_EnableFailure) String() string

type BatchGetServicesRequest 

type BatchGetServicesRequest struct {

	// Parent to retrieve services from.
	// If this is set, the parent of all of the services specified in `names` must
	// match this field. An example name would be: `projects/123` where `123` is
	// the project number. The `BatchGetServices` method currently only supports
	// projects.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Names of the services to retrieve.
	//
	// An example name would be:
	// `projects/123/services/serviceusage.googleapis.com` where `123` is the
	// project number.
	// A single request can get a maximum of 30 services at a time.
	Names []string `protobuf:"bytes,2,rep,name=names,proto3" json:"names,omitempty"`
	// contains filtered or unexported fields
}

Request message for the `BatchGetServices` method.

func (*BatchGetServicesRequest) Descriptor deprecated 

func (*BatchGetServicesRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchGetServicesRequest.ProtoReflect.Descriptor instead.

func (*BatchGetServicesRequest) GetNames 

func (x *BatchGetServicesRequest) GetNames() []string

func (*BatchGetServicesRequest) GetParent 

func (x *BatchGetServicesRequest) GetParent() string

func (*BatchGetServicesRequest) ProtoMessage 

func (*BatchGetServicesRequest) ProtoMessage()

func (*BatchGetServicesRequest) ProtoReflect 

func (x *BatchGetServicesRequest) ProtoReflect() protoreflect.Message

func (*BatchGetServicesRequest) Reset 

func (x *BatchGetServicesRequest) Reset()

func (*BatchGetServicesRequest) String 

func (x *BatchGetServicesRequest) String() string

type BatchGetServicesResponse 

type BatchGetServicesResponse struct {

	// The requested Service states.
	Services []*Service `protobuf:"bytes,1,rep,name=services,proto3" json:"services,omitempty"`
	// contains filtered or unexported fields
}

Response message for the `BatchGetServices` method.

func (*BatchGetServicesResponse) Descriptor deprecated 

func (*BatchGetServicesResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchGetServicesResponse.ProtoReflect.Descriptor instead.

func (*BatchGetServicesResponse) GetServices 

func (x *BatchGetServicesResponse) GetServices() []*Service

func (*BatchGetServicesResponse) ProtoMessage 

func (*BatchGetServicesResponse) ProtoMessage()

func (*BatchGetServicesResponse) ProtoReflect 

func (x *BatchGetServicesResponse) ProtoReflect() protoreflect.Message

func (*BatchGetServicesResponse) Reset 

func (x *BatchGetServicesResponse) Reset()

func (*BatchGetServicesResponse) String 

func (x *BatchGetServicesResponse) String() string

type DisableServiceRequest 

type DisableServiceRequest struct {

	// Name of the consumer and service to disable the service on.
	//
	// The enable and disable methods currently only support projects.
	//
	// An example name would be:
	// `projects/123/services/serviceusage.googleapis.com` where `123` is the
	// project number.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Indicates if services that are enabled and which depend on this service
	// should also be disabled. If not set, an error will be generated if any
	// enabled services depend on the service to be disabled. When set, the
	// service, and any enabled services that depend on it, will be disabled
	// together.
	DisableDependentServices bool `` /* 136-byte string literal not displayed */
	// Defines the behavior for checking service usage when disabling a service.
	CheckIfServiceHasUsage DisableServiceRequest_CheckIfServiceHasUsage `` /* 211-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request message for the `DisableService` method.

func (*DisableServiceRequest) Descriptor deprecated 

func (*DisableServiceRequest) Descriptor() ([]byte, []int)

Deprecated: Use DisableServiceRequest.ProtoReflect.Descriptor instead.

func (*DisableServiceRequest) GetCheckIfServiceHasUsage 

func (x *DisableServiceRequest) GetCheckIfServiceHasUsage() DisableServiceRequest_CheckIfServiceHasUsage

func (*DisableServiceRequest) GetDisableDependentServices 

func (x *DisableServiceRequest) GetDisableDependentServices() bool

func (*DisableServiceRequest) GetName 

func (x *DisableServiceRequest) GetName() string

func (*DisableServiceRequest) ProtoMessage 

func (*DisableServiceRequest) ProtoMessage()

func (*DisableServiceRequest) ProtoReflect 

func (x *DisableServiceRequest) ProtoReflect() protoreflect.Message

func (*DisableServiceRequest) Reset 

func (x *DisableServiceRequest) Reset()

func (*DisableServiceRequest) String 

func (x *DisableServiceRequest) String() string

type DisableServiceRequest_CheckIfServiceHasUsage 

type DisableServiceRequest_CheckIfServiceHasUsage int32

Enum to determine if service usage should be checked when disabling a service. 

const (
	// When unset, the default behavior is used, which is SKIP.
	DisableServiceRequest_CHECK_IF_SERVICE_HAS_USAGE_UNSPECIFIED DisableServiceRequest_CheckIfServiceHasUsage = 0
	// If set, skip checking service usage when disabling a service.
	DisableServiceRequest_SKIP DisableServiceRequest_CheckIfServiceHasUsage = 1
	// If set, service usage is checked when disabling the service. If a
	// service, or its dependents, has usage in the last 30 days, the request
	// returns a FAILED_PRECONDITION error.
	DisableServiceRequest_CHECK DisableServiceRequest_CheckIfServiceHasUsage = 2
)

func (DisableServiceRequest_CheckIfServiceHasUsage) Descriptor 

func (DisableServiceRequest_CheckIfServiceHasUsage) Descriptor() protoreflect.EnumDescriptor

func (DisableServiceRequest_CheckIfServiceHasUsage) Enum 

func (x DisableServiceRequest_CheckIfServiceHasUsage) Enum() *DisableServiceRequest_CheckIfServiceHasUsage

func (DisableServiceRequest_CheckIfServiceHasUsage) EnumDescriptor deprecated 

func (DisableServiceRequest_CheckIfServiceHasUsage) EnumDescriptor() ([]byte, []int)

Deprecated: Use DisableServiceRequest_CheckIfServiceHasUsage.Descriptor instead.

func (DisableServiceRequest_CheckIfServiceHasUsage) Number 

func (x DisableServiceRequest_CheckIfServiceHasUsage) Number() protoreflect.EnumNumber

func (DisableServiceRequest_CheckIfServiceHasUsage) String 

func (x DisableServiceRequest_CheckIfServiceHasUsage) String() string

func (DisableServiceRequest_CheckIfServiceHasUsage) Type 

func (DisableServiceRequest_CheckIfServiceHasUsage) Type() protoreflect.EnumType

type DisableServiceResponse 

type DisableServiceResponse struct {

	// The new state of the service after disabling.
	Service *Service `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
	// contains filtered or unexported fields
}

Response message for the `DisableService` method. This response message is assigned to the `response` field of the returned Operation when that operation is done.

func (*DisableServiceResponse) Descriptor deprecated 

func (*DisableServiceResponse) Descriptor() ([]byte, []int)

Deprecated: Use DisableServiceResponse.ProtoReflect.Descriptor instead.

func (*DisableServiceResponse) GetService 

func (x *DisableServiceResponse) GetService() *Service

func (*DisableServiceResponse) ProtoMessage 

func (*DisableServiceResponse) ProtoMessage()

func (*DisableServiceResponse) ProtoReflect 

func (x *DisableServiceResponse) ProtoReflect() protoreflect.Message

func (*DisableServiceResponse) Reset 

func (x *DisableServiceResponse) Reset()

func (*DisableServiceResponse) String 

func (x *DisableServiceResponse) String() string

type EnableServiceRequest 

type EnableServiceRequest struct {

	// Name of the consumer and service to enable the service on.
	//
	// The `EnableService` and `DisableService` methods currently only support
	// projects.
	//
	// Enabling a service requires that the service is public or is shared with
	// the user enabling the service.
	//
	// An example name would be:
	// `projects/123/services/serviceusage.googleapis.com` where `123` is the
	// project number.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for the `EnableService` method.

func (*EnableServiceRequest) Descriptor deprecated 

func (*EnableServiceRequest) Descriptor() ([]byte, []int)

Deprecated: Use EnableServiceRequest.ProtoReflect.Descriptor instead.

func (*EnableServiceRequest) GetName 

func (x *EnableServiceRequest) GetName() string

func (*EnableServiceRequest) ProtoMessage 

func (*EnableServiceRequest) ProtoMessage()

func (*EnableServiceRequest) ProtoReflect 

func (x *EnableServiceRequest) ProtoReflect() protoreflect.Message

func (*EnableServiceRequest) Reset 

func (x *EnableServiceRequest) Reset()

func (*EnableServiceRequest) String 

func (x *EnableServiceRequest) String() string

type EnableServiceResponse 

type EnableServiceResponse struct {

	// The new state of the service after enabling.
	Service *Service `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
	// contains filtered or unexported fields
}

Response message for the `EnableService` method. This response message is assigned to the `response` field of the returned Operation when that operation is done.

func (*EnableServiceResponse) Descriptor deprecated 

func (*EnableServiceResponse) Descriptor() ([]byte, []int)

Deprecated: Use EnableServiceResponse.ProtoReflect.Descriptor instead.

func (*EnableServiceResponse) GetService 

func (x *EnableServiceResponse) GetService() *Service

func (*EnableServiceResponse) ProtoMessage 

func (*EnableServiceResponse) ProtoMessage()

func (*EnableServiceResponse) ProtoReflect 

func (x *EnableServiceResponse) ProtoReflect() protoreflect.Message

func (*EnableServiceResponse) Reset 

func (x *EnableServiceResponse) Reset()

func (*EnableServiceResponse) String 

func (x *EnableServiceResponse) String() string

type GetServiceRequest 

type GetServiceRequest struct {

	// Name of the consumer and service to get the `ConsumerState` for.
	//
	// An example name would be:
	// `projects/123/services/serviceusage.googleapis.com` where `123` is the
	// project number.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for the `GetService` method.

func (*GetServiceRequest) Descriptor deprecated 

func (*GetServiceRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetServiceRequest.ProtoReflect.Descriptor instead.

func (*GetServiceRequest) GetName 

func (x *GetServiceRequest) GetName() string

func (*GetServiceRequest) ProtoMessage 

func (*GetServiceRequest) ProtoMessage()

func (*GetServiceRequest) ProtoReflect 

func (x *GetServiceRequest) ProtoReflect() protoreflect.Message

func (*GetServiceRequest) Reset 

func (x *GetServiceRequest) Reset()

func (*GetServiceRequest) String 

func (x *GetServiceRequest) String() string

type ListServicesRequest 

type ListServicesRequest struct {

	// Parent to search for services on.
	//
	// An example name would be:
	// `projects/123` where `123` is the project number.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Requested size of the next page of data.
	// Requested page size cannot exceed 200.
	// If not set, the default page size is 50.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Token identifying which result to start with, which is returned by a
	// previous list call.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Only list services that conform to the given filter.
	// The allowed filter strings are `state:ENABLED` and `state:DISABLED`.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for the `ListServices` method.

func (*ListServicesRequest) Descriptor deprecated 

func (*ListServicesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListServicesRequest.ProtoReflect.Descriptor instead.

func (*ListServicesRequest) GetFilter 

func (x *ListServicesRequest) GetFilter() string

func (*ListServicesRequest) GetPageSize 

func (x *ListServicesRequest) GetPageSize() int32

func (*ListServicesRequest) GetPageToken 

func (x *ListServicesRequest) GetPageToken() string

func (*ListServicesRequest) GetParent 

func (x *ListServicesRequest) GetParent() string

func (*ListServicesRequest) ProtoMessage 

func (*ListServicesRequest) ProtoMessage()

func (*ListServicesRequest) ProtoReflect 

func (x *ListServicesRequest) ProtoReflect() protoreflect.Message

func (*ListServicesRequest) Reset 

func (x *ListServicesRequest) Reset()

func (*ListServicesRequest) String 

func (x *ListServicesRequest) String() string

type ListServicesResponse 

type ListServicesResponse struct {

	// The available services for the requested project.
	Services []*Service `protobuf:"bytes,1,rep,name=services,proto3" json:"services,omitempty"`
	// Token that can be passed to `ListServices` to resume a paginated
	// query.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for the `ListServices` method.

func (*ListServicesResponse) Descriptor deprecated 

func (*ListServicesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListServicesResponse.ProtoReflect.Descriptor instead.

func (*ListServicesResponse) GetNextPageToken 

func (x *ListServicesResponse) GetNextPageToken() string

func (*ListServicesResponse) GetServices 

func (x *ListServicesResponse) GetServices() []*Service

func (*ListServicesResponse) ProtoMessage 

func (*ListServicesResponse) ProtoMessage()

func (*ListServicesResponse) ProtoReflect 

func (x *ListServicesResponse) ProtoReflect() protoreflect.Message

func (*ListServicesResponse) Reset 

func (x *ListServicesResponse) Reset()

func (*ListServicesResponse) String 

func (x *ListServicesResponse) String() string

type OperationMetadata 

type OperationMetadata struct {

	// The full name of the resources that this operation is directly
	// associated with.
	ResourceNames []string `protobuf:"bytes,2,rep,name=resource_names,json=resourceNames,proto3" json:"resource_names,omitempty"`
	// contains filtered or unexported fields
}

The operation metadata returned for the batchend services operation.

func (*OperationMetadata) Descriptor deprecated 

func (*OperationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.

func (*OperationMetadata) GetResourceNames 

func (x *OperationMetadata) GetResourceNames() []string

func (*OperationMetadata) ProtoMessage 

func (*OperationMetadata) ProtoMessage()

func (*OperationMetadata) ProtoReflect 

func (x *OperationMetadata) ProtoReflect() protoreflect.Message

func (*OperationMetadata) Reset 

func (x *OperationMetadata) Reset()

func (*OperationMetadata) String 

func (x *OperationMetadata) String() string

type Service 

type Service struct {

	// The resource name of the consumer and service.
	//
	// A valid name would be:
	// - projects/123/services/serviceusage.googleapis.com
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The resource name of the consumer.
	//
	// A valid name would be:
	// - projects/123
	Parent string `protobuf:"bytes,5,opt,name=parent,proto3" json:"parent,omitempty"`
	// The service configuration of the available service.
	// Some fields may be filtered out of the configuration in responses to
	// the `ListServices` method. These fields are present only in responses to
	// the `GetService` method.
	Config *ServiceConfig `protobuf:"bytes,2,opt,name=config,proto3" json:"config,omitempty"`
	// Whether or not the service has been enabled for use by the consumer.
	State State `protobuf:"varint,4,opt,name=state,proto3,enum=google.api.serviceusage.v1.State" json:"state,omitempty"`
	// contains filtered or unexported fields
}

A service that is available for use by the consumer.

func (*Service) Descriptor deprecated 

func (*Service) Descriptor() ([]byte, []int)

Deprecated: Use Service.ProtoReflect.Descriptor instead.

func (*Service) GetConfig 

func (x *Service) GetConfig() *ServiceConfig

func (*Service) GetName 

func (x *Service) GetName() string

func (*Service) GetParent 

func (x *Service) GetParent() string

func (*Service) GetState 

func (x *Service) GetState() State

func (*Service) ProtoMessage 

func (*Service) ProtoMessage()

func (*Service) ProtoReflect 

func (x *Service) ProtoReflect() protoreflect.Message

func (*Service) Reset 

func (x *Service) Reset()

func (*Service) String 

func (x *Service) String() string

type ServiceConfig 

type ServiceConfig struct {

	// The DNS address at which this service is available.
	//
	// An example DNS address would be:
	// `calendar.googleapis.com`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The product title for this service.
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// A list of API interfaces exported by this service. Contains only the names,
	// versions, and method names of the interfaces.
	Apis []*apipb.Api `protobuf:"bytes,3,rep,name=apis,proto3" json:"apis,omitempty"`
	// Additional API documentation. Contains only the summary and the
	// documentation URL.
	Documentation *serviceconfig.Documentation `protobuf:"bytes,6,opt,name=documentation,proto3" json:"documentation,omitempty"`
	// Quota configuration.
	Quota *serviceconfig.Quota `protobuf:"bytes,10,opt,name=quota,proto3" json:"quota,omitempty"`
	// Auth configuration. Contains only the OAuth rules.
	Authentication *serviceconfig.Authentication `protobuf:"bytes,11,opt,name=authentication,proto3" json:"authentication,omitempty"`
	// Configuration controlling usage of this service.
	Usage *serviceconfig.Usage `protobuf:"bytes,15,opt,name=usage,proto3" json:"usage,omitempty"`
	// Configuration for network endpoints. Contains only the names and aliases
	// of the endpoints.
	Endpoints []*serviceconfig.Endpoint `protobuf:"bytes,18,rep,name=endpoints,proto3" json:"endpoints,omitempty"`
	// Defines the monitored resources used by this service. This is required
	// by the [Service.monitoring][google.api.Service.monitoring] and
	// [Service.logging][google.api.Service.logging] configurations.
	MonitoredResources []*monitoredres.MonitoredResourceDescriptor `protobuf:"bytes,25,rep,name=monitored_resources,json=monitoredResources,proto3" json:"monitored_resources,omitempty"`
	// Monitoring configuration.
	// This should not include the 'producer_destinations' field.
	Monitoring *serviceconfig.Monitoring `protobuf:"bytes,28,opt,name=monitoring,proto3" json:"monitoring,omitempty"`
	// contains filtered or unexported fields
}

The configuration of the service.

func (*ServiceConfig) Descriptor deprecated 

func (*ServiceConfig) Descriptor() ([]byte, []int)

Deprecated: Use ServiceConfig.ProtoReflect.Descriptor instead.

func (*ServiceConfig) GetApis 

func (x *ServiceConfig) GetApis() []*apipb.Api

func (*ServiceConfig) GetAuthentication 

func (x *ServiceConfig) GetAuthentication() *serviceconfig.Authentication

func (*ServiceConfig) GetDocumentation 

func (x *ServiceConfig) GetDocumentation() *serviceconfig.Documentation

func (*ServiceConfig) GetEndpoints 

func (x *ServiceConfig) GetEndpoints() []*serviceconfig.Endpoint

func (*ServiceConfig) GetMonitoredResources 

func (x *ServiceConfig) GetMonitoredResources() []*monitoredres.MonitoredResourceDescriptor

func (*ServiceConfig) GetMonitoring 

func (x *ServiceConfig) GetMonitoring() *serviceconfig.Monitoring

func (*ServiceConfig) GetName 

func (x *ServiceConfig) GetName() string

func (*ServiceConfig) GetQuota 

func (x *ServiceConfig) GetQuota() *serviceconfig.Quota

func (*ServiceConfig) GetTitle 

func (x *ServiceConfig) GetTitle() string

func (*ServiceConfig) GetUsage 

func (x *ServiceConfig) GetUsage() *serviceconfig.Usage

func (*ServiceConfig) ProtoMessage 

func (*ServiceConfig) ProtoMessage()

func (*ServiceConfig) ProtoReflect 

func (x *ServiceConfig) ProtoReflect() protoreflect.Message

func (*ServiceConfig) Reset 

func (x *ServiceConfig) Reset()

func (*ServiceConfig) String 

func (x *ServiceConfig) String() string

type ServiceUsageClient 

type ServiceUsageClient interface {
	// Enable a service so that it can be used with a project.
	EnableService(ctx context.Context, in *EnableServiceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Disable a service so that it can no longer be used with a project.
	// This prevents unintended usage that may cause unexpected billing
	// charges or security leaks.
	//
	// It is not valid to call the disable method on a service that is not
	// currently enabled. Callers will receive a `FAILED_PRECONDITION` status if
	// the target service is not currently enabled.
	DisableService(ctx context.Context, in *DisableServiceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Returns the service configuration and enabled state for a given service.
	GetService(ctx context.Context, in *GetServiceRequest, opts ...grpc.CallOption) (*Service, error)
	// List all services available to the specified project, and the current
	// state of those services with respect to the project. The list includes
	// all public services, all services for which the calling user has the
	// `servicemanagement.services.bind` permission, and all services that have
	// already been enabled on the project. The list can be filtered to
	// only include services in a specific state, for example to only include
	// services enabled on the project.
	//
	// WARNING: If you need to query enabled services frequently or across
	// an organization, you should use
	// [Cloud Asset Inventory
	// API](https://cloud.google.com/asset-inventory/docs/apis), which provides
	// higher throughput and richer filtering capability.
	ListServices(ctx context.Context, in *ListServicesRequest, opts ...grpc.CallOption) (*ListServicesResponse, error)
	// Enable multiple services on a project. The operation is atomic: if enabling
	// any service fails, then the entire batch fails, and no state changes occur.
	// To enable a single service, use the `EnableService` method instead.
	BatchEnableServices(ctx context.Context, in *BatchEnableServicesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Returns the service configurations and enabled states for a given list of
	// services.
	BatchGetServices(ctx context.Context, in *BatchGetServicesRequest, opts ...grpc.CallOption) (*BatchGetServicesResponse, error)
}

ServiceUsageClient is the client API for ServiceUsage service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewServiceUsageClient 

func NewServiceUsageClient(cc grpc.ClientConnInterface) ServiceUsageClient

type ServiceUsageServer 

type ServiceUsageServer interface {
	// Enable a service so that it can be used with a project.
	EnableService(context.Context, *EnableServiceRequest) (*longrunningpb.Operation, error)
	// Disable a service so that it can no longer be used with a project.
	// This prevents unintended usage that may cause unexpected billing
	// charges or security leaks.
	//
	// It is not valid to call the disable method on a service that is not
	// currently enabled. Callers will receive a `FAILED_PRECONDITION` status if
	// the target service is not currently enabled.
	DisableService(context.Context, *DisableServiceRequest) (*longrunningpb.Operation, error)
	// Returns the service configuration and enabled state for a given service.
	GetService(context.Context, *GetServiceRequest) (*Service, error)
	// List all services available to the specified project, and the current
	// state of those services with respect to the project. The list includes
	// all public services, all services for which the calling user has the
	// `servicemanagement.services.bind` permission, and all services that have
	// already been enabled on the project. The list can be filtered to
	// only include services in a specific state, for example to only include
	// services enabled on the project.
	//
	// WARNING: If you need to query enabled services frequently or across
	// an organization, you should use
	// [Cloud Asset Inventory
	// API](https://cloud.google.com/asset-inventory/docs/apis), which provides
	// higher throughput and richer filtering capability.
	ListServices(context.Context, *ListServicesRequest) (*ListServicesResponse, error)
	// Enable multiple services on a project. The operation is atomic: if enabling
	// any service fails, then the entire batch fails, and no state changes occur.
	// To enable a single service, use the `EnableService` method instead.
	BatchEnableServices(context.Context, *BatchEnableServicesRequest) (*longrunningpb.Operation, error)
	// Returns the service configurations and enabled states for a given list of
	// services.
	BatchGetServices(context.Context, *BatchGetServicesRequest) (*BatchGetServicesResponse, error)
}

ServiceUsageServer is the server API for ServiceUsage service.

type State 

type State int32

Whether or not a service has been enabled for use by a consumer. 

const (
	// The default value, which indicates that the enabled state of the service
	// is unspecified or not meaningful. Currently, all consumers other than
	// projects (such as folders and organizations) are always in this state.
	State_STATE_UNSPECIFIED State = 0
	// The service cannot be used by this consumer. It has either been explicitly
	// disabled, or has never been enabled.
	State_DISABLED State = 1
	// The service has been explicitly enabled for use by this consumer.
	State_ENABLED State = 2
)

func (State) Descriptor 

func (State) Descriptor() protoreflect.EnumDescriptor

func (State) Enum 

func (x State) Enum() *State

func (State) EnumDescriptor deprecated 

func (State) EnumDescriptor() ([]byte, []int)

Deprecated: Use State.Descriptor instead.

func (State) Number 

func (x State) Number() protoreflect.EnumNumber

func (State) String 

func (x State) String() string

func (State) Type 

func (State) Type() protoreflect.EnumType

type UnimplementedServiceUsageServer 

type UnimplementedServiceUsageServer struct {
}

UnimplementedServiceUsageServer can be embedded to have forward compatible implementations.

func (*UnimplementedServiceUsageServer) BatchEnableServices 

func (*UnimplementedServiceUsageServer) BatchEnableServices(context.Context, *BatchEnableServicesRequest) (*longrunningpb.Operation, error)

func (*UnimplementedServiceUsageServer) BatchGetServices 

func (*UnimplementedServiceUsageServer) BatchGetServices(context.Context, *BatchGetServicesRequest) (*BatchGetServicesResponse, error)

func (*UnimplementedServiceUsageServer) DisableService 

func (*UnimplementedServiceUsageServer) DisableService(context.Context, *DisableServiceRequest) (*longrunningpb.Operation, error)

func (*UnimplementedServiceUsageServer) EnableService 

func (*UnimplementedServiceUsageServer) EnableService(context.Context, *EnableServiceRequest) (*longrunningpb.Operation, error)

func (*UnimplementedServiceUsageServer) GetService 

func (*UnimplementedServiceUsageServer) GetService(context.Context, *GetServiceRequest) (*Service, error)

func (*UnimplementedServiceUsageServer) ListServices 

func (*UnimplementedServiceUsageServer) ListServices(context.Context, *ListServicesRequest) (*ListServicesResponse, error)

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.