Console
    Contact Us Start free

    REST Resource: projects.locations.gateways

    Resource: 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.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "labels" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "displayName" 
 : 
 string 
 , 
 "apiConfig" 
 : 
 string 
 , 
 "state" 
 : 
 enum (  State 
 
) 
 , 
 "defaultHostname" 
 : 
 string 
 }
    Fields
    name

    string

    Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}
    createTime

    string ( Timestamp format)

    Output only. Created time.

    A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z" .
    updateTime

    string ( Timestamp format)

    Output only. Updated time.

    A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z" .
    labels

    map (key: string, value: string)

    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

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
    displayName

    string

    Optional. Display name.
    apiConfig

    string

    Required. Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
    state

    enum ( State )

    Output only. The current state of the Gateway.
    defaultHostname

    string

    Output only. The default API Gateway host name of the form {gatewayId}-{hash}.{region_code}.gateway.dev .

    State

    All the possible Gateway states.

    Enums
    STATE_UNSPECIFIED Gateway does not have a state yet.
    CREATING Gateway is being created.
    ACTIVE Gateway is running and ready for requests.
    FAILED Gateway creation failed.
    DELETING Gateway is being deleted.
    UPDATING Gateway is being updated.

    Methods

    create

    		Creates a new Gateway in a given project and location.

    delete

    		Deletes a single Gateway.

    get

    		Gets details of a single Gateway.

    getIamPolicy

    		Gets the access control policy for a resource.

    list

    		Lists Gateways in a given project and location.

    patch

    		Updates the parameters of a single Gateway.

    setIamPolicy

    		Sets the access control policy on the specified resource.

    testIamPermissions

    		Returns permissions that a caller has on the specified resource.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: