Show / Hide Table of Contents

Class ApigatewayApiConfig

An API Configuration is a combination of settings for both the Managed Service and Gateways serving this API Config.

Inheritance
object
ApigatewayApiConfig
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.Apigateway.v1beta.Data
Assembly: Google.Apis.Apigateway.v1beta.dll
Syntax
public class ApigatewayApiConfig : IDirectResponseSchema

Properties

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. Created time.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

DisplayName

Optional. Display name.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

GatewayConfig

Immutable. Gateway specific configuration.

Declaration
[JsonProperty("gatewayConfig")]
public virtual ApigatewayGatewayConfig GatewayConfig { get; set; }
Property Value
Type Description
ApigatewayGatewayConfig

GatewayServiceAccount

Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email ({ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com) or its full resource name (projects/{PROJECT}/accounts/{UNIQUE_ID}). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service.

Declaration
[JsonProperty("gatewayServiceAccount")]
public virtual string GatewayServiceAccount { get; set; }
Property Value
Type Description
string

GrpcServices

Optional. gRPC service definition files. If specified, openapi_documents must not be included.

Declaration
[JsonProperty("grpcServices")]
public virtual IList<ApigatewayApiConfigGrpcServiceDefinition> GrpcServices { get; set; }
Property Value
Type Description
IList<ApigatewayApiConfigGrpcServiceDefinition>

Labels

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

ManagedServiceConfigs

Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields.

Declaration
[JsonProperty("managedServiceConfigs")]
public virtual IList<ApigatewayApiConfigFile> ManagedServiceConfigs { get; set; }
Property Value
Type Description
IList<ApigatewayApiConfigFile>

Name

Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config}

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

OpenapiDocuments

Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.

Declaration
[JsonProperty("openapiDocuments")]
public virtual IList<ApigatewayApiConfigOpenApiDocument> OpenapiDocuments { get; set; }
Property Value
Type Description
IList<ApigatewayApiConfigOpenApiDocument>

ServiceConfigId

Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config).

Declaration
[JsonProperty("serviceConfigId")]
public virtual string ServiceConfigId { get; set; }
Property Value
Type Description
string

State

Output only. State of the API Config.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

Output only. Updated time.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX