public sealed class Gateway : IMessage<Gateway>, IEquatable<Gateway>, IDeepCloneable<Gateway>, IBufferMessage, IMessageReference documentation and code samples for the API Gateway v1 API class Gateway.
A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API-Consumer specific actions based on an API Config such as authentication, policy enforcement, and backend selection.
Namespace
Google.Cloud.ApiGateway.V1Assembly
Google.Cloud.ApiGateway.V1.dll
Constructors
Gateway()
public Gateway()Gateway(Gateway)
public Gateway(Gateway other)| Parameter | |
|---|---|
| Name | Description |
other |
Gateway |
Properties
ApiConfig
public string ApiConfig { get; set; }Required. Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
| Property Value | |
|---|---|
| Type | Description |
string |
|
ApiConfigAsApiConfigName
public ApiConfigName ApiConfigAsApiConfigName { get; set; }ApiConfigName-typed view over the ApiConfig resource name property.
| Property Value | |
|---|---|
| Type | Description |
ApiConfigName |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. Created time.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
DefaultHostname
public string DefaultHostname { get; set; }Output only. The default hostname that serves traffic for this Gateway.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DisplayName
public string DisplayName { get; set; }Optional. Display name.
| Property Value | |
|---|---|
| Type | Description |
string |
|
EffectiveStreamingMode
public Gateway.Types.EffectiveStreamingMode EffectiveStreamingMode { get; set; }Output only. The streaming mode this gateway is actually served with, which
the service resolves at creation from streaming_mode, the referenced API
Config, and the platform default at the time. Read this rather than
streaming_mode to determine whether a gateway supports streaming.
| Property Value | |
|---|---|
| Type | Description |
GatewayTypesEffectiveStreamingMode |
|
GatewayName
public GatewayName GatewayName { get; set; }GatewayName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
GatewayName |
|
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 |
|
Name
public string Name { get; set; }Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}
| Property Value | |
|---|---|
| Type | Description |
string |
|
State
public Gateway.Types.State State { get; set; }Output only. The current state of the Gateway.
| Property Value | |
|---|---|
| Type | Description |
GatewayTypesState |
|
StreamingMode
public Gateway.Types.StreamingMode StreamingMode { get; set; }Optional. Immutable. Requests streaming for a new gateway. An attempt to
change it on update is rejected. If unset, the service selects the mode.
This field records only what was requested and is never modified by the
service; read effective_streaming_mode for the mode the gateway is served
with.
| Property Value | |
|---|---|
| Type | Description |
GatewayTypesStreamingMode |
|
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. Updated time.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|