Class Service

Service is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: "google.calendar.v3." restriction: PREVIEW backend: rules: - selector: "google.calendar.v3." address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth

Inheritance

object

Service

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.ServiceNetworking.v1beta.Data

Assembly: Google.Apis.ServiceNetworking.v1beta.dll

Syntax

public class Service : IDirectResponseSchema

Properties

Apis

A list of API interfaces exported by this service. Only the name field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.

Declaration

[JsonProperty("apis")]
public virtual IList<Api> Apis { get; set; }

Property Value

Type	Description
IList<Api>

Aspects

Configuration aspects. This is a repeated field to allow multiple aspects to be configured. The kind field in each ConfigAspect specifies the type of aspect. The spec field contains the configuration for that aspect. The schema for the spec field is defined by the backend service owners.

Declaration

[JsonProperty("aspects")]
public virtual IList<Aspect> Aspects { get; set; }

Property Value

Type	Description
IList<Aspect>

Authentication

Auth configuration.

Declaration

[JsonProperty("authentication")]
public virtual Authentication Authentication { get; set; }

Property Value

Type	Description
Authentication

Backend

API backend configuration.

Declaration

[JsonProperty("backend")]
public virtual Backend Backend { get; set; }

Property Value

Type	Description
Backend

Billing

Billing configuration.

Declaration

[JsonProperty("billing")]
public virtual Billing Billing { get; set; }

Property Value

Type	Description
Billing

ConfigVersion

Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to 3.

Declaration

[JsonProperty("configVersion")]
public virtual long? ConfigVersion { get; set; }

Property Value

Type	Description
long?

Context

Context configuration.

Declaration

[JsonProperty("context")]
public virtual Context Context { get; set; }

Property Value

Type	Description
Context

Control

Configuration for the service control plane.

Declaration

[JsonProperty("control")]
public virtual Control Control { get; set; }

Property Value

Type	Description
Control

CustomError

Custom error configuration.

Declaration

[JsonProperty("customError")]
public virtual CustomError CustomError { get; set; }

Property Value

Type	Description
CustomError

Documentation

Additional API documentation.

Declaration

[JsonProperty("documentation")]
public virtual Documentation Documentation { get; set; }

Property Value

Type	Description
Documentation

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Endpoints

Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.

Declaration

[JsonProperty("endpoints")]
public virtual IList<Endpoint> Endpoints { get; set; }

Property Value

Type	Description
IList<Endpoint>

Enums

A list of all enum types included in this API service. Enums referenced directly or indirectly by the apis are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum

Declaration

[JsonProperty("enums")]
public virtual IList<Enum> Enums { get; set; }

Property Value

Type	Description
IList<Enum>

Http

HTTP configuration.

Declaration

[JsonProperty("http")]
public virtual Http Http { get; set; }

Property Value

Type	Description
Http

Id

A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead.

Declaration

[JsonProperty("id")]
public virtual string Id { get; set; }

Property Value

Type	Description
string

Logging

Logging configuration.

Declaration

[JsonProperty("logging")]
public virtual Logging Logging { get; set; }

Property Value

Type	Description
Logging

Logs

Defines the logs used by this service.

Declaration

[JsonProperty("logs")]
public virtual IList<LogDescriptor> Logs { get; set; }

Property Value

Type	Description
IList<LogDescriptor>

Metrics

Defines the metrics used by this service.

Declaration

[JsonProperty("metrics")]
public virtual IList<MetricDescriptor> Metrics { get; set; }

Property Value

Type	Description
IList<MetricDescriptor>

MonitoredResources

Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.

Declaration

[JsonProperty("monitoredResources")]
public virtual IList<MonitoredResourceDescriptor> MonitoredResources { get; set; }

Property Value

Type	Description
IList<MonitoredResourceDescriptor>

Monitoring

Monitoring configuration.

Declaration

[JsonProperty("monitoring")]
public virtual Monitoring Monitoring { get; set; }

Property Value

Type	Description
Monitoring

Name

The service name, which is a DNS-like logical identifier for the service, such as calendar.googleapis.com. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

ProducerProjectId

The Google project that owns this service.

Declaration

[JsonProperty("producerProjectId")]
public virtual string ProducerProjectId { get; set; }

Property Value

Type	Description
string

Publishing

Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.

Declaration

[JsonProperty("publishing")]
public virtual Publishing Publishing { get; set; }

Property Value

Type	Description
Publishing

Quota

Quota configuration.

Declaration

[JsonProperty("quota")]
public virtual Quota Quota { get; set; }

Property Value

Type	Description
Quota

SourceInfo

Output only. The source information for this configuration if available.

Declaration

[JsonProperty("sourceInfo")]
public virtual SourceInfo SourceInfo { get; set; }

Property Value

Type	Description
SourceInfo

SystemParameters

System parameter configuration.

Declaration

[JsonProperty("systemParameters")]
public virtual SystemParameters SystemParameters { get; set; }

Property Value

Type	Description
SystemParameters

SystemTypes

A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.

Declaration

[JsonProperty("systemTypes")]
public virtual IList<Type> SystemTypes { get; set; }

Property Value

Type	Description
IList<Type>

Title

The product title for this service, it is the name displayed in Google Cloud Console.

Declaration

[JsonProperty("title")]
public virtual string Title { get; set; }

Property Value

Type	Description
string

Types

A list of all proto message types included in this API service. Types referenced directly or indirectly by the apis are automatically included. Messages which are not referenced but shall be included, such as types used by the google.protobuf.Any type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32

Declaration

[JsonProperty("types")]
public virtual IList<Type> Types { get; set; }

Property Value

Type	Description
IList<Type>

Usage

Configuration controlling usage of this service.

Declaration

[JsonProperty("usage")]
public virtual Usage Usage { get; set; }

Property Value

Type	Description
Usage

Implements

IDirectResponseSchema