Google Git
Sign in
android/platform/external/python/google-api-python-client/refs/heads/upstream-main/./docs/dyn/threatintelligence_v1beta.projects.configurations.html
blob: ddbf66d83e26799dbbb329adc84a19bafcde4b49 [file] [log] [blame] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="threatintelligence_v1beta.html">Threat Intelligence API</a> . <a href="threatintelligence_v1beta.projects.html">projects</a> . <a href="threatintelligence_v1beta.projects.configurations.html">configurations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="threatintelligence_v1beta.projects.configurations.revisions.html">revisions()</a></code>
</p>
<p class="firstline">Returns the revisions Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get a configuration by name.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get a list of configurations that meet the filter criteria.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#upsert">upsert(parent, body=None, publishTime=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates or updates a configuration.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Get a configuration by name.
Args:
name: string, Required. Name of the configuration to get. Format: vaults/{vault}/configurations/{configuration} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A configuration represents a behavior an engine should follow when producing new findings.
&quot;audit&quot;: { # Tracks basic CRUD facts. # Output only. Audit information for the configuration.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Time of creation.
&quot;creator&quot;: &quot;A String&quot;, # Output only. Agent that created or updated the record, could be a UserId or a JobId.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time of creation or last update.
&quot;updater&quot;: &quot;A String&quot;, # Output only. Agent that last updated the record, could be a UserId or a JobId.
},
&quot;description&quot;: &quot;A String&quot;, # Optional. A description of the configuration.
&quot;detail&quot;: { # Wrapper class that contains the union struct for all the various configuration detail specific classes. # Required. Domain specific details for the configuration.
&quot;customerProfile&quot;: { # CustomerProfileConfig is the configuration for the customer profile. # Customer Profile detail config.
&quot;citations&quot;: [ # Optional. Citations for the organization profile.
{ # Citation information for the customer profile.
&quot;citationId&quot;: &quot;A String&quot;, # Required. The citation id for the citation. Should be unique within the profile.
&quot;document&quot;: &quot;A String&quot;, # Required. The name of the document the citation is from.
&quot;retrievalTime&quot;: &quot;A String&quot;, # The time the citation was retrieved.
&quot;source&quot;: &quot;A String&quot;, # Required. The source of the citation.
&quot;uri&quot;: &quot;A String&quot;, # Optional. The url of the citation.
},
],
&quot;contactInfo&quot;: [ # Optional. Contact information for the organization.
{ # Contact information for the customer profile.
&quot;address&quot;: &quot;A String&quot;, # The address of the contact.
&quot;citationIds&quot;: [ # Optional. The citation ids for the contact information.
&quot;A String&quot;,
],
&quot;email&quot;: &quot;A String&quot;, # The email address of the contact.
&quot;label&quot;: &quot;A String&quot;, # Optional. The name of the contact.
&quot;other&quot;: &quot;A String&quot;, # The other contact information.
&quot;phone&quot;: &quot;A String&quot;, # The phone number of the contact.
},
],
&quot;executives&quot;: [ # Optional. Executives of the organization.
{ # Person information for the customer profile.
&quot;citationIds&quot;: [ # Optional. The citation ids for the person.
&quot;A String&quot;,
],
&quot;name&quot;: &quot;A String&quot;, # Required. The name of the person.
&quot;title&quot;: &quot;A String&quot;, # Optional. The title of the person.
},
],
&quot;industries&quot;: [ # Optional. The industries the organization is involved in.
{ # Industry information for the customer profile.
&quot;citationIds&quot;: [ # Optional. The citation ids for the industry.
&quot;A String&quot;,
],
&quot;industry&quot;: &quot;A String&quot;, # Required. The name of the industry.
},
],
&quot;locations&quot;: [ # Optional. Locations the organization is present or conducts business in.
{ # Location information for the customer profile.
&quot;address&quot;: &quot;A String&quot;, # Required. The address of the location.
&quot;brand&quot;: &quot;A String&quot;, # Required. The brand of the location.
&quot;citationIds&quot;: [ # Optional. The citation ids for the location.
&quot;A String&quot;,
],
&quot;facilityType&quot;: &quot;A String&quot;, # Optional. The type of location.
},
],
&quot;org&quot;: &quot;A String&quot;, # Required. The name of the organization.
&quot;orgSummary&quot;: &quot;A String&quot;, # Optional. A summary of the organization.
&quot;parentCompanies&quot;: [ # Optional. The parent companies of the organization.
{ # Company information for the customer profile.
&quot;citationIds&quot;: [ # Optional. The citation ids for the company.
&quot;A String&quot;,
],
&quot;company&quot;: &quot;A String&quot;, # Required. The name of the company.
},
],
&quot;products&quot;: [ # Optional. Product information for the organization.
{ # Product information for the customer profile.
&quot;brand&quot;: &quot;A String&quot;, # Required. The brand of the product.
&quot;citationIds&quot;: [ # Optional. The citation ids for the product.
&quot;A String&quot;,
],
&quot;product&quot;: &quot;A String&quot;, # Required. The name of the product.
},
],
&quot;securityConsiderations&quot;: { # Security considerations for the customer profile. # Optional. Security considerations for the organization.
&quot;considerations&quot;: [ # Optional. A series of considerations for the security of the organization, such as &quot;high risk of compromise&quot; or &quot;vulnerable to cyberbullying&quot;.
&quot;A String&quot;,
],
&quot;note&quot;: &quot;A String&quot;, # Optional. A note about the security considerations.
},
&quot;summary&quot;: { # A summarized version of the customer profile. Generated by the backend. # Optional. A summarized version of the customer profile.
&quot;areaServed&quot;: { # A string with citation ids. # Optional. The area the customer serves.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;brands&quot;: { # A string with citation ids. # Optional. A narrative summary of brands.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;entityType&quot;: { # A string with citation ids. # Optional. The entity type of the customer.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;founded&quot;: { # A string with citation ids. # Optional. The date the customer was founded.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;headquarters&quot;: { # A string with citation ids. # Optional. The headquarters of the customer.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;industry&quot;: { # A string with citation ids. # Optional. The industry the customer is in.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;keyPeopleSummary&quot;: { # A string with citation ids. # Optional. A narrative summary of key people.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;parentCompany&quot;: { # A string with citation ids. # Optional. The parent company of the customer.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;primaryWebsite&quot;: { # A string with citation ids. # Optional. The primary website of the customer.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;productsSummary&quot;: { # A string with citation ids. # Optional. A narrative summary of products.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;servicesSummary&quot;: { # A string with citation ids. # Optional. A narrative summary of services.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;title&quot;: { # A string with citation ids. # Optional. The official name of the customer.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
},
&quot;technologyPresence&quot;: &quot;A String&quot;, # Optional. Technology presence of the organization.
&quot;webPresences&quot;: [ # Optional. Web presence of the organization.
{ # Web presence information for the customer profile.
&quot;citationIds&quot;: [ # Optional. The citation ids for the web presence.
&quot;A String&quot;,
],
&quot;domain&quot;: &quot;A String&quot;, # Required. The domain name of the web presence.
},
],
},
&quot;detailType&quot;: &quot;A String&quot;, # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union.
},
&quot;displayName&quot;: &quot;A String&quot;, # Output only. Human readable name for the configuration.
&quot;name&quot;: &quot;A String&quot;, # Identifier. Server generated name for the configuration. format is projects/{project}/configurations/{configuration}
&quot;provider&quot;: &quot;A String&quot;, # Required. Name of the service that provides the configuration.
&quot;state&quot;: &quot;A String&quot;, # Optional. State of the configuration.
&quot;version&quot;: &quot;A String&quot;, # Optional. A user-manipulatable version. Does not adhere to a specific format
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Get a list of configurations that meet the filter criteria.
Args:
parent: string, Required. Parent of the configuration. Format: vaults/{vault} (required)
filter: string, Optional. Filter criteria.
orderBy: string, Optional. Order by criteria in the csv format: &quot;field1,field2 desc&quot; or &quot;field1,field2&quot; or &quot;field1 asc, field2&quot;.
pageSize: integer, Optional. Page size.
pageToken: string, Optional. Page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ListConfigurations.
&quot;configurations&quot;: [ # List of configurations.
{ # A configuration represents a behavior an engine should follow when producing new findings.
&quot;audit&quot;: { # Tracks basic CRUD facts. # Output only. Audit information for the configuration.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Time of creation.
&quot;creator&quot;: &quot;A String&quot;, # Output only. Agent that created or updated the record, could be a UserId or a JobId.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time of creation or last update.
&quot;updater&quot;: &quot;A String&quot;, # Output only. Agent that last updated the record, could be a UserId or a JobId.
},
&quot;description&quot;: &quot;A String&quot;, # Optional. A description of the configuration.
&quot;detail&quot;: { # Wrapper class that contains the union struct for all the various configuration detail specific classes. # Required. Domain specific details for the configuration.
&quot;customerProfile&quot;: { # CustomerProfileConfig is the configuration for the customer profile. # Customer Profile detail config.
&quot;citations&quot;: [ # Optional. Citations for the organization profile.
{ # Citation information for the customer profile.
&quot;citationId&quot;: &quot;A String&quot;, # Required. The citation id for the citation. Should be unique within the profile.
&quot;document&quot;: &quot;A String&quot;, # Required. The name of the document the citation is from.
&quot;retrievalTime&quot;: &quot;A String&quot;, # The time the citation was retrieved.
&quot;source&quot;: &quot;A String&quot;, # Required. The source of the citation.
&quot;uri&quot;: &quot;A String&quot;, # Optional. The url of the citation.
},
],
&quot;contactInfo&quot;: [ # Optional. Contact information for the organization.
{ # Contact information for the customer profile.
&quot;address&quot;: &quot;A String&quot;, # The address of the contact.
&quot;citationIds&quot;: [ # Optional. The citation ids for the contact information.
&quot;A String&quot;,
],
&quot;email&quot;: &quot;A String&quot;, # The email address of the contact.
&quot;label&quot;: &quot;A String&quot;, # Optional. The name of the contact.
&quot;other&quot;: &quot;A String&quot;, # The other contact information.
&quot;phone&quot;: &quot;A String&quot;, # The phone number of the contact.
},
],
&quot;executives&quot;: [ # Optional. Executives of the organization.
{ # Person information for the customer profile.
&quot;citationIds&quot;: [ # Optional. The citation ids for the person.
&quot;A String&quot;,
],
&quot;name&quot;: &quot;A String&quot;, # Required. The name of the person.
&quot;title&quot;: &quot;A String&quot;, # Optional. The title of the person.
},
],
&quot;industries&quot;: [ # Optional. The industries the organization is involved in.
{ # Industry information for the customer profile.
&quot;citationIds&quot;: [ # Optional. The citation ids for the industry.
&quot;A String&quot;,
],
&quot;industry&quot;: &quot;A String&quot;, # Required. The name of the industry.
},
],
&quot;locations&quot;: [ # Optional. Locations the organization is present or conducts business in.
{ # Location information for the customer profile.
&quot;address&quot;: &quot;A String&quot;, # Required. The address of the location.
&quot;brand&quot;: &quot;A String&quot;, # Required. The brand of the location.
&quot;citationIds&quot;: [ # Optional. The citation ids for the location.
&quot;A String&quot;,
],
&quot;facilityType&quot;: &quot;A String&quot;, # Optional. The type of location.
},
],
&quot;org&quot;: &quot;A String&quot;, # Required. The name of the organization.
&quot;orgSummary&quot;: &quot;A String&quot;, # Optional. A summary of the organization.
&quot;parentCompanies&quot;: [ # Optional. The parent companies of the organization.
{ # Company information for the customer profile.
&quot;citationIds&quot;: [ # Optional. The citation ids for the company.
&quot;A String&quot;,
],
&quot;company&quot;: &quot;A String&quot;, # Required. The name of the company.
},
],
&quot;products&quot;: [ # Optional. Product information for the organization.
{ # Product information for the customer profile.
&quot;brand&quot;: &quot;A String&quot;, # Required. The brand of the product.
&quot;citationIds&quot;: [ # Optional. The citation ids for the product.
&quot;A String&quot;,
],
&quot;product&quot;: &quot;A String&quot;, # Required. The name of the product.
},
],
&quot;securityConsiderations&quot;: { # Security considerations for the customer profile. # Optional. Security considerations for the organization.
&quot;considerations&quot;: [ # Optional. A series of considerations for the security of the organization, such as &quot;high risk of compromise&quot; or &quot;vulnerable to cyberbullying&quot;.
&quot;A String&quot;,
],
&quot;note&quot;: &quot;A String&quot;, # Optional. A note about the security considerations.
},
&quot;summary&quot;: { # A summarized version of the customer profile. Generated by the backend. # Optional. A summarized version of the customer profile.
&quot;areaServed&quot;: { # A string with citation ids. # Optional. The area the customer serves.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;brands&quot;: { # A string with citation ids. # Optional. A narrative summary of brands.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;entityType&quot;: { # A string with citation ids. # Optional. The entity type of the customer.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;founded&quot;: { # A string with citation ids. # Optional. The date the customer was founded.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;headquarters&quot;: { # A string with citation ids. # Optional. The headquarters of the customer.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;industry&quot;: { # A string with citation ids. # Optional. The industry the customer is in.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;keyPeopleSummary&quot;: { # A string with citation ids. # Optional. A narrative summary of key people.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;parentCompany&quot;: { # A string with citation ids. # Optional. The parent company of the customer.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;primaryWebsite&quot;: { # A string with citation ids. # Optional. The primary website of the customer.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;productsSummary&quot;: { # A string with citation ids. # Optional. A narrative summary of products.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;servicesSummary&quot;: { # A string with citation ids. # Optional. A narrative summary of services.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;title&quot;: { # A string with citation ids. # Optional. The official name of the customer.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
},
&quot;technologyPresence&quot;: &quot;A String&quot;, # Optional. Technology presence of the organization.
&quot;webPresences&quot;: [ # Optional. Web presence of the organization.
{ # Web presence information for the customer profile.
&quot;citationIds&quot;: [ # Optional. The citation ids for the web presence.
&quot;A String&quot;,
],
&quot;domain&quot;: &quot;A String&quot;, # Required. The domain name of the web presence.
},
],
},
&quot;detailType&quot;: &quot;A String&quot;, # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union.
},
&quot;displayName&quot;: &quot;A String&quot;, # Output only. Human readable name for the configuration.
&quot;name&quot;: &quot;A String&quot;, # Identifier. Server generated name for the configuration. format is projects/{project}/configurations/{configuration}
&quot;provider&quot;: &quot;A String&quot;, # Required. Name of the service that provides the configuration.
&quot;state&quot;: &quot;A String&quot;, # Optional. State of the configuration.
&quot;version&quot;: &quot;A String&quot;, # Optional. A user-manipulatable version. Does not adhere to a specific format
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # Page token.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="upsert">upsert(parent, body=None, publishTime=None, x__xgafv=None)</code>
<pre>Creates or updates a configuration.
Args:
parent: string, Required. Parent of the configuration. (required)
body: object, The request body.
The object takes the form of:
{ # A configuration represents a behavior an engine should follow when producing new findings.
&quot;audit&quot;: { # Tracks basic CRUD facts. # Output only. Audit information for the configuration.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Time of creation.
&quot;creator&quot;: &quot;A String&quot;, # Output only. Agent that created or updated the record, could be a UserId or a JobId.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time of creation or last update.
&quot;updater&quot;: &quot;A String&quot;, # Output only. Agent that last updated the record, could be a UserId or a JobId.
},
&quot;description&quot;: &quot;A String&quot;, # Optional. A description of the configuration.
&quot;detail&quot;: { # Wrapper class that contains the union struct for all the various configuration detail specific classes. # Required. Domain specific details for the configuration.
&quot;customerProfile&quot;: { # CustomerProfileConfig is the configuration for the customer profile. # Customer Profile detail config.
&quot;citations&quot;: [ # Optional. Citations for the organization profile.
{ # Citation information for the customer profile.
&quot;citationId&quot;: &quot;A String&quot;, # Required. The citation id for the citation. Should be unique within the profile.
&quot;document&quot;: &quot;A String&quot;, # Required. The name of the document the citation is from.
&quot;retrievalTime&quot;: &quot;A String&quot;, # The time the citation was retrieved.
&quot;source&quot;: &quot;A String&quot;, # Required. The source of the citation.
&quot;uri&quot;: &quot;A String&quot;, # Optional. The url of the citation.
},
],
&quot;contactInfo&quot;: [ # Optional. Contact information for the organization.
{ # Contact information for the customer profile.
&quot;address&quot;: &quot;A String&quot;, # The address of the contact.
&quot;citationIds&quot;: [ # Optional. The citation ids for the contact information.
&quot;A String&quot;,
],
&quot;email&quot;: &quot;A String&quot;, # The email address of the contact.
&quot;label&quot;: &quot;A String&quot;, # Optional. The name of the contact.
&quot;other&quot;: &quot;A String&quot;, # The other contact information.
&quot;phone&quot;: &quot;A String&quot;, # The phone number of the contact.
},
],
&quot;executives&quot;: [ # Optional. Executives of the organization.
{ # Person information for the customer profile.
&quot;citationIds&quot;: [ # Optional. The citation ids for the person.
&quot;A String&quot;,
],
&quot;name&quot;: &quot;A String&quot;, # Required. The name of the person.
&quot;title&quot;: &quot;A String&quot;, # Optional. The title of the person.
},
],
&quot;industries&quot;: [ # Optional. The industries the organization is involved in.
{ # Industry information for the customer profile.
&quot;citationIds&quot;: [ # Optional. The citation ids for the industry.
&quot;A String&quot;,
],
&quot;industry&quot;: &quot;A String&quot;, # Required. The name of the industry.
},
],
&quot;locations&quot;: [ # Optional. Locations the organization is present or conducts business in.
{ # Location information for the customer profile.
&quot;address&quot;: &quot;A String&quot;, # Required. The address of the location.
&quot;brand&quot;: &quot;A String&quot;, # Required. The brand of the location.
&quot;citationIds&quot;: [ # Optional. The citation ids for the location.
&quot;A String&quot;,
],
&quot;facilityType&quot;: &quot;A String&quot;, # Optional. The type of location.
},
],
&quot;org&quot;: &quot;A String&quot;, # Required. The name of the organization.
&quot;orgSummary&quot;: &quot;A String&quot;, # Optional. A summary of the organization.
&quot;parentCompanies&quot;: [ # Optional. The parent companies of the organization.
{ # Company information for the customer profile.
&quot;citationIds&quot;: [ # Optional. The citation ids for the company.
&quot;A String&quot;,
],
&quot;company&quot;: &quot;A String&quot;, # Required. The name of the company.
},
],
&quot;products&quot;: [ # Optional. Product information for the organization.
{ # Product information for the customer profile.
&quot;brand&quot;: &quot;A String&quot;, # Required. The brand of the product.
&quot;citationIds&quot;: [ # Optional. The citation ids for the product.
&quot;A String&quot;,
],
&quot;product&quot;: &quot;A String&quot;, # Required. The name of the product.
},
],
&quot;securityConsiderations&quot;: { # Security considerations for the customer profile. # Optional. Security considerations for the organization.
&quot;considerations&quot;: [ # Optional. A series of considerations for the security of the organization, such as &quot;high risk of compromise&quot; or &quot;vulnerable to cyberbullying&quot;.
&quot;A String&quot;,
],
&quot;note&quot;: &quot;A String&quot;, # Optional. A note about the security considerations.
},
&quot;summary&quot;: { # A summarized version of the customer profile. Generated by the backend. # Optional. A summarized version of the customer profile.
&quot;areaServed&quot;: { # A string with citation ids. # Optional. The area the customer serves.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;brands&quot;: { # A string with citation ids. # Optional. A narrative summary of brands.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;entityType&quot;: { # A string with citation ids. # Optional. The entity type of the customer.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;founded&quot;: { # A string with citation ids. # Optional. The date the customer was founded.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;headquarters&quot;: { # A string with citation ids. # Optional. The headquarters of the customer.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;industry&quot;: { # A string with citation ids. # Optional. The industry the customer is in.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;keyPeopleSummary&quot;: { # A string with citation ids. # Optional. A narrative summary of key people.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;parentCompany&quot;: { # A string with citation ids. # Optional. The parent company of the customer.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;primaryWebsite&quot;: { # A string with citation ids. # Optional. The primary website of the customer.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;productsSummary&quot;: { # A string with citation ids. # Optional. A narrative summary of products.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;servicesSummary&quot;: { # A string with citation ids. # Optional. A narrative summary of services.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
&quot;title&quot;: { # A string with citation ids. # Optional. The official name of the customer.
&quot;citationIds&quot;: [ # Optional. The citation ids for the string.
&quot;A String&quot;,
],
&quot;value&quot;: &quot;A String&quot;, # Required. The value of the string.
},
},
&quot;technologyPresence&quot;: &quot;A String&quot;, # Optional. Technology presence of the organization.
&quot;webPresences&quot;: [ # Optional. Web presence of the organization.
{ # Web presence information for the customer profile.
&quot;citationIds&quot;: [ # Optional. The citation ids for the web presence.
&quot;A String&quot;,
],
&quot;domain&quot;: &quot;A String&quot;, # Required. The domain name of the web presence.
},
],
},
&quot;detailType&quot;: &quot;A String&quot;, # Output only. Name of the detail type. Will be set by the server during creation to the name of the field that is set in the detail union.
},
&quot;displayName&quot;: &quot;A String&quot;, # Output only. Human readable name for the configuration.
&quot;name&quot;: &quot;A String&quot;, # Identifier. Server generated name for the configuration. format is projects/{project}/configurations/{configuration}
&quot;provider&quot;: &quot;A String&quot;, # Required. Name of the service that provides the configuration.
&quot;state&quot;: &quot;A String&quot;, # Optional. State of the configuration.
&quot;version&quot;: &quot;A String&quot;, # Optional. A user-manipulatable version. Does not adhere to a specific format
}
publishTime: string, Optional. Time that the configuration should be considered to have been published. This is an advanced feature used when onboarding and bulk loading data from other systems. Do not set this field without consulting with the API team.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for UpsertConfiguration.
&quot;configuration&quot;: &quot;A String&quot;, # Output only. Created configuration ID with server assigned id.
}</pre>
</div>
</body></html>