Google Cloud Native v0.31.1, Jul 20 23

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

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.apigee/v1.getApi

Explore with Pulumi AI

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

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

Using getApi

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 getApi(args: GetApiArgs, opts?: InvokeOptions): Promise<GetApiResult>
function getApiOutput(args: GetApiOutputArgs, opts?: InvokeOptions): Output<GetApiResult>

def get_api(api_id: Optional[str] = None,
            organization_id: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetApiResult
def get_api_output(api_id: Optional[pulumi.Input[str]] = None,
            organization_id: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetApiResult]

func LookupApi(ctx *Context, args *LookupApiArgs, opts ...InvokeOption) (*LookupApiResult, error)
func LookupApiOutput(ctx *Context, args *LookupApiOutputArgs, opts ...InvokeOption) LookupApiResultOutput

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

public static class GetApi 
{
    public static Task<GetApiResult> InvokeAsync(GetApiArgs args, InvokeOptions? opts = null)
    public static Output<GetApiResult> Invoke(GetApiInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApiResult> getApi(GetApiArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:apigee/v1:getApi
  arguments:
    # arguments dictionary

The following arguments are supported:

ApiId string
OrganizationId string

ApiId string
OrganizationId string

apiId String
organizationId String

apiId string
organizationId string

api_id str
organization_id str

apiId String
organizationId String

getApi Result

The following output properties are available:

ApiProxyType string: The type of the API proxy.
Labels Dictionary<string, string>: User labels applied to this API Proxy.
LatestRevisionId string: The id of the most recently created revision for this api proxy.
MetaData Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1EntityMetadataResponse: Metadata describing the API proxy.
Name string: Name of the API proxy.
ReadOnly bool: Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
Revision List<string>: List of revisions defined for the API proxy.

ApiProxyType string: The type of the API proxy.
Labels map[string]string: User labels applied to this API Proxy.
LatestRevisionId string: The id of the most recently created revision for this api proxy.
MetaData GoogleCloudApigeeV1EntityMetadataResponse: Metadata describing the API proxy.
Name string: Name of the API proxy.
ReadOnly bool: Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
Revision []string: List of revisions defined for the API proxy.

apiProxyType String: The type of the API proxy.
labels Map<String,String>: User labels applied to this API Proxy.
latestRevisionId String: The id of the most recently created revision for this api proxy.
metaData GoogleCloudApigeeV1EntityMetadataResponse: Metadata describing the API proxy.
name String: Name of the API proxy.
readOnly Boolean: Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
revision List<String>: List of revisions defined for the API proxy.

apiProxyType string: The type of the API proxy.
labels {[key: string]: string}: User labels applied to this API Proxy.
latestRevisionId string: The id of the most recently created revision for this api proxy.
metaData GoogleCloudApigeeV1EntityMetadataResponse: Metadata describing the API proxy.
name string: Name of the API proxy.
readOnly boolean: Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
revision string[]: List of revisions defined for the API proxy.

api_proxy_type str: The type of the API proxy.
labels Mapping[str, str]: User labels applied to this API Proxy.
latest_revision_id str: The id of the most recently created revision for this api proxy.
meta_data GoogleCloudApigeeV1EntityMetadataResponse: Metadata describing the API proxy.
name str: Name of the API proxy.
read_only bool: Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
revision Sequence[str]: List of revisions defined for the API proxy.

apiProxyType String: The type of the API proxy.
labels Map<String>: User labels applied to this API Proxy.
latestRevisionId String: The id of the most recently created revision for this api proxy.
metaData Property Map: Metadata describing the API proxy.
name String: Name of the API proxy.
readOnly Boolean: Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive.
revision List<String>: List of revisions defined for the API proxy.

Supporting Types

GoogleCloudApigeeV1EntityMetadataResponse

CreatedAt string: Time at which the API proxy was created, in milliseconds since epoch.
LastModifiedAt string: Time at which the API proxy was most recently modified, in milliseconds since epoch.
SubType string: The type of entity described

CreatedAt string: Time at which the API proxy was created, in milliseconds since epoch.
LastModifiedAt string: Time at which the API proxy was most recently modified, in milliseconds since epoch.
SubType string: The type of entity described

createdAt String: Time at which the API proxy was created, in milliseconds since epoch.
lastModifiedAt String: Time at which the API proxy was most recently modified, in milliseconds since epoch.
subType String: The type of entity described

createdAt string: Time at which the API proxy was created, in milliseconds since epoch.
lastModifiedAt string: Time at which the API proxy was most recently modified, in milliseconds since epoch.
subType string: The type of entity described

created_at str: Time at which the API proxy was created, in milliseconds since epoch.
last_modified_at str: Time at which the API proxy was most recently modified, in milliseconds since epoch.
sub_type str: The type of entity described

createdAt String: Time at which the API proxy was created, in milliseconds since epoch.
lastModifiedAt String: Time at which the API proxy was most recently modified, in milliseconds since epoch.
subType String: The type of entity described

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.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.apigee/v1.getApi

On this page

On this page

Using getApi

getApi Result

Supporting Types

GoogleCloudApigeeV1EntityMetadataResponse

Package Details

On this page

On this page