1. Pulumi Registry
  2. Google Cloud Native
  3. API Docs
  4. connectors
  5. connectors/v2
  6. getEntity
google-native logo
Google Cloud Native v0.28.0, Feb 2 23

google-native.connectors/v2.getEntity

Gets a single entity row matching the entity type and entity id specified in the request.

Using getEntity

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 getEntity(args: GetEntityArgs, opts?: InvokeOptions): Promise<GetEntityResult>
function getEntityOutput(args: GetEntityOutputArgs, opts?: InvokeOptions): Output<GetEntityResult>
def get_entity(connection_id: Optional[str] = None,
               entity_id: Optional[str] = None,
               entity_type_id: Optional[str] = None,
               location: Optional[str] = None,
               project: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetEntityResult
def get_entity_output(connection_id: Optional[pulumi.Input[str]] = None,
               entity_id: Optional[pulumi.Input[str]] = None,
               entity_type_id: Optional[pulumi.Input[str]] = None,
               location: Optional[pulumi.Input[str]] = None,
               project: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetEntityResult]
func LookupEntity(ctx *Context, args *LookupEntityArgs, opts ...InvokeOption) (*LookupEntityResult, error)
func LookupEntityOutput(ctx *Context, args *LookupEntityOutputArgs, opts ...InvokeOption) LookupEntityResultOutput

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

public static class GetEntity 
{
    public static Task<GetEntityResult> InvokeAsync(GetEntityArgs args, InvokeOptions? opts = null)
    public static Output<GetEntityResult> Invoke(GetEntityInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetEntityResult> getEntity(GetEntityArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:connectors/v2:getEntity
  arguments:
    # arguments dictionary

The following arguments are supported:

ConnectionId string
EntityId string
EntityTypeId string
Location string
Project string
ConnectionId string
EntityId string
EntityTypeId string
Location string
Project string
connectionId String
entityId String
entityTypeId String
location String
project String
connectionId string
entityId string
entityTypeId string
location string
project string
connectionId String
entityId String
entityTypeId String
location String
project String

getEntity Result

The following output properties are available:

Fields Dictionary<string, string>

Fields of the entity. The key is name of the field and the value contains the applicable google.protobuf.Value entry for this field.

Name string

Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}

Fields map[string]string

Fields of the entity. The key is name of the field and the value contains the applicable google.protobuf.Value entry for this field.

Name string

Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}

fields Map<String,String>

Fields of the entity. The key is name of the field and the value contains the applicable google.protobuf.Value entry for this field.

name String

Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}

fields {[key: string]: string}

Fields of the entity. The key is name of the field and the value contains the applicable google.protobuf.Value entry for this field.

name string

Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}

fields Mapping[str, str]

Fields of the entity. The key is name of the field and the value contains the applicable google.protobuf.Value entry for this field.

name str

Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}

fields Map<String>

Fields of the entity. The key is name of the field and the value contains the applicable google.protobuf.Value entry for this field.

name String

Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}

Package Details

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