Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.apigee/v1.getApi
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Gets an API proxy including a list of existing revisions.
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:
- Api
Id string - Organization
Id string
- Api
Id string - Organization
Id string
- api
Id String - organization
Id String
- api
Id string - organization
Id string
- api_
id str - organization_
id str
- api
Id String - organization
Id String
getApi Result
The following output properties are available:
- Api
Proxy stringType The type of the API proxy.
- Labels Dictionary<string, string>
User labels applied to this API Proxy.
- Latest
Revision stringId The id of the most recently created revision for this api proxy.
- Meta
Data Pulumi.Google Native. Apigee. V1. Outputs. Google Cloud Apigee V1Entity Metadata Response Metadata describing the API proxy.
- Name string
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 List<string>
List of revisions defined for the API proxy.
- Api
Proxy stringType The type of the API proxy.
- Labels map[string]string
User labels applied to this API Proxy.
- Latest
Revision stringId The id of the most recently created revision for this api proxy.
- Meta
Data GoogleCloud Apigee V1Entity Metadata Response Metadata describing the API proxy.
- Name string
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 []string
List of revisions defined for the API proxy.
- api
Proxy StringType The type of the API proxy.
- labels Map<String,String>
User labels applied to this API Proxy.
- latest
Revision StringId The id of the most recently created revision for this api proxy.
- meta
Data GoogleCloud Apigee V1Entity Metadata Response Metadata describing the API proxy.
- name String
Name of the API proxy.
- read
Only 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.
- api
Proxy stringType The type of the API proxy.
- labels {[key: string]: string}
User labels applied to this API Proxy.
- latest
Revision stringId The id of the most recently created revision for this api proxy.
- meta
Data GoogleCloud Apigee V1Entity Metadata Response Metadata describing the API proxy.
- name string
Name of the API proxy.
- read
Only 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_ strtype The type of the API proxy.
- labels Mapping[str, str]
User labels applied to this API Proxy.
- latest_
revision_ strid The id of the most recently created revision for this api proxy.
- meta_
data GoogleCloud Apigee V1Entity Metadata Response 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.
- api
Proxy StringType The type of the API proxy.
- labels Map<String>
User labels applied to this API Proxy.
- latest
Revision StringId The id of the most recently created revision for this api proxy.
- meta
Data Property Map Metadata describing the API proxy.
- name String
Name of the API proxy.
- read
Only 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
- Created
At string Time at which the API proxy was created, in milliseconds since epoch.
- Last
Modified stringAt Time at which the API proxy was most recently modified, in milliseconds since epoch.
- Sub
Type string The type of entity described
- Created
At string Time at which the API proxy was created, in milliseconds since epoch.
- Last
Modified stringAt Time at which the API proxy was most recently modified, in milliseconds since epoch.
- Sub
Type string The type of entity described
- created
At String Time at which the API proxy was created, in milliseconds since epoch.
- last
Modified StringAt Time at which the API proxy was most recently modified, in milliseconds since epoch.
- sub
Type String The type of entity described
- created
At string Time at which the API proxy was created, in milliseconds since epoch.
- last
Modified stringAt Time at which the API proxy was most recently modified, in milliseconds since epoch.
- sub
Type string The type of entity described
- created_
at str Time at which the API proxy was created, in milliseconds since epoch.
- last_
modified_ strat Time at which the API proxy was most recently modified, in milliseconds since epoch.
- sub_
type str The type of entity described
- created
At String Time at which the API proxy was created, in milliseconds since epoch.
- last
Modified StringAt Time at which the API proxy was most recently modified, in milliseconds since epoch.
- sub
Type 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.