API Gateway v1 API - Class ApiConfig (2.4.0)

public sealed class ApiConfig : IMessage<ApiConfig>, IEquatable<ApiConfig>, IDeepCloneable<ApiConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the API Gateway v1 API class ApiConfig.

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

Inheritance

object > ApiConfig

Implements

IMessage ApiConfig, IEquatable ApiConfig, IDeepCloneable ApiConfig, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.ApiGateway.V1

Assembly

Google.Cloud.ApiGateway.V1.dll

Constructors

ApiConfig()

public ApiConfig()

ApiConfig(ApiConfig)

public ApiConfig(ApiConfig other)

Parameter
Name	Description
`other`	`ApiConfig`

Properties

ApiConfigName

public ApiConfigName ApiConfigName { get; set; }

ApiConfigName-typed view over the Name resource name property.

Property Value
Type	Description
`ApiConfigName`

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Created time.

Property Value
Type	Description
`Timestamp`

DisplayName

public string DisplayName { get; set; }

Optional. Display name.

Property Value
Type	Description
`string`

GatewayServiceAccount

public string GatewayServiceAccount { get; set; }

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.

Property Value
Type	Description
`string`

GatewayServiceAccountAsServiceAccountName

public ServiceAccountName GatewayServiceAccountAsServiceAccountName { get; set; }

ServiceAccountName-typed view over the GatewayServiceAccount resource name property.

Property Value
Type	Description
`ServiceAccountName`

GrpcServices

public RepeatedField<ApiConfig.Types.GrpcServiceDefinition> GrpcServices { get; }

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

Property Value
Type	Description
`RepeatedFieldApiConfigTypesGrpcServiceDefinition`

Labels

public MapField<string, string> Labels { get; }

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

Property Value
Type	Description
`MapFieldstringstring`

ManagedServiceConfigs

public RepeatedField<ApiConfig.Types.File> ManagedServiceConfigs { get; }

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.

Property Value
Type	Description
`RepeatedFieldApiConfigTypesFile`

Name

public string Name { get; set; }

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

Property Value
Type	Description
`string`

OpenapiDocuments

public RepeatedField<ApiConfig.Types.OpenApiDocument> OpenapiDocuments { get; }

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

Property Value
Type	Description
`RepeatedFieldApiConfigTypesOpenApiDocument`

ServiceConfigId

public string ServiceConfigId { get; set; }

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

Property Value
Type	Description
`string`

ServiceConfigIdAsServiceName

public ServiceName ServiceConfigIdAsServiceName { get; set; }

ServiceName-typed view over the ServiceConfigId resource name property.

Property Value
Type	Description
`ServiceName`

State

public ApiConfig.Types.State State { get; set; }

Output only. State of the API Config.

Property Value
Type	Description
`ApiConfigTypesState`

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Updated time.

Property Value
Type	Description
`Timestamp`