1. Packages
  2. Google Cloud Native
  3. API Docs
  4. metastore
  5. metastore/v1
  6. getFederation

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

google-native.metastore/v1.getFederation

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

Gets the details of a single federation.

Using getFederation

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 getFederation(args: GetFederationArgs, opts?: InvokeOptions): Promise<GetFederationResult>
function getFederationOutput(args: GetFederationOutputArgs, opts?: InvokeOptions): Output<GetFederationResult>
Copy
def get_federation(federation_id: Optional[str] = None,
                   location: Optional[str] = None,
                   project: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetFederationResult
def get_federation_output(federation_id: Optional[pulumi.Input[str]] = None,
                   location: Optional[pulumi.Input[str]] = None,
                   project: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetFederationResult]
Copy
func LookupFederation(ctx *Context, args *LookupFederationArgs, opts ...InvokeOption) (*LookupFederationResult, error)
func LookupFederationOutput(ctx *Context, args *LookupFederationOutputArgs, opts ...InvokeOption) LookupFederationResultOutput
Copy

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

public static class GetFederation 
{
    public static Task<GetFederationResult> InvokeAsync(GetFederationArgs args, InvokeOptions? opts = null)
    public static Output<GetFederationResult> Invoke(GetFederationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFederationResult> getFederation(GetFederationArgs args, InvokeOptions options)
public static Output<GetFederationResult> getFederation(GetFederationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:metastore/v1:getFederation
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

FederationId This property is required. string
Location This property is required. string
Project string
FederationId This property is required. string
Location This property is required. string
Project string
federationId This property is required. String
location This property is required. String
project String
federationId This property is required. string
location This property is required. string
project string
federation_id This property is required. str
location This property is required. str
project str
federationId This property is required. String
location This property is required. String
project String

getFederation Result

The following output properties are available:

BackendMetastores Dictionary<string, string>
A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number.
CreateTime string
The time when the metastore federation was created.
EndpointUri string
The federation endpoint.
Labels Dictionary<string, string>
User-defined labels for the metastore federation.
Name string
Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
State string
The current state of the federation.
StateMessage string
Additional information about the current state of the metastore federation, if available.
Uid string
The globally unique resource identifier of the metastore federation.
UpdateTime string
The time when the metastore federation was last updated.
Version string
Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
BackendMetastores map[string]string
A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number.
CreateTime string
The time when the metastore federation was created.
EndpointUri string
The federation endpoint.
Labels map[string]string
User-defined labels for the metastore federation.
Name string
Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
State string
The current state of the federation.
StateMessage string
Additional information about the current state of the metastore federation, if available.
Uid string
The globally unique resource identifier of the metastore federation.
UpdateTime string
The time when the metastore federation was last updated.
Version string
Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
backendMetastores Map<String,String>
A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number.
createTime String
The time when the metastore federation was created.
endpointUri String
The federation endpoint.
labels Map<String,String>
User-defined labels for the metastore federation.
name String
Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
state String
The current state of the federation.
stateMessage String
Additional information about the current state of the metastore federation, if available.
uid String
The globally unique resource identifier of the metastore federation.
updateTime String
The time when the metastore federation was last updated.
version String
Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
backendMetastores {[key: string]: string}
A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number.
createTime string
The time when the metastore federation was created.
endpointUri string
The federation endpoint.
labels {[key: string]: string}
User-defined labels for the metastore federation.
name string
Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
state string
The current state of the federation.
stateMessage string
Additional information about the current state of the metastore federation, if available.
uid string
The globally unique resource identifier of the metastore federation.
updateTime string
The time when the metastore federation was last updated.
version string
Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
backend_metastores Mapping[str, str]
A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number.
create_time str
The time when the metastore federation was created.
endpoint_uri str
The federation endpoint.
labels Mapping[str, str]
User-defined labels for the metastore federation.
name str
Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
state str
The current state of the federation.
state_message str
Additional information about the current state of the metastore federation, if available.
uid str
The globally unique resource identifier of the metastore federation.
update_time str
The time when the metastore federation was last updated.
version str
Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.
backendMetastores Map<String>
A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number.
createTime String
The time when the metastore federation was created.
endpointUri String
The federation endpoint.
labels Map<String>
User-defined labels for the metastore federation.
name String
Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.
state String
The current state of the federation.
stateMessage String
Additional information about the current state of the metastore federation, if available.
uid String
The globally unique resource identifier of the metastore federation.
updateTime String
The time when the metastore federation was last updated.
version String
Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version.

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