Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigateway
  5. apigateway/v1
  6. getGateway

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.apigateway/v1.getGateway

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Gets details of a single Gateway.

Using getGateway

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGateway(args: GetGatewayArgs, opts?: InvokeOptions): Promise<GetGatewayResult>
function getGatewayOutput(args: GetGatewayOutputArgs, opts?: InvokeOptions): Output<GetGatewayResult>
Copy
def get_gateway(gateway_id: Optional[str] = None,
                location: Optional[str] = None,
                project: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetGatewayResult
def get_gateway_output(gateway_id: Optional[pulumi.Input[str]] = None,
                location: Optional[pulumi.Input[str]] = None,
                project: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetGatewayResult]
Copy
func LookupGateway(ctx *Context, args *LookupGatewayArgs, opts ...InvokeOption) (*LookupGatewayResult, error)
func LookupGatewayOutput(ctx *Context, args *LookupGatewayOutputArgs, opts ...InvokeOption) LookupGatewayResultOutput
Copy

> Note: This function is named LookupGateway in the Go SDK.

public static class GetGateway 
{
    public static Task<GetGatewayResult> InvokeAsync(GetGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayResult> Invoke(GetGatewayInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
public static Output<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:apigateway/v1:getGateway
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GatewayId This property is required. string
Location This property is required. string
Project string
GatewayId This property is required. string
Location This property is required. string
Project string
gatewayId This property is required. String
location This property is required. String
project String
gatewayId This property is required. string
location This property is required. string
project string
gateway_id This property is required. str
location This property is required. str
project str
gatewayId This property is required. String
location This property is required. String
project String

getGateway Result

The following output properties are available:

ApiConfig string
Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
CreateTime string
Created time.
DefaultHostname string
The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.
DisplayName string
Optional. Display name.
Labels Dictionary<string, 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
Name string
Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}
State string
The current state of the Gateway.
UpdateTime string
Updated time.
ApiConfig string
Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
CreateTime string
Created time.
DefaultHostname string
The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.
DisplayName string
Optional. Display name.
Labels map[string]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
Name string
Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}
State string
The current state of the Gateway.
UpdateTime string
Updated time.
apiConfig String
Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
createTime String
Created time.
defaultHostname String
The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.
displayName String
Optional. Display name.
labels Map<String,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
name String
Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}
state String
The current state of the Gateway.
updateTime String
Updated time.
apiConfig string
Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
createTime string
Created time.
defaultHostname string
The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.
displayName string
Optional. Display name.
labels {[key: string]: 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
name string
Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}
state string
The current state of the Gateway.
updateTime string
Updated time.
api_config str
Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
create_time str
Created time.
default_hostname str
The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.
display_name str
Optional. Display name.
labels Mapping[str, str]
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
name str
Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}
state str
The current state of the Gateway.
update_time str
Updated time.
apiConfig String
Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
createTime String
Created time.
defaultHostname String
The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.
displayName String
Optional. Display name.
labels Map<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
name String
Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}
state String
The current state of the Gateway.
updateTime String
Updated time.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native