API Gateway v1 API - Class Api (2.1.0)

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

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

An API that can be served by one or more Gateways.

Inheritance

Object > Api

Implements

IMessage<Api>, IEquatable<Api>, IDeepCloneable<Api>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.ApiGateway.V1

Assembly

Google.Cloud.ApiGateway.V1.dll

Constructors

Api()

public Api()

Api(Api)

public Api(Api other)

Parameter

Name	Description
`other`	`Api`

Properties

ApiName

public ApiName ApiName { get; set; }

ApiName-typed view over the Name resource name property.

Property Value

Type	Description
`ApiName`

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`

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
`MapField<String, String>`

ManagedService

public string ManagedService { get; set; }

Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.

Property Value

Type	Description
`String`

ManagedServiceAsManagedServiceName

public ManagedServiceName ManagedServiceAsManagedServiceName { get; set; }

ManagedServiceName-typed view over the ManagedService resource name property.

Property Value

Type	Description
`ManagedServiceName`

Name

public string Name { get; set; }

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

Property Value

Type	Description
`String`

State

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

Output only. State of the API.

Property Value

Type	Description
`Api.Types.State`

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Updated time.

Property Value

Type	Description
`Timestamp`