snippet_metadata.google.cloud.securitycenter.settings.v1beta1.json

{
  "clientLibrary": {
    "name": "cloud.google.com/go/securitycenter/settings/apiv1beta1",
    "version": "1.27.0",
    "language": "GO",
    "apis": [
      {
        "id": "google.cloud.securitycenter.settings.v1beta1",
        "version": "v1beta1"
      }
    ]
  },
  "snippets": [
    {
      "regionTag": "securitycenter_v1beta1_generated_SecurityCenterSettingsService_BatchCalculateEffectiveSettings_sync",
      "title": "securitycenter BatchCalculateEffectiveSettings Sample",
      "description": "BatchCalculateEffectiveSettings gets a list of effective settings.",
      "file": "SecurityCenterSettingsClient/BatchCalculateEffectiveSettings/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "BatchCalculateEffectiveSettings",
        "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient.BatchCalculateEffectiveSettings",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "settingspb.BatchCalculateEffectiveSettingsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "*settingspb.BatchCalculateEffectiveSettingsResponse",
        "client": {
          "shortName": "SecurityCenterSettingsClient",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient"
        },
        "method": {
          "shortName": "BatchCalculateEffectiveSettings",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService.BatchCalculateEffectiveSettings",
          "service": {
            "shortName": "SecurityCenterSettingsService",
            "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "securitycenter_v1beta1_generated_SecurityCenterSettingsService_BatchGetSettings_sync",
      "title": "securitycenter BatchGetSettings Sample",
      "description": "BatchGetSettings gets a list of settings.",
      "file": "SecurityCenterSettingsClient/BatchGetSettings/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "BatchGetSettings",
        "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient.BatchGetSettings",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "settingspb.BatchGetSettingsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "*settingspb.BatchGetSettingsResponse",
        "client": {
          "shortName": "SecurityCenterSettingsClient",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient"
        },
        "method": {
          "shortName": "BatchGetSettings",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService.BatchGetSettings",
          "service": {
            "shortName": "SecurityCenterSettingsService",
            "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "securitycenter_v1beta1_generated_SecurityCenterSettingsService_CalculateEffectiveComponentSettings_sync",
      "title": "securitycenter CalculateEffectiveComponentSettings Sample",
      "description": "CalculateEffectiveComponentSettings gets the Effective Component Settings.",
      "file": "SecurityCenterSettingsClient/CalculateEffectiveComponentSettings/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "CalculateEffectiveComponentSettings",
        "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient.CalculateEffectiveComponentSettings",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "settingspb.CalculateEffectiveComponentSettingsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "*settingspb.ComponentSettings",
        "client": {
          "shortName": "SecurityCenterSettingsClient",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient"
        },
        "method": {
          "shortName": "CalculateEffectiveComponentSettings",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService.CalculateEffectiveComponentSettings",
          "service": {
            "shortName": "SecurityCenterSettingsService",
            "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "securitycenter_v1beta1_generated_SecurityCenterSettingsService_CalculateEffectiveSettings_sync",
      "title": "securitycenter CalculateEffectiveSettings Sample",
      "description": "CalculateEffectiveSettings calculateEffectiveSettings looks up all of the Security Center\nSettings resources in the GCP resource hierarchy, and calculates the\neffective settings on that resource by applying the following rules: \n* Settings provided closer to the target resource take precedence over\nthose further away (e.g. folder will override organization level\nsettings).\n* Product defaults can be overridden at org, folder, project, and cluster\nlevels.\n* Detectors will be filtered out if they belong to a billing tier the\ncustomer\nhas not configured.",
      "file": "SecurityCenterSettingsClient/CalculateEffectiveSettings/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "CalculateEffectiveSettings",
        "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient.CalculateEffectiveSettings",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "settingspb.CalculateEffectiveSettingsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "*settingspb.Settings",
        "client": {
          "shortName": "SecurityCenterSettingsClient",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient"
        },
        "method": {
          "shortName": "CalculateEffectiveSettings",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService.CalculateEffectiveSettings",
          "service": {
            "shortName": "SecurityCenterSettingsService",
            "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "securitycenter_v1beta1_generated_SecurityCenterSettingsService_GetComponentSettings_sync",
      "title": "securitycenter GetComponentSettings Sample",
      "description": "GetComponentSettings gets the Component Settings.",
      "file": "SecurityCenterSettingsClient/GetComponentSettings/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "GetComponentSettings",
        "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient.GetComponentSettings",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "settingspb.GetComponentSettingsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "*settingspb.ComponentSettings",
        "client": {
          "shortName": "SecurityCenterSettingsClient",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient"
        },
        "method": {
          "shortName": "GetComponentSettings",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService.GetComponentSettings",
          "service": {
            "shortName": "SecurityCenterSettingsService",
            "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "securitycenter_v1beta1_generated_SecurityCenterSettingsService_GetServiceAccount_sync",
      "title": "securitycenter GetServiceAccount Sample",
      "description": "GetServiceAccount retrieves the organizations service account, if it exists, otherwise it\ncreates the organization service account. This API is idempotent and\nwill only create a service account once. On subsequent calls it will\nreturn the previously created service account.  SHA, SCC and CTD Infra\nAutomation will use this SA.  This SA will not have any permissions when\ncreated.  The UI will provision this via IAM or the user will using\ntheir own internal process. This API only creates SAs on the organization.\nFolders are not supported and projects will use per-project SAs associated\nwith APIs enabled on a project. This API will be called by the UX\nonboarding workflow.",
      "file": "SecurityCenterSettingsClient/GetServiceAccount/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "GetServiceAccount",
        "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient.GetServiceAccount",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "settingspb.GetServiceAccountRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "*settingspb.ServiceAccount",
        "client": {
          "shortName": "SecurityCenterSettingsClient",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient"
        },
        "method": {
          "shortName": "GetServiceAccount",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService.GetServiceAccount",
          "service": {
            "shortName": "SecurityCenterSettingsService",
            "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "securitycenter_v1beta1_generated_SecurityCenterSettingsService_GetSettings_sync",
      "title": "securitycenter GetSettings Sample",
      "description": "GetSettings gets the Settings.",
      "file": "SecurityCenterSettingsClient/GetSettings/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "GetSettings",
        "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient.GetSettings",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "settingspb.GetSettingsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "*settingspb.Settings",
        "client": {
          "shortName": "SecurityCenterSettingsClient",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient"
        },
        "method": {
          "shortName": "GetSettings",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService.GetSettings",
          "service": {
            "shortName": "SecurityCenterSettingsService",
            "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "securitycenter_v1beta1_generated_SecurityCenterSettingsService_ListComponents_sync",
      "title": "securitycenter ListComponents Sample",
      "description": "ListComponents retrieves an unordered list of available SCC components.",
      "file": "SecurityCenterSettingsClient/ListComponents/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "ListComponents",
        "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient.ListComponents",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "settingspb.ListComponentsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "StringIterator",
        "client": {
          "shortName": "SecurityCenterSettingsClient",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient"
        },
        "method": {
          "shortName": "ListComponents",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService.ListComponents",
          "service": {
            "shortName": "SecurityCenterSettingsService",
            "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 60,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "securitycenter_v1beta1_generated_SecurityCenterSettingsService_ListDetectors_sync",
      "title": "securitycenter ListDetectors Sample",
      "description": "ListDetectors retrieves an unordered list of available detectors.",
      "file": "SecurityCenterSettingsClient/ListDetectors/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "ListDetectors",
        "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient.ListDetectors",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "settingspb.ListDetectorsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "DetectorIterator",
        "client": {
          "shortName": "SecurityCenterSettingsClient",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient"
        },
        "method": {
          "shortName": "ListDetectors",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService.ListDetectors",
          "service": {
            "shortName": "SecurityCenterSettingsService",
            "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 60,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "securitycenter_v1beta1_generated_SecurityCenterSettingsService_ResetComponentSettings_sync",
      "title": "securitycenter ResetComponentSettings Sample",
      "description": "ResetComponentSettings reset the organization, folder or project's component settings and return\nthe settings to the default. Settings are present at the\norganization, folder and project levels. Using Reset for a folder or\nproject will remove the override that was set and result in the\norganization-level settings being used.",
      "file": "SecurityCenterSettingsClient/ResetComponentSettings/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "ResetComponentSettings",
        "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient.ResetComponentSettings",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "settingspb.ResetComponentSettingsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "client": {
          "shortName": "SecurityCenterSettingsClient",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient"
        },
        "method": {
          "shortName": "ResetComponentSettings",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService.ResetComponentSettings",
          "service": {
            "shortName": "SecurityCenterSettingsService",
            "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 51,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "securitycenter_v1beta1_generated_SecurityCenterSettingsService_ResetSettings_sync",
      "title": "securitycenter ResetSettings Sample",
      "description": "ResetSettings reset the organization, folder or project's settings and return\nthe settings of just that resource to the default.\n\nSettings are present at the organization, folder, project, and cluster\nlevels. Using Reset on a sub-organization level will remove that resource's\noverride and result in the parent's settings being used (eg: if Reset on a\ncluster, project settings will be used).\n\nUsing Reset on organization will remove the override that was set and\nresult in default settings being used.",
      "file": "SecurityCenterSettingsClient/ResetSettings/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "ResetSettings",
        "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient.ResetSettings",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "settingspb.ResetSettingsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "client": {
          "shortName": "SecurityCenterSettingsClient",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient"
        },
        "method": {
          "shortName": "ResetSettings",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService.ResetSettings",
          "service": {
            "shortName": "SecurityCenterSettingsService",
            "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 51,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "securitycenter_v1beta1_generated_SecurityCenterSettingsService_UpdateComponentSettings_sync",
      "title": "securitycenter UpdateComponentSettings Sample",
      "description": "UpdateComponentSettings updates the Component Settings.",
      "file": "SecurityCenterSettingsClient/UpdateComponentSettings/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "UpdateComponentSettings",
        "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient.UpdateComponentSettings",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "settingspb.UpdateComponentSettingsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "*settingspb.ComponentSettings",
        "client": {
          "shortName": "SecurityCenterSettingsClient",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient"
        },
        "method": {
          "shortName": "UpdateComponentSettings",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService.UpdateComponentSettings",
          "service": {
            "shortName": "SecurityCenterSettingsService",
            "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    },
    {
      "regionTag": "securitycenter_v1beta1_generated_SecurityCenterSettingsService_UpdateSettings_sync",
      "title": "securitycenter UpdateSettings Sample",
      "description": "UpdateSettings updates the Settings.",
      "file": "SecurityCenterSettingsClient/UpdateSettings/main.go",
      "language": "GO",
      "clientMethod": {
        "shortName": "UpdateSettings",
        "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient.UpdateSettings",
        "parameters": [
          {
            "type": "context.Context",
            "name": "ctx"
          },
          {
            "type": "settingspb.UpdateSettingsRequest",
            "name": "req"
          },
          {
            "type": "...gax.CallOption",
            "name": "opts"
          }
        ],
        "resultType": "*settingspb.Settings",
        "client": {
          "shortName": "SecurityCenterSettingsClient",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsClient"
        },
        "method": {
          "shortName": "UpdateSettings",
          "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService.UpdateSettings",
          "service": {
            "shortName": "SecurityCenterSettingsService",
            "fullName": "google.cloud.securitycenter.settings.v1beta1.SecurityCenterSettingsService"
          }
        }
      },
      "origin": "API_DEFINITION",
      "segments": [
        {
          "start": 18,
          "end": 53,
          "type": "FULL"
        }
      ]
    }
  ]
}