1. Registry
  2. Packages
  3. Google Cloud Native
  4. API Docs
  5. apigee
  6. apigee/v1
  7. Override

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

Viewing docs for Google Cloud Native v0.32.0
published on Wednesday, Nov 29, 2023 by Pulumi
google-native logo Google Cloud Native

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

Viewing docs for Google Cloud Native v0.32.0
published on Wednesday, Nov 29, 2023 by Pulumi

    Creates a trace configuration override. The response contains a system-generated UUID, that can be used to view, update, or delete the configuration override. Use the List API to view the existing trace configuration overrides.

    Create Override Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Override(name: string, args: OverrideArgs, opts?: CustomResourceOptions);
    @overload
    def Override(resource_name: str,
                 args: OverrideArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Override(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 environment_id: Optional[str] = None,
                 organization_id: Optional[str] = None,
                 api_proxy: Optional[str] = None,
                 name: Optional[str] = None,
                 sampling_config: Optional[GoogleCloudApigeeV1TraceSamplingConfigArgs] = None)
    func NewOverride(ctx *Context, name string, args OverrideArgs, opts ...ResourceOption) (*Override, error)
    public Override(string name, OverrideArgs args, CustomResourceOptions? opts = null)
    public Override(String name, OverrideArgs args)
    public Override(String name, OverrideArgs args, CustomResourceOptions options)
    
    type: google-native:apigee/v1:Override
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "google-native_apigee_v1_override" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args OverrideArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OverrideArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OverrideArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OverrideArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OverrideArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var overrideResource = new GoogleNative.Apigee.V1.Override("overrideResource", new()
    {
        EnvironmentId = "string",
        OrganizationId = "string",
        ApiProxy = "string",
        Name = "string",
        SamplingConfig = new GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1TraceSamplingConfigArgs
        {
            Sampler = GoogleNative.Apigee.V1.GoogleCloudApigeeV1TraceSamplingConfigSampler.SamplerUnspecified,
            SamplingRate = 0.0,
        },
    });
    
    example, err := apigee.NewOverride(ctx, "overrideResource", &apigee.OverrideArgs{
    	EnvironmentId:  pulumi.String("string"),
    	OrganizationId: pulumi.String("string"),
    	ApiProxy:       pulumi.String("string"),
    	Name:           pulumi.String("string"),
    	SamplingConfig: &apigee.GoogleCloudApigeeV1TraceSamplingConfigArgs{
    		Sampler:      apigee.GoogleCloudApigeeV1TraceSamplingConfigSamplerSamplerUnspecified,
    		SamplingRate: pulumi.Float64(0),
    	},
    })
    
    resource "google-native_apigee_v1_override" "overrideResource" {
      lifecycle {
        create_before_destroy = true
      }
      environment_id  = "string"
      organization_id = "string"
      api_proxy       = "string"
      name            = "string"
      sampling_config = {
        sampler       = "SAMPLER_UNSPECIFIED"
        sampling_rate = 0
      }
    }
    
    var overrideResource = new Override("overrideResource", OverrideArgs.builder()
        .environmentId("string")
        .organizationId("string")
        .apiProxy("string")
        .name("string")
        .samplingConfig(GoogleCloudApigeeV1TraceSamplingConfigArgs.builder()
            .sampler(com.pulumi.googlenative.apigee_v1.enums.GoogleCloudApigeeV1TraceSamplingConfigSampler.SamplerUnspecified)
            .samplingRate(0.0)
            .build())
        .build());
    
    override_resource = google_native.apigee.v1.Override("overrideResource",
        environment_id="string",
        organization_id="string",
        api_proxy="string",
        name="string",
        sampling_config={
            "sampler": google_native.apigee.v1.GoogleCloudApigeeV1TraceSamplingConfigSampler.SAMPLER_UNSPECIFIED,
            "sampling_rate": float(0),
        })
    
    const overrideResource = new google_native.apigee.v1.Override("overrideResource", {
        environmentId: "string",
        organizationId: "string",
        apiProxy: "string",
        name: "string",
        samplingConfig: {
            sampler: google_native.apigee.v1.GoogleCloudApigeeV1TraceSamplingConfigSampler.SamplerUnspecified,
            samplingRate: 0,
        },
    });
    
    type: google-native:apigee/v1:Override
    properties:
        apiProxy: string
        environmentId: string
        name: string
        organizationId: string
        samplingConfig:
            sampler: SAMPLER_UNSPECIFIED
            samplingRate: 0
    

    Override Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Override resource accepts the following input properties:

    EnvironmentId string
    OrganizationId string
    ApiProxy string
    ID of the API proxy that will have its trace configuration overridden.
    Name string
    ID of the trace configuration override specified as a system-generated UUID.
    SamplingConfig Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1TraceSamplingConfig
    Trace configuration to override.
    EnvironmentId string
    OrganizationId string
    ApiProxy string
    ID of the API proxy that will have its trace configuration overridden.
    Name string
    ID of the trace configuration override specified as a system-generated UUID.
    SamplingConfig GoogleCloudApigeeV1TraceSamplingConfigArgs
    Trace configuration to override.
    environment_id string
    organization_id string
    api_proxy string
    ID of the API proxy that will have its trace configuration overridden.
    name string
    ID of the trace configuration override specified as a system-generated UUID.
    sampling_config object
    Trace configuration to override.
    environmentId String
    organizationId String
    apiProxy String
    ID of the API proxy that will have its trace configuration overridden.
    name String
    ID of the trace configuration override specified as a system-generated UUID.
    samplingConfig GoogleCloudApigeeV1TraceSamplingConfig
    Trace configuration to override.
    environmentId string
    organizationId string
    apiProxy string
    ID of the API proxy that will have its trace configuration overridden.
    name string
    ID of the trace configuration override specified as a system-generated UUID.
    samplingConfig GoogleCloudApigeeV1TraceSamplingConfig
    Trace configuration to override.
    environment_id str
    organization_id str
    api_proxy str
    ID of the API proxy that will have its trace configuration overridden.
    name str
    ID of the trace configuration override specified as a system-generated UUID.
    sampling_config GoogleCloudApigeeV1TraceSamplingConfigArgs
    Trace configuration to override.
    environmentId String
    organizationId String
    apiProxy String
    ID of the API proxy that will have its trace configuration overridden.
    name String
    ID of the trace configuration override specified as a system-generated UUID.
    samplingConfig Property Map
    Trace configuration to override.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Override resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Override Resource

    Get an existing Override resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): Override
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> Override
    func GetOverride(ctx *Context, name string, id IDInput, state *OverrideState, opts ...ResourceOption) (*Override, error)
    public static Override Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static Override get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingOverride:    type: google-native:apigee/v1:Override    get:      id: ${id}
    import {
      to = google-native_apigee_v1_override.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state OverrideState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    GoogleCloudApigeeV1TraceSamplingConfig, GoogleCloudApigeeV1TraceSamplingConfigArgs

    TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs.
    Sampler Pulumi.GoogleNative.Apigee.V1.GoogleCloudApigeeV1TraceSamplingConfigSampler
    Sampler of distributed tracing. OFF is the default value.
    SamplingRate double
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    Sampler GoogleCloudApigeeV1TraceSamplingConfigSampler
    Sampler of distributed tracing. OFF is the default value.
    SamplingRate float64
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    sampler "SAMPLER_UNSPECIFIED" | "OFF" | "PROBABILITY"
    Sampler of distributed tracing. OFF is the default value.
    sampling_rate number
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    sampler GoogleCloudApigeeV1TraceSamplingConfigSampler
    Sampler of distributed tracing. OFF is the default value.
    samplingRate Double
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    sampler GoogleCloudApigeeV1TraceSamplingConfigSampler
    Sampler of distributed tracing. OFF is the default value.
    samplingRate number
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    sampler GoogleCloudApigeeV1TraceSamplingConfigSampler
    Sampler of distributed tracing. OFF is the default value.
    sampling_rate float
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    sampler "SAMPLER_UNSPECIFIED" | "OFF" | "PROBABILITY"
    Sampler of distributed tracing. OFF is the default value.
    samplingRate Number
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.

    GoogleCloudApigeeV1TraceSamplingConfigResponse, GoogleCloudApigeeV1TraceSamplingConfigResponseArgs

    TraceSamplingConfig represents the detail settings of distributed tracing. Only the fields that are defined in the distributed trace configuration can be overridden using the distribute trace configuration override APIs.
    Sampler string
    Sampler of distributed tracing. OFF is the default value.
    SamplingRate double
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    Sampler string
    Sampler of distributed tracing. OFF is the default value.
    SamplingRate float64
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    sampler string
    Sampler of distributed tracing. OFF is the default value.
    sampling_rate number
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    sampler String
    Sampler of distributed tracing. OFF is the default value.
    samplingRate Double
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    sampler string
    Sampler of distributed tracing. OFF is the default value.
    samplingRate number
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    sampler str
    Sampler of distributed tracing. OFF is the default value.
    sampling_rate float
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.
    sampler String
    Sampler of distributed tracing. OFF is the default value.
    samplingRate Number
    Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5.

    GoogleCloudApigeeV1TraceSamplingConfigSampler, GoogleCloudApigeeV1TraceSamplingConfigSamplerArgs

    Sampler of distributed tracing. OFF is the default value.
    NameValueDescription
    SamplerUnspecifiedSAMPLER_UNSPECIFIEDSampler unspecified.
    OffOFFOFF means distributed trace is disabled, or the sampling probability is 0.
    ProbabilityPROBABILITYPROBABILITY means traces are captured on a probability that defined by sampling_rate. The sampling rate is limited to 0 to 0.5 when this is set.
    NameValueDescription
    GoogleCloudApigeeV1TraceSamplingConfigSamplerSamplerUnspecifiedSAMPLER_UNSPECIFIEDSampler unspecified.
    GoogleCloudApigeeV1TraceSamplingConfigSamplerOffOFFOFF means distributed trace is disabled, or the sampling probability is 0.
    GoogleCloudApigeeV1TraceSamplingConfigSamplerProbabilityPROBABILITYPROBABILITY means traces are captured on a probability that defined by sampling_rate. The sampling rate is limited to 0 to 0.5 when this is set.
    ValueDescription
    SAMPLER_UNSPECIFIEDSampler unspecified.
    OFFOFF means distributed trace is disabled, or the sampling probability is 0.
    PROBABILITYPROBABILITY means traces are captured on a probability that defined by sampling_rate. The sampling rate is limited to 0 to 0.5 when this is set.
    NameValueDescription
    SamplerUnspecifiedSAMPLER_UNSPECIFIEDSampler unspecified.
    OffOFFOFF means distributed trace is disabled, or the sampling probability is 0.
    ProbabilityPROBABILITYPROBABILITY means traces are captured on a probability that defined by sampling_rate. The sampling rate is limited to 0 to 0.5 when this is set.
    NameValueDescription
    SamplerUnspecifiedSAMPLER_UNSPECIFIEDSampler unspecified.
    OffOFFOFF means distributed trace is disabled, or the sampling probability is 0.
    ProbabilityPROBABILITYPROBABILITY means traces are captured on a probability that defined by sampling_rate. The sampling rate is limited to 0 to 0.5 when this is set.
    NameValueDescription
    SAMPLER_UNSPECIFIEDSAMPLER_UNSPECIFIEDSampler unspecified.
    OFFOFFOFF means distributed trace is disabled, or the sampling probability is 0.
    PROBABILITYPROBABILITYPROBABILITY means traces are captured on a probability that defined by sampling_rate. The sampling rate is limited to 0 to 0.5 when this is set.
    ValueDescription
    SAMPLER_UNSPECIFIEDSampler unspecified.
    OFFOFF means distributed trace is disabled, or the sampling probability is 0.
    PROBABILITYPROBABILITY means traces are captured on a probability that defined by sampling_rate. The sampling rate is limited to 0 to 0.5 when this is set.

    Package Details

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

    This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

    Viewing docs for Google Cloud Native v0.32.0
    published on Wednesday, Nov 29, 2023 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial