Skip to content
This repository has been archived by the owner on Nov 14, 2024. It is now read-only.

Commit

Permalink
Use out_name instead of name for nested properties in markdown doc.
Browse files Browse the repository at this point in the history 
Signed-off-by: Modular Magician <magic-modules@google.com>
  • Loading branch information
@slevenick @modular-magician
slevenick authored and modular-magician committed Mar 22, 2019
1 parent cc64fa6 commit c9d5493
Show file tree
Hide file tree
Showing 15 changed files with 97 additions and 97 deletions.
10 changes: 5 additions & 5 deletions docs/resources/google_bigquery_dataset.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,23 +39,23 @@ Properties that can be accessed from the `google_bigquery_dataset` resource:

* `domain`: A domain to grant access to. Any users signed in with the domain specified will be granted the specified access

* `groupByEmail`: An email address of a Google Group to grant access to
* `group_by_email`: An email address of a Google Group to grant access to

* `role`: Describes the rights granted to the user specified by the other member of the access object

* `specialGroup`: A special group to grant access to.
* `special_group`: A special group to grant access to.

* `userByEmail`: An email address of a user to grant access to. For example: fred@example.com
* `user_by_email`: An email address of a user to grant access to. For example: fred@example.com

* `view`: A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.

* `creation_time`: The time when this dataset was created, in milliseconds since the epoch.

* `dataset_reference`: A reference that identifies the dataset.

* `datasetId`: A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
* `dataset_id`: A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

* `projectId`: The ID of the project containing this dataset.
* `project_id`: The ID of the project containing this dataset.

* `default_table_expiration_ms`: The default lifetime of all tables in the dataset, in milliseconds

Expand Down
34 changes: 17 additions & 17 deletions docs/resources/google_bigquery_table.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ Properties that can be accessed from the `google_bigquery_table` resource:

* `table_reference`: Reference describing the ID of this table

* `datasetId`: The ID of the dataset containing this table
* `dataset_id`: The ID of the dataset containing this table

* `projectId`: The ID of the project containing this table
* `project_id`: The ID of the project containing this table

* `tableId`: The ID of the the table
* `table_id`: The ID of the the table

* `creation_time`: The time when this dataset was created, in milliseconds since the epoch.

Expand Down Expand Up @@ -58,31 +58,31 @@ Properties that can be accessed from the `google_bigquery_table` resource:

* `view`: The view definition.

* `useLegacySql`: Specifies whether to use BigQuery's legacy SQL for this view
* `use_legacy_sql`: Specifies whether to use BigQuery's legacy SQL for this view

* `userDefinedFunctionResources`: Describes user-defined function resources used in the query.
* `user_defined_function_resources`: Describes user-defined function resources used in the query.

* `time_partitioning`: If specified, configures time-based partitioning for this table.

* `expirationMs`: Number of milliseconds for which to keep the storage for a partition.
* `expiration_ms`: Number of milliseconds for which to keep the storage for a partition.

* `type`: The only type supported is DAY, which will generate one partition per day.

* `streaming_buffer`: Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.

* `estimatedBytes`: A lower-bound estimate of the number of bytes currently in the streaming buffer.
* `estimated_bytes`: A lower-bound estimate of the number of bytes currently in the streaming buffer.

* `estimatedRows`: A lower-bound estimate of the number of rows currently in the streaming buffer.
* `estimated_rows`: A lower-bound estimate of the number of rows currently in the streaming buffer.

* `oldestEntryTime`: Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.
* `oldest_entry_time`: Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

* `schema`: Describes the schema of this table

* `fields`: Describes the fields in a table.

* `encryption_configuration`: Custom encryption configuration

* `kmsKeyName`: Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
* `kms_key_name`: Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

* `expiration_time`: The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely.

Expand All @@ -92,21 +92,21 @@ Properties that can be accessed from the `google_bigquery_table` resource:

* `compression`: The compression type of the data source

* `ignoreUnknownValues`: Indicates if BigQuery should allow extra values that are not represented in the table schema
* `ignore_unknown_values`: Indicates if BigQuery should allow extra values that are not represented in the table schema

* `maxBadRecords`: The maximum number of bad records that BigQuery can ignore when reading data
* `max_bad_records`: The maximum number of bad records that BigQuery can ignore when reading data

* `sourceFormat`: The data format
* `source_format`: The data format

* `sourceUris`: The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.
* `source_uris`: The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.

* `schema`: The schema for the data. Schema is required for CSV and JSON formats

* `googleSheetsOptions`: Additional options if sourceFormat is set to GOOGLE_SHEETS.
* `google_sheets_options`: Additional options if sourceFormat is set to GOOGLE_SHEETS.

* `csvOptions`: Additional properties to set if sourceFormat is set to CSV.
* `csv_options`: Additional properties to set if sourceFormat is set to CSV.

* `bigtableOptions`: Additional options if sourceFormat is set to BIGTABLE.
* `bigtable_options`: Additional options if sourceFormat is set to BIGTABLE.

* `dataset`: Name of the dataset

Expand Down
10 changes: 5 additions & 5 deletions docs/resources/google_cloudbuild_trigger.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,17 +43,17 @@ Properties that can be accessed from the `google_cloudbuild_trigger` resource:

* `trigger_template`: Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build.

* `projectId`: ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
* `project_id`: ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.

* `repoName`: Name of the Cloud Source Repository. If omitted, the name "default" is assumed.
* `repo_name`: Name of the Cloud Source Repository. If omitted, the name "default" is assumed.

* `dir`: Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's dir is specified and is an absolute path, this value is ignored for that step's execution.

* `branchName`: Name of the branch to build. Exactly one a of branch name, tag, or commit SHA must be provided.
* `branch_name`: Name of the branch to build. Exactly one a of branch name, tag, or commit SHA must be provided.

* `tagName`: Name of the tag to build. Exactly one of a branch name, tag, or commit SHA must be provided.
* `tag_name`: Name of the tag to build. Exactly one of a branch name, tag, or commit SHA must be provided.

* `commitSha`: Explicit commit SHA to build. Exactly one of a branch name, tag, or commit SHA must be provided.
* `commit_sha`: Explicit commit SHA to build. Exactly one of a branch name, tag, or commit SHA must be provided.

* `build`: Contents of the build template. Either a filename or build template must be provided.

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/google_cloudfunctions_cloud_function.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,15 @@ Properties that can be accessed from the `google_cloudfunctions_cloud_function`

* `url`: The URL pointing to the hosted repository where the function is defined

* `deployedUrl`: The URL pointing to the hosted repository where the function were defined at the time of deployment.
* `deployed_url`: The URL pointing to the hosted repository where the function were defined at the time of deployment.

* `https_trigger`: An HTTPS endpoint type of source that can be triggered via URL.

* `url`: The deployed url for the function.

* `event_trigger`: An HTTPS endpoint type of source that can be triggered via URL.

* `eventType`: The type of event to observe. For example: `providers/cloud.storage/eventTypes/object.change` and `providers/cloud.pubsub/eventTypes/topic.publish`.
* `event_type`: The type of event to observe. For example: `providers/cloud.storage/eventTypes/object.change` and `providers/cloud.pubsub/eventTypes/topic.publish`.

* `resource`: The resource(s) from which to observe events, for example, `projects/_/buckets/myBucket.`

Expand Down
12 changes: 6 additions & 6 deletions docs/resources/google_compute_autoscaler.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,17 @@ Properties that can be accessed from the `google_compute_autoscaler` resource:

* `autoscaling_policy`: The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.

* `minNumReplicas`: The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.
* `min_num_replicas`: The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.

* `maxNumReplicas`: The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.
* `max_num_replicas`: The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.

* `coolDownPeriodSec`: The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.
* `cool_down_period_sec`: The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.

* `cpuUtilization`: Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
* `cpu_utilization`: Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.

* `customMetricUtilizations`: Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.
* `custom_metric_utilizations`: Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.

* `loadBalancingUtilization`: Configuration parameters of autoscaling based on a load balancer.
* `load_balancing_utilization`: Configuration parameters of autoscaling based on a load balancer.

* `target`: URL of the managed instance group that this autoscaler will scale.

Expand Down
24 changes: 12 additions & 12 deletions docs/resources/google_compute_backend_service.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,31 +29,31 @@ Properties that can be accessed from the `google_compute_backend_service` resour

* `backends`: The list of backends that serve this BackendService.

* `balancingMode`: Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). This cannot be used for internal load balancing.
* `balancing_mode`: Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL). This cannot be used for internal load balancing.

* `capacityScaler`: A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. This cannot be used for internal load balancing.
* `capacity_scaler`: A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0]. This cannot be used for internal load balancing.

* `description`: An optional description of this resource. Provide this property when you create the resource.

* `group`: This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. When the BackendService has load balancing scheme INTERNAL, the instance group must be in a zone within the same region as the BackendService.

* `maxConnections`: The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing.
* `max_connections`: The max number of simultaneous connections for the group. Can be used with either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing.

* `maxConnectionsPerInstance`: The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing.
* `max_connections_per_instance`: The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set. This cannot be used for internal load balancing.

* `maxRate`: The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing.
* `max_rate`: The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing.

* `maxRatePerInstance`: The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing.
* `max_rate_per_instance`: The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. This cannot be used for internal load balancing.

* `maxUtilization`: Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0]. This cannot be used for internal load balancing.
* `max_utilization`: Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0]. This cannot be used for internal load balancing.

* `cdn_policy`: Cloud CDN configuration for this BackendService.

* `cacheKeyPolicy`: The CacheKeyPolicy for this CdnPolicy.
* `cache_key_policy`: The CacheKeyPolicy for this CdnPolicy.

* `connection_draining`: Settings for connection draining

* `drainingTimeoutSec`: Time for which instance will be drained (not accept new connections, but still work to finish started).
* `draining_timeout_sec`: Time for which instance will be drained (not accept new connections, but still work to finish started).

* `creation_timestamp`: Creation timestamp in RFC3339 text format.

Expand All @@ -69,11 +69,11 @@ Properties that can be accessed from the `google_compute_backend_service` resour

* `enabled`: Enables IAP.

* `oauth2ClientId`: OAuth2 Client ID for IAP
* `oauth2_client_id`: OAuth2 Client ID for IAP

* `oauth2ClientSecret`: OAuth2 Client Secret for IAP
* `oauth2_client_secret`: OAuth2 Client Secret for IAP

* `oauth2ClientSecretSha256`: OAuth2 Client Secret SHA-256 for IAP
* `oauth2_client_secret_sha256`: OAuth2 Client Secret SHA-256 for IAP

* `load_balancing_scheme`: Indicates whether the backend service will be used with internal or external load balancing. A backend service created for one type of load balancing cannot be used with the other.

Expand Down
Loading

0 comments on commit c9d5493

Please sign in to comment.